Merge lp:~matiasb/launchpad-buildd/add-build-request-id into lp:launchpad-buildd

[Matias Bordese]

Add build_request_id and build_request_timestamp to SNAPCRAFT_IMAGE_INFO if provided.

[Colin Watson (cjwatson)]

This looks OK from a launchpad-buildd point of view, but I think you should get review from somebody who's authoritative for adding more keys to SNAPCRAFT_IMAGE_INFO and hence to image-info in the snap manifest. Sergio? A store or snapd architect? Somebody like that ...

review: Approve

[lp:~matiasb/launchpad-buildd/add-build-request-id]

373. By Matias Bordese on 2019-04-25

Add build_request_timestamp to image_info.

[Colin Watson (cjwatson)]

review: Approve

=== modified file 'lpbuildd/target/build_snap.py'
--- lpbuildd/target/build_snap.py	2019-03-06 22:45:38 +0000
+++ lpbuildd/target/build_snap.py	2019-04-25 13:45:08 +0000
@@ -63,6 +63,12 @@
                 "(supported snaps: {}, snapcraft)".format(
                     ", ".join(cls.core_snap_names))))
         parser.add_argument(
+            "--build-request-id",
+            help="ID of the request triggering this build on Launchpad")
+        parser.add_argument(
+            "--build-request-timestamp",
+            help="RFC3339 timestamp of the Launchpad build request")
+        parser.add_argument(
             "--build-url", help="URL of this build on Launchpad")
         parser.add_argument("--proxy-url", help="builder proxy url")
         parser.add_argument(
@@ -195,9 +201,13 @@
     @property
     def image_info(self):
         data = {}
+        if self.args.build_request_id is not None:
+            data["build_request_id"] = self.args.build_request_id
+        if self.args.build_request_timestamp is not None:
+            data["build_request_timestamp"] = self.args.build_request_timestamp
         if self.args.build_url is not None:
             data["build_url"] = self.args.build_url
-        return json.dumps(data)
+        return json.dumps(data, sort_keys=True)
 
     def pull(self):
         """Run pull phase."""

=== modified file 'lpbuildd/target/tests/test_build_snap.py'
--- lpbuildd/target/tests/test_build_snap.py	2019-03-12 16:09:00 +0000
+++ lpbuildd/target/tests/test_build_snap.py	2019-04-25 13:45:08 +0000
@@ -448,6 +448,40 @@
                 SNAPCRAFT_IMAGE_INFO="{}", SNAPCRAFT_BUILD_ENVIRONMENT="host"),
             ]))
 
+    def test_build_including_build_request_id(self):
+        args = [
+            "buildsnap",
+            "--backend=fake", "--series=xenial", "--arch=amd64", "1",
+            "--build-request-id", "13", "--branch", "lp:foo", "test-snap",
+            ]
+        build_snap = parse_args(args=args).operation
+        build_snap.build()
+        self.assertThat(build_snap.backend.run.calls, MatchesListwise([
+            RanBuildCommand(
+                ["snapcraft"], cwd="/build/test-snap",
+                SNAPCRAFT_BUILD_INFO="1",
+                SNAPCRAFT_IMAGE_INFO='{"build_request_id": "13"}',
+                SNAPCRAFT_BUILD_ENVIRONMENT="host"),
+            ]))
+
+    def test_build_including_build_request_timestamp(self):
+        args = [
+            "buildsnap",
+            "--backend=fake", "--series=xenial", "--arch=amd64", "1",
+            "--build-request-timestamp", "2018-04-13T14:50:02Z",
+            "--branch", "lp:foo", "test-snap",
+            ]
+        build_snap = parse_args(args=args).operation
+        build_snap.build()
+        self.assertThat(build_snap.backend.run.calls, MatchesListwise([
+            RanBuildCommand(
+                ["snapcraft"], cwd="/build/test-snap",
+                SNAPCRAFT_BUILD_INFO="1",
+                SNAPCRAFT_IMAGE_INFO=(
+                    '{"build_request_timestamp": "2018-04-13T14:50:02Z"}'),
+                SNAPCRAFT_BUILD_ENVIRONMENT="host"),
+            ]))
+
     # XXX cjwatson 2017-08-07: Test revoke_token.  It may be easiest to
     # convert it to requests first.
 
@@ -455,6 +489,7 @@
         args = [
             "buildsnap",
             "--backend=fake", "--series=xenial", "--arch=amd64", "1",
+            "--build-request-id", "13",
             "--build-url", "https://launchpad.example/build",
             "--branch", "lp:foo", "test-snap",
             ]
@@ -471,13 +506,15 @@
                 SNAPCRAFT_LOCAL_SOURCES="1", SNAPCRAFT_SETUP_CORE="1",
                 SNAPCRAFT_BUILD_INFO="1",
                 SNAPCRAFT_IMAGE_INFO=(
-                    '{"build_url": "https://launchpad.example/build"}'),
+                    '{"build_request_id": "13",'
+                    ' "build_url": "https://launchpad.example/build"}'),
                 SNAPCRAFT_BUILD_ENVIRONMENT="host")),
             AnyMatch(RanBuildCommand(
                 ["snapcraft"], cwd="/build/test-snap",
                 SNAPCRAFT_BUILD_INFO="1",
                 SNAPCRAFT_IMAGE_INFO=(
-                    '{"build_url": "https://launchpad.example/build"}'),
+                    '{"build_request_id": "13",'
+                    ' "build_url": "https://launchpad.example/build"}'),
                 SNAPCRAFT_BUILD_ENVIRONMENT="host")),
             ))