Merge lp:~rockstar/launchpad/use-suspended-job-status into lp:launchpad

[Paul Hummer]

[Paul Hummer (rockstar)]

Hi Jeroen-

  This branch just adds an IArchive.enable and IArchive.disable method to the
IArchive to appropriately tests it.

Paul

[Jeroen T. Vermeulen (jtv)]

Went over this in IRL.

Some small superficial points—mainly indentation of query text, and XXXes to factor duplicated setup out into helpers.

Also, instead of a test method "assert that there are no builds with status X" it's probably more helpful to have one that returns whether there are any builds with status X, and use that for assertions directly in your tests. Two advantages:

 * A failure shows up at the bottom of its stack trace, not in a generic method where you have to browse further up the trace to get to the semantic failure.

 * You can show before/after comparisons very effectively. That can help separate bad test setup (which also sometimes tells you what you want to hear) from the change you're really testing for.

With those notes, r=me.

Jeroen

review: Approve (code)

=== modified file 'lib/lp/soyuz/configure.zcml'
--- lib/lp/soyuz/configure.zcml	2010-01-07 05:32:58 +0000
+++ lib/lp/soyuz/configure.zcml	2010-01-12 04:24:18 +0000
@@ -401,7 +401,7 @@
         <require
             permission="launchpad.Edit"
             interface="lp.soyuz.interfaces.archive.IArchiveEdit"
-            set_attributes="description displayname enabled"/>
+            set_attributes="description displayname"/>
         <require
             permission="launchpad.Commercial"
             set_attributes="authorized_size buildd_secret

=== modified file 'lib/lp/soyuz/interfaces/archive.py'
--- lib/lp/soyuz/interfaces/archive.py	2009-12-08 15:40:23 +0000
+++ lib/lp/soyuz/interfaces/archive.py	2010-01-12 04:24:18 +0000
@@ -1084,6 +1084,12 @@
         :param component: An `IComponent` or textual component name.
         """
 
+    def enable():
+        """Enable the archive."""
+
+    def disable():
+        """Disable the archive."""
+
 
 class IArchive(IArchivePublic, IArchiveAppend, IArchiveEdit, IArchiveView):
     """Main Archive interface."""

=== modified file 'lib/lp/soyuz/model/archive.py'
--- lib/lp/soyuz/model/archive.py	2009-12-24 08:15:46 +0000
+++ lib/lp/soyuz/model/archive.py	2010-01-12 04:24:18 +0000
@@ -31,6 +31,7 @@
 from canonical.database.enumcol import EnumCol
 from canonical.database.sqlbase import (
     cursor, quote, quote_like, sqlvalues, SQLBase)
+from lp.services.job.interfaces.job import JobStatus
 from lp.soyuz.adapters.packagelocation import PackageLocation
 from canonical.launchpad.components.tokens import (
     create_unique_token_for_table)
@@ -130,7 +131,8 @@
     purpose = EnumCol(
         dbName='purpose', unique=False, notNull=True, schema=ArchivePurpose)
 
-    enabled = BoolCol(dbName='enabled', notNull=True, default=True)
+    _enabled = BoolCol(dbName='enabled', notNull=True, default=True)
+    enabled = property(lambda x: x._enabled)
 
     publish = BoolCol(dbName='publish', notNull=True, default=True)
 
@@ -1238,6 +1240,38 @@
         result_set.config(distinct=True).order_by(SourcePackageRelease.id)
         return result_set
 
+    def _setBuildStatuses(self, status):
+        """Update the pending Build Jobs' status for this archive."""
+
+        query = """
+            UPDATE Job SET status = %s
+            FROM Build, BuildPackageJob, BuildQueue
+            WHERE
+                -- insert self.id here
+                Build.archive = %s
+                AND BuildPackageJob.build = Build.id
+                AND BuildPackageJob.job = BuildQueue.job
+                AND Job.id = BuildQueue.job
+                -- Build is in state BuildStatus.NEEDSBUILD (0)
+                AND Build.buildstate = %s;
+        """ % sqlvalues(status, self, BuildStatus.NEEDSBUILD)
+
+        store = Store.of(self)
+        store.execute(query)
+
+    def enable(self):
+        """See `IArchive`."""
+        assert self._enabled == False, "This archive is already enabled."
+        self._enabled = True
+        self._setBuildStatuses(JobStatus.WAITING)
+
+    def disable(self):
+        """See `IArchive`."""
+        assert self._enabled == True, "This archive is already disabled."
+        self._enabled = False
+        self._setBuildStatuses(JobStatus.SUSPENDED)
+
+
 class ArchiveSet:
     implements(IArchiveSet)
     title = "Archives registered in Launchpad"

