SteeringFileTest Class Reference

Inheritance diagram for SteeringFileTest:

Collaboration diagram for SteeringFileTest:

Public Member Functions
def	test_lessons_1_to_5 (self)

Protected Member Functions
def	_test_examples_dir (self, str path_to_glob, Optional[List[str]] broken=None, Optional[List[str]] additional_arguments=None, Optional[List[str]] expensive_tests=None, Optional[List[str]] skip_in_light=None, Optional[List[str]] skip=None, Optional[Dict[str, int]] n_events=None)

Detailed Description

Test steering files

Definition at line 101 of file steering_files.py.

Member Function Documentation

_test_examples_dir()

def _test_examples_dir (   self, str  path_to_glob, Optional[List[str]]   broken = None, Optional[List[str]]   additional_arguments = None, Optional[List[str]]   expensive_tests = None, Optional[List[str]]   skip_in_light = None, Optional[List[str]]   skip = None, Optional[Dict[str, int]]   n_events = None  )

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 a directory to search for python
        scripts (must end in .py)
    broken (list(str)): (optional) names of scripts that are known to
        be broken and can be skipped
    additional_arguments (list(str)): (optional) additional arguments
        for basf2 to be passed when testing the scripts
    expensive_tests (list(str)): (optional) names of scripts that take
        longer and should e.g. not run in GitLab pipeline
    skip_in_light (list(str)): (optional) names of scripts that have to
        be excluded in light builds
    skip (list(str)): (optional) names of scripts to always skip
    n_events (dict(str, int)): mapping of name of script to number of
        required events for it to run (`-n` argument). If a filename
        isn't listed, we assume 1

Definition at line 104 of file steering_files.py.

    ):
        """
        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 a directory to search for python
                scripts (must end in .py)
            broken (list(str)): (optional) names of scripts that are known to
                be broken and can be skipped
            additional_arguments (list(str)): (optional) additional arguments
                for basf2 to be passed when testing the scripts
            expensive_tests (list(str)): (optional) names of scripts that take
                longer and should e.g. not run in GitLab pipeline
            skip_in_light (list(str)): (optional) names of scripts that have to
                be excluded in light builds
            skip (list(str)): (optional) names of scripts to always skip
            n_events (dict(str, int)): mapping of name of script to number of
                required events for it to run (`-n` argument). If a filename
                isn't listed, we assume 1
        """
        if additional_arguments is None:
            additional_arguments = []
        if broken is None:
            broken = []
        if expensive_tests is None:
            expensive_tests = []
        if skip_in_light is None:
            skip_in_light = []
        if skip is None:
            skip = []
        if n_events is None:
            n_events = {}
        # we have to copy all the steering files (plus other stuffs, like decfiles) we want to test
        # into a new directory and then cd it as working directory when subprocess.run is executed,
        # otherwise the test will fail horribly if find_file is called by one of the tested steerings.
        original_dir = find_file(path_to_glob)
        print(f"Our user id: {os.getuid()}")
        _permission_report(original_dir)
        working_dir = find_file(shutil.copytree(original_dir, "working_dir"))
        _permission_report(working_dir)
        # Add write permissions for user to this directory
        os.chmod(working_dir, 0o744)
        _permission_report(working_dir)
        all_egs = sorted(glob.glob(working_dir + "/*.py"))
        for eg in all_egs:
            filename = os.path.basename(eg)
            if filename in broken:
                continue
            if is_ci() and filename in expensive_tests:
                continue
            if light_release() and filename in skip_in_light:
                continue
            if filename in skip:
                continue
            with self.subTest(msg=filename):
                # pylint: disable=subprocess-run-check
                result = subprocess.run(
                    [
                        "basf2",
                        "-n",
                        str(n_events.get(filename, 1)),
                        eg,
                        *additional_arguments,
                    ],
                    stdout=subprocess.PIPE,
                    stderr=subprocess.STDOUT,
                    cwd=working_dir,
                )
                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)
 

test_lessons_1_to_5()

def test_lessons_1_to_5

(

self

)

Test lesson on basf2 basics.

Definition at line 201 of file steering_files.py.

    def test_lessons_1_to_5(self):
        """Test lesson on basf2 basics."""
        self._test_examples_dir(
            path_to_glob="online_book/basf2/steering_files",
            additional_arguments=["1"],
            expensive_tests=["065_generate_mc.py", "067_generate_mc.py"],
            skip_in_light=[
                "065_generate_mc.py",
                "067_generate_mc.py",
                "085_module.py",
                "087_module.py",
            ],
            n_events={
                # See https://questions.belle2.org/question/11344/
                "091_cs.py": 3000,
            },
        )
 
 

---

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

• online_book/tests/steering_files.py