always include mandatory easyconfig parameters in dumped easyconfig file, regardless of whether default value is used or not

Author: boegel

easybuild/framework/easyconfig/format/one.py

@@ -286,7 +286,9 @@ def dump(self, ecfg, default_values, templ_const, templ_val):
         # print other easyconfig parameters at the end
         keys_to_ignore = printed_keys + LAST_PARAMS
         for key in default_values:
-            if key not in keys_to_ignore and ecfg[key] != default_values[key]:
+            mandatory = ecfg.is_mandatory_param(key)
+            non_default_value = ecfg[key] != default_values[key]
+            if key not in keys_to_ignore and (mandatory or non_default_value):
                 dump.extend(self._find_param_with_comments(key, quote_py_str(ecfg[key]), templ_const, templ_val))
         dump.append('')
 

test/framework/easyconfig.py

@@ -357,6 +357,19 @@ def test_extra_options(self):
         self.assertEqual(ec['mandatory_key'], 'value')
         self.assertTrue(ec.is_mandatory_param('mandatory_key'))
 
+        # check whether mandatory key is retained in dumped easyconfig file, even if it's set to the default value
+        ec['mandatory_key'] = 'default'
+        test_ecfile = os.path.join(self.test_prefix, 'test_dump_mandatory.eb')
+        ec.dump(test_ecfile)
+
+        regex = re.compile("^mandatory_key = 'default'$", re.M)
+        ectxt = read_file(test_ecfile)
+        self.assertTrue(regex.search(ectxt), "Pattern '%s' found in: %s" % (regex.pattern, ectxt))
+
+        # parsing again should work fine (if mandatory easyconfig parameters are indeed retained)
+        ec = EasyConfig(test_ecfile, extra_options=extra_vars)
+        self.assertEqual(ec['mandatory_key'], 'default')
+
     def test_exts_list(self):
         """Test handling of list of extensions."""
         topdir = os.path.dirname(os.path.abspath(__file__))