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

[Colin Watson]

Add an option to build source tarballs for snaps.

See https://code.launchpad.net/~cjwatson/launchpad-buildd/snap-source-tarball/+merge/343721 and https://code.launchpad.net/~cjwatson/launchpad/db-snap-source-tarball/+merge/343726.

Landing https://code.launchpad.net/~cjwatson/launchpad/snap-dispatch-store-name/+merge/343713 to improve the source tarball names in many cases would also be preferable, although not mandatory.

[William Grant (wgrant)]

review: Approve (code)

=== modified file 'lib/lp/snappy/browser/snap.py'
--- lib/lp/snappy/browser/snap.py	2018-04-04 13:28:28 +0000
+++ lib/lp/snappy/browser/snap.py	2018-04-21 10:15:59 +0000
@@ -320,6 +320,7 @@
         'private',
         'require_virtualized',
         'allow_internet',
+        'build_source_tarball',
         'auto_build',
         'store_upload',
         ])
@@ -374,6 +375,7 @@
         'owner',
         'name',
         'store_distro_series',
+        'build_source_tarball',
         'auto_build',
         'auto_build_archive',
         'auto_build_pocket',
@@ -511,6 +513,7 @@
             auto_build_archive=data['auto_build_archive'],
             auto_build_pocket=data['auto_build_pocket'],
             processors=data['processors'], private=private,
+            build_source_tarball=data['build_source_tarball'],
             store_upload=data['store_upload'],
             store_series=data['store_distro_series'].snappy_series,
             store_name=data['store_name'],
@@ -681,6 +684,7 @@
         'vcs',
         'branch',
         'git_ref',
+        'build_source_tarball',
         'auto_build',
         'auto_build_archive',
         'auto_build_pocket',

=== modified file 'lib/lp/snappy/browser/tests/test_snap.py'
--- lib/lp/snappy/browser/tests/test_snap.py	2018-04-04 14:14:30 +0000
+++ lib/lp/snappy/browser/tests/test_snap.py	2018-04-21 10:15:59 +0000
@@ -243,6 +243,9 @@
             "Source:\n%s\nEdit snap package" % source_display,
             MatchesTagText(content, "source"))
         self.assertThat(
+            "Build source tarball:\nNo\nEdit snap package",
+            MatchesTagText(content, "build_source_tarball"))
+        self.assertThat(
             "Build schedule:\n(?)\nBuilt on request\nEdit snap package\n",
             MatchesTagText(content, "auto_build"))
         self.assertThat(
@@ -277,6 +280,9 @@
             "Source:\n%s\nEdit snap package" % source_display,
             MatchesTagText(content, "source"))
         self.assertThat(
+            "Build source tarball:\nNo\nEdit snap package",
+            MatchesTagText(content, "build_source_tarball"))
+        self.assertThat(
             "Build schedule:\n(?)\nBuilt on request\nEdit snap package\n",
             MatchesTagText(content, "auto_build"))
         self.assertThat(
@@ -355,6 +361,20 @@
             extract_text(find_tag_by_id(browser.contents, "privacy"))
         )
 
+    def test_create_new_snap_build_source_tarball(self):
+        # We can create a new snap and ask for it to build a source tarball.
+        branch = self.factory.makeAnyBranch()
+        browser = self.getViewBrowser(
+            branch, view_name="+new-snap", user=self.person)
+        browser.getControl(name="field.name").value = "snap-name"
+        browser.getControl("Build source tarball").selected = True
+        browser.getControl("Create snap package").click()
+
+        content = find_main_content(browser.contents)
+        self.assertThat(
+            "Build source tarball:\nYes\nEdit snap package",
+            MatchesTagText(content, "build_source_tarball"))
+
     def test_create_new_snap_auto_build(self):
         # Creating a new snap and asking for it to be automatically built
         # sets all the appropriate fields.
@@ -686,6 +706,7 @@
         browser.getControl("Git repository").value = (
             new_git_ref.repository.identity)
         browser.getControl("Git branch").value = new_git_ref.path
+        browser.getControl("Build source tarball").selected = True
         browser.getControl(
             "Automatically build when branch changes").selected = True
         browser.getControl("PPA").click()
