Merge lp:~cjwatson/launchpad/snap-source-deletion into lp:launchpad

[Colin Watson]

Detach snap packages from their source branch/repository when it is deleted.

Detach snap packages from their source branch/repository when it is deleted.

This will make it feasible to add the tests requested in a review comment on https://code.launchpad.net/~cjwatson/launchpad/snap-build-behaviour/+merge/266736.

[William Grant (wgrant)]

review: Approve (code)

=== modified file 'lib/lp/code/model/branch.py'
--- lib/lp/code/model/branch.py	2015-07-08 16:05:11 +0000
+++ lib/lp/code/model/branch.py	2015-08-05 10:53:23 +0000
@@ -179,6 +179,7 @@
 from lp.services.propertycache import cachedproperty
 from lp.services.webapp import urlappend
 from lp.services.webapp.authorization import check_permission
+from lp.snappy.interfaces.snap import ISnapSet
 
 
 @implementer(IBranch, IPrivacy, IInformationType)
@@ -814,6 +815,10 @@
         deletion_operations.extend(
             DeletionCallable.forSourcePackageRecipe(recipe)
             for recipe in self.recipes)
+        if not getUtility(ISnapSet).findByBranch(self).is_empty():
+            alteration_operations.append(DeletionCallable(
+                None, _('Some snap packages build from this branch.'),
+                getUtility(ISnapSet).detachFromBranch, self))
         return (alteration_operations, deletion_operations)
 
     def deletionRequirements(self):
@@ -1436,12 +1441,14 @@
 class DeletionCallable(DeletionOperation):
     """Deletion operation that invokes a callable."""
 
-    def __init__(self, affected_object, rationale, func):
+    def __init__(self, affected_object, rationale, func, *args, **kwargs):
         DeletionOperation.__init__(self, affected_object, rationale)
         self.func = func
+        self.args = args
+        self.kwargs = kwargs
 
     def __call__(self):
-        self.func()
+        self.func(*self.args, **self.kwargs)
 
     @classmethod
     def forSourcePackageRecipe(cls, recipe):

=== modified file 'lib/lp/code/model/gitrepository.py'
--- lib/lp/code/model/gitrepository.py	2015-07-17 07:34:21 +0000
+++ lib/lp/code/model/gitrepository.py	2015-08-05 10:53:23 +0000
@@ -148,6 +148,7 @@
 from lp.services.webapp.authorization import available_with_permission
 from lp.services.webhooks.interfaces import IWebhookSource
 from lp.services.webhooks.model import WebhookTargetMixin
+from lp.snappy.interfaces.snap import ISnapSet
 
 
 object_type_map = {
@@ -1002,6 +1003,10 @@
             prerequisite_git_repository=self):
             alteration_operations.append(
                 ClearPrerequisiteRepository(merge_proposal))
+        if not getUtility(ISnapSet).findByGitRepository(self).is_empty():
+            alteration_operations.append(DeletionCallable(
+                None, msg("Some snap packages build from this repository."),
+                getUtility(ISnapSet).detachFromGitRepository, self))
 
         return (alteration_operations, deletion_operations)
 
@@ -1103,12 +1108,14 @@
 class DeletionCallable(DeletionOperation):
     """Deletion operation that invokes a callable."""
 
-    def __init__(self, affected_object, rationale, func):
+    def __init__(self, affected_object, rationale, func, *args, **kwargs):
         super(DeletionCallable, self).__init__(affected_object, rationale)
         self.func = func
+        self.args = args
+        self.kwargs = kwargs
 
     def __call__(self):
-        self.func()
+        self.func(*self.args, **self.kwargs)
 
 
 class ClearPrerequisiteRepository(DeletionOperation):