=== modified file 'lib/lp/soyuz/tests/test_archive.py'
--- lib/lp/soyuz/tests/test_archive.py	2009-11-06 21:06:38 +0000
+++ lib/lp/soyuz/tests/test_archive.py	2010-01-12 04:24:18 +0000
@@ -3,24 +3,30 @@
 
 """Test Archive features."""
 
-from datetime import datetime
+from datetime import datetime, timedelta
 import pytz
 import unittest
 
 from zope.component import getUtility
 from zope.security.proxy import removeSecurityProxy
 
+from canonical.database.sqlbase import sqlvalues
+from canonical.launchpad.webapp.interfaces import (
+    IStoreSelector, MAIN_STORE, DEFAULT_FLAVOR)
 from canonical.testing import LaunchpadZopelessLayer
 
 from lp.registry.interfaces.distribution import IDistributionSet
 from lp.registry.interfaces.person import IPersonSet
+from lp.services.job.interfaces.job import JobStatus
 from lp.soyuz.interfaces.archive import IArchiveSet, ArchivePurpose
 from lp.soyuz.interfaces.binarypackagerelease import BinaryPackageFormat
 from lp.soyuz.interfaces.build import BuildStatus
 from lp.soyuz.interfaces.publishing import PackagePublishingStatus
+from lp.soyuz.model.build import Build
 from lp.soyuz.tests.test_publishing import SoyuzTestPublisher
 from lp.testing import TestCaseWithFactory
 
+
 class TestGetPublicationsInArchive(TestCaseWithFactory):
 
     layer = LaunchpadZopelessLayer
@@ -382,5 +388,131 @@
         self.assertIs(
             self.primary_archive.debug_archive, None)
 
