Ticket #99: first_steps_to_99.patch

a/buildbot/interfaces.py

@@ -1006 +1006 @@
-        to a scarcity of build slaves). These upcoming builds can be canceled
-        through the control object."""
-
+    def cancelBuildRequest(self, request_number):
+        """If there is a build request with the given number on the builder's queue,
+        cancel the request"""
+
-    def getBuild(number):
-        """Attempt to return an IBuildControl object for the given build.
-        Returns None if no such object is available. This will only work for

a/buildbot/process/base.py

@@ -133 +133 @@
-        not yet been started.
-
-        @return: a boolean indicating if the cancel was successful."""
+        log.msg("Cancelling %r" % self)
-        if self.builder:
-            return self.builder.cancelBuildRequest(self)
-        return False

a/buildbot/process/builder.py

@@ -333 +333 @@
-    def __repr__(self):
-        return "<Builder '%s' at %d>" % (self.name, id(self))
-
-
-    def submitBuildRequest(self, req):
-        req.submittedAt = now()
-        self.buildable.append(req)
@@ -714 +713 @@
-            return
-
-        ss = bs.getSourceStamp(absolute=True)
-
+
+
-        self.requestBuild(req)
-
-    def getPendingBuilds(self):
-        # return IBuildRequestControl objects
-        raise NotImplementedError
+#        """Return a list of L{IBuildRequestControl} objects for this Builder.
+#        Each one corresponds to a pending build that has not yet started (due
+#        to a scarcity of build slaves). These upcoming builds can be canceled
+#        through the control object."""
+#        return self.original.buildable
-
-    def getBuild(self, number):
-        return self.original.getBuild(number)
@@ -736 +741 @@
-        d.addCallback(self._gatherPingResults)
-        return d
-
+    def cancelBuildRequest(self, request_number):
+        # Delete the build request from queue
+        for br in self.original.buildable:
+            if br.status.getNumber() == request_number:
+                br.cancel()
+
-    def _gatherPingResults(self, res):
-        for ignored,success in res:
-            if not success:

a/buildbot/process/properties.py

@@ -39 +39 @@
-
-    def __getitem__(self, name):
-        """Just get the value for this property."""
-
-
+
+
+
+
-
-    def has_key(self, name):
-        return self.properties.has_key(name)

a/buildbot/status/builder.py

