# ========================================================================== # Python base class for unit tests # # Copyright (C) 2016-2018 Juergen Knoedlseder # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # # ========================================================================== import os import sys import pickle import gammalib # ================================ # # Python base class for unit tests # # ================================ # class test(gammalib.GPythonTestSuite): """ Python base class for unit tests """ # Constructor def __init__(self): """ Constructor """ # Call base class constructor gammalib.GPythonTestSuite.__init__(self) # Set test data directory self._datadir = os.environ['TEST_DATA'] # Set some standard test data (additional test data will be set in # the derived classes as needed) self._events = self._datadir + '/crab_events.fits' self._cntcube = self._datadir + '/crab_cntmap.fits' self._model = self._datadir + '/crab.xml' self._caldb = 'prod2' self._irf = 'South_0.5h' # Return return # Set script name def _script(self, name): """ Set script name Parameters ---------- name : str Script name Returns ------- script : str Script name including path """ # Set script name dependent on whether the software is installed or # not. If the software is not installed the 'TEST_BUILDDIR' environment # variable will exist if 'TEST_BUILDDIR' in os.environ: script = '@PYTHON_COVERAGE@' + os.environ['TEST_BUILDDIR'] + \ '/cscripts/'+name+'.py' else: script = name # Return script name return script # Set tool name def _tool(self, name): """ Set tool name Parameters ---------- name : str Tool name Returns ------- tool : str Tool name including path """ # Set tool name dependent on whether the software is installed or # not. If the software is not installed the 'TEST_BUILDDIR' environment # variable will exist if 'TEST_BUILDDIR' in os.environ: tool = os.environ['TEST_BUILDDIR'] + '/src/'+name+'/'+name else: tool = name # Return tool name return tool # Execute command and catch any exception def _execute(self, cmd, success=True): """ Execute command Parameters ---------- cmd : str Command string to be executed success : bool True if success is expected, False otherwise Returns ------- rc : int Return code """ # Execute command, make sure we catch any exception try: rc = os.system(cmd+' > ctools_test_output.dmp 2>&1') except: rc = -1 # If an exception occured then put output on screen if success and rc != 0 or not success and rc == 0: print('\n*** Unexpected exception (%d) for command %s:' % (rc, cmd)) f = open('ctools_test_output.dmp', 'r') for line in f: print(line.rstrip('\n')) f.close() # Remove test output os.remove('ctools_test_output.dmp') # Return return code return rc # Return observation container with 3 identical event lists def _obs_events(self): """ Return observation container with 3 identical event lists Returns ------- obs : `~gammalib.GObservations` Observations container """ # Load CTA event list cta = gammalib.GCTAObservation(self._events) # Allocate observation container obs = gammalib.GObservations() # Append CTA observation with ID "0001" cta.id('0001') obs.append(cta) # Append CTA observation with ID "0002" cta.id('0002') obs.append(cta) # Append CTA observation with ID "0003" cta.id('0003') obs.append(cta) # Return observation container return obs # Return observation container with event list, counts cube and LAT # observation def _obs_mixed(self): """ Return observation container with event list, counts cube and LAT observation Returns ------- obs : `~gammalib.GObservations` Observations container """ # Load CTA event list obs1 = gammalib.GCTAObservation(self._events) obs1.id('0001') # Load CTA counts cube obs2 = gammalib.GCTAObservation(self._cntcube) obs2.id('0002') # Create empty LAT observation obs3 = gammalib.GLATObservation() obs3.id('0001') obs3.events(gammalib.GLATEventList()) # Allocate observation container obs = gammalib.GObservations() # Append observations to container obs.append(obs1) obs.append(obs2) obs.append(obs3) # Return observation container return obs # Check def _check_help(self, tool): """ Check for help text Parameters ---------- name : str Tool name """ # Setup tool --help option cmd = tool+' --help' # Check if execution was successful in case that the CTOOLS # environment variable was set or failed otherwise if 'CTOOLS' in os.environ: self.test_value(self._execute(cmd), 0, 'Check successful execution with --help option') else: self.test_assert(self._execute(cmd, success=False) != 0, 'Check execution failure with --help option') # Return return # Test pickeling def _pickeling(self, object): """ Test class pickeling Parameters ---------- object : `~gammalib.GBase` Class instance """ # Get class name name = object.__class__.__name__ # Start exception catching self.test_try('Test pickeling of "%s" class.' % name) # Test if pickling results in an exception try: dump = pickle.dumps(object) obj = pickle.loads(dump) dump_again = pickle.dumps(obj) self.test_assert(dump == dump_again, 'Check pickled dump of "%s\n%s\n%s"' % (name, str(object), str(obj))) self.test_try_success() except: _, e, _ = sys.exc_info() self.test_try_failure('Error in pickeling "%s" (%s).' % (name, str(e))) # Return return obj