Merge lp:~jml/launchpad/remove-builder-status into lp:launchpad

[Jonathan Lange]

Remove IBuilder.status and IBuildFarmJobBehaviour.status, neither of which are actually used.

[Jonathan Lange (jml)]

It looks like Builder.status and BuildJobBehaviour.status aren't used. This branch deletes them.

[Michael Nelson (michael.nelson)]

Thanks again Jonathan. Please check the text in the documentation at the points where you've removed the status examples, I think you'll find they need to be updated, but other than that, r=me.

review: Approve (code)

=== modified file 'lib/lp/buildmaster/doc/builder.txt'
--- lib/lp/buildmaster/doc/builder.txt	2010-01-13 04:41:19 +0000
+++ lib/lp/buildmaster/doc/builder.txt	2010-01-13 20:22:13 +0000
@@ -23,20 +23,6 @@
     >>> print builder.name
     bob
 
-Test 'status' property:
-
-    >>> print builder.status
-    Building i386 build of mozilla-firefox 0.9 in ubuntu hoary RELEASE
-
-    >>> builder.manual = True
-    >>> print builder.status
-    Building i386 build of mozilla-firefox 0.9 in ubuntu hoary RELEASE
-
-    >>> builder.builderok = False
-    >>> builder.failnotes = 'Could not open Socket'
-    >>> print builder.status
-    Could not open Socket
-
     >>> builder.builderok = True
     >>> builder.failnotes = None
 
@@ -52,55 +38,6 @@
     ...     builder.current_build_behavior, BinaryPackageBuildBehavior)
     True
 
-In case of copy archives the status string will show both the copy
-archive owner as well as the copy archive name.
-
-    >>> from lp.soyuz.interfaces.archive import ArchivePurpose
-    >>> from zope.security.proxy import removeSecurityProxy
-    >>> from lp.soyuz.interfaces.build import IBuildSet
-    >>> build = getUtility(IBuildSet).getByQueueEntry(builder.currentjob)
-    >>> builder_archive = removeSecurityProxy(
-    ...     build.archive)
-    >>> saved_purpose = builder_archive.purpose
-    >>> builder_archive.purpose = ArchivePurpose.COPY
-
-The archive owner and name are shown at the end of the status string.
-
-    >>> print builder.status
-    Building ... mozilla-firefox 0.9 in ubuntu ... [ubuntu-team/primary]
-
-Similarly, the status for a build in a PPA will show the owner and the
-archive name:
-
-    >>> builder_archive.purpose = ArchivePurpose.PPA
-    >>> print builder.status
-    Building ... mozilla-firefox 0.9 in ubuntu ... [ubuntu-team/primary]
-
-The name of a PRIVATE team cannot be displayed publicly, so it is we
-simply don't bother in adding the PPA information in the content
-class domain.
-
-    # Create a new PRIVATE team and reassign the building PPA to it.
-    >>> from lp.registry.interfaces.person import (
-    ...     IPersonSet, PersonVisibility)
-    >>> login('[e-mail]')
-    >>> salgado = getUtility(IPersonSet).getByName('salgado')
-    >>> private_team = factory.makeTeam(
-    ...     salgado, name='private-team',
-    ...     displayname='Private Team',
-    ...     visibility=PersonVisibility.PRIVATE)
-    >>> saved_owner = builder_archive.owner
-    >>> builder_archive.owner = private_team
-    >>> login(ANONYMOUS)
-
-    >>> print builder.status
-    Building i386 build of mozilla-firefox 0.9 in ubuntu hoary RELEASE
-
-Restore the original archive purpose and owner.
-
-    >>> builder_archive.purpose = saved_purpose
-    >>> builder_archive.owner = saved_owner
-
 Confirm we can get the slave xmlrpc interface
 
     >>> s = builder.slave

=== modified file 'lib/lp/buildmaster/doc/buildfarmjobbehavior.txt'
--- lib/lp/buildmaster/doc/buildfarmjobbehavior.txt	2010-01-13 04:41:19 +0000
+++ lib/lp/buildmaster/doc/buildfarmjobbehavior.txt	2010-01-13 20:22:13 +0000
@@ -33,10 +33,6 @@
     ...
     ...     def dispatchBuildToSlave(self, build_queue_item_id, logger):
     ...         print "Did something special to dispatch MySpecialBuild."
-    ...
-    ...     @property
-    ...     def status(self):
-    ...         return "Currently building a MyNewBuild object."
 
 For this documentation, we'll also need a dummy new build farm job.
 
@@ -65,16 +61,14 @@
 
 This will then allow the builder to request and set the required behavior from
 the current job. Bob the builder currently has a binary package job and so
-finds itself with a binary package build behavior which defines the status
-attribute with some binary-build specific information.
+finds itself with a binary package build behavior which defines binary-build
+specific information.
 
     >>> from lp.buildmaster.model.builder import Builder
     >>> from canonical.launchpad.webapp.interfaces import (
     ...     IStoreSelector, MAIN_STORE, DEFAULT_FLAVOR)
     >>> store = getUtility(IStoreSelector).get(MAIN_STORE, DEFAULT_FLAVOR)
     >>> bob = store.find(Builder, Builder.name == 'bob').one()
-    >>> print bob.status
-    Building i386 build of mozilla-firefox 0.9 in ubuntu hoary RELEASE
 
 XXX Michael Nelson 2009-12-04 bug 484819. At the time of writing the
 BuildQueue.specific_job method has not been updated to support different
@@ -85,19 +79,7 @@
 
 Once the builder has the relevant behavior, it is able to provide both general
 builder functionality of its own accord, while delegating any build-type
