Merge lp:~mvo/launchpad/add-cnf-metadata-to-release-file into lp:launchpad

[Michael Vogt]

Add command-not-found metadata in the archive to the Release file.

This tiny MP adds code to launchpad to add command-not-found metadata in the archive to the Release file so that this metadata can be fetched via `apt update`. Getting the metadata to this dir will require an extra MP for ubuntu-archive-publishing.

[Colin Watson (cjwatson)]

Looks good to me apart from these comments, so let me know when you've fixed them and I can land this.

review: Approve

[Michael Vogt (mvo)]

Thanks for the review! I updated the code now.

=== modified file 'lib/lp/archivepublisher/publishing.py'
--- lib/lp/archivepublisher/publishing.py	2019-02-20 16:13:20 +0000
+++ lib/lp/archivepublisher/publishing.py	2019-03-15 17:32:59 +0000
@@ -1218,6 +1218,17 @@
             except OSError as e:
                 if e.errno != errno.ENOENT:
                     raise
+            cnf_dir = os.path.join(suite_dir, component, "cnf")
+            try:
+                for cnf_file in os.listdir(cnf_dir):
+                    if cnf_file.startswith("Commands-"):
+                        cnf_path = os.path.join(
+                            component, "cnf", cnf_file)
+                        extra_files.add(remove_suffix(cnf_path))
+                        extra_files.add(cnf_path)
+            except OSError as e:
+                if e.errno != errno.ENOENT:
+                    raise
         for architecture in all_architectures:
             for contents_path in get_suffixed_indices(
                     'Contents-' + architecture):
 
=== modified file 'lib/lp/archivepublisher/tests/test_publisher.py'
--- lib/lp/archivepublisher/tests/test_publisher.py	2019-02-20 16:13:20 +0000
+++ lib/lp/archivepublisher/tests/test_publisher.py	2019-03-15 17:32:59 +0000
@@ -2190,6 +2190,36 @@
                 self.assertReleaseContentsMatch(
                     release, os.path.join('main', 'dep11', name), f.read())
 
+    def testReleaseFileForCommandNotFound(self):
+        # Test Release file writing for command-not-found metadata.
+        publisher = Publisher(
+            self.logger, self.config, self.disk_pool,
+            self.ubuntutest.main_archive)
+
+        # Put some cnf metadata files in place, and force the publisher
+        # to republish that suite.
+        series_path = os.path.join(self.config.distsroot, 'breezy-autotest')
+        cnf_path = os.path.join(series_path, 'main', 'cnf')
+        cnf_names = ('Commands-amd64.xz', 'Commands-i386.xz')
+        os.makedirs(cnf_path)
+        for name in cnf_names:
+            with gzip.GzipFile(os.path.join(cnf_path, name), 'wb') as f:
+                f.write(name)
+        publisher.markPocketDirty(
+            self.ubuntutest.getSeries('breezy-autotest'),
+            PackagePublishingPocket.RELEASE)
+
+        publisher.A_publish(False)
+        publisher.C_doFTPArchive(False)
+        publisher.D_writeReleaseFiles(False)
+
+        # The metadata files are listed correctly in Release.
+        release = self.parseRelease(os.path.join(series_path, 'Release'))
+        for name in cnf_names:
+            with open(os.path.join(cnf_path, name), 'rb') as f:
+                self.assertReleaseContentsMatch(
+                    release, os.path.join('main', 'cnf', name), f.read())
+
     def testReleaseFileTimestamps(self):
         # The timestamps of Release and all its core entries match.
         publisher = Publisher(