Ticket #87: custombuildproperties.diff

buildbot/status/html.py

@@ -538 +538 @@
                            "<input type='text' name='branch' />")
                 + make_row("Revision to build:",
                            "<input type='text' name='revision' />")
+                + self.make_user_defined_rows()
+
                 + """
                 <input type='submit' value='Force Build' />
                 </form>
@@ -560 +562 @@
 
         return data
 
+    # Providing the users custom properties are set in the master.cfg file
+    # this method will generate custom widgets (text fields, radio buttons and
+    # check boxes) for the slave build page. The method returns a html string
+    # representing the widgets. This string is added to the body of the slave
+    # build page.
+    def make_user_defined_rows(self):
+        userDefRows = name = type = label = value = ""
+        customBuildProperties = self.status.getCustomBuildProperties()   
+        for properties in customBuildProperties:
+            name = properties['propertyName']
+            type = properties['propertyType']
+            label = properties['propertyLabel']               
+            if type == 'radio':               
+                value = properties['groupValue']
+                field = "<input type=" + "\'" + type + "\'" + "name=" + "\'" + \
+                                name + "\'" + "value=" + "\'" + value + "\'" + " />"
+            else:
+                field = "<input type=" + "\'" + type + "\'" +  \
+                                "name=" + "\'" + name + "\'" + " />"
+
+            userDefRows += make_row(label, field)
+            name = type = label = value = ""
+
+        return userDefRows
+
     def force(self, request):
         name = request.args.get("username", ["<unknown>"])[0]
         reason = request.args.get("comments", ["<no reason specified>"])[0]
         branch = request.args.get("branch", [""])[0]
         revision = request.args.get("revision", [""])[0]
 
+        # Custom properties.
+        custom_props = {}          
+        forceBuildProperties = self.status.getCustomBuildProperties()   
+        for dict in forceBuildProperties:
+            for key, value in dict.iteritems():             
+               if key == 'propertyName':
+                   custom_props[value] = request.args.get(value, [""])[0]
+
         r = "The web-page 'force build' button was pressed by '%s': %s\n" \
             % (name, reason)
         log.msg("web forcebuild of builder '%s', branch='%s', revision='%s'"
@@ -593 +628 @@
         # button, use their name instead of None, so they'll be informed of
         # the results.
         s = SourceStamp(branch=branch, revision=revision)
-        req = BuildRequest(r, s, self.builder.getName())
+        req = BuildRequest(r, s, custom_props, self.builder.getName())
         try:
             self.control.requestBuildSoon(req)
         except interfaces.NoSlaveError:

buildbot/status/builder.py

@@ -1777 +1777 @@
         return self.botmaster.parent.projectURL
     def getBuildbotURL(self):
         return self.botmaster.parent.buildbotURL
+    def getCustomBuildProperties(self):
+     return self.botmaster.parent.customBuildProperties
 
     def getURLForThing(self, thing):
         prefix = self.getBuildbotURL()

buildbot/process/base.py

@@ -39 +39 @@
                   provide this, but for forced builds the user requesting the
                   build will provide a string.
 
+    @type custom_props: dictionary.
+    @ivar custom_props: custom user properties.
+
     @ivar status: the IBuildStatus object which tracks our status
 
     @ivar submittedAt: a timestamp (seconds since epoch) when this request
@@ -49 +52 @@
     source = None
     builder = None
     startCount = 0 # how many times we have tried to start this build
+    custom_props = {}
 
     if implements:
         implements(interfaces.IBuildRequestControl)
     else:
         __implements__ = interfaces.IBuildRequestControl,
 
-    def __init__(self, reason, source, builderName=None):
+    def __init__(self, reason, source, custom_props, builderName=None):
         # TODO: remove the =None on builderName, it is there so I don't have
         # to change a lot of tests that create BuildRequest objects
         assert interfaces.ISourceStamp(source, None)
         self.reason = reason
         self.source = source
+        self.custom_props = custom_props
         self.start_watchers = []
         self.finish_watchers = []
         self.status = BuildRequestStatus(source, builderName)
@@ -87 +92 @@
         self.finish_watchers.append(d)
         return d
 
+    def customProps(self):
+     return self.custom_props;
+
     # these are called by the Builder
 
     def requestSubmitted(self, builder):
@@ -175 +183 @@
         self.source = requests[0].mergeWith(requests[1:])
         self.reason = requests[0].mergeReasons(requests[1:])
 
+        # Set custom properties.
+        self.custom_properties = requests[0].customProps()
+
         #self.abandoned = False
 
         self.progress = None
@@ -269 +280 @@
         self.setProperty("buildnumber", self.build_status.number)
         self.setProperty("branch", self.source.branch)
         self.setProperty("revision", self.source.revision)
+        cp = self.custom_properties
+        for key,userProp in cp.iteritems():
+         self.setProperty(key,userProp)
 
     def setupSlaveBuilder(self, slavebuilder):
         self.slavebuilder = slavebuilder

buildbot/master.py

@@ -543 +543 @@
     projectURL = None
     buildbotURL = None
     change_svc = None
+    customBuildProperties = None
 
     def __init__(self, basedir, configFileName="master.cfg"):
         service.MultiService.__init__(self)
@@ -694 +695 @@
 
         known_keys = "bots sources schedulers builders slavePortnum " + \
                      "debugPassword manhole " + \
-                     "status projectName projectURL buildbotURL"
+                     "status projectName projectURL buildbotURL " + \
+                     "customBuildProperties"
         known_keys = known_keys.split()
         for k in config.keys():
             if k not in known_keys:
@@ -715 +717 @@
             projectName = config.get('projectName')
             projectURL = config.get('projectURL')
             buildbotURL = config.get('buildbotURL')
+            customBuildProperties = config.get('customBuildProperties')
 
         except KeyError, e:
             log.msg("config dictionary is missing a required parameter")
@@ -818 +821 @@
         self.projectName = projectName
         self.projectURL = projectURL
         self.buildbotURL = buildbotURL
+        self.customBuildProperties = customBuildProperties
 
         # self.bots: Disconnect any that were attached and removed from the
         # list. Update self.checker with the new list of passwords,

buildbot/scripts/sample.cfg

@@ -173 +173 @@
 # without some help.
 
 c['buildbotURL'] = "http://localhost:8010/"
+
+###### CUSTOM BUILD PROPERTIES FOR THE SLAVE BUILD PAGE.
+
+"""
+textField = {'propertyName' : 'text_field',
+             'propertyType' : 'text',
+             'propertyLabel': 'Text Label',
+             }
+
+checkBox = {'propertyName' : 'check_box',
+            'propertyType' : 'checkbox',
+            'propertyLabel': 'Check Box',
+            }
+
+radio1 = {'propertyName' : 'radio_group',
+          'propertyType' : 'radio',
+          'propertyLabel': 'Male',
+          'groupValue'   : 'm',
+          }
+
+radio2 = {'propertyName' : 'radio_group',
+          'propertyType' : 'radio',
+          'propertyLabel': 'Female',
+          'groupValue'   : 'f',
+          }
+
+c['customBuildProperties'] = [textField, checkBox, radio1, radio2]
+"""