Merge lp:~ltrager/maas/lp1656425_2.1 into lp:maas/2.1

[Lee Trager]

Backport r5642 from trunk: Only create hard links for the product subarch, not its subarches

Every Ubuntu product in a SimpleStream contains a list of subarches which contain what subarches are a subset of the current product. The rack controller was creating hard links for each subarch in this list. Kernel flavors contain the same subarches list as the generic kernel as the only difference between them is their config. For example both ga-16.04 and ga-16.04-lowlatency have a subarches list of "hwe-{p,q,r,s,t,u,v,w},ga-16.04". Whatever product was processed last ended up owning all of the hard links. The region prevents older subarches from being used so MAAS only needs hard links for the subarches it has downloaded.

[Lee Trager (ltrager)]

Reviewed in https://code.launchpad.net/~ltrager/maas/lp1656425/+merge/314761

review: Approve

[MAAS Lander (maas-lander)]

The attempt to merge lp:~ltrager/maas/lp1656425_2.1 into lp:maas/2.1 failed. Below is the output from the failed tests.

Get:1 http://security.ubuntu.com/ubuntu xenial-security InRelease [102 kB]
Hit:2 http://prodstack-zone-1.clouds.archive.ubuntu.com/ubuntu xenial InRelease
Get:3 http://prodstack-zone-1.clouds.archive.ubuntu.com/ubuntu xenial-updates InRelease [102 kB]
Hit:4 http://prodstack-zone-1.clouds.archive.ubuntu.com/ubuntu xenial-backports InRelease
Fetched 204 kB in 0s (462 kB/s)
Reading package lists...
sudo DEBIAN_FRONTEND=noninteractive apt-get -y \
    --no-install-recommends install apache2 archdetect-deb authbind avahi-utils bash bind9 bind9utils build-essential bzr bzr-builddeb chromium-browser chromium-chromedriver curl daemontools debhelper dh-apport dh-systemd distro-info dnsutils firefox freeipmi-tools git gjs ipython isc-dhcp-common isc-dhcp-server libjs-angularjs libjs-jquery libjs-jquery-hotkeys libjs-yui3-full libjs-yui3-min libpq-dev make nodejs-legacy npm postgresql pxelinux python3-all python3-apt python3-attr python3-bson python3-convoy python3-crochet python3-cssselect python3-curtin python3-dev python3-distro-info python3-django python3-django-nose python3-django-piston3 python3-dnspython python3-docutils python3-formencode python3-hivex python3-httplib2 python3-jinja2 python3-jsonschema python3-lxml python3-netaddr python3-netifaces python3-novaclient python3-oauth python3-oauthlib python3-openssl python3-paramiko python3-petname python3-pexpect python3-psycopg2 python3-pyinotify python3-pyparsing python3-pyvmomi python3-requests python3-seamicroclient python3-setuptools python3-simplestreams python3-sphinx python3-tempita python3-twisted python3-txtftp python3-tz python3-yaml python3-zope.interface python-bson python-crochet python-django python-django-piston python-djorm-ext-pgarray python-formencode python-lxml python-netaddr python-netifaces python-pocket-lint python-psycopg2 python-simplejson python-tempita python-twisted python-yaml socat syslinux-common tgt ubuntu-cloudimage-keyring wget xvfb
Reading package lists...
Building dependency tree...
Reading state information...
authbind is already the newest version (2.1.1+nmu1).
avahi-utils is already the newest version (0.6.32~rc+dfsg-1ubuntu2).
build-essential is already the newest version (12.1ubuntu2).
debhelper is already the newest version (9.20160115ubuntu3).
distro-info is already the newest version (0.14build1).
git is already the newest version (1:2.7.4-0ubuntu1).
libjs-angularjs is already the newest version (1.2.28-1ubuntu2).
libjs-jquery is already the newest version (1.11.3+dfsg-4).
libjs-yui3-full is already the newest version (3.5.1-1ubuntu3).
libjs-yui3-min is already the newest version (3.5.1-1ubuntu3).
make is already the newest version (4.1-6).
postgresql is already the newest version (9.5+173).
pxelinux is already the newest version (3:6.03+dfsg-11ubuntu1).
python-formencode is already the newest version (1.3.0-0ubuntu5).
python-lxml is already the newest version (3.5.0-1build1).
python-netaddr is already the newest version (0.7.18-1).
python-netifaces is already the newest version (0.10.4-0.1build2).
python-psycopg2 is already the newes...

