Add unit test for csinfo (#1828)

Jürgen Knödlseder
1 parent 4c6494dd
Showing 4 changed files with 277 additions and 58 deletions
cscripts/csinfo.py
test/test_cscaldb.py
test/test_csinfo.py
test/test_python_cscripts.py
@@ -2,7 +2,7 @@
 # ==========================================================================
 # Print info about Gammalib / ctools to the console.
 #
-# Copyright (C) 2015 Christoph Deil
+# Copyright (C) 2015-2016 Christoph Deil
 #
 # 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
@@ -21,27 +21,18 @@
 import sys
 import os
-
-def get_command_output(cmd):
-    """Utility function to get command output on old and new Python versions.
-    """
-    try:
-        from subprocess import getoutput
-    except ImportError:
-        from commands import getoutput
-
-    return getoutput(cmd)
-
-
-# Copied and edited a bit from the `doc/source/reference_manual/index.rst` file
-# The list there and here needs to be manually updated and kept in sync.
+# Copied and edited a bit from the `doc/source/users/reference_manual/index.rst`
+# file. The list there and here needs to be manually updated and kept in sync.
 CTOOL_LIST = """
    ctbin         Generates counts cube
    ctbkgcube     Generates background cube
    ctbutterfly   Compute butterfly
    ctcubemask    Filter counts cube
+   ctedispcube   Generates energy dispersion cube
+   cterror       Calculates likelihood profile errors
    ctexpcube     Generates exposure cube
    ctlike        Performs maximum likelihood fitting
+   ctmapcube     Generates a map cube
    ctmodel       Computes model counts cube
    ctobssim      Simulate CTA observations
    ctpsfcube     Generates point spread function cube
@@ -49,47 +40,112 @@ CTOOL_LIST = &quot;&quot;&quot;
    ctskymap      Generates sky map
    cttsmap       Generates Test Statistics map
    ctulimit      Calculates upper limit
-   cterror       Calculates likelihood profile errors
 """
 CSCRIPT_LIST = """
    cscaldb       Lists available instrument response functions
+   cslightcrv    Computes lightcurve
    csinfo        Checks ctools and GammaLib installations
+   csmodelinfo   Shows model container content
+   csmodelmerge  Merges several model containers into one file
    csobsdef      Generates observation definition file
-   cslightcrv    Computes lightcurve
+   csobsinfo     Shows observation container content
    cspull        Generates pull distribution
+   csresmap      Generates residual map
    cssens        Computes CTA sensitivity
    csspec        Computes spectral points
-   csresmap      Generates residual map
    cstsdist      Generates TS distribution
+   cstsmapsplit  Creates commands to split the Test Statistic map computations
+   cstsmapmerge  Merges slices from Test Statistic map computations\n
+   csobs2caldb   Creates a caldb entry from an input observation
+   csiactdata    Shows information about IACT data available on the user machine
+   csiactobs     Generates observation definition file for IACT data from observation IDs
+   csfindobs     Generates a list of IACT observation IDs
+   csiactcopy    Copies IACT data from one location to another
 """
+
+# ============================================================ #
+# Workaround for command output on old and new Python versions #
+# ============================================================ #
+def get_command_output(cmd):
+    """
+    Utility function to get command output on old and new Python versions
+
+    Parameters
+    ----------
+    cmd : str
+        Command string
+
+    Returns
+    -------
+    output : str
+        Command output
+    """
+    # Try to import getoutput from subprocess, alternatively get it from
+    # commands
+    try:
+        from subprocess import getoutput
+    except ImportError:
+        from commands import getoutput
+
+    # Return command output
+    return getoutput(cmd)
+
+
+# ===================================== #
+# Workaround for print without linefeed #
+# ===================================== #
 def log(text, end='\n'):
-    """Print text to console.
+    """
+    Print text to console
     Workaround to have an `end=''` option on old Pythons:
     http://stackoverflow.com/a/493399/498873
     """
+    # Print without linefeed
     sys.stdout.write(text + end)
+    # Return
+    return
+
+# ====================== #
+# Print list information #
+# ====================== #
 def csinfo_list_tools():
-    """Print available ctools with one-line description to the console.
     """
+    Print available ctools with one-line description to the console
+    """
+    # Print list of available ctools
     print('\nAvailable ctools:')
     print(CTOOL_LIST)
+
+    # Print list of available cscripts
     print('Available cscripts:')
     print(CSCRIPT_LIST)
+    # Return
+    return
-def csinfo_setup_check():
-    print('\nGammalib / ctools setup check:\n')
+# ======================= #
+# Print check information #
+# ======================= #
+def csinfo_setup_check():
+    """
+    Print check information
+    """
+    # Initialise success flags
     all_ok           = True
     gammalib_environ = False
     ctools_environ   = False
     gammalib_python  = False
     ctools_python    = False
+    # Print header
+    print('\nGammalib / ctools setup check:\n')
+
+    # Check if GAMMALIB is set
     log('   GAMMALIB environment variable ... ', end='')
     try:
         gammalib_env = os.environ['GAMMALIB']
@@ -99,6 +155,7 @@ def csinfo_setup_check():
         all_ok           = False
         gammalib_environ = True
+    # Check if CTOOLS is set
     log('   CTOOLS   environment variable ... ', end='')
     try:
         ctools_env = os.environ['CTOOLS']
@@ -108,6 +165,7 @@ def csinfo_setup_check():
         all_ok         = False
         ctools_environ = True
+    # Check if gammalib Python module import works
     log('   gammalib Python import .......... ', end='')
     try:
         import gammalib
@@ -117,6 +175,7 @@ def csinfo_setup_check():
         all_ok          = False
         gammalib_python = True
+    # Check if ctools Python module import works
     log('   ctools   Python import .......... ', end='')
     try:
         import ctools
@@ -126,6 +185,8 @@ def csinfo_setup_check():
         all_ok        = False
         ctools_python = True
+    # Signal if everything is okay, or notify about the problems that have
+    # been encountered
     if all_ok:
         print('\n   ===> Your Gammalib / ctools setup is OK.')
     else:
@@ -138,64 +199,107 @@ def csinfo_setup_check():
             print('      - Did you source gammalib-init.sh?')
             print('      - Did you source ctools-init.sh ?')
             print('      - Are you using the correct Python ?')
-
         print('')
-        print('   Gammalib:  http://cta.irap.omp.eu/gammalib-devel/')
-        print('   ctools:    http://cta.irap.omp.eu/ctools-devel/')
-
+        print('   Gammalib:  http://cta.irap.omp.eu/gammalib/')
+        print('   ctools:    http://cta.irap.omp.eu/ctools/')
     print('')
+    # Return
+    return
-def csinfo_setup_info():
-    print('\nGammalib / ctools setup info:\n')
-
-    gammalib_version = 'TODO'  # a function needs to be added to the library to get the version
-    print('   Gammalib version ................. {0}'.format(gammalib_version))
-
-    ctools_version = 'TODO'  # a function needs to be added to the library to get the version
-    print('   ctools   version ................. {0}'.format(ctools_version))
-
-    gammalib_env = os.environ.get('GAMMALIB', 'Not found')
-    print('   $GAMMALIB environment variable ... {0}'.format(gammalib_env))
-    ctools_env = os.environ.get('CTOOLS', 'Not found')
-    print('   $CTOOLS   environment variable ... {0}'.format(ctools_env))
-
-    print('   Python executable ................ {0}'.format(sys.executable))
-
-    log('   gammalib  Python package ......... ', end='')
+# ======================= #
+# Print setup information #
+# ======================= #
+def csinfo_setup_info():
+    """
+    Print setup information
+    """
+    # Try importing GammaLib, and flag if this was unsuccessful
     try:
         import gammalib
-        print(gammalib.__path__[0])
+        gammalib_path    = gammalib.__path__[0]
+        gammalib_version = gammalib.__version__
     except ImportError:
-        print('Not found')
+        gammalib_path    = 'Not found'
+        gammalib_version = 'Unknown'
-    log('   ctools    Python package  ........ ', end='')
+    # Try importing ctools, and flag if this was unsuccessful
     try:
         import ctools
-        print(ctools.__path__[0])
+        ctools_path    = ctools.__path__[0]
+        ctools_version = ctools.__version__
     except ImportError:
-        print('Not found')
+        ctools_path    = 'Not found'
+        ctools_version = 'Unknown'
+
+    # Get GAMMALIB and CTOOLS environment variables
+    gammalib_env = os.environ.get('GAMMALIB', 'Not found')
+    ctools_env   = os.environ.get('CTOOLS', 'Not found')
+
+    # Print header
+    print('\nGammalib / ctools setup info:\n')
+    # Print package versions
+    print('   Gammalib version ................. {0}'.format(gammalib_version))
+    print('   ctools   version ................. {0}'.format(ctools_version))
+    print('   $GAMMALIB environment variable ... {0}'.format(gammalib_env))
+    print('   $CTOOLS   environment variable ... {0}'.format(ctools_env))
+    print('   Python executable ................ {0}'.format(sys.executable))
+    print('   gammalib  Python package ......... {0}'.format(gammalib_path))
+    print('   ctools    Python package  ........ {0}'.format(ctools_path))
     print('   GAMMALIB  CFLAGS ................. {0}'.format(get_pkg_config_info('cflags', 'gammalib')))
     print('   CTOOLS    CFLAGS ................. {0}'.format(get_pkg_config_info('cflags', 'ctools')))
-
     print('   GAMMALIB  LIBS   ................. {0}'.format(get_pkg_config_info('libs', 'gammalib')))
     print('   CTOOLS    LIBS   ................. {0}'.format(get_pkg_config_info('libs', 'ctools')))
-
     print('')
+    # Return
+    return
+
+# =============================== #
+# Get information from pkg-config #
+# =============================== #
 def get_pkg_config_info(info, library):
+    """
+    Get information from pkg-config
+
+    Parameters
+    ----------
+    info : str
+        Information to extract
+    library : str
+        Library name for which information is to be extracted
+
+    Returns
+    -------
+    out : str
+        Information string, 'Not available' if pkg-config is not installed
+    """
+    # Set pkg-config command
     cmd = 'pkg-config --{0} {1}'.format(info, library)
+
+    # Execute command
     out = get_command_output(cmd)
-    if 'was not found' in out:
-        return 'Not available'
-    else:
-        return out
+    # If the command returns 'was not found' then pkg-config is not
+    # avaailable
+    if 'not found' in out:
+        out = 'Not available'
+
+    # Return output
+    return out
+
+# ============================ #
+# Print help text into console #
+# ============================ #
 def csinfo_print_help():
+    """
+    Print help text into console
+    """
+    # Print help text
     print('\nPrint info about Gammalib and ctools to the console.\n')
     print('Available commands:')
     print('   csinfo list    List available ctools and cscripts')
@@ -203,14 +307,24 @@ def csinfo_print_help():
     print('   csinfo info    Print Gammalib / ctools setup info')
     print('')
+    # Return
+    return
+
+# ============================ #
+# Print information to console #
+# ============================ #
 def csinfo(argv):
-    """Print info about Gammalib / ctools to the console.
     """
+    Print information about Gammalib and ctools to the console
+    """
+    # If there are no command line arguments then print help and exit
+    # with success
     if len(argv) <= 1:
         csinfo_print_help()
         sys.exit(0)
+    # Dispatch according to the command line argument
     cmd = argv[1]
     if cmd == 'list':
         csinfo_list_tools()
@@ -223,6 +337,14 @@ def csinfo(argv):
         csinfo_print_help()
         sys.exit(-1)
+    # Return
+    return
+
+# ======================== #
+# Main routine entry point #
+# ======================== #
 if __name__ == '__main__':
+
+    # Run the script
     csinfo(sys.argv)
@@ -29,9 +29,6 @@ from testing import test
 class Test(test):
     """
     Test class for cscaldb script
-
-    This test class makes unit tests for the cslightcrv script by using it
-    from the command line and from Python.
     """
     # Constructor
+#! /usr/bin/env python
+# ==========================================================================
+# This scripts performs unit tests for the csinfo 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 csinfo script #
+# ============================ #
+class Test(test):
+    """
+    Test class for csinfo script
+    """
+
+    # 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('csinfo')
+
+        # Append tests
+        self.append(self._test_cmd, 'Test csinfo on command line')
+
+        # Return
+        return
+
+    # Test csinfo on command line
+    def _test_cmd(self):
+        """
+        Test csinfo on the command line.
+        """
+        # Set script name
+        csinfo = self._script('csinfo')
+
+        # Setup csinfo command
+        cmd = csinfo
+
+        # Check if execution of wrong command fails
+        self.test_assert(self._execute('command_that_does_not_exist') != 0,
+             'Self test of test script')
+
+        # Execute script without arguments
+        self.test_assert(self._execute(cmd) == 0,
+             'Check successful execution from command line')
+
+        # Execute script with "list" argument
+        self.test_assert(self._execute(cmd+' list') == 0,
+             'Check successful execution with "list" argument from command line')
+
+        # Execute script with "check" argument
+        self.test_assert(self._execute(cmd+' check') == 0,
+             'Check successful execution with "check" argument from command line')
+
+        # Execute script with "info" argument
+        self.test_assert(self._execute(cmd+' info') == 0,
+             'Check successful execution with "info" argument from command line')
+
+        # Execute script with invalid argument
+        self.test_assert(self._execute(cmd+' not_a_valid_argument') != 0,
+             'Check unsuccessful execution with unsupported argument from '
+             'command line')
+
+        # Return
+        return
@@ -25,6 +25,7 @@ import cscripts
 sys.path.append(os.path.dirname(os.path.abspath(__file__)))
 import test_cscaldb
 import test_csfindobs
+import test_csinfo
 import test_cslightcrv
 import test_csmodelinfo
 import test_csmodelmerge
@@ -105,6 +106,7 @@ def test(installed=False, debug=False):
     # Allocate test suites
     suite_cscaldb      = test_cscaldb.Test()
+    suite_csinfo       = test_csinfo.Test()
     suite_cslightcrv   = test_cslightcrv.Test()
     suite_csmodelinfo  = test_csmodelinfo.Test()
     suite_csmodelmerge = test_csmodelmerge.Test()
@@ -123,6 +125,7 @@ def test(installed=False, debug=False):
     # Setup unit tests
     suite_cscaldb.set()
+    suite_csinfo.set()
     suite_cslightcrv.set()
     suite_csmodelinfo.set()
     suite_csmodelmerge.set()
@@ -141,6 +144,7 @@ def test(installed=False, debug=False):
     # Append tests to container
     suites.append(suite_cscaldb)
+    suites.append(suite_csinfo)
     suites.append(suite_cslightcrv)
     suites.append(suite_csmodelinfo)
     suites.append(suite_csmodelmerge)