=== modified file 'lib/lp/code/model/tests/test_branch.py'
--- lib/lp/code/model/tests/test_branch.py	2015-07-24 09:16:50 +0000
+++ lib/lp/code/model/tests/test_branch.py	2015-08-05 10:53:23 +0000
@@ -1,4 +1,4 @@
-# Copyright 2009-2013 Canonical Ltd.  This software is licensed under the
+# Copyright 2009-2015 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Tests for Branches."""
@@ -72,7 +72,6 @@
 from lp.code.interfaces.branchjob import (
     IBranchScanJobSource,
     IBranchUpgradeJobSource,
-    IReclaimBranchSpaceJobSource,
     )
 from lp.code.interfaces.branchlookup import IBranchLookup
 from lp.code.interfaces.branchmergeproposal import (
@@ -143,6 +142,7 @@
     IOpenLaunchBag,
     OAuthPermission,
     )
+from lp.snappy.interfaces.snap import SNAP_FEATURE_FLAG
 from lp.testing import (
     admin_logged_in,
     ANONYMOUS,
@@ -1672,6 +1672,25 @@
                                         self.factory.makePerson())
         merge_proposal.target_branch.destroySelf(break_references=True)
 
+    def test_snap_requirements(self):
+        # If a branch is used by a snap package, the deletion requirements
+        # indicate this.
+        self.useFixture(FeatureFixture({SNAP_FEATURE_FLAG: u"on"}))
+        self.factory.makeSnap(branch=self.branch)
+        self.assertEqual(
+            {None: ('alter', _('Some snap packages build from this branch.'))},
+            self.branch.deletionRequirements())
+
+    def test_snap_deletion(self):
+        # break_references allows deleting a branch used by a snap package.
+        self.useFixture(FeatureFixture({SNAP_FEATURE_FLAG: u"on"}))
+        snap1 = self.factory.makeSnap(branch=self.branch)
+        snap2 = self.factory.makeSnap(branch=self.branch)
+        self.branch.destroySelf(break_references=True)
+        transaction.commit()
+        self.assertIsNone(snap1.branch)
+        self.assertIsNone(snap2.branch)
+
     def test_ClearDependentBranch(self):
         """ClearDependent.__call__ must clear the prerequisite branch."""
         merge_proposal = removeSecurityProxy(self.makeMergeProposals()[0])

=== modified file 'lib/lp/code/model/tests/test_gitrepository.py'
--- lib/lp/code/model/tests/test_gitrepository.py	2015-07-17 07:34:21 +0000
+++ lib/lp/code/model/tests/test_gitrepository.py	2015-08-05 10:53:23 +0000
@@ -104,12 +104,14 @@
 from lp.services.config import config
 from lp.services.database.constants import UTC_NOW
 from lp.services.database.interfaces import IStore
+from lp.services.features.testing import FeatureFixture
 from lp.services.job.interfaces.job import JobStatus
 from lp.services.job.model.job import Job
 from lp.services.job.runner import JobRunner
 from lp.services.mail import stub
 from lp.services.webapp.authorization import check_permission
 from lp.services.webapp.interfaces import OAuthPermission
+from lp.snappy.interfaces.snap import SNAP_FEATURE_FLAG
 from lp.testing import (
     admin_logged_in,
     ANONYMOUS,
@@ -620,6 +622,32 @@
             self.factory.makePerson(), self.factory.makePerson())
         merge_proposal.target_git_repository.destroySelf(break_references=True)
 
+    def test_snap_requirements(self):
+        # If a repository is used by a snap package, the deletion
+        # requirements indicate this.
+        self.useFixture(FeatureFixture({SNAP_FEATURE_FLAG: u"on"}))
+        [ref] = self.factory.makeGitRefs()
+        self.factory.makeSnap(git_ref=ref)
+        self.assertEqual(
+            {None:
+             ("alter", _("Some snap packages build from this repository."))},
+            ref.repository.getDeletionRequirements())
+
+    def test_snap_deletion(self):
+        # break_references allows deleting a repository used by a snap package.
+        self.useFixture(FeatureFixture({SNAP_FEATURE_FLAG: u"on"}))
+        repository = self.factory.makeGitRepository()
+        [ref1, ref2] = self.factory.makeGitRefs(
+            repository=repository, paths=[u"refs/heads/1", u"refs/heads/2"])
+        snap1 = self.factory.makeSnap(git_ref=ref1)
+        snap2 = self.factory.makeSnap(git_ref=ref2)
+        repository.destroySelf(break_references=True)
+        transaction.commit()
+        self.assertIsNone(snap1.git_repository)
+        self.assertIsNone(snap1.git_path)
+        self.assertIsNone(snap2.git_repository)
+        self.assertIsNone(snap2.git_path)
+
     def test_ClearPrerequisiteRepository(self):
         # ClearPrerequisiteRepository.__call__ must clear the prerequisite
         # repository.

