examples.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
 
import os
import sys
import subprocess
import unittest
import glob
from basf2 import find_file
from b2test_utils import clean_working_directory, skip_test_if_light
 
 
class ExamplesTest(unittest.TestCase):
    """Test to run all example scripts."""
 
    @unittest.skipIf(not os.getenv('BELLE2_EXAMPLES_DATA_DIR'),
                     "$BELLE2_EXAMPLES_DATA_DIR not found.")
    @unittest.skipIf(not os.getenv('BELLE2_VALIDATION_DATA_DIR'),
                     "$BELLE2_VALIDATION_DATA_DIR not found.")
    def _test_examples_dir(self, path_to_glob, broken=[]):
        """
        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
        """
        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], 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)
 
    def test_calibration_examples(self):
        """
        Test supported calibration examples.
        """
        skip_test_if_light(self)  # calibration dataobjects not supported in light releases
 
        # list of the broken examples (to be removed when they are individually fixed)
        broken_cal_egs = ['B2CAL901-cDSTECLTRG.py'  # BII-4276
                          ]
 
        self._test_examples_dir('analysis/examples/calibration/', broken_cal_egs)
 
    def test_fei_examples(self):
        """
        Test supported FEI examples.
        """
 
        self._test_examples_dir('analysis/examples/FEI/')
 
    def test_fitting_examples(self):
        """
        Test supported fitting examples.
        """
 
        self._test_examples_dir('analysis/examples/fitting/')
 
    def test_mva_examples(self):
        """
        Test supported mva examples.
        """
        # list of the broken examples (to be removed when they are individually fixed)
        broken_mva_egs = ['B2A711-DeepContinuumSuppression_Input.py',  # BII-4279
                          'B2A713-DeepContinuumSuppression_MVAExpert.py',  # BII-4279
                          'B2A712-DeepContinuumSuppression_MVATrain.py',  # BII-4279
                          'B2A714-DeepContinuumSuppression_MVAModel.py'  # BII-4279
                          ]
 
        self._test_examples_dir('analysis/examples/mva/', broken_mva_egs)
 
    def test_reconstruction_examples(self):
        """
        Test supported reconstruction examples.
        """
 
        self._test_examples_dir('analysis/examples/reconstruction/')
 
    def test_simulation_examples(self):
        """
        Test supported simulation examples.
        """
        skip_test_if_light(self)  # simulation doesn't work in light releaes
 
        # list of the broken examples (to be removed when they are individually fixed)
        broken_sim_egs = ['B2A104-SimulateAndReconstruct-withBeamBkg.py'
                          ]
 
        self._test_examples_dir('analysis/examples/simulations/', broken_sim_egs)
 
    def test_tagging_examples(self):
        """
        Test supported tagging examples.
        """
 
        self._test_examples_dir('analysis/examples/tagging/')
 
    def test_variablemanager_examples(self):
        """
        Test supported variable manager examples.
        """
 
        self._test_examples_dir('analysis/examples/VariableManager/')
 
    def test_postmdstidentification_examples(self):
        """
        Test supported PostMdstIdentification examples.
        """
 
        self._test_examples_dir('analysis/examples/PostMdstIdentification/')
 
 
if __name__ == '__main__':
    with clean_working_directory():
        unittest.main()