@@ -705,6 +726,9 @@
             "Source:\n%s\nEdit snap package" % new_git_ref.display_name,
             MatchesTagText(content, "source"))
         self.assertThat(
+            "Build source tarball:\nYes\nEdit snap package",
+            MatchesTagText(content, "build_source_tarball"))
+        self.assertThat(
             "Build schedule:\n(?)\nBuilt automatically\nEdit snap package\n",
             MatchesTagText(content, "auto_build"))
         self.assertThat(
@@ -1223,6 +1247,7 @@
             Owner: Test Person
             Distribution series: Ubuntu Shiny
             Source: lp://dev/~test-person/\\+junk/snap-branch
+            Build source tarball: No
             Build schedule: \(\?\)
             Built on request
             Source archive for automatic builds:
@@ -1250,6 +1275,7 @@
             Owner: Test Person
             Distribution series: Ubuntu Shiny
             Source: ~test-person/\\+git/snap-repository:master
+            Build source tarball: No
             Build schedule: \(\?\)
             Built on request
             Source archive for automatic builds:
@@ -1277,6 +1303,7 @@
             Owner: Test Person
             Distribution series: Ubuntu Shiny
             Source: https://git.example.org/foo master
+            Build source tarball: No
             Build schedule: \(\?\)
             Built on request
             Source archive for automatic builds:

=== modified file 'lib/lp/snappy/interfaces/snap.py'
--- lib/lp/snappy/interfaces/snap.py	2018-04-15 16:23:14 +0000
+++ lib/lp/snappy/interfaces/snap.py	2018-04-21 10:15:59 +0000
@@ -498,6 +498,13 @@
             "The Git branch containing a snap/snapcraft.yaml, snapcraft.yaml, "
             "or .snapcraft.yaml recipe at the top level.")))
 
+    build_source_tarball = exported(Bool(
+        title=_("Build source tarball"),
+        required=True, readonly=False,
+        description=_(
+            "Whether builds of this snap package should also build a tarball "
+            "containing all source code, including external dependencies.")))
+
     auto_build = exported(Bool(
         title=_("Automatically build when branch changes"),
         required=True, readonly=False,

=== modified file 'lib/lp/snappy/model/snap.py'
--- lib/lp/snappy/model/snap.py	2018-04-04 14:14:30 +0000
+++ lib/lp/snappy/model/snap.py	2018-04-21 10:15:59 +0000
@@ -200,6 +200,8 @@
 
     allow_internet = Bool(name='allow_internet', allow_none=False)
 
+    build_source_tarball = Bool(name='build_source_tarball', allow_none=False)
+
     store_upload = Bool(name='store_upload', allow_none=False)
 
     store_series_id = Int(name='store_series', allow_none=True)
@@ -216,8 +218,9 @@
                  auto_build_archive=None, auto_build_pocket=None,
                  auto_build_channels=None, require_virtualized=True,
                  date_created=DEFAULT, private=False, allow_internet=True,
-                 store_upload=False, store_series=None, store_name=None,
-                 store_secrets=None, store_channels=None):
+                 build_source_tarball=False, store_upload=False,
+                 store_series=None, store_name=None, store_secrets=None,
+                 store_channels=None):
         """Construct a `Snap`."""
         super(Snap, self).__init__()
         self.registrant = registrant
@@ -236,6 +239,7 @@
         self.date_last_modified = date_created
         self.private = private
         self.allow_internet = allow_internet
+        self.build_source_tarball = build_source_tarball
         self.store_upload = store_upload
         self.store_series = store_series
         self.store_name = store_name
@@ -672,8 +676,9 @@
             auto_build_archive=None, auto_build_pocket=None,
             auto_build_channels=None, require_virtualized=True,
             processors=None, date_created=DEFAULT, private=False,
-            allow_internet=True, store_upload=False, store_series=None,
-            store_name=None, store_secrets=None, store_channels=None):
+            allow_internet=True, build_source_tarball=False,
+            store_upload=False, store_series=None, store_name=None,
+            store_secrets=None, store_channels=None):
         """See `ISnapSet`."""
         if not registrant.inTeam(owner):
             if owner.is_team:
@@ -717,6 +722,7 @@
             auto_build_channels=auto_build_channels,
             require_virtualized=require_virtualized, date_created=date_created,
             private=private, allow_internet=allow_internet,
+            build_source_tarball=build_source_tarball,
             store_upload=store_upload, store_series=store_series,
             store_name=store_name, store_secrets=store_secrets,
             store_channels=store_channels)