=== modified file 'lib/lp/snappy/interfaces/snap.py'
--- lib/lp/snappy/interfaces/snap.py	2015-08-03 13:16:48 +0000
+++ lib/lp/snappy/interfaces/snap.py	2015-08-05 10:53:23 +0000
@@ -347,6 +347,26 @@
     def findByPerson(owner):
         """Return all snap packages with the given `owner`."""
 
+    def findByBranch(branch):
+        """Return all snap packages for the given Bazaar branch."""
+
+    def findByGitRepository(repository):
+        """Return all snap packages for the given Git repository."""
+
+    def detachFromBranch(branch):
+        """Detach all snap packages from the given Bazaar branch.
+
+        After this, any snap packages that previously used this branch will
+        have no source and so cannot dispatch new builds.
+        """
+
+    def detachFromGitRepository(repository):
+        """Detach all snap packages from the given Git repository.
+
+        After this, any snap packages that previously used this repository
+        will have no source and so cannot dispatch new builds.
+        """
+
     @collection_default_content()
     def empty_list():
         """Return an empty collection of snap packages.

=== modified file 'lib/lp/snappy/model/snap.py'
--- lib/lp/snappy/model/snap.py	2015-08-03 13:16:48 +0000
+++ lib/lp/snappy/model/snap.py	2015-08-05 10:53:23 +0000
@@ -334,6 +334,24 @@
         """See `ISnapSet`."""
         return IStore(Snap).find(Snap, Snap.owner == owner)
 
+    def findByBranch(self, branch):
+        """See `ISnapSet`."""
+        return IStore(Snap).find(Snap, Snap.branch == branch)
+
+    def findByGitRepository(self, repository):
+        """See `ISnapSet`."""
+        return IStore(Snap).find(Snap, Snap.git_repository == repository)
+
+    def detachFromBranch(self, branch):
+        """See `ISnapSet`."""
+        self.findByBranch(branch).set(
+            branch_id=None, date_last_modified=UTC_NOW)
+
+    def detachFromGitRepository(self, repository):
+        """See `ISnapSet`."""
+        self.findByGitRepository(repository).set(
+            git_repository_id=None, git_path=None, date_last_modified=UTC_NOW)
+
     def empty_list(self):
         """See `ISnapSet`."""
         return []

=== modified file 'lib/lp/snappy/tests/test_snap.py'
--- lib/lp/snappy/tests/test_snap.py	2015-08-03 13:16:48 +0000
+++ lib/lp/snappy/tests/test_snap.py	2015-08-05 10:53:23 +0000
@@ -5,13 +5,9 @@
 
 __metaclass__ = type
 
-from datetime import (
-    datetime,
-    timedelta,
-    )
+from datetime import timedelta
 
 from lazr.lifecycle.event import ObjectModifiedEvent
-import pytz
 from storm.locals import Store
 from testtools.matchers import Equals
 import transaction
@@ -28,7 +24,10 @@
 from lp.buildmaster.model.buildqueue import BuildQueue
 from lp.registry.interfaces.distribution import IDistributionSet
 from lp.registry.interfaces.pocket import PackagePublishingPocket
-from lp.services.database.constants import UTC_NOW
+from lp.services.database.constants import (
+    ONE_DAY_AGO,
+    UTC_NOW,
+    )
 from lp.services.features.testing import FeatureFixture
 from lp.services.webapp.interfaces import OAuthPermission
 from lp.snappy.interfaces.snap import (
@@ -98,15 +97,13 @@
 
     def test_initial_date_last_modified(self):
         # The initial value of date_last_modified is date_created.
-        snap = self.factory.makeSnap(
-            date_created=datetime(2014, 04, 25, 10, 38, 0, tzinfo=pytz.UTC))
+        snap = self.factory.makeSnap(date_created=ONE_DAY_AGO)
         self.assertEqual(snap.date_created, snap.date_last_modified)
 
     def test_modifiedevent_sets_date_last_modified(self):
         # When a Snap receives an object modified event, the last modified
         # date is set to UTC_NOW.
-        snap = self.factory.makeSnap(
-            date_created=datetime(2014, 04, 25, 10, 38, 0, tzinfo=pytz.UTC))
+        snap = self.factory.makeSnap(date_created=ONE_DAY_AGO)
         notify(ObjectModifiedEvent(
             removeSecurityProxy(snap), snap, [ISnap["name"]]))
         self.assertSqlAttributeEqualsDate(snap, "date_last_modified", UTC_NOW)
@@ -451,6 +448,74 @@
         self.assertContentEqual(
             snaps[2:], getUtility(ISnapSet).findByPerson(owners[1]))
 
+    def test_findByBranch(self):
+        # ISnapSet.findByBranch returns all Snaps with the given Bazaar branch.
+        branches = [self.factory.makeAnyBranch() for i in range(2)]
+        snaps = []
+        for branch in branches:
+            for i in range(2):
+                snaps.append(self.factory.makeSnap(branch=branch))
+        self.assertContentEqual(
+            snaps[:2], getUtility(ISnapSet).findByBranch(branches[0]))
+        self.assertContentEqual(
+            snaps[2:], getUtility(ISnapSet).findByBranch(branches[1]))
+
+    def test_findByGitRepository(self):
+        # ISnapSet.findByGitRepository returns all Snaps with the given Git
+        # repository.
+        repositories = [self.factory.makeGitRepository() for i in range(2)]
+        snaps = []
+        for repository in repositories:
+            for i in range(2):
+                [ref] = self.factory.makeGitRefs(repository=repository)
+                snaps.append(self.factory.makeSnap(git_ref=ref))
+        self.assertContentEqual(
+            snaps[:2],
+            getUtility(ISnapSet).findByGitRepository(repositories[0]))
+        self.assertContentEqual(
+            snaps[2:],
+            getUtility(ISnapSet).findByGitRepository(repositories[1]))
+
+    def test_detachFromBranch(self):
+        # ISnapSet.detachFromBranch clears the given Bazaar branch from all
+        # Snaps.
+        branches = [self.factory.makeAnyBranch() for i in range(2)]
+        snaps = []
+        for branch in branches:
+            for i in range(2):
+                snaps.append(self.factory.makeSnap(
+                    branch=branch, date_created=ONE_DAY_AGO))
+        getUtility(ISnapSet).detachFromBranch(branches[0])
+        self.assertEqual(
+            [None, None, branches[1], branches[1]],
+            [snap.branch for snap in snaps])
+        for snap in snaps[:2]:
+            self.assertSqlAttributeEqualsDate(
+                snap, "date_last_modified", UTC_NOW)
+
+    def test_detachFromGitRepository(self):
+        # ISnapSet.detachFromGitRepository clears the given Git repository
+        # from all Snaps.
+        repositories = [self.factory.makeGitRepository() for i in range(2)]
+        snaps = []
+        paths = []
+        for repository in repositories:
+            for i in range(2):
+                [ref] = self.factory.makeGitRefs(repository=repository)
+                paths.append(ref.path)
+                snaps.append(self.factory.makeSnap(
+                    git_ref=ref, date_created=ONE_DAY_AGO))
+        getUtility(ISnapSet).detachFromGitRepository(repositories[0])
+        self.assertEqual(
+            [None, None, repositories[1], repositories[1]],
+            [snap.git_repository for snap in snaps])
+        self.assertEqual(
+            [None, None, paths[2], paths[3]],
+            [snap.git_path for snap in snaps])
+        for snap in snaps[:2]:
+            self.assertSqlAttributeEqualsDate(
+                snap, "date_last_modified", UTC_NOW)
+
 
 class TestSnapProcessors(TestCaseWithFactory):