Merge pull request #8 from boegel/feature_package_step_w_fpm

add unit tests for --package* (+ --skip)

Author: rjeschmi

easybuild/main.py

@@ -56,6 +56,7 @@
 from easybuild.tools.filetools import cleanup, write_file
 from easybuild.tools.options import process_software_build_specs
 from easybuild.tools.robot import det_robot_path, dry_run, resolve_dependencies, search_easyconfigs
+from easybuild.tools.package.utilities import check_pkg_support
 from easybuild.tools.parallelbuild import submit_jobs
 from easybuild.tools.repository.repository import init_repository
 from easybuild.tools.testing import create_test_report, overall_test_report, regtest, session_module_list, session_state
@@ -210,6 +211,12 @@ def main(testing_data=(None, None, None)):
     config.init(options, config_options_dict)
     config.init_build_options(build_options=build_options, cmdline_options=options)
 
+    # check whether packaging is supported when it's being used
+    if options.package:
+        check_pkg_support()
+    else:
+        _log.debug("Packaging not enabled, so not check for packaging support.")
+
     # update session state
     eb_config = eb_go.generate_cmd_line(add_default=True)
     modlist = session_module_list(testing=testing)  # build options must be initialized first before 'module list' works

easybuild/tools/options.py

@@ -67,7 +67,7 @@
 from easybuild.tools.modules import Lmod
 from easybuild.tools.ordereddict import OrderedDict
 from easybuild.tools.package.utilities import DEFAULT_PNS, PKG_TOOL_FPM, PKG_TYPE_RPM
-from easybuild.tools.package.utilities import avail_package_naming_schemes, check_pkg_support
+from easybuild.tools.package.utilities import avail_package_naming_schemes
 from easybuild.tools.toolchain.utilities import search_toolchain
 from easybuild.tools.repository.repository import avail_repositories
 from easybuild.tools.version import this_is_easybuild
@@ -369,8 +369,8 @@ def package_options(self):
 
         opts = OrderedDict({
             'package': ("Enabling packaging", None, 'store_true', False),
-            'package-tool': ("Packaging tool to use", None, 'store_or_None', PKG_TOOL_FPM),
-            'package-type': ("Type of package to generate", None, 'store_or_None', PKG_TYPE_RPM),
+            'package-tool': ("Packaging tool to use", None, 'store', PKG_TOOL_FPM),
+            'package-type': ("Type of package to generate", None, 'store', PKG_TYPE_RPM),
             'package-release': ("Package release iteration number", None, 'store', '1'),
         })
 
@@ -503,12 +503,6 @@ def postprocess(self):
 
         self._postprocess_config()
 
-        # check whether packaging is supported when it's being used
-        if self.options.package:
-            check_pkg_support()
-        else:
-            self.log.debug("Packaging not enabled, so not check for packaging support.")
-
     def _postprocess_external_modules_metadata(self):
         """Parse file(s) specifying metadata for external modules."""
         # leave external_modules_metadata untouched if no files are provided

easybuild/tools/package/utilities.py

@@ -88,6 +88,7 @@ def package_with_fpm(easyblock):
     _log.info("Will be creating %s package(s) in %s", pkgtype, workdir)
 
     try:
+        origdir = os.getcwd()
         os.chdir(workdir)
     except OSError, err:
         raise EasyBuildError("Failed to chdir into workdir %s: %s", workdir, err)
@@ -133,12 +134,16 @@ def package_with_fpm(easyblock):
 
     _log.info("Created %s package(s) in %s", pkgtype, workdir)
 
+    try:
+        os.chdir(origdir)
+    except OSError, err:
+        raise EasyBuildError("Failed to chdir back to %s: %s", origdir, err)
+
     return workdir
 
 
 def check_pkg_support():
     """Check whether packaging is supported, i.e. whether the required dependencies are available."""
-
     # packaging support is considered experimental for now (requires using --experimental)
     _log.experimental("Support for packaging installed software.")
 

test/framework/options.py

@@ -1815,6 +1815,8 @@ def test_include_toolchains(self):
         logtxt = read_file(self.logfile)
         self.assertTrue(tc_regex.search(logtxt), "Pattern '%s' *not* found in: %s" % (tc_regex.pattern, logtxt))
 
+    def test_package(self):
+        """Test use of --package."""
 
 def suite():
     """ returns all the testcases in this module """

test/framework/package.py

@@ -42,7 +42,7 @@
 from easybuild.tools.version import VERSION as EASYBUILD_VERSION
 
 
