Merge lp:~jtv/maas/curtin-preseed-helpers into lp:~maas-committers/maas/trunk

[Jeroen T. Vermeulen]

Two helpers that I need for generating Curtin preseeds: compose_write_text_file and compose_mv_command.

Part of the work for writing a node's network configuration on the server side.

Jeroen

[Gavin Panella (allenap)]

I don't really know how compose_write_text_file() is going to be used, but it looks sane, as do the tests :)

review: Approve

[Jeroen T. Vermeulen (jtv)]

I should have covered the basics better. This data is for passing into Curtin as a Curtin preseed — not to be confused with a cloud-init preseed, which is incredibly similar but subtly different. Most of the documentation I have is examples, so for the file permissions I just stuck to a format I knew worked.

Thanks for the review.

[MAAS Lander (maas-lander)]

The attempt to merge lp:~jtv/maas/curtin-preseed-helpers into lp:maas failed. Below is the output from the failed tests.

Ign http://security.ubuntu.com trusty-security InRelease
Hit http://security.ubuntu.com trusty-security Release.gpg
Hit http://security.ubuntu.com trusty-security Release
Ign http://nova.clouds.archive.ubuntu.com trusty InRelease
Ign http://nova.clouds.archive.ubuntu.com trusty-updates InRelease
Hit http://nova.clouds.archive.ubuntu.com trusty Release.gpg
Hit http://nova.clouds.archive.ubuntu.com trusty-updates Release.gpg
Hit http://nova.clouds.archive.ubuntu.com trusty Release
Hit http://nova.clouds.archive.ubuntu.com trusty-updates Release
Hit http://security.ubuntu.com trusty-security/main Sources
Hit http://security.ubuntu.com trusty-security/universe Sources
Hit http://security.ubuntu.com trusty-security/main amd64 Packages
Hit http://security.ubuntu.com trusty-security/universe amd64 Packages
Hit http://security.ubuntu.com trusty-security/main Translation-en
Hit http://security.ubuntu.com trusty-security/universe Translation-en
Hit http://nova.clouds.archive.ubuntu.com trusty/main Sources
Hit http://nova.clouds.archive.ubuntu.com trusty/universe Sources
Hit http://nova.clouds.archive.ubuntu.com trusty/main amd64 Packages
Hit http://nova.clouds.archive.ubuntu.com trusty/universe amd64 Packages
Hit http://nova.clouds.archive.ubuntu.com trusty/main Translation-en
Hit http://nova.clouds.archive.ubuntu.com trusty/universe Translation-en
Hit http://nova.clouds.archive.ubuntu.com trusty-updates/main Sources
Hit http://nova.clouds.archive.ubuntu.com trusty-updates/universe Sources
Hit http://nova.clouds.archive.ubuntu.com trusty-updates/main amd64 Packages
Hit http://nova.clouds.archive.ubuntu.com trusty-updates/universe amd64 Packages
Hit http://nova.clouds.archive.ubuntu.com trusty-updates/main Translation-en
Hit http://nova.clouds.archive.ubuntu.com trusty-updates/universe Translation-en
Ign http://nova.clouds.archive.ubuntu.com trusty/main Translation-en_US
Ign http://nova.clouds.archive.ubuntu.com trusty/universe Translation-en_US
Reading package lists...
sudo DEBIAN_FRONTEND=noninteractive apt-get -y \
     --no-install-recommends install apache2 authbind bind9 bind9utils build-essential bzr-builddeb curl daemontools debhelper dh-apport distro-info dnsutils firefox freeipmi-tools ipython isc-dhcp-common libjs-raphael libjs-yui3-full libjs-yui3-min libpq-dev make pep8 postgresql pyflakes python-amqplib python-bzrlib python-celery python-convoy python-crochet python-cssselect python-curtin python-dev python-distro-info python-django python-django-piston python-django-south python-djorm-ext-pgarray python-docutils python-extras python-fixtures python-flake8 python-formencode python-hivex python-httplib2 python-jinja2 python-jsonschema python-lockfile python-lxml python-mimeparse python-mock python-netaddr python-netifaces python-nose python-oauth python-oops python-oops-amqp python-oops-datedir-repo python-oops-twisted python-oops-wsgi python-openssl python-paramiko python-pexpect python-pip python-pocket-lint python-psycopg2 python-pyinotify python-seamicroclient python-simplejson python-simplestreams python-sphinx pyth...

[Jeroen T. Vermeulen (jtv)]

Apparently unrelated failure: timeout waiting for BIND to start.

