check_payload_metadata.py

 
'''
Check the revision number of a payload used by a module.
'''
 
import os
 
import basf2 as b2
import b2test_utils as b2tu
from ROOT import Belle2  # noqa: make Belle2 namespace accessible
import ROOT.Belle2 as B2
 
 
class CheckPayloadMetadata(b2.Module):
    '''
    Small module for checking some payload metadata.
    '''
 
    def __init__(self, use_testing_payloads, md5_revision):
        '''Consructor.'''
        super().__init__()
        
        self.beam_parameters = B2.PyDBObj('BeamParameters')
        
        self.use_testing_payloads = use_testing_payloads
        
        self.md5_revision = md5_revision
 
    def beginRun(self):
        '''Begin run.'''
        assert (self.beam_parameters.isValid())
        if self.use_testing_payloads:
            assert ('testingdb/testingdb.txt' in self.beam_parameters.getGlobaltag())
            assert (self.beam_parameters.getRevision() == 0)
            assert (os.path.basename(self.beam_parameters.getFilename()).startswith('dbstore'))
            assert (os.path.basename(self.beam_parameters.getFilename()).index(self.md5_revision) != -1)
            assert (self.beam_parameters.getIoV() == B2.IntervalOfValidity(0, 1, 2, 3))
        else:
            assert (self.beam_parameters.getGlobaltag() == b2.conditions.default_globaltags[0])
            assert (self.beam_parameters.getRevision() > 0)
            assert (self.beam_parameters.getFilename().startswith('/cvmfs'))
            assert (self.beam_parameters.getIoV() == B2.IntervalOfValidity(0, 0, 0, -1))
 
 
def create_beam_parameters_payload(testing_database_path):
    '''
    Create locally a BeamParameters payload.
    '''
    b2.conditions.expert_settings(save_payloads=testing_database_path)
    beam_parameters = B2.BeamParameters()
    database = B2.Database.Instance()
    iov = B2.IntervalOfValidity(0, 1, 2, 3)
    assert (database.storeData('BeamParameters', beam_parameters, iov))
 
 
def testing_path(use_testing_payloads=False, remove_default_globaltag=False, testing_database_path=None, md5_revision=None):
    '''
    The basf2 steering path for this test.
    '''
    if remove_default_globaltag:
        b2.conditions.override_globaltags()
    if use_testing_payloads:
        b2.conditions.prepend_testing_payloads(b2.find_file(testing_database_path))
    testing_path = b2.Path()
    testing_path.add_module('EventInfoSetter', expList=[0], runList=[1])
    testing_path.add_module(CheckPayloadMetadata(use_testing_payloads=use_testing_payloads, md5_revision=md5_revision))
    b2.process(testing_path)
 
 
if __name__ == '__main__':
 
    with b2tu.clean_working_directory():
 
        
        testing_database_path = 'testingdb/testingdb.txt'
 
        # Create the testing payloads.
        assert (b2tu.run_in_subprocess(target=create_beam_parameters_payload, testing_database_path=testing_database_path) == 0)
 
        # Identify the md5 revision string of the payload.
        
        md5_revision = None
        with open(b2.find_file('testingdb/testingdb.txt')) as testing_database_file:
            for line in testing_database_file:
                md5_revision = str(line.split(' ')[1])
 
        # Check if the process aborts because no valid payloads are found.
        assert (b2tu.run_in_subprocess(target=testing_path,
                                       use_testing_payloads=False,
                                       remove_default_globaltag=True,
                                       ) == 1)
 
        # Check if the default globaltag is correctly used.
        assert (b2tu.run_in_subprocess(target=testing_path,
                                       use_testing_payloads=False,
                                       remove_default_globaltag=False,
                                       ) == 0)
 
        # Check if the testing payload is correctly used.
        assert (b2tu.run_in_subprocess(target=testing_path,
                                       use_testing_payloads=True,
                                       remove_default_globaltag=True,
                                       testing_database_path=testing_database_path,
                                       md5_revision=md5_revision,
                                       ) == 0)
 
        # Check if the testing payload is used instead of the default globaltag.
        assert (b2tu.run_in_subprocess(target=testing_path,
                                       use_testing_payloads=True,
                                       remove_default_globaltag=False,
                                       testing_database_path=testing_database_path,
                                       md5_revision=md5_revision,
                                       ) == 0)