+
+class TestArchiveEnableDisable(TestCaseWithFactory):
+    """Test the enable and disable methods of Archive."""
+
+    layer = LaunchpadZopelessLayer
+
+    def setUp(self):
+        #XXX: rockstar - 12 Jan 2010 - Bug #506255 - Tidy up these tests!
+        super(TestArchiveEnableDisable, self).setUp()
+
+        self.publisher = SoyuzTestPublisher()
+        self.publisher.prepareBreezyAutotest()
+
+        self.ubuntutest = getUtility(IDistributionSet)['ubuntutest']
+        self.archive = getUtility(IArchiveSet).getByDistroPurpose(
+            self.ubuntutest, ArchivePurpose.PRIMARY)
+
+        store = getUtility(IStoreSelector).get(MAIN_STORE, DEFAULT_FLAVOR)
+        sample_data = store.find(Build)
+        for build in sample_data:
+            build.buildstate = BuildStatus.FULLYBUILT
+        store.flush()
+
+        # We test builds that target a primary archive.
+        self.builds = []
+        self.builds.extend(
+            self.publisher.getPubSource(
+                sourcename="gedit", status=PackagePublishingStatus.PUBLISHED,
+                archive=self.archive).createMissingBuilds())
+        self.builds.extend(
+            self.publisher.getPubSource(
+                sourcename="firefox",
+                status=PackagePublishingStatus.PUBLISHED,
+                archive=self.archive).createMissingBuilds())
+        self.builds.extend(
+            self.publisher.getPubSource(
+                sourcename="apg", status=PackagePublishingStatus.PUBLISHED,
+                archive=self.archive).createMissingBuilds())
+        self.builds.extend(
+            self.publisher.getPubSource(
+                sourcename="vim", status=PackagePublishingStatus.PUBLISHED,
+                archive=self.archive).createMissingBuilds())
+        self.builds.extend(
+            self.publisher.getPubSource(
+                sourcename="gcc", status=PackagePublishingStatus.PUBLISHED,
+                archive=self.archive).createMissingBuilds())
+        self.builds.extend(
+            self.publisher.getPubSource(
+                sourcename="bison", status=PackagePublishingStatus.PUBLISHED,
+                archive=self.archive).createMissingBuilds())
+        self.builds.extend(
+            self.publisher.getPubSource(
+                sourcename="flex", status=PackagePublishingStatus.PUBLISHED,
+                archive=self.archive).createMissingBuilds())
+        self.builds.extend(
+            self.publisher.getPubSource(
+                sourcename="postgres",
+                status=PackagePublishingStatus.PUBLISHED,
+                archive=self.archive).createMissingBuilds())
+        # Set up the builds for test.
+        score = 1000
+        duration = 0
+        for build in self.builds:
+            score += 1
+            duration += 60
+            bq = build.buildqueue_record
+            bq.lastscore = score
+            bq.estimated_duration = timedelta(seconds=duration)
+
+    def _getBuildJobsByStatus(self, archive, status):
+        # Return the count for archive build jobs with the given status.
+        query = """
+            SELECT COUNT(Job.id)
+            FROM Build, BuildPackageJob, BuildQueue, Job
+            WHERE
+                Build.archive = %s
+                AND BuildPackageJob.build = Build.id
+                AND BuildPackageJob.job = BuildQueue.job
+                AND Job.id = BuildQueue.job
+                AND Build.buildstate = %s
+                AND Job.status = %s;
+        """ % sqlvalues(archive, BuildStatus.NEEDSBUILD, status)
+
+        store = getUtility(IStoreSelector).get(MAIN_STORE, DEFAULT_FLAVOR)
+        return store.execute(query).get_one()[0]
+
+    def assertNoBuildJobsHaveStatus(self, archive, status):
+        # Check that that the jobs attached to this archive do not have this
+        # status.
+        self.assertEqual(self._getBuildJobsByStatus(archive, status), 0)
+
+    def assertHasBuildJobsWithStatus(self, archive, status):
+        # Check that that there are jobs attached to this archive that have
+        # the specified status.
+        self.assertEqual(self._getBuildJobsByStatus(archive, status), 8)
+
+    def test_enableArchive(self):
+        # Enabling an archive should set all the Archive's suspended builds to
+        # WAITING.
+
+        # Disable the archive, because it's currently enabled.
+        self.archive.disable()
+        self.assertHasBuildJobsWithStatus(self.archive, JobStatus.SUSPENDED)
+        self.archive.enable()
+        self.assertNoBuildJobsHaveStatus(self.archive, JobStatus.SUSPENDED)
+        self.assertTrue(self.archive.enabled)
+
+    def test_enableArchiveAlreadyEnabled(self):
+        # Enabling an already enabled Archive should raise an AssertionError.
+        self.assertRaises(AssertionError, self.archive.enable)
+
+    def test_disableArchive(self):
+        # Disabling an archive should set all the Archive's pending bulds to
+        # SUSPENDED.
+        self.assertHasBuildJobsWithStatus(self.archive, JobStatus.WAITING)
+        self.archive.disable()
+        self.assertNoBuildJobsHaveStatus(self.archive, JobStatus.WAITING)
+        self.assertFalse(self.archive.enabled)
+
+    def test_disableArchiveAlreadyDisabled(self):
+        # Disabling an already disabled Archive should raise an
+        # AssertionError.
+        self.archive.disable()
+        self.assertRaises(AssertionError, self.archive.disable)
+
+
 def test_suite():
     return unittest.TestLoader().loadTestsFromName(__name__)