test_ctulimit.py 4.12 KB
#! /usr/bin/env python
# ==========================================================================
# This scripts performs unit tests for the ctulimit tool.
#
# Copyright (C) 2015-2016 Michael Mayer
#
# 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 <http://www.gnu.org/licenses/>.
#
# ==========================================================================
import os
import gammalib
import ctools


# ============================ #
# Test class for ctulimit tool #
# ============================ #
class Test(gammalib.GPythonTestSuite):
    """
    Test class for ctulimit tool.
    """
    # Constructor
    def __init__(self):
        """
        Constructor.
        """
        # Call base class constructor
        gammalib.GPythonTestSuite.__init__(self)

        # Return
        return

    # Set test functions
    def set(self):
        """
        Set all test functions.
        """
        # Set test name
        self.name('ctulimit')

        # Append tests
        self.append(self._test_cmd, 'Test ctulimit on command line')
        self.append(self._test_python, 'Test ctulimit from Python')

        # Return
        return

    # Test ctulimit on command line
    def _test_cmd(self):
        """
        Test ctulimit on the command line.
        """
        # Kluge to set the command (installed version has no README file)
        if os.path.isfile('README.md'):
            ctulimit = '../src/ctulimit/ctulimit'
        else:
            ctulimit = 'ctulimit'

        # Setup ctulimit command
        cmd = ctulimit+' inobs="data/crab_events.fits"'+ \
                       ' inmodel="data/crab.xml" srcname="Crab"'+ \
                       ' caldb="prod2" irf="South_0.5h"'+ \
                       ' logfile="ctulimit_cmd1.log" chatter=1'

        # Execute ctulimit, make sure we catch any exception
        try:
            rc = os.system(cmd+' >/dev/null 2>&1')
        except:
            pass

        # Check if execution was successful
        self.test_assert(rc == 0,
                         'Successful ctulimit execution on command line')

        # Check result file
        self._check_result_file('ctulimit_cmd1.log')

        # Setup ctulimit command
        cmd = ctulimit+' inobs="event_file_that_does_not_exist.fits"'+ \
                       ' inmodel="data/crab.xml" srcname="Crab"'+ \
                       ' caldb="prod2" irf="South_0.5h"'+ \
                       ' logfile="ctulimit_cmd2.log" chatter=1'

        # Execute ctulimit, make sure we catch any exception
        try:
            rc = os.system(cmd+' >/dev/null 2>&1')
        except:
            pass

        # Check if execution failed
        self.test_assert(rc != 0,
                         'Failure of ctulimit execution on command line')

        # Return
        return

    # Test ctulimit from Python
    def _test_python(self):
        """
        Test ctulimit from Python.
        """
        # Set-up ctulimit
        ulimit = ctools.ctulimit()
        ulimit['inobs']   = 'data/crab_events.fits'
        ulimit['inmodel'] = 'data/crab.xml'
        ulimit['srcname'] = 'Crab'
        ulimit['caldb']   = 'prod2'
        ulimit['irf']     = 'South_0.5h'
        ulimit['logfile'] = 'ctulimit_py1.log'
        ulimit['chatter'] = 2

        # Run ctulimit tool
        ulimit.logFileOpen()   # Make sure we get a log file
        ulimit.run()
        ulimit.save()

        # Check result file
        self._check_result_file('ctulimit_py1.log')

        # Return
        return

    # Check result file
    def _check_result_file(self, filename):
        """
        Check result file.
        """
        # Return
        return