=== modified file 'lib/lp/snappy/model/snapbuildbehaviour.py'
--- lib/lp/snappy/model/snapbuildbehaviour.py	2018-04-04 14:14:30 +0000
+++ lib/lp/snappy/model/snapbuildbehaviour.py	2018-04-21 10:15:59 +0000
@@ -132,6 +132,7 @@
             raise CannotBuild(
                 "Source branch/repository for ~%s/%s has been deleted." %
                 (build.snap.owner.name, build.snap.name))
+        args["build_source_tarball"] = build.snap.build_source_tarball
         defer.returnValue(args)
 
     @defer.inlineCallbacks

=== modified file 'lib/lp/snappy/templates/snap-edit.pt'
--- lib/lp/snappy/templates/snap-edit.pt	2017-03-27 19:28:36 +0000
+++ lib/lp/snappy/templates/snap-edit.pt	2018-04-21 10:15:59 +0000
@@ -60,6 +60,10 @@
           </td>
         </tr>
 
+        <tal:widget define="widget nocall:view/widgets/build_source_tarball">
+          <metal:block use-macro="context/@@launchpad_form/widget_row" />
+        </tal:widget>
+
         <tal:widget define="widget nocall:view/widgets/auto_build">
           <metal:block use-macro="context/@@launchpad_form/widget_row" />
         </tal:widget>

=== modified file 'lib/lp/snappy/templates/snap-index.pt'
--- lib/lp/snappy/templates/snap-index.pt	2017-01-04 20:52:12 +0000
+++ lib/lp/snappy/templates/snap-index.pt	2018-04-21 10:15:59 +0000
@@ -61,6 +61,15 @@
           <a tal:replace="structure view/menu:overview/edit/fmt:icon"/>
         </dd>
       </dl>
+      <dl id="build_source_tarball"
+          tal:define="build_source_tarball context/build_source_tarball">
+        <dt>Build source tarball:</dt>
+        <dd>
+          <span tal:condition="build_source_tarball">Yes</span>
+          <span tal:condition="not: build_source_tarball">No</span>
+          <a tal:replace="structure view/menu:overview/edit/fmt:icon"/>
+        </dd>
+      </dl>
 
       <dl id="auto_build">
         <dt>Build schedule:

=== modified file 'lib/lp/snappy/templates/snap-new.pt'
--- lib/lp/snappy/templates/snap-new.pt	2017-03-27 19:28:36 +0000
+++ lib/lp/snappy/templates/snap-new.pt	2018-04-21 10:15:59 +0000
@@ -35,6 +35,9 @@
         <tal:widget define="widget nocall:view/widgets/processors">
           <metal:block use-macro="context/@@launchpad_form/widget_row" />
         </tal:widget>
+        <tal:widget define="widget nocall:view/widgets/build_source_tarball">
+          <metal:block use-macro="context/@@launchpad_form/widget_row" />
+        </tal:widget>
 
         <tal:widget define="widget nocall:view/widgets/auto_build">
           <metal:block use-macro="context/@@launchpad_form/widget_row" />

=== modified file 'lib/lp/snappy/tests/test_snap.py'
--- lib/lp/snappy/tests/test_snap.py	2018-04-15 16:23:14 +0000
+++ lib/lp/snappy/tests/test_snap.py	2018-04-21 10:15:59 +0000
@@ -654,6 +654,7 @@
         self.assertTrue(snap.require_virtualized)
         self.assertFalse(snap.private)
         self.assertTrue(snap.allow_internet)
+        self.assertFalse(snap.build_source_tarball)
 
     def test_creation_git(self):
         # The metadata entries supplied when a Snap is created for a Git
@@ -676,6 +677,7 @@
         self.assertTrue(snap.require_virtualized)
         self.assertFalse(snap.private)
         self.assertTrue(snap.allow_internet)
+        self.assertFalse(snap.build_source_tarball)
 
     def test_creation_git_url(self):
         # A Snap can be backed directly by a URL for an external Git
@@ -1381,6 +1383,7 @@
             self.assertIsNone(snap["git_ref_link"])
             self.assertTrue(snap["require_virtualized"])
             self.assertTrue(snap["allow_internet"])
+            self.assertFalse(snap["build_source_tarball"])
 
     def test_new_git(self):
         # Ensure Snap creation based on a Git branch works.
@@ -1402,6 +1405,7 @@
             self.assertEqual(self.getURL(ref), snap["git_ref_link"])
             self.assertTrue(snap["require_virtualized"])
             self.assertTrue(snap["allow_internet"])
