ExamplesTest Class Reference

Inheritance diagram for ExamplesTest:

Collaboration diagram for ExamplesTest:

Protected Member Functions
	_test_examples_dir (self, path_to_glob, broken=None, filepattern="", nevents=10, cleanup=False)

Detailed Description

Test to run all example scripts.

Definition at line 21 of file b2test_utils_analysis.py.

Member Function Documentation

_test_examples_dir()

_test_examples_dir ( self, path_to_glob, broken = None, filepattern = "", nevents = 10, cleanup = False )

protected

Internal function to test a directory full of example scripts with an optional list of broken scripts to be skipped.

Parameters:
    path_to_glob (str): the path to search for scripts
    broken (list(str)): (optional) scripts that are known to be broken and can be skipped

Definition at line 28 of file b2test_utils_analysis.py.

    def _test_examples_dir(self, path_to_glob, broken=None, filepattern="", nevents=10, cleanup=False):
        """
        Internal function to test a directory full of example scripts with an optional list of broken scripts to be skipped.
 
        Parameters:
            path_to_glob (str): the path to search for scripts
            broken (list(str)): (optional) scripts that are known to be broken and can be skipped
        """
        if broken is None:
            broken = []
        configure_logging_for_tests()
        all_egs = sorted(glob.glob(find_file(path_to_glob) + f"/{filepattern}*.py"))
        for eg in all_egs:
            with (clean_working_directory() if cleanup else nullcontext()):
                filename = os.path.basename(eg)
                if filename not in broken:
                    with self.subTest(msg=filename):
                        outputfilename = filename.replace('.py', '.root')
                        result = subprocess.run(['basf2', '-n', f'{nevents}', eg, '-o',
                                                outputfilename], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
                        if result.returncode != 0:
                            # failure running example so let's print the output
                            # on stderr so it's not split from output of unittest
                            # done like this since we don't want to decode/encode utf8
                            sys.stdout.buffer.write(result.stdout)
                        self.assertEqual(result.returncode, 0)
 
                        if os.path.exists(outputfilename) and isNtuple(outputfilename):
                            scanTTree(outputfilename)
 
 

---

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

• analysis/scripts/b2test_utils_analysis.py