=== modified file 'docs/changelog.rst'
--- docs/changelog.rst	2017-01-12 14:14:52 +0000
+++ docs/changelog.rst	2017-01-19 17:54:18 +0000
@@ -14,6 +14,7 @@
 
 LP: #1654412	Unable to set edge kernel as the min_hwe_kernel and deploy with the default kernel
 
+LP: #1656425    Ephemeral environments using the wrong kernel
 
 2.1.3
 =====

=== modified file 'src/provisioningserver/import_images/download_resources.py'
--- src/provisioningserver/import_images/download_resources.py	2016-10-28 15:58:32 +0000
+++ src/provisioningserver/import_images/download_resources.py	2017-01-19 17:54:18 +0000
@@ -1,4 +1,4 @@
-# Copyright 2014-2016 Canonical Ltd.  This software is licensed under the
+# Copyright 2014-2017 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Simplestreams code to download boot resources."""
@@ -287,11 +287,33 @@
                 self.store, filename, tag, checksums, size, contentsource)
 
         osystem = get_os_from_product(item)
-        subarches = self.product_mapping.get(item)
+
+        # link_resources creates a hardlink for every subarch. Every Ubuntu
+        # product in a SimpleStream contains a list of subarches which list
+        # what subarches are a subset of that subarch. For example Xenial
+        # ga-16.04 has the subarches list hwe-{p,q,r,s,t,u,v,w},ga-16.04.
+        # Kernel flavors are the same arch, the only difference is the kernel
+        # config. So ga-16.04-lowlatency has the same subarch list as ga-16.04.
+        # If we create hard links for all subarches a kernel flavor may
+        # overwrite the generic kernel hard link. This happens if a kernel
+        # flavor is processed after the generic kernel. Since MAAS doesn't use
+        # the other hard links only create hard links for the subarch of the
+        # product we have and a rolling link if it's a rolling kernel.
+        if 'subarch' in item:
+            # MAAS uses the 'generic' subarch when it doesn't know which
+            # subarch to use. This happens during enlistment and commissioning.
+            # Allow the 'generic' kflavor to own the 'generic' hardlink.
+            if item.get('kflavor') == 'generic':
+                subarches = {item['subarch'], 'generic'}
+            else:
+                subarches = {item['subarch']}
+        else:
+            subarches = {'generic'}
+
         if item.get('rolling', False):
             subarch_parts = item['subarch'].split('-')
             subarch_parts[1] = 'rolling'
