run cleanup command if a command failed or requested break

Author: Vladimir Kotal

tools/sync/README.md

@@ -17,7 +17,9 @@ where the sync.conf file contents might look like this:
                   ["sudo", "-u", "webservd", "/usr/opengrok/bin/reindex-project.ksh",
                    "/opengrok/etc/opengrok.conf", "/usr/opengrok/bin"],
                   ["/usr/opengrok/bin/Messages", "-n", "abort", "-t"],
-                  ["/scripts/check-indexer-logs.ksh"]]
+                  ["/scripts/check-indexer-logs.ksh"]],
+     "ignore_errors": ["NetBSD-current", "linux-mainline-next"],
+     "cleanup": ["/usr/opengrok/bin/Messages", "-n", "abort", "-t"]
   }
 ```
 

tools/sync/commands.py

@@ -35,12 +35,13 @@ class CommandsBase:
     so that it can be passed through Pool.map().
     """
 
-    def __init__(self, name, commands):
+    def __init__(self, name, commands, cleanup=None):
         self.name = name
         self.commands = commands
         self.failed = False
         self.retcodes = {}
         self.outputs = {}
+        self.cleanup = cleanup
 
     def __str__(self):
         return str(self.name)
@@ -61,7 +62,7 @@ def fill(self, retcodes, outputs, failed):
 
 class Commands(CommandsBase):
     def __init__(self, base):
-        super().__init__(base.name, base.commands)
+        super().__init__(base.name, base.commands, base.cleanup)
 
         self.logger = logging.getLogger(__name__)
         logging.basicConfig()
@@ -88,12 +89,29 @@ def run(self):
                 if retcode == 2:
                     self.logger.info("command '{}' requested break".
                                      format(cmd))
+                    self.run_cleanup()
                 else:
                     self.logger.info("command '{}' failed with code {}, "
                                      "breaking".format(cmd, retcode))
                     self.failed = True
+                    self.run_cleanup()
                 break
 
+    def run_cleanup(self):
+        """
+        Call cleanup in case the sequence failed or termination was requested.
+        """
+        if self.cleanup:
+            self.logger.debug("Running cleanup command '{}'".
+                              format(self.cleanup))
+            cmd = Command(self.cleanup,
+                          args_subst={"ARG": self.name},
+                          args_append=[self.name], excl_subst=True)
+            cmd.execute()
+            if cmd.getretcode() != 0:
+                self.logger.info("cleanup command '{}' failed with code {}".
+                                 format(self.cleanup, cmd.getretcode()))
+
     def check(self, ignore_errors):
         """
         Check the output of the commands and perform logging.

tools/sync/sync.py

@@ -158,7 +158,8 @@ def worker(base):
 
             projects = []
             for d in dirs_to_process:
-                proj = CommandsBase(d, config["commands"])
+                proj = CommandsBase(d, config.get("commands"),
+                                    config.get("cleanup"))
                 projects.append(proj)
 
             try: