Merge lp:~mpontillo/maas/fix-curtin-custom-driver-preseed--bug-1667426--2.1 into lp:maas/2.1

[Mike Pontillo]

Merge revision 5756 from trunk.
Fix curtin config rendering for third-party drivers.

[Mike Pontillo (mpontillo)]

Self-approved backport.

review: Approve

[MAAS Lander (maas-lander)]

The attempt to merge lp:~mpontillo/maas/fix-curtin-custom-driver-preseed--bug-1667426--2.1 into lp:maas/2.1 failed. Below is the output from the failed tests.

Hit:1 http://prodstack-zone-1.clouds.archive.ubuntu.com/ubuntu xenial InRelease
Get:2 http://prodstack-zone-1.clouds.archive.ubuntu.com/ubuntu xenial-updates InRelease [102 kB]
Get:3 http://security.ubuntu.com/ubuntu xenial-security InRelease [102 kB]
Get:4 http://prodstack-zone-1.clouds.archive.ubuntu.com/ubuntu xenial-backports InRelease [102 kB]
Fetched 306 kB in 0s (757 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-...

[MAAS Lander (maas-lander)]

The attempt to merge lp:~mpontillo/maas/fix-curtin-custom-driver-preseed--bug-1667426--2.1 into lp:maas/2.1 failed. Below is the output from the failed tests.

Hit:1 http://prodstack-zone-1.clouds.archive.ubuntu.com/ubuntu xenial InRelease
Get:2 http://prodstack-zone-1.clouds.archive.ubuntu.com/ubuntu xenial-updates InRelease [102 kB]
Get:3 http://prodstack-zone-1.clouds.archive.ubuntu.com/ubuntu xenial-backports InRelease [102 kB]
Get:4 http://security.ubuntu.com/ubuntu xenial-security InRelease [102 kB]
Fetched 306 kB in 0s (667 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-...

[Mike Pontillo (mpontillo)]

Hm, at first I thought the 1.9 lander was just being the 1.9 lander again, but it seems that the preseed code has changed significantly enough that these modifications aren't an easy backport.

With a MAAS 2.2 release imminent, that makes this lower priority for 2.1. We'll circle back if the need arises.

Unmerged revisions

5591. By Mike Pontillo on 2017-02-24

Update changelog.

5590. By Mike Pontillo on 2017-02-24

Merge revision 5756 from trunk.
Fix curtin config rendering for third-party drivers.

=== modified file 'contrib/preseeds_v2/curtin_userdata'
--- contrib/preseeds_v2/curtin_userdata	2016-12-08 13:45:40 +0000
+++ contrib/preseeds_v2/curtin_userdata	2017-02-24 04:33:23 +0000
@@ -6,21 +6,35 @@
   {{endfor}}
 {{if third_party_drivers and driver}}
 early_commands:
-  {{py: key_string = ''.join(['\\x%x' % x for x in map(ord, driver['key_binary'])])}}
+  {{py: key_string = ''.join(['\\x%x' % x for x in driver['key_binary']])}}
+  {{if driver['key_binary'] and driver['repository'] and driver['package']}}
   driver_00_get_key: /bin/echo -en '{{key_string}}' > /tmp/maas-{{driver['package']}}.gpg
   driver_01_add_key: ["apt-key", "add", "/tmp/maas-{{driver['package']}}.gpg"]
+  {{endif}}
+  {{if driver['repository']}}
   driver_02_add: ["add-apt-repository", "-y", "deb {{driver['repository']}} {{node.get_distro_series()}} main"]
+  {{endif}}
+  {{if driver['package']}}
   driver_03_update_install: ["sh", "-c", "apt-get update --quiet && apt-get --assume-yes install {{driver['package']}}"]
-  driver_04_load: ["sh", "-c", "depmod && modprobe {{driver['module']}}"]
+  {{endif}}
+  {{if driver['module']}}
+  driver_04_load: ["sh", "-c", "depmod && modprobe {{driver['module']}} || echo 'Warning: Failed to load module: {{driver['module']}}'"]
+  {{endif}}
 {{endif}}
 late_commands:
   maas: [wget, '--no-proxy', {{node_disable_pxe_url|escape.json}}, '--post-data', {{node_disable_pxe_data|escape.json}}, '-O', '/dev/null']
 {{if third_party_drivers and driver}}
+  {{if driver['key_binary'] and driver['repository'] and driver['package']}}
   driver_00_key_get: curtin in-target -- sh -c "/bin/echo -en '{{key_string}}' > /tmp/maas-{{driver['package']}}.gpg"
   driver_02_key_add: ["curtin", "in-target", "--", "apt-key", "add", "/tmp/maas-{{driver['package']}}.gpg"]
+  {{endif}}
+  {{if driver['repository']}}
   driver_03_add: ["curtin", "in-target", "--", "add-apt-repository", "-y", "deb {{driver['repository']}} {{node.get_distro_series()}} main"]
+  {{endif}}
   driver_04_update_install: ["curtin", "in-target", "--", "apt-get", "update", "--quiet"]
+  {{if driver['package']}}
   driver_05_install: ["curtin", "in-target", "--", "apt-get", "-y", "install", "{{driver['package']}}"]
+  {{endif}}
   driver_06_depmod: ["curtin", "in-target", "--", "depmod"]
   driver_07_update_initramfs: ["curtin", "in-target", "--", "update-initramfs", "-u"]
 {{endif}}

=== modified file 'docs/changelog.rst'
--- docs/changelog.rst	2017-02-17 05:59:11 +0000
+++ docs/changelog.rst	2017-02-24 04:33:23 +0000
@@ -34,6 +34,8 @@
 
 LP: #1665459    Fix anonymous auto-enlistment to properly detect rack-facing region IP address
 
+LP: #1667426    Fix curtin config rendering for custom third-party drivers.
+
 
 Other notable changes
 ---------------------

=== modified file 'src/maasserver/tests/test_preseed.py'
--- src/maasserver/tests/test_preseed.py	2016-12-13 17:26:28 +0000
+++ src/maasserver/tests/test_preseed.py	2017-02-24 04:33:23 +0000
@@ -77,6 +77,7 @@
     MAASServerTestCase,
     MAASTransactionServerTestCase,
 )
+from maasserver.third_party_drivers import DriversConfig
 from maasserver.utils import absolute_reverse
 from maasserver.utils.curtin import curtin_supports_webhook_events
 from maastesting.matchers import (
@@ -850,6 +851,54 @@
         self.assertThat(mock_supports_storage, MockCalledOnceWith())
 
 
+class TestRenderCurtinUserdataWithThirdPartyDrivers(
+        PreseedRPCMixin, BootImageHelperMixin, MAASServerTestCase):
+    """Ensures curtin configs for all third-party drivers can be rendered."""
+
+    # Try rendering each driver in drivers.yaml.
+    scenarios = [
+        (driver['comment'], {'driver': driver})
+        for driver in DriversConfig.load_from_cache()['drivers']
+    ]
+
+    def test_render_curtin_preseed_with_third_party_driver(self):
+        node = factory.make_Node_with_Interface_on_Subnet(
+            primary_rack=self.rpc_rack_controller)
+        Config.objects.set_config(
+            'enable_third_party_drivers', True)
+        self.configure_get_boot_images_for_node(node, 'xinstall')
+        get_third_party_driver = self.patch(
+            preseed_module, "get_third_party_driver")
+        get_third_party_driver.return_value = self.driver
+        curtin_config_text = get_curtin_config(node)
+        config = yaml.safe_load(curtin_config_text)
+        self.assertThat(
+            config['early_commands'], Contains('driver_00_get_key'))
+        self.assertThat(
+            config['early_commands'], Contains('driver_01_add_key'))
+        self.assertThat(
+            config['early_commands'], Contains('driver_02_add'))
+        self.assertThat(
+            config['early_commands'], Contains('driver_03_update_install'))
+        self.assertThat(
+            config['early_commands'], Contains('driver_04_load'))
+        self.assertThat(
+            config['late_commands'], Contains('driver_00_key_get'))
+        self.assertThat(
+            config['late_commands'], Contains('driver_02_key_add'))
+        self.assertThat(
+            config['late_commands'], Contains('driver_03_add'))
+        self.assertThat(
+            config['late_commands'], Contains('driver_04_update_install'))
+        self.assertThat(
+            config['late_commands'], Contains('driver_05_install'))
+        self.assertThat(
+            config['late_commands'], Contains('driver_06_depmod'))
+        self.assertThat(
+            config['late_commands'],
+            Contains('driver_07_update_initramfs'))
+
+
 class TestGetCurtinUserDataOS(
         PreseedRPCMixin, BootImageHelperMixin, MAASTransactionServerTestCase):
     """Tests for `get_curtin_userdata` using os specific scenarios."""