Added support for specifying EasyConfig specific options, for easystack files based on the 'easyconfig' top level keyword

Author: casparvl

easybuild/framework/easystack.py

@@ -69,6 +69,8 @@ def __init__(self):
         self.robot = False
         self.software_list = []
         self.easyconfigs = []  # A list of easyconfig names. May or may not include .eb extension
+        # A dict where keys are easyconfig names, values are dictionary of options that should be applied for that easyconfig
+        self.ec_opts = {}
 
     def compose_ec_filenames(self):
         """Returns a list of all easyconfig names"""
@@ -171,7 +173,11 @@ def parse_by_easyconfigs(filepath, easyconfigs, easybuild_version=None, robot=Fa
                 if len(easyconfig) == 1:
                     # Get single key from dictionary 'easyconfig'
                     easyconf_name = list(easyconfig.keys())[0]
+                    # Add easyconfig name to the list
                     easystack.easyconfigs.append(easyconf_name)
+                    # Add options to the ec_opts dict
+                    if 'options' in easyconfig[easyconf_name].keys():
+                        easystack.ec_opts[easyconf_name] = easyconfig[easyconf_name]['options']
                 else:
                     dict_keys = ', '.join(easyconfig.keys())
                     msg = "Failed to parse easystack file: expected a dictionary with one key (the EasyConfig name). "
@@ -307,12 +313,16 @@ def parse_easystack(filepath):
 
     easyconfig_names = easystack.compose_ec_filenames()
 
-    general_options = easystack.get_general_options()
+    # Disabled general options for now. We weren't using them, and first want support for EasyConfig-specific options.
+    # Then, we need a method to resolve conflicts (specific options should win)
+    # general_options = easystack.get_general_options()
 
     _log.debug("EasyStack parsed. Proceeding to install these Easyconfigs: %s" % ', '.join(sorted(easyconfig_names)))
-    if len(general_options) != 0:
-        _log.debug("General options for installation are: \n%s" % str(general_options))
-    else:
-        _log.debug("No general options were specified in easystack")
-
-    return easyconfig_names, general_options
+    _log.debug("Using EasyConfig specific options based on the following dict:")
+    _log.debug(easystack.ec_opts)
+    # if len(general_options) != 0:
+    #    _log.debug("General options for installation are: \n%s" % str(general_options))
+    # else:
+    #    _log.debug("No general options were specified in easystack")
+
+    return easyconfig_names, easystack.ec_opts

easybuild/main.py

@@ -43,7 +43,7 @@
 
 # IMPORTANT this has to be the first easybuild import as it customises the logging
 #  expect missing log output when this not the case!
-from easybuild.tools.build_log import EasyBuildError, print_error, print_msg, stop_logging
+from easybuild.tools.build_log import EasyBuildError, print_error, print_msg, stop_logging, print_warning
 
 from easybuild.framework.easyblock import build_and_install_one, inject_checksums
 from easybuild.framework.easyconfig import EASYCONFIGS_PKG_SUBDIR
@@ -261,7 +261,7 @@ def main(args=None, logfile=None, do_build=None, testing=False, modtool=None):
         # TODO add general_options (i.e. robot) to build options
         orig_paths, general_options = parse_easystack(options.easystack)
         if general_options:
-            raise EasyBuildError("Specifying general configuration options in easystack file is not supported yet.")
+            print_warning("Specifying options in easystack files is not supported yet. They are parsed, but ignored.")
 
     # check whether packaging is supported when it's being used
     if options.package:

test/framework/easystack.py

@@ -101,6 +101,25 @@ def test_easystack_easyconfigs_with_eb_ext(self):
         self.assertEqual(sorted(ec_fns), sorted(expected))
         self.assertEqual(opts, {})
 
+    def test_easystack_easyconfig_opts(self):
+        """Teast an easystack file using the 'easyconfigs' key, where additonal options are defined for some easyconfigs"""
+        topdir = os.path.dirname(os.path.abspath(__file__))
+        test_easystack = os.path.join(topdir, 'easystacks', 'test_easystack_easyconfigs_opts.yaml')
+
+        ec_fns, opts = parse_easystack(test_easystack)
+        expected = [
+            'binutils-2.25-GCCcore-4.9.3.eb',
+            'binutils-2.26-GCCcore-4.9.3.eb',
+            'foss-2018a.eb',
+            'toy-0.0-gompi-2018a-test.eb',
+        ]
+        expected_opts = {
+            'binutils-2.25-GCCcore-4.9.3.eb': {'debug': True},
+            'foss-2018a.eb': {'robot': True},
+        }
+        self.assertEqual(sorted(ec_fns), sorted(expected))
+        self.assertEqual(opts, expected_opts)
+
     def test_parse_fail(self):
         """Test for clean error when easystack file fails to parse."""
         test_yml = os.path.join(self.test_prefix, 'test.yml')

test/framework/easystacks/test_easystack_easyconfig_opts.yaml

@@ -0,0 +1,11 @@
+easyconfigs:
+    - binutils-2.25-GCCcore-4.9.3:
+        options: {
+          'debug': True,
+        }
+    - binutils-2.26-GCCcore-4.9.3
+    - foss-2018a:
+        options: {
+          'robot': True,
+        }
+    - toy-0.0-gompi-2018a-test