test_GApplication.py 15.4 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
# ==========================================================================
# This module performs unit tests for the GammaLib application module
#
# Copyright (C) 2012-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 <http://www.gnu.org/licenses/>.
#
# ==========================================================================
import os
import gammalib
import test_support


# ========================================== #
# Test class for GammaLib application module #
# ========================================== #
class Test(gammalib.GPythonTestSuite):
    """
    Test class for GammaLib application module
    """
    # Constructor
    def __init__(self):
        """
        Constructor
        """
        # Call base class constructor
        gammalib.GPythonTestSuite.__init__(self)

        # Set members
        self._logfile = 'test_logger.log'

        # Return
        return

    # Check log file versus a reference
    def _check_log_file(self, ref, calls):
        """
        Check log file versus a reference

        Parameters
        ----------
        ref : list of str
            Reference lines
        calls : list of str
            Methods that are tested
        """
        # Open log file, read all line and close file
        file  = open(self._logfile, 'r')
        lines = file.readlines()
        file.close()

        # Check all lines versus reference. There is a special kluge in case
        # that the reference is "true\n" as in some Python/SWIG version this
        # is displayed by "1\n". Both variants are tested to avoid version
        # dependent test results.
        for i, line in enumerate(lines):
            if ref[i] == 'true\n':
                self.test_assert(line == ref[i] or line == '1\n',
                                 'Check '+calls[i]+': '+line)
            else:
                self.test_value(line, ref[i], 'Check '+calls[i]+': '+line)

        # Return
        return

    # Setup GApplicationPars container
    def _setup_pars(self):
        """
        Setup GApplicationPars container

        Returns
        -------
        pars : `~gammalib.GApplicationPars`
            Parameter container
        """
        # Setup application parameter container
        pars = gammalib.GApplicationPars()
        for i in range(10):
            name = '%s' % i
            par  = gammalib.GApplicationPar(name,'r','a','1.0','0.0','2.0','Dummy')
            pars.append(par)

        # Return application parameter container
        return pars

    # Test GLog class
    def _test_log(self):
        """
        Test GLog class
        """
        # Allocate logger
        log = gammalib.GLog(self._logfile, True)

        # Test print methods
        log('Test __call__(std::string)\n')
        log(True)
        log('\n')
        log(41)
        log('\n')
        log(3.1415)
        log('\n')
        log.parformat('This is a parameter')
        log('\n')
        log.toupper('upper case')
        log('\n')
        log.tolower('LOWER CASE')
        log('\n')
        log.fill('Higgs', 3)
        log('\n')
        log.left('Left', 10)
        log('\n')
        log.right('Right', 10)
        log('\n')
        log.centre('Centre', 10)
        log('\n')
        log.header0('Header 0')
        log('\n')
        log.header1('Header 1')
        log.header2('Header 2')
        log.header3('Header 3')

        # Close logger
        log.close()

        # Set reference
        ref = []
        ref.append('Test __call__(std::string)\n')
        ref.append('true\n') # New swig version (3.x.y)
        ref.append('41\n')
        ref.append('3.1415\n')
        ref.append(' This is a parameter .......: \n')
        ref.append('UPPER CASE\n')
        ref.append('lower case\n')
        ref.append('HiggsHiggsHiggs\n')
        ref.append('Left      \n')
        ref.append('     Right\n')
        ref.append('  Centre  \n')
        ref.append('\n')
        ref.append('+==========+\n')
        ref.append('| Header 1 |\n')
        ref.append('+==========+\n')
        ref.append('+----------+\n')
        ref.append('| Header 2 |\n')
        ref.append('+----------+\n')
        ref.append('=== Header 3 ===\n')

        # Set calls for error messages
        calls = []
        calls.append('__call__(std::string)')
        calls.append('__call__(bool)')
        calls.append('__call__(int)')
        calls.append('__call__(double)')
        calls.append('parformat()')
        calls.append('toupper()')
        calls.append('tolower()')
        calls.append('fill()')
        calls.append('left()')
        calls.append('right()')
        calls.append('centre()')
        calls.append('header0()')
        calls.append('header1()')
        calls.append('header1()')
        calls.append('header1()')
        calls.append('header2()')
        calls.append('header2()')
        calls.append('header2()')
        calls.append('header3()')

        # Check log file
        self._check_log_file(ref, calls)

        # Create copy of logger
        cpy_log = log.copy()

        # Print one more line into copy
        cpy_log.header3('Header 3bis')

        # Append reference and call for error message
        ref.append('=== Header 3bis ===\n')
        calls.append('header3()')

        # Check log file again
        self._check_log_file(ref, calls)

        # Return
        return

    # Test GApplication class
    def _test_app(self):
        """
        Test GApplication class
        """
        # Set PFILES environment variable
        os.environ['PFILES'] = os.environ['TEST_DATA']

        # Allocate test application
        app = gammalib.GApplication('test_GApplication', '1.1.0')

        # Check proper allocation of test application
        self.test_value(app._name(), 'test_GApplication', 'Check application name')
        self.test_value(app._version(), '1.1.0', 'Check application version')
        self.test_value(app.pars().size(), 10, 'Check number of parameters')

        # Check that we properly can loop over all parameters. The npars
        # variable counts the number of iterations. If the parameter "chatter"
        # is encounter then set the chattiness to 4
        npars = 0
        for par in app:
            npars += 1
            if par.name() == 'chatter':
                par.integer(4)

        # Check outcome of loop
        self.test_value(npars, 10, 'Check number of parameters in loop')
        self.test_value(app['chatter'].integer(), 4, 'Check that "chatter" '
                        'parameter could be stored correctly')

        # Check access by index
        self.test_value(app[1].integer(), 1)
        self.test_value(app[-5].integer(), 4)

        # Check setting by index
        par = app[1]
        par.integer(5)
        app[1] = par
        par = app[-5]
        par.integer(4)
        app[-5] = par
        self.test_value(app[1].integer(), 5)
        self.test_value(app[-5].integer(), 4)

        # Check setting and getting of parameters
        app['real']     = 100.0
        app['integer']  = 10
        app['string']   = 'GAL'
        app['filename'] = 'newfile.fits'
        app['time']     = gammalib.GTime('2000-01-01T12:00:00')
        self.test_value(app['real'].real(), 100.0)
        self.test_value(app['integer'].integer(), 10)
        self.test_value(app['string'].string(), 'GAL')
        self.test_value(app['filename'].filename().url(), 'newfile.fits')
        self.test_value(app['time'].time().utc(), '2000-01-01T12:00:00')
        app['real']     = 100
        self.test_value(app['real'].real(), 100.0)
        app['time']     = '2000-01-01T12:00:00'
        self.test_value(app['time'].time().utc(), '2000-01-01T12:00:00')
        app['time']     = '1800.0'
        self.test_value(app['time'].time().secs(), 1800.0)
        app['time']     = 1800.0
        self.test_value(app['time'].time().secs(), 1800.0)
        app['time']     = 1800
        self.test_value(app['time'].time().secs(), 1800.0)

        # Check boolean exception (does not work on older Linux systems)
        #self.test_try('Test GApplication boolean parameter exception')
        #try:
        #    app['real'] = False
        #    self.test_try_failure('Exception not thrown')
        #except:
        #    self.test_try_success()
        #else:
        #    self.test_try_failure('This should never happen')

        # Check integer exception
        self.test_try('Test GApplication integer parameter exception')
        try:
            app['string'] = 1
            self.test_try_failure('Exception not thrown')
        except:
            self.test_try_success()
        else:
            self.test_try_failure('This should never happen')

        # Check string exception
        self.test_try('Test GApplication string parameter exception')
        try:
            app['real'] = 'Unknown'
            self.test_try_failure('Exception not thrown')
        except:
            self.test_try_success()
        else:
            self.test_try_failure('This should never happen')
        self.test_try('Test GApplication string parameter exception')
        try:
            app['clobber'] = 'Unknown'
            self.test_try_failure('Exception not thrown')
        except:
            self.test_try_success()
        else:
            self.test_try_failure('This should never happen')

        # Check time exception
        self.test_try('Test GApplication time parameter exception')
        try:
            app['real'] = gammalib.GTime()
            self.test_try_failure('Exception not thrown')
        except:
            self.test_try_success()
        else:
            self.test_try_failure('This should never happen')

        # Check handling of undefined parameters
        app['real']    = 'INDEF'
        app['integer'] = 'INDEF'
        app['time']    = 'INDEF'
        self.test_assert(app['real'].is_undefined(), 'INDEF real parameter')
        self.test_assert(app['integer'].is_undefined(), 'INDEF integer parameter')
        self.test_assert(app['time'].is_undefined(), 'INDEF time parameter')
        app['real']    = 'NONE'
        app['integer'] = 'NONE'
        app['time']    = 'NONE'
        self.test_assert(app['real'].is_undefined(), 'NONE real parameter')
        self.test_assert(app['integer'].is_undefined(), 'NONE integer parameter')
        self.test_assert(app['time'].is_undefined(), 'NONE time parameter')
        app['real']    = 'UNDEF'
        app['integer'] = 'UNDEF'
        app['time']    = 'UNDEF'
        self.test_assert(app['real'].is_undefined(), 'UNDEF real parameter')
        self.test_assert(app['integer'].is_undefined(), 'UNDEF integer parameter')
        self.test_assert(app['time'].is_undefined(), 'UNDEF time parameter')
        app['real']    = 'UNDEFINED'
        app['integer'] = 'UNDEFINED'
        app['time']    = 'UNDEFINED'
        self.test_assert(app['real'].is_undefined(), 'UNDEFINED real parameter')
        self.test_assert(app['integer'].is_undefined(), 'UNDEFINED integer parameter')
        self.test_assert(app['time'].is_undefined(), 'UNDEFINED time parameter')

        # Check handling of NaN parameters
        app['real']    = 'INF'
        app['integer'] = 'INF'
        self.test_assert(app['real'].is_notanumber(), 'INF real parameter')
        self.test_assert(app['integer'].is_valid(), 'INF integer parameter')
        app['real']    = 'INFINITY'
        app['integer'] = 'INFINITY'
        self.test_assert(app['real'].is_notanumber(), 'INFINITY real parameter')
        self.test_assert(app['integer'].is_valid(), 'INFINITY integer parameter')
        app['real']    = 'NAN'
        app['integer'] = 'NAN'
        self.test_assert(app['real'].is_notanumber(), 'NAN real parameter')
        self.test_assert(app['integer'].is_valid(), 'NAN integer parameter')

        # Return
        return

    # Test GApplicationPars class
    def _test_pars(self):
        """
        Test GApplicationPars class
        """
        # Test GApplicationPars constructor with bad filename
        self.test_try('Test GApplicationPars constructor with bad filename')
        try:
            pars = gammalib.GApplicationPars('testme.par')
            self.test_try_failure('Exception not thrown')
        except:
            self.test_try_success()
        else:
            self.test_try_failure('This should never happen')

        # Return
        return

    # Test GApplicationPars class access operators
    def _test_pars_access(self):
        """
        Test GApplicationPars class model access
        """
        # Setup application parameter container
        pars = self._setup_pars()

        # Perform application parameter access tests
        test_support.container_access_index(self, pars)

        # Check application parameter setting by index from start
        par     = gammalib.GApplicationPar('98','r','a','1.0','0.0','2.0','Dummy')
        pars[3] = par
        self.test_value(pars[3].name(),  '98')

        # Check application parameter setting by index from end
        par      = gammalib.GApplicationPar('99','r','a','1.0','0.0','2.0','Dummy')
        pars[-2] = par
        self.test_value(pars[-2].name(), '99')

        # Return
        return

    # Test GApplicationPars class slicing
    def _test_pars_slicing(self):
        """
        Test GApplicationPars class slicing
        """
        # Setup application parameter container
        pars = self._setup_pars()

        # Perform slicing tests
        test_support.container_slicing(self, pars)

        # Return
        return

    # Test class pickeling
    def _test_pickeling(self):
        """
        Test class pickeling
        """
        # Set PFILES environment variable
        os.environ['PFILES'] = os.environ['TEST_DATA']

        # Perform pickeling tests of empty classes
        test_support.pickeling(self, gammalib.GApplication())
        test_support.pickeling(self, gammalib.GApplicationPar())
        test_support.pickeling(self, gammalib.GApplicationPars())
        #test_support.pickeling(self, gammalib.GLog())

        # Setup for tests
        par = gammalib.GApplicationPar('Test','r','a','1.0','0.0','2.0','Dummy text')
        app = gammalib.GApplication('test_GApplication', '1.1.0')

        # Perform pickeling tests of filled classes
        test_support.pickeling(self, gammalib.GApplication(app))
        test_support.pickeling(self, gammalib.GApplicationPar(par))
        test_support.pickeling(self, gammalib.GApplicationPars('test_GApplication.par'))
        #test_support.pickeling(self, gammalib.GLog())

        # Return
        return

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

        # Append tests
        self.append(self._test_log, 'Test GLog')
        self.append(self._test_app, 'Test GApplication')
        self.append(self._test_pars, 'Test GApplicationPars')
        self.append(self._test_pars_access, 'Test GApplicationPars parameter access')
        self.append(self._test_pars_access, 'Test GApplicationPars slicing')
        self.append(self._test_pickeling, 'Test application class pickeling')

        # Return
        return