=== added file 'src/provisioningserver/utils/curtin.py'
--- src/provisioningserver/utils/curtin.py	1970-01-01 00:00:00 +0000
+++ src/provisioningserver/utils/curtin.py	2014-09-29 02:51:51 +0000
@@ -0,0 +1,51 @@
+# Copyright 2014 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Utilities related to Curtin."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+str = None
+
+__metaclass__ = type
+__all__ = [
+    'compose_mv_command',
+    'compose_write_text_file',
+    ]
+
+
+def compose_write_text_file(path, content, owner='root:root',
+                            permissions=0600):
+    """Return preseed for uploading a text file to the install target.
+
+    Use this to write files into the filesystem that Curtin is installing.  The
+    result goes into a `write_files` preseed entry.
+    """
+    return {
+        'path': path,
+        'content': content,
+        'owner': owner,
+        'permissions': '0%o' % permissions,
+        }
+
+
+def compose_mv_command(source, dest):
+    """Return preseed for running the `mv` command in the install target.
+
+    Use this for moving files around in the filesystem that Curtin is
+    installing.  The result goes in a preseed entry for running commands, such
+    as an entry in `late_commands` dict.
+    """
+    return [
+        'curtin',
+        'in-target',
+        '--',
+        'mv',
+        '--',
+        source,
+        dest,
+        ]

=== added file 'src/provisioningserver/utils/tests/test_curtin.py'
--- src/provisioningserver/utils/tests/test_curtin.py	1970-01-01 00:00:00 +0000
+++ src/provisioningserver/utils/tests/test_curtin.py	2014-09-29 02:51:51 +0000
@@ -0,0 +1,96 @@
+# Copyright 2014 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Tests for Curtin-related utilities."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+str = None
+
+__metaclass__ = type
+__all__ = []
+
+from maastesting.factory import factory
+from maastesting.testcase import MAASTestCase
+from provisioningserver.utils.curtin import (
+    compose_mv_command,
+    compose_write_text_file,
+    )
+from testtools.matchers import (
+    AllMatch,
+    ContainsAll,
+    IsInstance,
+    )
+
+
+class TestComposeMvCommand(MAASTestCase):
+
+    def test__returns_command_list(self):
+        command = compose_mv_command(
+            factory.make_name('source'), factory.make_name('dest'))
+        self.expectThat(command, IsInstance(list))
+        self.expectThat(command, AllMatch(IsInstance(unicode)))
+
+    def test__runs_command_in_target(self):
+        command = compose_mv_command(
+            factory.make_name('source'), factory.make_name('dest'))
+        self.assertEqual(['curtin', 'in-target', '--'], command[:3])
+
+    def test__moves_file(self):
+        source = factory.make_name('source')
+        dest = factory.make_name('dest')
+        self.assertEqual(
+            ['mv', '--', source, dest],
+            compose_mv_command(source, dest)[-4:])
+
+
+class TestComposeWriteTextFile(MAASTestCase):
+
+    def test__returns_complete_write_file_dict(self):
+        preseed = compose_write_text_file(
+            factory.make_name('file'), factory.make_name('content'))
+        self.expectThat(preseed, IsInstance(dict))
+        self.expectThat(
+            preseed.keys(),
+            ContainsAll(['path', 'content', 'owner', 'permissions']))
+
+    def test__obeys_path_param(self):
+        path = factory.make_name('path')
+        preseed = compose_write_text_file(path, factory.make_name('content'))
+        self.assertEqual(path, preseed['path'])
+
+    def test__obeys_content_param(self):
+        content = factory.make_name('content')
+        preseed = compose_write_text_file(factory.make_name('path'), content)
+        self.assertEqual(content, preseed['content'])
+
+    def test__defaults_owner_to_root(self):
+        preseed = compose_write_text_file(
+            factory.make_name('file'), factory.make_name('content'))
+        self.assertEqual('root:root', preseed['owner'])
+
+    def test__obeys_owner_param(self):
+        owner = '%s:%s' % (
+            factory.make_name('user'),
+            factory.make_name('group'),
+            )
+        preseed = compose_write_text_file(
+            factory.make_name('file'), factory.make_name('content'),
+            owner=owner)
+        self.assertEqual(owner, preseed['owner'])
+
+    def test__defaults_permissions_to_0600(self):
+        preseed = compose_write_text_file(
+            factory.make_name('file'), factory.make_name('content'))
+        self.assertEqual('0600', preseed['permissions'])
+
+    def test__obeys_permissions_param(self):
+        permissions = 0123
+        preseed = compose_write_text_file(
+            factory.make_name('file'), factory.make_name('content'),
+            permissions=permissions)
+        self.assertEqual('0123', preseed['permissions'])