[zorg] r283592 - Refactored to support extra options.

[Galina Kistanova via llvm-commits]

Author: gkistanova
Date: Fri Oct  7 15:36:35 2016
New Revision: 283592

URL: http://llvm.org/viewvc/llvm-project?rev=283592&view=rev
Log:
Refactored to support extra options.

Modified:
    zorg/trunk/zorg/buildbot/commands/NinjaCommand.py

Modified: zorg/trunk/zorg/buildbot/commands/NinjaCommand.py
URL: http://llvm.org/viewvc/llvm-project/zorg/trunk/zorg/buildbot/commands/NinjaCommand.py?rev=283592&r1=283591&r2=283592&view=diff
==============================================================================
--- zorg/trunk/zorg/buildbot/commands/NinjaCommand.py (original)
+++ zorg/trunk/zorg/buildbot/commands/NinjaCommand.py Fri Oct  7 15:36:35 2016
@@ -3,31 +3,77 @@ from buildbot.steps.shell import Warning
 
 class NinjaCommand(WarningCountingShellCommand):
 
-    def __init__(self, prefixCommand=None, targets=None, **kwargs):
+    @staticmethod
+    def sanitize_kwargs(kwargs):
+        # kwargs we could get and must not pass through
+        # to the buildstep.RemoteShellCommand constructor.
+        # Note: This is a workaround of the buildbot design issue,
+        # thus should be removed once the original issue gets fixed.
+        consume_kwargs = [
+                             "jobs",
+                             "loadaverage",
+                         ]
+
+        sanitized_kwargs = kwargs.copy()
+        for k in consume_kwargs:
+            if k in sanitized_kwargs.keys():
+                del sanitized_kwargs[k]
+
+        return sanitized_kwargs
+
+
+    def __init__(self, prefixCommand=None, options=None, targets=None, **kwargs):
         self.prefixCommand = prefixCommand
         self.targets = targets
 
+        if options is None:
+            self.options = list()
+        else:
+            self.options = list(options)
+
+        if kwargs.get('jobs', None):
+             self.options += ["-j", kwargs['jobs']]
+        else:
+             self.options += [
+                 WithProperties("%(jobs:+-j)s"),
+                 WithProperties("%(jobs:-)s"),
+                 ]
+
+        if kwargs.get('loadaverage', None):
+            self.options += ["-l", kwargs['loadaverage']]
+        else:
+            self.options += [
+                WithProperties("%(loadaverage:+-l)s"),
+                WithProperties("%(loadaverage:-)s"),
+                ]
+
         command = []
         if prefixCommand:
             command += prefixCommand
 
-        command += ["ninja",
-                     WithProperties("%(jobs:+-j)s"),        WithProperties("%(jobs:-)s"),
-                     WithProperties("%(loadaverage:+-l)s"), WithProperties("%(loadaverage:-)s")]
+        command += ["ninja"]
+
+        if self.options:
+            command += self.options
 
         if targets:
             command += targets
 
-        # Don't forget to remove all the empty items from the command,
-        # which we could get because of WithProperties rendered as empty strings.
-        kwargs['command'] = command
+        # Remove here all the kwargs any of our LLVM buildbot command could consume.
+        # Note: We will remove all the empty items from the command at start, as we
+        # still didn't get yet WithProperties rendered.
+        sanitized_kwargs = self.sanitize_kwargs(kwargs)
+
+        sanitized_kwargs["command"] = command
 
         # And upcall to let the base class do its work
-        WarningCountingShellCommand.__init__(self, **kwargs)
+        WarningCountingShellCommand.__init__(self, **sanitized_kwargs)
 
         self.addFactoryArguments(prefixCommand=prefixCommand,
+                                 options=self.options,
                                  targets=targets)
 
+
     def setupEnvironment(self, cmd):
         # First upcall to get everything prepared.
         WarningCountingShellCommand.setupEnvironment(self, cmd)
@@ -37,6 +83,7 @@ class NinjaCommand(WarningCountingShellC
             cmd.args['env'] = {}
         cmd.args['env']['NINJA_STATUS'] = cmd.args['env'].get('NINJA_STATUS', "%e [%u/%r/%f] ")
 
+
     def start(self):
         # Don't forget to remove all the empty items from the command,
         # which we could get because of WithProperties rendered as empty strings.