@@ -614 +614 @@
-        self.builderName = builderName
-        self.builds = [] # list of BuildStatus objects
-        self.observers = []
+        self.number = None
-
-    def buildStarted(self, build):
-        self.builds.append(build)
@@ -635 +636 @@
-    def unsubscribe(self, observer):
-        self.observers.remove(observer)
-
+    def setNumber(self, number):
+        self.number = number
+    def getNumber(self):
+        return self.number
+
-
-class BuildStepStatus(styles.Versioned):
-    """
@@ -1370 +1376 @@
-        self.nextBuild = None
-        self.watchers = []
-        self.buildCache = [] # TODO: age builds out of the cache
+        self.nextRequestNumber = 0
-
-    # persistence
-
@@ -1390 +1397 @@
-        del d['basedir']
-        del d['status']
-        del d['nextBuildNumber']
+        del d['nextRequestNumber']
-        return d
-
-    def __setstate__(self, d):
@@ -1401 +1409 @@
-        self.pendingBuilds = []
-        self.watchers = []
-        self.slavenames = []
+        self.nextRequestNumber = 0
-        # self.basedir must be filled in by our parent
-        # self.status must be filled in by our parent
-
@@ -1656 +1665 @@
-        return s
-
-    def addBuildRequest(self, brstatus):
+        req_number = self.nextRequestNumber
+        self.nextRequestNumber += 1
+        brstatus.setNumber(req_number)
+
+        log.msg("Adding build request %u" % req_number)
-        self.pendingBuilds.append(brstatus)
-    def removeBuildRequest(self, brstatus):
-        self.pendingBuilds.remove(brstatus)

a/buildbot/status/web/baseweb.py

@@ -20 +20 @@
-from buildbot.status.web.slaves import BuildSlavesResource
-from buildbot.status.web.xmlrpc import XMLRPCServer
-from buildbot.status.web.about import AboutBuildbot
+from buildbot.status.web.build import QueueStatusResource
-
-# this class contains the status services (WebStatus and the older Waterfall)
-# which can be put in c['status']. It also contains some of the resources

a/buildbot/status/web/build.py

@@ -11 +11 @@
-from buildbot.status.web.tests import TestsResource
-from buildbot.status.web.step import StepsResource
-from buildbot import version, util
+from buildbot.status.web.queue import QueueEntryStatusResource
-
-# /builders/$builder/builds/$buildnum
-class StatusResourceBuild(HtmlResource):
@@ -56 +57 @@
-            results = b.getResults()
-            data += "<h2>Results:</h2>\n"
-            text = " ".join(b.getText())
-data += '<span class="%s">%s</span>\n' % (css_classes[results],
-                                     
+if results != None:
+data += '<span class="%s">%s</span>\n' % (css_classes[results],
-            if b.getTestResults():
-                url = req.childLink("tests")
-                data += "<h3><a href=\"%s\">test results</a></h3>\n" % url
@@ -294 +295 @@
-                    build_control = None
-                return StatusResourceBuild(build_status, build_control,
-                                           self.builder_control)
+            else:
+                # Probably a build that was not started yet
+                return QueueEntryStatusResource(path, req, num, self.builder_status, self.builder_control)
+
+        return HtmlResource.getChild(self, path, req)
+
+# /builders/$builder/queue
+class QueueStatusResource(HtmlResource):
+    addSlash = True
+
+    def __init__(self, builder_status, builder_control):
+        HtmlResource.__init__(self)
+        self.builder_status = builder_status
+        self.builder_control = builder_control
+
+    def getChild(self, path, req):
+        try:
+            num = int(path)
+        except ValueError:
+            num = None
+        if num is not None:
+                return QueueEntryStatusResource(path, req, num, self.builder_status, self.builder_control)
-
-        return HtmlResource.getChild(self, path, req)
-

a/buildbot/status/web/builder.py

@@ -9 +9 @@
-from buildbot.status.web.base import HtmlResource, make_row, \
-     make_force_build_form, OneLineMixin
-from buildbot.process.base import BuildRequest
+from buildbot.process.properties import Properties
-from buildbot.sourcestamp import SourceStamp
-from buildbot import version, util
-
-
+, QueueStatusResource
-
-# /builders/$builder
-class StatusResourceBuilder(HtmlResource, OneLineMixin):
@@ -50 +51 @@
-  <input type="submit" value="Stop Build" />
-</form>''' % stopURL
-        return data
+    
+    def makeRemoveFromQueueButton(self, req, req_num):
+        stopURL = urllib.quote(req.childLink("queue/%d/remove" % req_num))
+        data = '''
+<form action="%s" class="command stopbuild" style="display:inline">
+  <input type="submit" value="Remove Build" />
+</form>''' % stopURL
+        return data
-
-    def body(self, req):
-        b = self.builder_status
@@ -76 +85 @@
-            data += "</ul>\n"
-        else:
-            data += "<h2>no current builds</h2>\n"
+            
+        # Then a section with the queued build requests
+        data += "<h2>Pending Builds:</h2>\n"
+        # Retrieve the builders queue
+        pendingBuilds = b.getPendingBuilds()
+        if pendingBuilds:
+            # Determine the build numbers of the queue builds.
+            # Sadly we cannot remove the build from the queue with this
+            # number as it is not valid yet.
+            data += "<ul>\n"
+            for buildRequestStatus in pendingBuilds:
+                sourceStamp = buildRequestStatus.getSourceStamp()
+                req_number = buildRequestStatus.getNumber()
+                data += "<li>#%u " % req_number
+                data += "Branch: %s " % sourceStamp.branch
+                data += "[rev=%s]" % sourceStamp.revision
+                data += self.makeRemoveFromQueueButton(req, req_number)
+                data += "</li>"
+            data += "</ul>\n"
+        else:
+            data += "No pending builds"
-
-        # Then a section with the last 5 builds, with the most recent build
-        # distinguished from the rest.
@@ -237 +267 @@
-            return file
-        if path == "builds":
-            return BuildsResource(self.builder_status, self.builder_control)
+        if path == "queue":
+            return QueueStatusResource(self.builder_status, self.builder_control)
-
-        return HtmlResource.getChild(self, path, req)
-

/dev/null

@@ +1 @@
+from twisted.web.util import Redirect, DeferredResource
+from twisted.python import log
+from twisted.internet import defer, reactor
+from buildbot.status.web.base import HtmlResource
+
+# Shows the queue of a Builder
+class QueueEntryStatusResource(HtmlResource):
+    def __init__(self, path, req, num, builder_status, builder_control):
+        HtmlResource.__init__(self)
+        self.path = path
+        self.req  = req
+        self.num  = num
+        self.builder_status = builder_status
+        self.builder_control = builder_control
+        
+    def body(self, request):    
+        return ""
+    
+    # Removes a build from a builders queue
+    def removeFromQueue(self, req):
+        self.builder_control.cancelBuildRequest(self.num)
+
+        # we're at http://localhost:8080/svn-hello/builds/5/stop?[args] and
+        # we want to go to: http://localhost:8080/svn-hello
+        r = Redirect("../..")
+        d = defer.Deferred()
+        reactor.callLater(1, d.callback, r)
+        return DeferredResource(d)
+        
+    def getChild(self, path, req):
+        if path == "remove":
+            return self.removeFromQueue(req)
+        else:
+            return HtmlResource.getChild(self, path, req)

/dev/null

@@ +1 @@
+# -*- test-case-name: buildbot.test.test_builder -*-
+
+from twisted.trial import unittest
+
+from buildbot.process.base import BuildRequest
+from buildbot.process.builder import Builder
+from buildbot.status.builder import BuilderStatus
+from buildbot.sourcestamp import SourceStamp
+
+from buildbot.interfaces import IBuilderControl
+
+def makeABuilderWithNRequests(how_many_requests):
+    b = QueueTest_MockBuilder(
+        setup = {
+            'name': "Builder 1",
+            'builddir': "/tmp",
+            'factory': "NoSuchFactory"
+            },
+        how_many_requests = how_many_requests
+        )
+
+    builder_control = IBuilderControl(b)
+    return (builder_control, b)
+
+class QueueTest_MockBuilder(Builder):
+    def __init__(self, setup, how_many_requests):
+        Builder.__init__(self, setup, BuilderStatus(self))
+
+        for i in range(how_many_requests):
+            self.submitBuildRequest(BuildRequest("a reason", SourceStamp()))
+
+    def maybeStartBuild(self):
+        pass
+
+class Queue(unittest.TestCase):
+    def failUnlessPendingBuildsHaveNumbers(self, expected_numbers, builder):
+        pending_builds = builder.buildable
+        request_numbers = map( lambda req : req.status.getNumber(), pending_builds )
+        self.failUnlessEqual(request_numbers, expected_numbers)
+
+    def testRemoveOnEmptyQueue(self):
+        (builder_control, builder) = makeABuilderWithNRequests(0)
+        self.failUnlessPendingBuildsHaveNumbers([], builder)
+        builder_control.cancelBuildRequest(2)
+        self.failUnlessPendingBuildsHaveNumbers([], builder)
+
+    def testRemoveOnlyQueueEntry(self):
+        (builder_control, builder) = makeABuilderWithNRequests(1)
+        self.failUnlessPendingBuildsHaveNumbers([0], builder)
+        builder_control.cancelBuildRequest(0)
+        self.failUnlessPendingBuildsHaveNumbers([], builder)
+
+    def testRemoveFirstQueueEntry(self):
+        (builder_control, builder) = makeABuilderWithNRequests(3)
+        self.failUnlessPendingBuildsHaveNumbers([0,1,2], builder)
+        builder_control.cancelBuildRequest(0)
+        self.failUnlessPendingBuildsHaveNumbers([1,2], builder)
+
+    def testRemoveQueueEntryFromMiddle(self):
+        (builder_control, builder) = makeABuilderWithNRequests(5)
+        self.failUnlessPendingBuildsHaveNumbers([0,1,2,3,4], builder)
+        builder_control.cancelBuildRequest(1)
+        self.failUnlessPendingBuildsHaveNumbers([0,2,3,4], builder)
+
+    def testRemoveLastQueueEntry(self):
+        (builder_control, builder) = makeABuilderWithNRequests(3)
+        self.failUnlessPendingBuildsHaveNumbers([0,1,2], builder)
+        builder_control.cancelBuildRequest(2)
+        self.failUnlessPendingBuildsHaveNumbers([0,1], builder)
+
+    def testRemoveUnknownQueueEntry(self):
+        (builder_control, builder) = makeABuilderWithNRequests(3)
+        self.failUnlessPendingBuildsHaveNumbers([0,1,2], builder)
+        builder_control.cancelBuildRequest(5)
+        self.failUnlessPendingBuildsHaveNumbers([0,1,2], builder)
+
+    def testRemoveSeveralInTurn(self):
+        (builder_control, builder) = makeABuilderWithNRequests(5)
+        self.failUnlessPendingBuildsHaveNumbers([0,1,2,3,4], builder)
+        builder_control.cancelBuildRequest(1)
+        self.failUnlessPendingBuildsHaveNumbers([0,2,3,4], builder)
+        builder_control.cancelBuildRequest(3)
+        self.failUnlessPendingBuildsHaveNumbers([0,2,4], builder)
+        builder_control.cancelBuildRequest(0)
+        self.failUnlessPendingBuildsHaveNumbers([2,4], builder)

a/docs/buildbot.texinfo

@@ -6789 +6789 @@
-
-@item /builders/$BUILDERNAME
-
-
+
+
-
-@item /builders/$BUILDERNAME/builds/$BUILDNUM
-