test_csiactcopy.py 4.88 KB
#! /usr/bin/env python
# ==========================================================================
# This scripts performs unit tests for the csiactcopy script.
#
# Copyright (C) 2016 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 <http://www.gnu.org/licenses/>.
#
# ==========================================================================
import gammalib
import cscripts
from testing import test


# ================================ #
# Test class for csiactcopy script #
# ================================ #
class Test(test):
    """
    Test class for csiactcopy script

    This test class makes unit tests for the csiactcopy script by using it
    from the command line and from Python.
    """
    
    # Constructor
    def __init__(self):
        """
        Constructor.
        """
        # Call base class constructor
        test.__init__(self)

        # Set data members
        self._remote = self._datadir + '/iactdata/master.json'

        # Return
        return

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

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

        # Return
        return

    # Test csiactcopy on command line
    def _test_cmd(self):
        """
        Test csiactcopy on the command line
        """
        # Set script name
        csiactcopy = self._script('csiactcopy')

        # Setup csiactcopy command
        cmd = csiactcopy+' remote_master="'+self._remote+'"'+ \
                         ' prodname="unit-test"'+ \
                         ' outpath="iactdata_cmd1"'+ \
                         ' logfile="csiactcopy_cmd1.log" chatter=1'

        # Check if execution of wrong command fails
        self.test_assert(self._execute('command_that_does_not_exist') != 0,
             'Self test of test script')

        # Check if execution was successful
        self.test_assert(self._execute(cmd) == 0,
             'Check successful execution from command line')

        # Check copy
        self._check_copy('iactdata_cmd1')

        # Setup csiactcopy command
        cmd = csiactcopy+' remote_master="master_that_does_not_exist"'+ \
                         ' prodname="unit-test"'+ \
                         ' outpath="iactdata_test"'+ \
                         ' logfile="csiactcopy_cmd2.log"'

        # Check if execution failed
        self.test_assert(self._execute(cmd) != 0,
             'Check invalid input file when executed from command line')

        # Return
        return

    # Test csiactcopy from Python
    def _test_python(self):
        """
        Test csiactcopy from Python
        """
        # Set-up csiactcopy
        findobs = cscripts.csiactcopy()
        findobs['remote_master'] = self._remote
        findobs['prodname']      = 'unit-test'
        findobs['outpath']       = 'iactdata_py1'
        findobs['logfile']       = 'csiactcopy_py1.log'
        findobs['chatter']       = 2

        # Run csiactcopy script and save run list
        findobs.logFileOpen()   # Make sure we get a log file
        findobs.run()
        findobs.save()

        # Check copy
        self._check_copy('iactdata_py1')

        # Return
        return

    # Check copy
    def _check_copy(self, pathname):
        """
        Check copy.
        """
        # Set file names
        hdu_index_name = gammalib.GFilename(pathname+'/hdu-index.fits')
        obs_index_name = gammalib.GFilename(pathname+'/obs-index.fits')
        master_name    = gammalib.GFilename(pathname+'/master.json')

        # Check for existence of files
        self.test_assert(hdu_index_name.exists(),
                         'Check if file "hdu-index.fits" exists.')
        self.test_assert(obs_index_name.exists(),
                         'Check if file "obs-index.fits" exists.')
        self.test_assert(master_name.exists(),
                         'Check if file "master.json" exists.')

        # Check if index files are FITS file
        self.test_assert(hdu_index_name.is_fits(),
                         'Check if file "hdu-index.fits" is FITS file.')
        self.test_assert(obs_index_name.is_fits(),
                         'Check if file "obs-index.fits" is FITS file.')
        
        # Return
        return