#! /usr/bin/env python
# ==========================================================================
# This scripts performs unit tests for the cterror tool.
#
# Copyright (C) 2015-2016 Florent Forest
#
# 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 ctools
from testing import test


# =========================== #
# Test class for cterror tool #
# =========================== #
class Test(test):
    """
    Test class for cterror tool
    """
    # Constructor
    def __init__(self):
        """
        Constructor.
        """
        # Call base class constructor
        test.__init__(self)

        # Return
        return

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

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

        # Return
        return

    # Test cterror on command line
    def _test_cmd(self):
        """
        Test cterror on the command line
        """
        # Set tool name
        cterror = self._tool('cterror')

        # Setup cterror command
        cmd = cterror+' inobs="'+self._events+'"'+ \
                      ' inmodel="'+self._model+'" srcname="Crab"'+ \
                      ' caldb="'+self._caldb+'" irf="'+self._irf+'"'+ \
                      ' outmodel="cterror_cmd1.xml"'+ \
                      ' logfile="cterror_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 result file
        self._check_result_file('cterror_cmd1.xml')

        # Setup cterror command
        cmd = cterror+' inobs="event_file_that_does_not_exist.fits"'+ \
                      ' inmodel="'+self._model+'" srcname="Crab"'+ \
                      ' caldb="'+self._caldb+'" irf="'+self._irf+'"'+ \
                      ' outmodel="cterror_cmd2.xml"'+ \
                      ' logfile="cterror_cmd2.log" chatter=1'

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

        # Return
        return

    # Test cterror from Python
    def _test_python(self):
        """
        Test cterror from Python
        """
        # Set-up cterror
        error = ctools.cterror()
        error['inobs']    = self._events
        error['inmodel']  = self._model
        error['outmodel'] = 'cterror_py1.xml'
        error['srcname']  = 'Crab'
        error['caldb']    = self._caldb
        error['irf']      = self._irf
        error['logfile']  = 'cterror_py1.log'
        error['chatter']  = 2

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

        # Check result file
        self._check_result_file('cterror_py1.xml')

        # Return
        return

    # Check result file
    def _check_result_file(self, filename):
        """
        Check result file
        """
        # Open result file
        result = gammalib.GModels(filename)

        # Check results
        self.test_value(result['Crab']['Prefactor'].value(), 1.58907e-16,
                        1.0e-3, 'Check fitted Crab Prefactor')
        self.test_value(result['Crab']['Prefactor'].error(), 0.0529105e-16,
                        1.0e-3, 'Check Crab Prefactor error')
        self.test_value(result['Crab']['Index'].value(), -2.43549,
                        1.0e-3, 'Check fitted Crab Index')
        self.test_value(result['Crab']['Index'].error(), 0.027804,
                        1.0e-3, 'Check Crab Index error')
        self.test_value(result['Background']['Prefactor'].value(), 61.6919e-6,
                        1.0e-3, 'Check fitted background Prefactor')
        self.test_value(result['Background']['Prefactor'].error(), 1.49438e-6,
                        1.0e-3, 'Check background Prefactor error')
        self.test_value(result['Background']['Index'].value(), -2.20535,
                        1.0e-3, 'Check fitted background Index')
        self.test_value(result['Background']['Index'].error(), 0.0113269,
                        1.0e-3, 'Check background Index error')
        self.test_value(result['Background']['Sigma'].value(), 3.04252,
                        1.0e-3, 'Check fitted background Sigma')
        self.test_value(result['Background']['Sigma'].error(), 0.0307008,
                        1.0e-3, 'Check background Sigma error')

        # Return
        return