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, path_to_glob, broken=None, additional_arguments=None)

Detailed Description

Test steering files 

Definition at line 18 of file steering_files.py.

Member Function Documentation

_test_examples_dir()

def _test_examples_dir (   self,   path_to_glob,   broken = None,   additional_arguments = None  )

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 search for scripts
    broken (list(str)): (optional) scripts that are known to be broken
and can be skipped

Definition at line 21 of file steering_files.py.

    def _test_examples_dir(self, path_to_glob, broken=None, additional_arguments=None):
        """
        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 additional_arguments is None:
            additional_arguments = []
        if broken is None:
            broken = []
        all_egs = sorted(glob.glob(find_file(path_to_glob) + "/*.py"))
        for eg in all_egs:
            filename = os.path.basename(eg)
            if filename not in broken:
                with self.subTest(msg=filename):
                    result = subprocess.run(
                        ["basf2", "-n1", eg, *additional_arguments],
                        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)
 

---

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

• online_book/tests/steering_files.py