-MOCKED_FPM_RPM = """#!/bin/bash
+MOCKED_FPM = """#!/bin/bash
 # only parse what we need to spit out the expected package file, ignore the rest
 workdir=`echo $@ | sed 's/--workdir \([^ ]*\).*/\\1/g'`
 name=`echo $@ | sed 's/.* --name \([^ ]*\).*/\\1/g'`
@@ -54,6 +54,21 @@
 """
 
 
+def mock_fpm(tmpdir):
+    """Put mocked version of fpm command in place in specified tmpdir."""
+    # put mocked 'fpm' command in place, just for testing purposes
+    fpm = os.path.join(tmpdir, 'fpm')
+    write_file(fpm, MOCKED_FPM)
+    adjust_permissions(fpm, stat.S_IXUSR, add=True)
+
+    # also put mocked rpmbuild in place
+    rpmbuild = os.path.join(tmpdir, 'rpmbuild')
+    write_file(rpmbuild, '#!/bin/bash')  # only needs to be there, doesn't need to actually do something...
+    adjust_permissions(rpmbuild, stat.S_IXUSR, add=True)
+
+    os.environ['PATH'] = '%s:%s' % (tmpdir, os.environ['PATH'])
+
+
 class PackageTest(EnhancedTestCase):
     """Tests for packaging support."""
 
@@ -103,11 +118,7 @@ def test_package(self):
         test_easyconfigs = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'easyconfigs')
         ec = EasyConfig(os.path.join(test_easyconfigs, 'toy-0.0-gompi-1.3.12-test.eb'), validate=False)
 
-        # put mocked 'fpm' command in place, just for testing purposes
-        fpm = os.path.join(self.test_prefix, 'fpm')
-        write_file(fpm, MOCKED_FPM_RPM)
-        adjust_permissions(fpm, stat.S_IXUSR, add=True)
-        os.environ['PATH'] = '%s:%s' % (self.test_prefix, os.environ['PATH'])
+        mock_fpm(self.test_prefix)
 
         # import needs to be done here, since test easyblocks are only included later
         from easybuild.easyblocks.toy import EB_toy

test/framework/toy_build.py

@@ -36,6 +36,7 @@
 import sys
 import tempfile
 from test.framework.utilities import EnhancedTestCase
+from test.framework.package import mock_fpm
 from unittest import TestLoader
 from unittest import main as unittestmain
 from vsc.utils.fancylogger import setLogLevelDebug, logToScreen
@@ -46,6 +47,7 @@
 from easybuild.tools.config import get_module_syntax
 from easybuild.tools.filetools import mkdir, read_file, which, write_file
 from easybuild.tools.modules import modules_tool
+from easybuild.tools.version import VERSION as EASYBUILD_VERSION
 
 
 class ToyBuildTest(EnhancedTestCase):
@@ -970,6 +972,39 @@ def test_module_only(self):
             modtxt = read_file(toy_mod + '.lua')
             self.assertTrue(re.search('load.*ictce/4.1.13', modtxt), "load statement for ictce/4.1.13 found in module")
 
+    def test_package(self):
+        """Test use of --package and accompanying package configuration settings."""
+        mock_fpm(self.test_prefix)
+        pkgpath = os.path.join(self.test_prefix, 'pkgs')
+
+        extra_args = [
+            '--experimental',
+            '--package',
+            '--package-release=321',
+            '--package-tool=fpm',
+            '--package-type=foo',
+            '--packagepath=%s' % pkgpath,
+        ]
+
+        self.test_toy_build(extra_args=extra_args)
+
+        toypkg = os.path.join(pkgpath, 'toy-0.0-eb-%s.321.foo' % EASYBUILD_VERSION)
+        self.assertTrue(os.path.exists(toypkg), "%s is there" % toypkg)
+
+    def test_package_skip(self):
+        """Test use of --package with --skip."""
+        mock_fpm(self.test_prefix)
+        pkgpath = os.path.join(self.test_prefix, 'packages')  # default path
+
+        self.test_toy_build(['--packagepath=%s' % pkgpath])
+        self.assertFalse(os.path.exists(pkgpath), "%s is not created without use of --package" % pkgpath)
+
+        self.test_toy_build(extra_args=['--experimental', '--package', '--skip'], verify=False)
+
+        toypkg = os.path.join(pkgpath, 'toy-0.0-eb-%s.1.rpm' % EASYBUILD_VERSION)
+        self.assertTrue(os.path.exists(toypkg), "%s is there" % toypkg)
+
+
 def suite():
     """ return all the tests in this file """
     return TestLoader().loadTestsFromTestCase(ToyBuildTest)