python.Checks.MetadataCheck Class Reference

Inheritance diagram for python.Checks.MetadataCheck:

Collaboration diagram for python.Checks.MetadataCheck:

Public Member Functions
None	__init__ (self, TestSetup setup, str input_format)
bool	run (self, WorkflowTest test)
Path|None	reference_file (self, "WorkflowTest" test, str file_name)

Public Attributes
	format = input_format
	setup = setup
	logger = setup.logger

Detailed Description

Run metadata check.

Definition at line 239 of file Checks.py.

Constructor & Destructor Documentation

__init__()

None python.Checks.MetadataCheck.__init__	(		self,
		TestSetup	setup,
		str	input_format )

Definition at line 242 of file Checks.py.

    def __init__(self, setup: TestSetup, input_format: str) -> None:
        super().__init__(setup)
        self.format = input_format
 

Member Function Documentation

reference_file()

Path | None python.Test.WorkflowCheck.reference_file ( self, "WorkflowTest" test, str file_name )

inherited

Definition at line 93 of file Tools/WorkflowTestRunner/python/Test.py.

    def reference_file(self, test: "WorkflowTest", file_name: str) -> Path | None:
        reference_path: Path = test.reference_path
        reference_file = reference_path / file_name
 
        # Read references from CVMFS
        if self.setup.validation_only:
            # Resolve the subfolder first. Results are stored like: main_folder/branch/test/version/.
            reference_revision = references_map[f"{test.ID}"]
            cvmfs_path = Path(references_CVMFS_path)
            rel_path = Path(self.setup.release_ID) / test.ID / reference_revision
            reference_path = cvmfs_path / rel_path
            reference_file = reference_path / file_name
 
            if not reference_path.exists():
                self.logger.error(f"CVMFS reference location {reference_path} does not exist!")
                return None
 
            if references_override_url is not None:
                import requests
 
                url = references_override_url
                if not url.endswith("/"): url += "/"
                url += str(rel_path / file_name)
                self.logger.info("Checking for reference override at %s", url)
                if requests.head(url).ok: # file exists at url
                    reference_file = Path.cwd() / f"reference_{file_name}"
                    self.logger.info("Downloading reference from %s to %s", url, reference_file)
                    r = requests.get(url, stream=True)
                    with reference_file.open('wb') as f:
                        for chunk in r.iter_content(chunk_size=1024):
                            if chunk: # filter out keep-alive new chunks
                                f.write(chunk)
                else:
                    self.logger.info("No reference override found")
 
        return reference_file
 
 

run()

bool python.Checks.MetadataCheck.run	(		self,
		WorkflowTest	test )

Definition at line 246 of file Checks.py.

    def run(self, test: WorkflowTest) -> bool:
        self.logger.info("---------------------------------------------------------------------------------------")
        self.logger.info(f"Running {test.ID} metadata check on {self.format}")
 
        file_name = f"my{self.format}.pool.root"
        if test.type == WorkflowType.Derivation:
            file_name = f"{self.format}.myOutput.pool.root"
 
        reference_file = self.reference_file(test, file_name)
        if reference_file is None:
            self.logger.error(f"Reference file {file_name} not found")
            return False
 
        self.logger.info(f"Reading the reference file from location {reference_file}")
 
        exclusion_list = " ".join([
            "file_guid", "file_size",
            "/TagInfo/AtlasRelease", "FileMetaData/productionRelease",
        ] + ([
            "auto_flush",
            "StreamDAOD_PHYS/eventTypes", "StreamDAOD_PHYSLITE/eventTypes",
        ] if test.type is WorkflowType.Derivation else []))
 
        validation_file = test.validation_path / file_name
        log_file = test.validation_path / f"meta-diff-{test.ID}.{self.format}.log"
 
        comparison_command = f"meta-diff --ordered -m full -x diff {reference_file} {validation_file} --drop {exclusion_list} --ignoreTrigger > {log_file} 2>&1"
        output, error = subprocess.Popen(["/bin/bash", "-c", comparison_command], stdout=subprocess.PIPE, stderr=subprocess.PIPE).communicate()
        output, error = output.decode("utf-8"), error.decode("utf-8")
 
        result = True
        with log_file.open() as file:
            for line in file:
                if line.strip():
                    result = False
 
        if result:
            self.logger.info("Passed!\n")
        else:
            # print CI helper directly to avoid logger decorations
            if self.setup.disable_release_setup:
                self.logger.print(f"ATLAS-CI-ADD-LABEL: {test.run.value}-{test.type.value}-output-changed")
                self.logger.print("")
 
            self.logger.error(f"Your change breaks the frozen tier0 policy in test {test.ID}.")
            self.logger.error("Please make sure this has been discussed in the correct meeting (RIG or Simulation) meeting and approved by the relevant experts.")
 
            # copy the artifacts
            if self.setup.disable_release_setup:
                comparison_command = f"CopyCIArtifact.sh {validation_file}"
                output, error = subprocess.Popen(["/bin/bash", "-c", comparison_command], stdout=subprocess.PIPE, stderr=subprocess.PIPE).communicate()
                output, error = output.decode("utf-8"), error.decode("utf-8")
 
                if error or not output:
                    self.logger.error(f"Tried copying '{validation_file}' to the CI artifacts area but it failed.")
                    self.logger.error(f"  {error.strip()}")
                else:
                    self.logger.error(output)
 
            with log_file.open() as file:
                for line in file:
                    self.logger.info(f"  {line.strip()}")
                self.logger.info("-----------------------------------------------------\n")
 
        return result
 

Member Data Documentation

format

python.Checks.MetadataCheck.format = input_format

Definition at line 244 of file Checks.py.

logger

python.Test.WorkflowCheck.logger = setup.logger

inherited

Definition at line 91 of file Tools/WorkflowTestRunner/python/Test.py.

setup

python.Test.WorkflowCheck.setup = setup

inherited

Definition at line 90 of file Tools/WorkflowTestRunner/python/Test.py.

---

The documentation for this class was generated from the following file:

• Checks.py