Ticket #87: 124.patch

old-124/buildbot/buildset.py

@@ -1 @@
-
-from buildbot.process import base
-from buildbot.status import builder
+from buildbot.process.properties import Properties
-
-
-class BuildSet:
@@ -11 +11 @@
-    (source.changes=list)."""
-
-    def __init__(self, builderNames, source, reason=None, bsid=None,
-scheduler=None, custom_prop
+propertie
-        """
-        @param source: a L{buildbot.sourcestamp.SourceStamp}
-        """
@@ -19 +19 @@
-        self.source = source
-        self.reason = reason
-
-if not custom_props: custom_props = {}
-self.custom_props = custom_props
+self.properties = Properties()
+if properties: self.properties.updateFromProperties(properties)
-
-        self.stillHopeful = True
-        self.status = bss = builder.BuildSetStatus(source, reason,
-                                                   builderNames, bsid)
-        self.scheduler = scheduler
-
-    def waitUntilSuccess(self):
-        return self.status.waitUntilSuccess()
@@ -41 +40 @@
-        # create the requests
-        for b in builders:
-            req = base.BuildRequest(self.reason, self.source, b.name, 
-
-
+
-            reqs.append((b, req))
-            self.requests.append(req)
-            d = req.waitUntilFinished()

old-124/buildbot/buildslave.py

@@ -11 +11 @@
-from buildbot.status.builder import SlaveStatus
-from buildbot.status.mail import MailNotifier
-from buildbot.interfaces import IBuildSlave
+from buildbot.process.properties import Properties
-
-class BuildSlave(NewCredPerspective, service.MultiService):
-    """This is the master-side representative for a remote buildbot slave.
@@ -26 +27 @@
-    implements(IBuildSlave)
-
-    def __init__(self, name, password, max_builds=None,
-
+
+
-        """
-        @param name: botname this machine will supply when it connects
-        @param password: password this machine will supply when
@@ -34 +36 @@
-        @param max_builds: maximum number of simultaneous builds that will
-                           be run concurrently on this buildslave (the
-                           default is None for no limit)
+        @param properties: properties that will be applied to builds run on 
+                           this slave
+        @type properties: dictionary
-        """
-        service.MultiService.__init__(self)
-        self.slavename = name
@@ -44 +49 @@
-        self.slave_commands = None
-        self.slavebuilders = []
-        self.max_builds = max_builds
+
+        self.properties = Properties()
+        self.properties.update(properties, "BuildSlave")
+        self.properties.setProperty("slavename", name, "BuildSlave")
+
-        self.lastMessageReceived = 0
-        if isinstance(notify_on_missing, str):
-            notify_on_missing = [notify_on_missing]

old-124/buildbot/clients/debug.py

@@ -105 +105 @@
-            if revision == '':
-                revision = None
-        reason = "debugclient 'Request Build' button pushed"
-custom_prop
+propertie
-        d = self.remote.callRemote("requestBuild",
-custom_prop
+propertie
-        d.addErrback(self.err)
-
-    def do_ping(self, widget):

old-124/buildbot/interfaces.py

@@ -38 +38 @@
-class IScheduler(Interface):
-    """I watch for Changes in the source tree and decide when to trigger
-    Builds. I create BuildSet objects and submit them to the BuildMaster. I
-
+
+
+
+
+
+
-
-    def addChange(change):
-        """A Change has just been dispatched by one of the ChangeSources.

old-124/buildbot/master.py

@@ -27 +27 @@
-from buildbot.sourcestamp import SourceStamp
-from buildbot.buildslave import BuildSlave
-from buildbot import interfaces
+from buildbot.process.properties import Properties
-
-########################################
-
@@ -227 +228 @@
-    def detached(self, mind):
-        pass
-
-
-
-
-
-
-
-
-
-
+
-        c = interfaces.IControl(self.master)
-        bc = c.getBuilder(buildername)
-        ss = SourceStamp(branch, revision)
-
+
+
+
-        bc.requestBuild(br)
-
-    def perspective_pingBuilder(self, buildername):
@@ -347 +342 @@
-    projectURL = None
-    buildbotURL = None
-    change_svc = None
-customBuildProperties = None
+properties = Properties()
-
-    def __init__(self, basedir, configFileName="master.cfg"):
-        service.MultiService.__init__(self)
@@ -503 +498 @@
-                      "schedulers", "builders",
-                      "slavePortnum", "debugPassword", "manhole",
-                      "status", "projectName", "projectURL", "buildbotURL",
-customBuildP
+p
-                      )
-        for k in config.keys():
-            if k not in known_keys:
@@ -531 +526 @@
-            projectName = config.get('projectName')
-            projectURL = config.get('projectURL')
-            buildbotURL = config.get('buildbotURL')
-customBuildProperties = config.get('customBuildProperties'
+properties = config.get('properties', {}
-
-        except KeyError, e:
-            log.msg("config dictionary is missing a required parameter")
@@ -663 +658 @@
-                    else:
-                        locks[l.name] = l
-
+        if not isinstance(properties, dict):
+            raise ValueError("c['properties'] must be a dictionary")
+
-        # slavePortnum supposed to be a strports specification
-        if type(slavePortnum) is int:
-            slavePortnum = "tcp:%d" % slavePortnum
@@ -677 +675 @@
-        self.projectName = projectName
-        self.projectURL = projectURL
-        self.buildbotURL = buildbotURL
-
+
+
+
-
-        # self.slaves: Disconnect any that were attached and removed from the
-        # list. Update self.checker with the new list of passwords, including

old-124/buildbot/process/base.py

@@ -11 +11 @@
-from buildbot.status.builder import SUCCESS, WARNINGS, FAILURE, EXCEPTION
-from buildbot.status.builder import Results, BuildRequestStatus
-from buildbot.status.progress import BuildProgress
+from buildbot.process.properties import Properties
-
-class BuildRequest:
-    """I represent a request to a specific Builder to run a single build.
@@ -39 +40 @@
-                  provide this, but for forced builds the user requesting the
-                  build will provide a string.
-
-custom_props: dictionary.
-custom_props: custom user properties.
+properties: Properties object
+properties: properties that should be applied to this build
-
-    @ivar status: the IBuildStatus object which tracks our status
-
@@ -52 +53 @@
-    source = None
-    builder = None
-    startCount = 0 # how many times we have tried to start this build
-    custom_props = {}
-
-    implements(interfaces.IBuildRequestControl)
-
-scheduler=None, custom_prop
+propertie
-        # 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.scheduler = scheduler
-
-
-
-
-
+
+
+
-
-        self.start_watchers = []
-        self.finish_watchers = []
@@ -95 +93 @@
-        self.finish_watchers.append(d)
-        return d
-
-    def customProps(self):
-     return self.custom_props
-
-    # these are called by the Builder
-
-    def requestSubmitted(self, builder):
@@ -182 +177 @@
-        # build a source stamp
-        self.source = requests[0].mergeWith(requests[1:])
-        self.reason = requests[0].mergeReasons(requests[1:])
-        self.scheduler = requests[0].scheduler
-
-        # Set custom properties.
-        self.custom_properties = requests[0].customProps()
-
-        #self.abandoned = False
-
-        self.progress = None
-        self.currentStep = None
@@ -207 +196 @@
-    def getSourceStamp(self):
-        return self.source
-
-
+, source
-        """Set a property on this build. This may only be called after the
-        build has started, so that it has a BuildStatus object where the
-        properties can live."""
-
+, source
-
-Custom
-custom_properties
+
+build_status.getProperties()
-
-    def getProperty(self, propname):
-properties[propname]
+getProperty(propname)
-
-    def allChanges(self):
-        return self.source.changes
@@ -275 +264 @@
-    def getSlaveName(self):
-        return self.slavebuilder.slave.slavename
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    def setupSlaveBuilder(self, slavebuilder):
-        self.slavebuilder = slavebuilder
+
+        # navigate our way back to the L{buildbot.buildslave.BuildSlave}
+        # object that came from the config, and get its properties
+        buildslave_properties = slavebuilder.slave.properties
+        self.getProperties().updateFromProperties(buildslave_properties)
+
-        self.slavename = slavebuilder.slave.slavename
-        self.build_status.setSlavename(self.slavename)
-        self.setProperty("slavename", self.slavename)
-
-    def startBuild(self, build_status, expectations, slavebuilder):
-        """This method sets up the build, then starts it by invoking the
@@ -305 +305 @@
-        # the Deferred returned by this method.
-
-        log.msg("%s.startBuild" % self)
-setupStatus(build_status)
+build_status = build_status
-        # now that we have a build_status, we can set properties
+        self.setupProperties()
-        self.setupSlaveBuilder(slavebuilder)
-
-        # convert all locks into their real forms

old-124/buildbot/process/builder.py

@@ -253 +253 @@
-    @type building: list of L{buildbot.process.base.Build}
-    @ivar building: Builds that are actively running
-
+    @type slaves: list of L{buildbot.buildslave.BuildSlave} objects
+    @ivar slaves: the slaves currently available for building
-    """
-
-    expectations = None # this is created the first time we get a good build
@@ -445 +447 @@
-        """This is invoked by the BuildSlave when the self.slavename bot
-        registers their builder.
-
-master
+buildslave
-        @param slave: the BuildSlave that represents the buildslave as a whole
-        @type  remote: L{twisted.spread.pb.RemoteReference}
-        @param remote: a reference to the L{buildbot.slave.bot.SlaveBuilder}

old-124/buildbot/process/buildstep.py

@@ -632 +632 @@
-    def getProperty(self, propname):
-        return self.build.getProperty(propname)
-
-
-
+, source
+, source
-
-    def startStep(self, remote):
-        """Begin the step. This returns a Deferred that will fire when the
@@ -1092 +1092 @@
-        self.step_status.setText(self.getText(cmd, results))
-        self.step_status.setText2(self.maybeGetText2(cmd, results))
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+

old-124/buildbot/process/properties.py

@@ +1 @@
+from zope.interface import implements
+from buildbot import util
+from twisted.python import log
+from twisted.python.failure import Failure
+
+class Properties(util.ComparableMixin):
+    """
+    I represent a set of properties that can be interpolated into various
+    strings in buildsteps.
+
+    @ivar properties: dictionary mapping property values to tuples 
+        (value, source), where source is a string identifing the source
+        of the property.
+
+    Objects of this class can be read like a dictionary -- in this case,
+    only the property value is returned.
+
+    As a special case, a property value of None is returned as an empty 
+    string when used as a mapping.
+    """
+
+    compare_attrs = ('properties')
+
+    def __init__(self, **kwargs):
+        """
+        @param kwargs: initial property values (for testing)
+        """
+        self.properties = {}
+        if kwargs: self.update(kwargs, "TEST")
+
+    def __getitem__(self, name):
+        """Just get the value for this property, special-casing None -> ''"""
+        rv = self.properties[name][0]
+        if rv is None: rv = ''
+        return rv
+
+    def has_key(self, name):
+        return self.properties.has_key(name)
+
+    def getProperty(self, name, default=None):
+        """Get the value for the given property, with no None -> '' special case"""
+        return self.properties.get(name, (default,))[0]
+
+    def getPropertySource(self, name):
+        return self.properties[name][1]
+
+    def asList(self):
+        """Return the properties as a sorted list of (name, value, source)"""
+        l = [ (k, v[0], v[1]) for k,v in self.properties.items() ]
+        l.sort()
+        return l
+
+    def __repr__(self):
+        return repr(dict([ (k,v[0]) for k,v in self.properties.iteritems() ]))
+
+    def setProperty(self, name, value, source):
+        self.properties[name] = (value, source)
+
+    def update(self, dict, source):
+        """Update this object from a dictionary, with an explicit source specified."""
+        for k, v in dict.items():
+            self.properties[k] = (v, source)
+
+    def updateFromProperties(self, other):
+        """Update this object based on another object; the other object's """
+        self.properties.update(other.properties)
+
+    def render(self, value):
+        """
+        Return a variant of value that has any WithProperties objects
+        substituted.  This recurses into Python's compound data types.
+        """
+        if isinstance(value, (str, unicode)):
+            return value
+        elif isinstance(value, WithProperties):
+            return value.render(self)
+        elif isinstance(value, list):
+            return [ self.render(e) for e in value ]
+        elif isinstance(value, tuple):
+            return tuple([ self.render(e) for e in value ])
+        elif isinstance(value, dict):
+            return dict([ (self.render(k), self.render(v)) for k,v in value.iteritems() ])
+        else:
+            return value
+
+class WithProperties(util.ComparableMixin):
+    """This is a marker class, used in ShellCommand's command= argument to
+    indicate that we want to interpolate a build property.
+    """
+
+    compare_attrs = ('fmtstring', 'args')
+
+    def __init__(self, fmtstring, *args):
+        self.fmtstring = fmtstring
+        self.args = args
+
+    def render(self, properties):
+        if self.args:
+            strings = []
+            for name in self.args:
+                strings.append(properties[name])
+            s = self.fmtstring % tuple(strings)
+        else:
+            s = self.fmtstring % properties
+        return s

old-124/buildbot/scheduler.py

@@ -14 +14 @@
-from buildbot.status import builder
-from buildbot.sourcestamp import SourceStamp
-from buildbot.changes.maildir import MaildirService
+from buildbot.process.properties import Properties
-
-
-class BaseScheduler(service.MultiService, util.ComparableMixin):
+    """
+    A Schduler creates BuildSets and submits them to the BuildMaster.
+
+    @ivar name: name of the scheduler
+
+    @ivar properties: additional properties specified in this 
+        scheduler's configuration
+    @type properties: Properties object
+    """
-    implements(interfaces.IScheduler)
-
-
+
+
+
+
+
+
+
-        service.MultiService.__init__(self)
-        self.name = name
+        self.properties = Properties()
+        self.properties.update(properties, "Scheduler")
+        self.properties.setProperty("scheduler", name, "Scheduler")
-
-    def __repr__(self):
-        # TODO: why can't id() return a positive number? %d is ugly.
-        return "<Scheduler '%s' at %d>" % (self.name, id(self))
-
-
+BuildSet
-        self.parent.submitBuildSet(bs)
-
-    def addChange(self, change):
@@ -36 +55 @@
-class BaseUpstreamScheduler(BaseScheduler):
-    implements(interfaces.IUpstreamScheduler)
-
-
-
+, properties={}
+, properties
-        self.successWatchers = []
-
-    def subscribeToSuccessfulBuilds(self, watcher):
@@ -45 +64 @@
-    def unsubscribeToSuccessfulBuilds(self, watcher):
-        self.successWatchers.remove(watcher)
-
-
+BuildSet
-        d = bs.waitUntilFinished()
-        d.addCallback(self.buildSetFinished)
-self.parent.submitBuildSet(
+BaseScheduler.submitBuildSet(self, 
-
-    def buildSetFinished(self, bss):
-        if not self.running:
@@ -69 +88 @@
-
-    fileIsImportant = None
-    compare_attrs = ('name', 'treeStableTimer', 'builderNames', 'branch',
-
+, 'properties'
-    
-    def __init__(self, name, branch, treeStableTimer, builderNames,
-
+, properties={}
-        """
-        @param name: the name of this Scheduler
-        @param branch: The branch name that the Scheduler should pay
@@ -94 +113 @@
-                                build is triggered by an important change.
-                                The default value of None means that all
-                                Changes are important.
+
+        @param properties: properties to apply to all builds started from this 
+                           scheduler
-        """
-
-
+, properties
-        self.treeStableTimer = treeStableTimer
-        errmsg = ("The builderNames= argument to Scheduler must be a list "
-                  "of Builder description names (i.e. the 'name' key of the "
@@ -171 +193 @@
-        # create a BuildSet, submit it to the BuildMaster
-        bs = buildset.BuildSet(self.builderNames,
-                               SourceStamp(changes=changes),
-scheduler=self
-
+properties=self.properties
+BuildSet
-
-    def stopService(self):
-        self.stopTimer()
@@ -188 +210 @@
-    fileIsImportant = None
-
-    compare_attrs = ('name', 'branches', 'treeStableTimer', 'builderNames',
-
+, 'properties'
-
-    def __init__(self, name, branches, treeStableTimer, builderNames,
-
+, properties={}
-        """
-        @param name: the name of this Scheduler
-        @param branches: The branch names that the Scheduler should pay
@@ -216 +238 @@
-                                build is triggered by an important change.
-                                The default value of None means that all
-                                Changes are important.
+
+        @param properties: properties to apply to all builds started from this 
+                           scheduler
-        """
-
-
+, properties
-        self.treeStableTimer = treeStableTimer
-        for b in builderNames:
-            assert isinstance(b, str)
@@ -272 +297 @@
-            self.schedulers[branch] = s
-        s.addChange(change)
-
-    def submitBuildSet(self, bs):
-        self.parent.submitBuildSet(bs)
-
-
-class Dependent(BaseUpstreamScheduler):
-    """This scheduler runs some set of 'downstream' builds when the
-    'upstream' scheduler has completed successfully."""
-
-
+, 'properties'
-
-
+, properties={}
-        assert interfaces.IUpstreamScheduler.providedBy(upstream)
-
+, properties
-        self.upstream = upstream
-        self.builderNames = builderNames
-
@@ -305 +327 @@
-        return d
-
-    def upstreamBuilt(self, ss):
-
-
+
+
+
-
-
-
@@ -319 +342 @@
-    # TODO: consider having this watch another (changed-based) scheduler and
-    # merely enforce a minimum time between builds.
-
-
+, 'properties'
-
-    def __init__(self, name, builderNames, periodicBuildTimer,
-
-
+, properties={}
+, properties
-        self.builderNames = builderNames
-        self.periodicBuildTimer = periodicBuildTimer
-        self.branch = branch
@@ -344 +367 @@
-    def doPeriodicBuild(self):
-        bs = buildset.BuildSet(self.builderNames,
-                               SourceStamp(branch=self.branch),
-
-
+
+
+
-
-
-
@@ -389 +413 @@
-
-    compare_attrs = ('name', 'builderNames',
-                     'minute', 'hour', 'dayOfMonth', 'month',
-
+, 'properties'
-
-    def __init__(self, name, builderNames, minute=0, hour='*',
-                 dayOfMonth='*', month='*', dayOfWeek='*',
-
+, properties={}
-        # Setting minute=0 really makes this an 'Hourly' scheduler. This
-        # seemed like a better default than minute='*', which would result in
-        # a build every 60 seconds.
-
+, properties
-        self.builderNames = builderNames
-        self.minute = minute
-        self.hour = hour
@@ -502 +526 @@
-        # And trigger a build
-        bs = buildset.BuildSet(self.builderNames,
-                               SourceStamp(branch=self.branch),
-
-
+
+
+
-
-    def addChange(self, change):
-        pass
-
-
-
-
-
-
-
-
-
+
+
+
-        self.builderNames = builderNames
-
-    def listBuilderNames(self):
@@ -546 +568 @@
-        self.error = True
-
-class Try_Jobdir(TryBase):
-["name", "builderNames", "jobdir"]
+( 'name', 'builderNames', 'jobdir', 'properties' )
-
-
-
+, properties={}
+, properties
-        self.jobdir = jobdir
-        self.watcher = MaildirService()
-        self.watcher.setServiceParent(self)
@@ -624 +646 @@
-                return
-
-        reason = "'try' job"
-
-
+
+
+
-
-class Try_Userpass(TryBase):
-["name", "builderNames", "port", "userpass"]
+( 'name', 'builderNames', 'port', 'userpass', 'properties' )
-    implements(portal.IRealm)
-
-
-
+, properties={}
+, properties
-        if type(port) is int:
-            port = "tcp:%d" % port
-        self.port = port
@@ -657 +680 @@
-        p = Try_Userpass_Perspective(self, avatarID)
-        return (pb.IPerspective, p, lambda: None)
-
-    def submitBuildSet(self, bs):
-        return self.parent.submitBuildSet(bs)
-
-class Try_Userpass_Perspective(pbutil.NewCredPerspective):
-    def __init__(self, parent, username):
-        self.parent = parent
-        self.username = username
-
-
-
+
-        log.msg("user %s requesting build on builders %s" % (self.username,
-                                                             builderNames))
-        for b in builderNames:
@@ -678 +697 @@
-        ss = SourceStamp(branch, revision, patch)
-        reason = "'try' job from user %s" % self.username
-
+        # roll the specified props in with our inherited props
+        combined_props = Properties()
+        combined_props.updateFromProperties(self.parent.properties)
+        combined_props.update(properties, "try build")
+
-        bs = buildset.BuildSet(builderNames, 
-                               ss,
-                               reason=reason, 
-
-
+
-
-        self.parent.submitBuildSet(bs)
-
@@ -696 +719 @@
-    the builds that I fire have finished.
-    """
-
-
-
+
+
+
+
-        self.builderNames = builderNames
-
-    def listBuilderNames(self):
@@ -706 +731 @@
-    def getPendingBuildTimes(self):
-        return []
-
-custom_props={}
+set_props=None
-        """Trigger this scheduler. Returns a deferred that will fire when the
-        buildset is finished.
-        """
-
+
+
+
+
+
+
+
+
-        d = bs.waitUntilFinished()
-
+BuildSet
-        return d

old-124/buildbot/scripts/runner.py

@@ -763 +763 @@
-
-        ["builder", "b", None,
-         "Run the trial build on this Builder. Can be used multiple times."],
-custom
-custom 
+
+
-        ]
-
-    optFlags = [
@@ -774 +774 @@
-    def __init__(self):
-        super(TryOptions, self).__init__()
-        self['builders'] = []
-custom_prop
+propertie
-
-    def opt_builder(self, option):
-        self['builders'].append(option)
-
-
-
-
-
+
+
+
-        propertylist = option.split(",")
-        for i in range(0,len(propertylist)):
-            print propertylist[i]
-            splitproperty = propertylist[i].split("=")
-custom_prop
-custom_props'] = custom_prop
+propertie
+properties'] = propertie
-
-    def opt_patchlevel(self, option):
-        self['patchlevel'] = int(option)

old-124/buildbot/scripts/tryclient.py

@@ -448 +448 @@
-                              ss.revision,
-                              ss.patch,
-                              self.builderNames,
-custom_prop
+propertie
-        d.addCallback(self._deliverJob_pb2)
-        return d
-    def _deliverJob_pb2(self, status):

old-124/buildbot/status/builder.py

@@ -5 +5 @@
-from twisted.persisted import styles
-from twisted.internet import reactor, defer
-from twisted.protocols import basic
+from buildbot.process.properties import Properties
-
-import os, shutil, sys, re, urllib, itertools
-from cPickle import load, dump
@@ -888 +889 @@
-
-class BuildStatus(styles.Versioned):
-    implements(interfaces.IBuildStatus, interfaces.IStatusEvent)
-2
+3
-
-    source = None
-    reason = None
@@ -924 +925 @@
-        self.finishedWatchers = []
-        self.steps = []
-        self.testResults = {}
-{}
+Properties()
-
-    # IBuildStatus
-
@@ -937 +938 @@
-    def getProperty(self, propname):