+            self.assertFalse(snap["build_source_tarball"])
 
     def test_new_private(self):
         # Ensure private Snap creation works.

=== modified file 'lib/lp/snappy/tests/test_snapbuildbehaviour.py'
--- lib/lp/snappy/tests/test_snapbuildbehaviour.py	2018-04-04 14:14:30 +0000
+++ lib/lp/snappy/tests/test_snapbuildbehaviour.py	2018-04-21 10:15:59 +0000
@@ -278,6 +278,7 @@
             "archives": expected_archives,
             "arch_tag": "i386",
             "branch": branch.bzr_identity,
+            "build_source_tarball": False,
             "build_url": canonical_url(job.build),
             "name": "test-snap",
             "proxy_url": self.proxy_url,
@@ -300,6 +301,7 @@
             "archive_private": False,
             "archives": expected_archives,
             "arch_tag": "i386",
+            "build_source_tarball": False,
             "build_url": canonical_url(job.build),
             "git_repository": ref.repository.git_https_url,
             "git_path": ref.name,
@@ -325,6 +327,7 @@
             "archive_private": False,
             "archives": expected_archives,
             "arch_tag": "i386",
+            "build_source_tarball": False,
             "build_url": canonical_url(job.build),
             "git_repository": ref.repository.git_https_url,
             "name": "test-snap",
@@ -350,6 +353,7 @@
             "archive_private": False,
             "archives": expected_archives,
             "arch_tag": "i386",
+            "build_source_tarball": False,
             "build_url": canonical_url(job.build),
             "git_repository": url,
             "git_path": "master",
@@ -375,6 +379,7 @@
             "archive_private": False,
             "archives": expected_archives,
             "arch_tag": "i386",
+            "build_source_tarball": False,
             "build_url": canonical_url(job.build),
             "git_repository": url,
             "name": "test-snap",
@@ -414,6 +419,7 @@
         self.assertFalse(isProxy(args["channels"]))
         self.assertEqual({"snapcraft": "edge"}, args["channels"])
 
+    @defer.inlineCallbacks
     def test_extraBuildArgs_disallow_internet(self):
         # If external network access is not allowed for the snap,
         # _extraBuildArgs does not dispatch a proxy token.
@@ -423,6 +429,14 @@
         self.assertNotIn("revocation_endpoint", args)
 
     @defer.inlineCallbacks
+    def test_extraBuildArgs_build_source_tarball(self):
+        # If the snap requests building of a source tarball, _extraBuildArgs
+        # sends the appropriate arguments.
+        job = self.makeJob(build_source_tarball=True)
+        args = yield job._extraBuildArgs()
+        self.assertTrue(args["build_source_tarball"])
+
+    @defer.inlineCallbacks
     def test_composeBuildRequest_proxy_url_set(self):
         job = self.makeJob()
         build_request = yield job.composeBuildRequest(None)

=== modified file 'lib/lp/testing/factory.py'
--- lib/lp/testing/factory.py	2018-04-04 14:14:30 +0000
+++ lib/lp/testing/factory.py	2018-04-21 10:15:59 +0000
@@ -4673,8 +4673,9 @@
                  auto_build_channels=None, is_stale=None,
                  require_virtualized=True, processors=None,
                  date_created=DEFAULT, private=False, allow_internet=True,
-                 store_upload=False, store_series=None, store_name=None,
-                 store_secrets=None, store_channels=None):
+                 build_source_tarball=False, store_upload=False,
+                 store_series=None, store_name=None, store_secrets=None,
+                 store_channels=None):
         """Make a new Snap."""
         if registrant is None:
             registrant = self.makePerson()
@@ -4699,9 +4700,11 @@
             auto_build=auto_build, auto_build_archive=auto_build_archive,
             auto_build_pocket=auto_build_pocket,
             auto_build_channels=auto_build_channels, private=private,
-            allow_internet=allow_internet, store_upload=store_upload,
-            store_series=store_series, store_name=store_name,
-            store_secrets=store_secrets, store_channels=store_channels)
+            allow_internet=allow_internet,
+            build_source_tarball=build_source_tarball,
+            store_upload=store_upload, store_series=store_series,
+            store_name=store_name, store_secrets=store_secrets,
+            store_channels=store_channels)
         if is_stale is not None:
             removeSecurityProxy(snap).is_stale = is_stale
         IStore(snap).flush()