Merge pull request #3696 from boegel/ext_postinstallcmds

run post-install commands specified for a specific extension

Author: smoors

easybuild/framework/easyblock.py

@@ -2436,21 +2436,34 @@ def fix_shebang(self):
                             contents = shebang + '\n' + contents
                             write_file(path, contents)
 
-    def post_install_step(self):
+    def run_post_install_commands(self, commands=None):
         """
-        Do some postprocessing
-        - run post install commands if any were specified
+        Run post install commands that are specified via 'postinstallcmds' easyconfig parameter.
         """
+        if commands is None:
+            commands = self.cfg['postinstallcmds']
+
+        if commands:
+            self.log.debug("Specified post install commands: %s", commands)
 
-        if self.cfg['postinstallcmds'] is not None:
             # make sure we have a list of commands
-            if not isinstance(self.cfg['postinstallcmds'], (list, tuple)):
-                raise EasyBuildError("Invalid value for 'postinstallcmds', should be list or tuple of strings.")
-            for cmd in self.cfg['postinstallcmds']:
+            if not isinstance(commands, (list, tuple)):
+                error_msg = "Invalid value for 'postinstallcmds', should be list or tuple of strings: %s"
+                raise EasyBuildError(error_msg, commands)
+
+            for cmd in commands:
                 if not isinstance(cmd, string_type):
                     raise EasyBuildError("Invalid element in 'postinstallcmds', not a string: %s", cmd)
                 run_cmd(cmd, simple=True, log_ok=True, log_all=True)
 
+    def post_install_step(self):
+        """
+        Do some postprocessing
+        - run post install commands if any were specified
+        """
+
+        self.run_post_install_commands()
+
         self.fix_shebang()
 
         lib_dir = os.path.join(self.installdir, 'lib')

easybuild/framework/extension.py

@@ -105,16 +105,17 @@ def __init__(self, mself, ext, extra_params=None):
 
         name, version = self.ext['name'], self.ext.get('version', None)
 
-        # parent sanity check paths/commands are not relevant for extension
+        # parent sanity check paths/commands and postinstallcmds are not relevant for extension
         self.cfg['sanity_check_commands'] = []
         self.cfg['sanity_check_paths'] = []
+        self.cfg['postinstallcmds'] = []
 
         # construct dict with template values that can be used
         self.cfg.template_values.update(template_constant_dict({'name': name, 'version': version}))
 
         # Add install/builddir templates with values from master.
-        for name in TEMPLATE_NAMES_EASYBLOCK_RUN_STEP:
-            self.cfg.template_values[name[0]] = str(getattr(self.master, name[0], None))
+        for key in TEMPLATE_NAMES_EASYBLOCK_RUN_STEP:
+            self.cfg.template_values[key[0]] = str(getattr(self.master, key[0], None))
 
         # list of source/patch files: we use an empty list as default value like in EasyBlock
         self.src = resolve_template(self.ext.get('src', []), self.cfg.template_values)
@@ -169,7 +170,7 @@ def postrun(self):
         """
         Stuff to do after installing a extension.
         """
-        pass
+        self.master.run_post_install_commands(commands=self.cfg.get('postinstallcmds', []))
 
     @property
     def toolchain(self):

test/framework/toy_build.py

@@ -1190,8 +1190,8 @@ def test_toy_patches(self):
         archived_patch_file = os.path.join(repositorypath, 'toy', 'toy-0.0_fix-silly-typo-in-printf-statement.patch')
         self.assertTrue(os.path.isfile(archived_patch_file))
 
-    def test_toy_extension_patches(self):
-        """Test install toy that includes extensions with patches."""
+    def test_toy_extension_patches_postinstallcmds(self):
+        """Test install toy that includes extensions with patches and postinstallcmds."""
         test_ecs = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'easyconfigs', 'test_ecs')
         toy_ec = os.path.join(test_ecs, 't', 'toy', 'toy-0.0.eb')
         toy_ec_txt = read_file(toy_ec)
@@ -1210,13 +1210,25 @@ def test_toy_extension_patches(self):
             '           ("bar-0.0_fix-very-silly-typo-in-printf-statement.patch", 0),',  # patch with patch level
             '           ("test.txt", "."),',  # file to copy to build dir (not a real patch file)
             '       ],',
+            '       "postinstallcmds": ["touch %(installdir)s/created-via-postinstallcmds.txt"],',
             '   }),',
             ']',
         ])
         write_file(test_ec, test_ec_txt)
 
         self.test_toy_build(ec_file=test_ec)
 
+        installdir = os.path.join(self.test_installpath, 'software', 'toy', '0.0')
+
+        # make sure that patches were actually applied (without them the message producded by 'bar' is different)
+        bar_bin = os.path.join(installdir, 'bin', 'bar')
+        out, _ = run_cmd(bar_bin)
+        self.assertEqual(out, "I'm a bar, and very very proud of it.\n")
+
+        # verify that post-install command for 'bar' extension was executed
+        fn = 'created-via-postinstallcmds.txt'
+        self.assertTrue(os.path.exists(os.path.join(installdir, fn)))
+
     def test_toy_extension_sources(self):
         """Test install toy that includes extensions with 'sources' spec (as single-item list)."""
         topdir = os.path.dirname(os.path.abspath(__file__))