LHCb Workflow: AnalyseXMLSummary command

[aldbr]

Please read #67 first.

• disentangle the module (https://gitlab.cern.ch/lhcb-dirac/LHCbDIRAC/-/blob/devel/src/LHCbDIRAC/Workflow/Modules/AnalyseXMLSummary.py?ref_type=heads)

---

Once you have the green light:

• implement it
• unit test it (reuse the existing ones as much as possible, adapting the code to the conventions of the repo https://gitlab.cern.ch/lhcb-dirac/LHCbDIRAC/-/blob/devel/src/LHCbDIRAC/Workflow/Modules/test/Test_Modules_AnalyseXMLSummary.py?ref_type=heads)
• document it correctly (you can ask for clarification here of course, code is not obvious)

[AcquaDiGiorgio]

If I understood this module correctly, and from the talks with @aldbr, if we want the module to be executed after every GaudiApplication and not only at the end of the workflow, it should be completely contained on a CommandLineTool implementation of lb-prod-run.

Separating each part as a bullet point:

• _resolveInputVariables gets the path of the file containing the XMLSummary and the FileReport. It does not need anything else.
• The first conditional of the execute function and the _basicSuccess function perform a series of checks in relation to the contents of the XMLSummary file. _basicSuccess also calls the FileReport in case of a failing condition.
• _finalizeWithErrors saves the contents of "listoutput" in "outputList", both from the workflowCommons. This only executes if any of the previous checks fail.

The only part that I'm unsure about is the FileReport, which could be contained at the post-process stage.

The AnalyseXMLSummary module could be summarised as:

jobPasses = (
	self.XMLSummary_o.success == "True"
	and self.XMLSummary_o.step == "finalize"
	and self.XMLSummary_o._outputsOK()
	and not self.XMLSummary_o.inputFileStats["mult"]
	and not self.XMLSummary_o.inputFileStats["other"]
	and (not self.XMLSummary_o.inputFileStats["part"] or self.numberOfEvents != -1)
	and not self.XMLSummary_o.inputFileStats["fail"]
)

if not jobPasses:
	if "outputList" not in self.workflow_commons:
		self.workflow_commons["outputList"] = self.step_commons["listoutput"]
	else:
		self.workflow_commons["outputList"].extend(self.workflow_commons["listoutput"])

The current devel branch of LHCbDIRAC removed the DebugLFNs and nc.sendMail parts at _finalizeWithErrors that could have been executed at the end of the workflow instead of after every step, but I don't think there is now anything that should be executed at that stage.