-            subarches.append('-'.join(subarch_parts))
+            subarches.add('-'.join(subarch_parts))
         link_resources(
             snapshot_path=self.root_path, links=links,
             osystem=osystem, arch=item['arch'], release=item['release'],

=== modified file 'src/provisioningserver/import_images/tests/test_download_resources.py'
--- src/provisioningserver/import_images/tests/test_download_resources.py	2016-10-12 15:26:17 +0000
+++ src/provisioningserver/import_images/tests/test_download_resources.py	2017-01-19 17:54:18 +0000
@@ -182,124 +182,213 @@
 class TestRepoWriter(MAASTestCase):
     """Tests for `RepoWriter`."""
 
-    def make_product(self, ftype=None):
-        if ftype is None:
-            ftype = factory.make_name('ftype')
+    def make_product(self, **kwargs):
         return {
             'content_id': 'maas:v2:download',
             'product_name': factory.make_string(),
             'version_name': datetime.utcnow().strftime('%Y%m%d'),
             'sha256': factory.make_name('sha256'),
             'size': random.randint(2, 2**16),
-            'ftype': ftype,
+            'ftype': factory.make_name('ftype'),
             'path': '/path/to/%s' % factory.make_name('filename'),
             'os': factory.make_name('os'),
             'release': factory.make_name('release'),
             'arch': factory.make_name('arch'),
             'label': factory.make_name('label'),
+            **kwargs,
         }
 
     def test_inserts_archive(self):
-        product = self.make_product('archive.tar.xz')
         product_mapping = ProductMapping()
         subarch = factory.make_name('subarch')
+        product = self.make_product(ftype='archive.tar.xz', subarch=subarch)
         product_mapping.add(product, subarch)
         repo_writer = download_resources.RepoWriter(
             None, None, product_mapping)
         self.patch(
             download_resources, 'products_exdata').return_value = product
+        # Prevent MAAS from trying to actually write the file.
         mock_extract_archive_tar = self.patch(
             download_resources, 'extract_archive_tar')
         mock_link_resources = self.patch(download_resources, 'link_resources')
+        # We only need to provide the product as the other fields are only used
+        # when writing the actual files to disk.
         repo_writer.insert_item(product, None, None, None, None)
+        # None is used for the store and the content source as we're not
+        # writing anything to disk.
         self.assertThat(
             mock_extract_archive_tar,
             MockCalledOnceWith(
-                mock.ANY, os.path.basename(product['path']), product['sha256'],
+                None, os.path.basename(product['path']), product['sha256'],
                 {'sha256': product['sha256']}, product['size'], None))
+        # links are mocked out by the mock_insert_file above.
         self.assertThat(
             mock_link_resources,
             MockCalledOnceWith(
                 snapshot_path=None, links=mock.ANY, osystem=product['os'],
                 arch=product['arch'], release=product['release'],
-                label=product['label'], subarches=[subarch],
+                label=product['label'], subarches={subarch},
                 bootloader_type=None))
 
     def test_inserts_root_image(self):
-        product = self.make_product('root-image.gz')
         product_mapping = ProductMapping()
         subarch = factory.make_name('subarch')
+        product = self.make_product(ftype='root-image.gz', subarch=subarch)
         product_mapping.add(product, subarch)
         repo_writer = download_resources.RepoWriter(
             None, None, product_mapping)
         self.patch(
             download_resources, 'products_exdata').return_value = product
+        # Prevent MAAS from trying to actually write the file.
         mock_insert_root_image = self.patch(
             download_resources, 'insert_root_image')
         mock_link_resources = self.patch(download_resources, 'link_resources')
+        # We only need to provide the product as the other fields are only used
+        # when writing the actual files to disk.
         repo_writer.insert_item(product, None, None, None, None)
+        # None is used for the store and the content source as we're not
+        # writing anything to disk.
         self.assertThat(
             mock_insert_root_image,
             MockCalledOnceWith(
-                mock.ANY, product['sha256'], {'sha256': product['sha256']},
+                None, product['sha256'], {'sha256': product['sha256']},
                 product['size'], None))
+        # links are mocked out by the mock_insert_file above.
         self.assertThat(
             mock_link_resources,
             MockCalledOnceWith(
                 snapshot_path=None, links=mock.ANY, osystem=product['os'],
                 arch=product['arch'], release=product['release'],
-                label=product['label'], subarches=[subarch],
+                label=product['label'], subarches={subarch},
                 bootloader_type=None))
 
     def test_inserts_file(self):
-        product = self.make_product()
         product_mapping = ProductMapping()
         subarch = factory.make_name('subarch')
+        product = self.make_product(subarch=subarch)
         product_mapping.add(product, subarch)
         repo_writer = download_resources.RepoWriter(
             None, None, product_mapping)
         self.patch(
             download_resources, 'products_exdata').return_value = product
+        # Prevent MAAS from trying to actually write the file.
         mock_insert_file = self.patch(download_resources, 'insert_file')
         mock_link_resources = self.patch(download_resources, 'link_resources')
+        # We only need to provide the product as the other fields are only used
+        # when writing the actual files to disk.
         repo_writer.insert_item(product, None, None, None, None)
+        # None is used for the store and the content source as we're not
+        # writing anything to disk.
         self.assertThat(
             mock_insert_file,
             MockCalledOnceWith(
-                mock.ANY, os.path.basename(product['path']), product['sha256'],
+                None, os.path.basename(product['path']), product['sha256'],
                 {'sha256': product['sha256']}, product['size'], None))
+        # links are mocked out by the mock_insert_file above.
         self.assertThat(
             mock_link_resources,
             MockCalledOnceWith(
                 snapshot_path=None, links=mock.ANY, osystem=product['os'],
                 arch=product['arch'], release=product['release'],
-                label=product['label'], subarches=[subarch],
+                label=product['label'], subarches={subarch},
                 bootloader_type=None))
 
     def test_inserts_rolling_links(self):
-        product = self.make_product()
-        product['subarch'] = 'hwe-16.04'
-        product['rolling'] = True
         product_mapping = ProductMapping()
+        product = self.make_product(subarch='hwe-16.04', rolling=True)
         product_mapping.add(product, 'hwe-16.04')
         repo_writer = download_resources.RepoWriter(
             None, None, product_mapping)
         self.patch(
             download_resources, 'products_exdata').return_value = product
-        mock_insert_file = self.patch(download_resources, 'insert_file')
-        mock_link_resources = self.patch(download_resources, 'link_resources')
-        repo_writer.insert_item(product, None, None, None, None)
-        self.assertThat(
-            mock_insert_file,
-            MockCalledOnceWith(
-                mock.ANY, os.path.basename(product['path']), product['sha256'],
-                {'sha256': product['sha256']}, product['size'], None))
-        self.assertThat(
-            mock_link_resources,
-            MockCalledOnceWith(
-                snapshot_path=None, links=mock.ANY, osystem=product['os'],
-                arch=product['arch'], release=product['release'],
-                label=product['label'], subarches=['hwe-16.04', 'hwe-rolling'],
+        # Prevent MAAS from trying to actually write the file.
+        mock_insert_file = self.patch(download_resources, 'insert_file')
+        mock_link_resources = self.patch(download_resources, 'link_resources')
+        # We only need to provide the product as the other fields are only used
+        # when writing the actual files to disk.
+        repo_writer.insert_item(product, None, None, None, None)
+        # None is used for the store and the content source as we're not
+        # writing anything to disk.
+        self.assertThat(
+            mock_insert_file,
+            MockCalledOnceWith(
+                None, os.path.basename(product['path']), product['sha256'],
+                {'sha256': product['sha256']}, product['size'], None))
+        # links are mocked out by the mock_insert_file above.
+        self.assertThat(
+            mock_link_resources,
+            MockCalledOnceWith(
+                snapshot_path=None, links=mock.ANY, osystem=product['os'],
+                arch=product['arch'], release=product['release'],
+                label=product['label'], subarches={'hwe-16.04', 'hwe-rolling'},
+                bootloader_type=None))
+
+    def test_only_creates_links_for_its_own_subarch(self):
+        # Regression test for LP:1656425
+        product_name = factory.make_name('product_name')
+        version_name = factory.make_name('version_name')
+        product_mapping = ProductMapping()
+        for subarch in [
+                'hwe-p', 'hwe-q', 'hwe-r', 'hwe-s', 'hwe-t', 'hwe-u', 'hwe-v',
+                'hwe-w', 'ga-16.04']:
+            product = self.make_product(
+                product_name=product_name, version_name=version_name,
+                subarch=subarch)
+            product_mapping.add(product, subarch)
+        repo_writer = download_resources.RepoWriter(
+            None, None, product_mapping)
+        self.patch(
+            download_resources, 'products_exdata').return_value = product
+        # Prevent MAAS from trying to actually write the file.
+        mock_insert_file = self.patch(download_resources, 'insert_file')
+        mock_link_resources = self.patch(download_resources, 'link_resources')
+        # We only need to provide the product as the other fields are only used
+        # when writing the actual files to disk.
+        repo_writer.insert_item(product, None, None, None, None)
+        # None is used for the store and the content source as we're not
+        # writing anything to disk.
+        self.assertThat(
+            mock_insert_file,
+            MockCalledOnceWith(
+                None, os.path.basename(product['path']), product['sha256'],
+                {'sha256': product['sha256']}, product['size'], None))
+        # links are mocked out by the mock_insert_file above.
+        self.assertThat(
+            mock_link_resources,
+            MockCalledOnceWith(
+                snapshot_path=None, links=mock.ANY, osystem=product['os'],
+                arch=product['arch'], release=product['release'],
+                label=product['label'], subarches={'ga-16.04'},
+                bootloader_type=None))
+
+    def test_inserts_generic_link_for_generic_kflavor(self):
+        product_mapping = ProductMapping()
+        product = self.make_product(subarch='ga-16.04', kflavor='generic')
+        product_mapping.add(product, 'ga-16.04')
+        repo_writer = download_resources.RepoWriter(
+            None, None, product_mapping)
+        self.patch(
+            download_resources, 'products_exdata').return_value = product
+        # Prevent MAAS from trying to actually write the file.
+        mock_insert_file = self.patch(download_resources, 'insert_file')
+        mock_link_resources = self.patch(download_resources, 'link_resources')
+        # We only need to provide the product as the other fields are only used
+        # when writing the actual files to disk.
+        repo_writer.insert_item(product, None, None, None, None)
+        # None is used for the store and the content source as we're not
+        # writing anything to disk.
+        self.assertThat(
+            mock_insert_file,
+            MockCalledOnceWith(
+                None, os.path.basename(product['path']), product['sha256'],
+                {'sha256': product['sha256']}, product['size'], None))
+        # links are mocked out by the mock_insert_file above.
+        self.assertThat(
+            mock_link_resources,
+            MockCalledOnceWith(
+                snapshot_path=None, links=mock.ANY, osystem=product['os'],
+                arch=product['arch'], release=product['release'],
+                label=product['label'], subarches={'ga-16.04', 'generic'},
                 bootloader_type=None))