SteeringFileTest Class Reference

Inheritance diagram for SteeringFileTest:

Collaboration diagram for SteeringFileTest:

Public Member Functions
def	test_lessons_1_to_5 (self)

Private 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, change_working_directory=True)

Detailed Description

Test steering files 

Definition at line 31 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,   change_working_directory = True  )

private

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
    expensive_tests (list(str)): (optional) names of scripts that take
longer and should e.g. not run on bamboo
    additional_arguments (list(str)): (optional) additional arguments
for basf2 to be passed when testing the scripts
    change_working_directory: Change to path_to_glob for execution

Definition at line 34 of file steering_files.py.

    def _test_examples_dir(
        self,
        path_to_glob: str,
        broken: Optional[List[str]] = None,
        additional_arguments: Optional[List[str]] = None,
        expensive_tests: Optional[List[str]] = None,
        change_working_directory=True,
    ):
        """
        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
            expensive_tests (list(str)): (optional) names of scripts that take
                longer and should e.g. not run on bamboo
            additional_arguments (list(str)): (optional) additional arguments
                for basf2 to be passed when testing the scripts
            change_working_directory: Change to path_to_glob for execution
        """
        if additional_arguments is None:
            additional_arguments = []
        if broken is None:
            broken = []
        if expensive_tests is None:
            expensive_tests = []
        working_dir = find_file(path_to_glob)
        all_egs = sorted(glob.glob(working_dir + "/*.py"))
        for eg in all_egs:
            filename = os.path.basename(eg)
            if filename in broken:
                continue
            if skip_expensive_tests and filename in expensive_tests:
                continue
            with self.subTest(msg=filename):
                result = subprocess.run(
                    ["basf2", "-n1", 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)
 

---

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

• online_book/tests/steering_files.py