-specific functionality to the behavior. For example, if the builder is not
-disabled, the builder delegates the status property to the behavior.
-
-    >>> print bob.status
-    Currently building a MyNewBuild object.
-
-On the other hand, if the builder is disabled, the builder itself determines
-the status.
-
-    >>> bob.builderok = False
-    >>> print bob.status
-    Disabled
-    >>> bob.builderok = True
+specific functionality to the behavior.
 
 The IBuildFarmJobBehavior interface currently provides customisation points
 throughout the build life-cycle, from logging the start of a build, verifying
@@ -120,9 +102,6 @@
     >>> bob.current_build_behavior = None
     >>> bob.currentjob.destroySelf()
 
-    >>> print bob.status
-    Idle
-
 Attempting to use any other build-related functionality when a builder is
 idle, such as making a call to log the start of a build, will raise an
 appropriate exception.

=== modified file 'lib/lp/buildmaster/interfaces/builder.py'
--- lib/lp/buildmaster/interfaces/builder.py	2010-01-13 04:41:19 +0000
+++ lib/lp/buildmaster/interfaces/builder.py	2010-01-13 20:22:13 +0000
@@ -143,8 +143,6 @@
 
     currentjob = Attribute("BuildQueue instance for job being processed.")
 
-    status = Attribute("Generated status information")
-
     is_available = Bool(
         title=_("Whether or not a builder is available for building "
                 "new jobs. "),

=== modified file 'lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py'
--- lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py	2010-01-11 21:59:08 +0000
+++ lib/lp/buildmaster/interfaces/buildfarmjobbehavior.py	2010-01-13 20:22:13 +0000
@@ -12,7 +12,7 @@
     'IBuildFarmJobBehavior',
     ]
 
-from zope.interface import Attribute, Interface
+from zope.interface import Interface
 
 
 class BuildBehaviorMismatch(Exception):
@@ -24,9 +24,6 @@
 
 class IBuildFarmJobBehavior(Interface):
 
-    status = Attribute(
-        "Generated status information for this particular job.")
-
     def setBuilder(builder):
         """Sets the associated builder reference for this instance."""
 

=== modified file 'lib/lp/buildmaster/model/builder.py'
--- lib/lp/buildmaster/model/builder.py	2010-01-13 05:07:42 +0000
+++ lib/lp/buildmaster/model/builder.py	2010-01-13 20:22:13 +0000
@@ -331,24 +331,6 @@
             self.handleTimeout(logger, error_message)
             raise BuildSlaveFailure
 
-
-    # XXX cprov 2009-06-24: This code does not belong to the content
-    # class domain. Here we cannot make sensible decisions about what
-    # we are allowed to present according to the request user. Then
-    # bad things happens, see bug #391721.
-
-    @property
-    def status(self):
-        """See IBuilder"""
-        if not self.builderok:
-            if self.failnotes is not None:
-                return self.failnotes
-            return 'Disabled'
-
-        # If the builder is OK then we delegate the status
-        # to our current behavior.
-        return self.current_build_behavior.status
-
     def failbuilder(self, reason):
         """See IBuilder"""
         self.builderok = False

=== modified file 'lib/lp/soyuz/browser/tests/builder-views.txt'
--- lib/lp/soyuz/browser/tests/builder-views.txt	2009-12-14 21:13:49 +0000
+++ lib/lp/soyuz/browser/tests/builder-views.txt	2010-01-13 20:22:13 +0000
@@ -171,7 +171,6 @@
  * Frog is OK;
  * Frog 'currentjob' exists;
  * Frog has no 'failnotes';
- * Frog status exposes its 'currentjob'.
 
     >>> print frog.builderok
     True
@@ -184,10 +183,6 @@
     >>> print frog.failnotes
     None
 
-    >>> print frog.status
-    Building i386 build of privacy-test 666 in ubuntutest breezy-autotest
-        RELEASE [cprov/ppa]
-
 Accessing the view for $builder/+index as a Foo Bar, which has
 launchpad.View permission on the target archive of the 'currentjob',
 all the 'private' information is exposed.
@@ -209,10 +204,6 @@
     >>> print admin_view.context.failnotes
     None
 
-    >>> print admin_view.context.status
-    Building i386 build of privacy-test 666 in ubuntutest breezy-autotest
-        RELEASE [cprov/ppa]
-
     >>> import datetime
     >>> import pytz
     >>> private_job.setDateStarted(
@@ -233,9 +224,6 @@
     >>> login('[e-mail]')
     >>> nopriv_view = getMultiAdapter((frog, empty_request), name="+index")
 
-    >>> print nopriv_view.context.status
-    Idle
-
     >>> login(ANONYMOUS)
 
 

=== modified file 'lib/lp/soyuz/model/binarypackagebuildbehavior.py'
--- lib/lp/soyuz/model/binarypackagebuildbehavior.py	2010-01-13 04:41:19 +0000
+++ lib/lp/soyuz/model/binarypackagebuildbehavior.py	2010-01-13 20:22:13 +0000
@@ -41,16 +41,6 @@
         logger.info("startBuild(%s, %s, %s, %s)", self._builder.url,
                     spr.name, spr.version, self.build.pocket.title)
 
-    @property
-    def status(self):
-        """See `IBuildFarmJobBehavior`."""
-        msg = 'Building %s' % self.build.title
-        archive = self.build.archive
-        if not archive.owner.private and (archive.is_ppa or archive.is_copy):
-            return '%s [%s/%s]' % (msg, archive.owner.name, archive.name)
-        else:
-            return msg
-
     def dispatchBuildToSlave(self, build_queue_id, logger):
         """See `IBuildFarmJobBehavior`."""