Merge lp:~jtv/maas/move-udev-code into lp:~maas-committers/maas/trunk

[Jeroen T. Vermeulen]

Move the code for generating udev rules server-side from maasserver to provisioningserver. Needed to allow the OS-specific code in the cluster to generate its own Curtin networking preseed.

The code just moves unchanged, but I extended the test coverage. On a sidenote, it's nice to have some more of the code (and especially tests) clearly independent from the database.

Jeroen

[Gavin Panella (allenap)]

review: Approve

=== modified file 'src/maasserver/networking_preseed.py'
--- src/maasserver/networking_preseed.py	2014-09-26 11:35:28 +0000
+++ src/maasserver/networking_preseed.py	2014-09-29 03:38:08 +0000
@@ -29,7 +29,6 @@
     ]
 
 from collections import defaultdict
-from textwrap import dedent
 
 from lxml import etree
 from maasserver.dns.zonegenerator import get_dns_server_address
@@ -381,64 +380,3 @@
                 compose_debian_network_interfaces_ipv6_stanza(
                     interface, static_ipv6, gateway))
     return '%s\n' % '\n\n'.join(stanzas)
-
-
-def compose_udev_equality(key, value):
-    """Return a udev comparison clause, like `ACTION=="add"`."""
-    assert key == key.upper()
-    return '%s=="%s"' % (key, value)
-
-
-def compose_udev_attr_equality(attribute, value):
-    """Return a udev attribute comparison clause, like `ATTR{type}=="1"`."""
-    assert attribute == attribute.lower()
-    return 'ATTR{%s}=="%s"' % (attribute, value)
-
-
-def compose_udev_setting(key, value):
-    """Return a udev assignment clause, like `NAME="eth0"`."""
-    assert key == key.upper()
-    return '%s="%s"' % (key, value)
-
-
-def compose_udev_rule(interface, mac):
-    """Return a udev rule to set the name of network interface with `mac`.
-
-    The rule ends up as a single line looking something like:
-
-        SUBSYSTEM=="net", ACTION=="add", DRIVERS=="?*",
-        ATTR{address}="ff:ee:dd:cc:bb:aa", NAME="eth0"
-
-    (Note the difference between `=` and `==`: they both occur.)
-    """
-    rule = ', '.join([
-        compose_udev_equality('SUBSYSTEM', 'net'),
-        compose_udev_equality('ACTION', 'add'),
-        compose_udev_equality('DRIVERS', '?*'),
-        compose_udev_attr_equality('address', mac),
-        compose_udev_setting('NAME', interface),
-        ])
-    return '%s\n' % rule
-
-
-def compose_linux_udev_rules_file(interfaces):
-    """Return text for a udev persistent-net rules file.
-
-    These rules assign fixed names to network interfaces.  They ensure that
-    the same network interface cards come up with the same interface names on
-    every boot.  Otherwise, the kernel may assign interface names in different
-    orders on every boot, and so network interfaces can "switch identities"
-    every other time the machine reboots.
-
-    :param interfaces: List of tuples of interface name and MAC address.
-    :return: Text to write into a udev rules file.
-    """
-    rules = [
-        compose_udev_rule(interface, mac)
-        for interface, mac in interfaces
-        ]
-    return dedent("""\
-        # MAAS-assigned network interface names.
-        %s
-        # End of MAAS-assigned network interface names.
-        """) % '\n\n'.join(rules)

=== modified file 'src/maasserver/tests/test_networking_preseed.py'
--- src/maasserver/tests/test_networking_preseed.py	2014-09-26 11:35:28 +0000
+++ src/maasserver/tests/test_networking_preseed.py	2014-09-29 03:38:08 +0000
@@ -31,7 +31,6 @@
     compose_debian_network_interfaces_file,
     compose_debian_network_interfaces_ipv4_stanza,
     compose_debian_network_interfaces_ipv6_stanza,
-    compose_linux_udev_rules_file,
     extract_mac_string,
     extract_network_interfaces,
     generate_dns_server_entry,
@@ -886,17 +885,3 @@
 
         self.assertIn('auto %s' % interface, interfaces_file)
         self.assertEqual(1, interfaces_file.count('auto %s' % interface))
-
-
-class TestComposeLinuxUdevRulesFile(MAASServerTestCase):
-
-    def test__generates_udev_rule(self):
-        interface = factory.make_name('eth')
-        mac = factory.make_mac_address()
-        expected_rule = (
-            '\nSUBSYSTEM=="net", ACTION=="add", DRIVERS=="?*", '
-            'ATTR{address}=="%(mac)s", NAME="%(interface)s"\n'
-            ) % {'mac': mac, 'interface': interface}
-        self.assertIn(
-            expected_rule,
-            compose_linux_udev_rules_file([(interface, mac)]))

=== added file 'src/provisioningserver/tests/test_udev.py'
--- src/provisioningserver/tests/test_udev.py	1970-01-01 00:00:00 +0000
+++ src/provisioningserver/tests/test_udev.py	2014-09-29 03:38:08 +0000
@@ -0,0 +1,89 @@
+# Copyright 2014 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Tests for udev rules generation code."""
+
+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.udev import (
+    compose_network_interfaces_udev_rules,
+    compose_udev_attr_equality,
+    compose_udev_equality,
+    compose_udev_rule,
+    compose_udev_setting,
+    )
+from testtools.matchers import ContainsAll
+
+
+class TestComposeUdevEquality(MAASTestCase):
+
+    def test__generates_comparison_with_double_equals_sign(self):
+        self.assertEqual('KEY=="value"', compose_udev_equality('KEY', 'value'))
+
+    def test__rejects_lower_case_letters_in_key(self):
+        self.assertRaises(
+            AssertionError,
+            compose_udev_equality, 'key', 'value')
+
+
+class TestComposeUdevAttrEquality(MAASTestCase):
+
+    def test__generates_comparison_with_double_equals_sign(self):
+        self.assertEqual(
+            'ATTR{key}=="value"',
+            compose_udev_attr_equality('key', 'value'))
+
+    def test__rejects_upper_case_letters_in_key(self):
+        self.assertRaises(
+            AssertionError,
+            compose_udev_attr_equality, 'KEY', 'value')
+
+
+class TestComposeUdevSetting(MAASTestCase):
+
+    def test__generates_assignment_with_single_equals_sign(self):
+        self.assertEqual('KEY="value"', compose_udev_setting('KEY', 'value'))
+
+    def test__rejects_lower_case_letters_in_key(self):
+        self.assertRaises(
+            AssertionError,
+            compose_udev_setting, 'key', 'value')
+
+
+class TestComposeUdevRule(MAASTestCase):
+
+    def test__generates_rule(self):
+        interface = factory.make_name('eth')
+        mac = factory.make_mac_address()
+        expected_rule = (
+            'SUBSYSTEM=="net", ACTION=="add", DRIVERS=="?*", '
+            'ATTR{address}=="%(mac)s", NAME="%(interface)s"\n'
+            ) % {'mac': mac, 'interface': interface}
+        self.assertEqual(expected_rule, compose_udev_rule(interface, mac))
+
+
+class TestComposeNetworkInterfacesUdevRules(MAASTestCase):
+
+    def test__generates_udev_rules(self):
+        interfaces = [
+            (factory.make_name('eth'), factory.make_mac_address())
+            for _ in range(2)
+            ]
+
+        self.assertThat(
+            compose_network_interfaces_udev_rules(interfaces),
+            ContainsAll([
+                'ATTR{address}=="%s", NAME="%s"\n' % (interface, mac)
+                for mac, interface in interfaces
+                ]))

=== added file 'src/provisioningserver/udev.py'
--- src/provisioningserver/udev.py	1970-01-01 00:00:00 +0000
+++ src/provisioningserver/udev.py	2014-09-29 03:38:08 +0000
@@ -0,0 +1,80 @@
+# Copyright 2014 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Code to generate `udev` rules."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+str = None
+
+__metaclass__ = type
+__all__ = [
+    'compose_network_interfaces_udev_rules',
+    ]
+
+from textwrap import dedent
+
+
+def compose_udev_equality(key, value):
+    """Return a udev comparison clause, like `ACTION=="add"`."""
+    assert key == key.upper()
+    return '%s=="%s"' % (key, value)
+
+
+def compose_udev_attr_equality(attribute, value):
+    """Return a udev attribute comparison clause, like `ATTR{type}=="1"`."""
+    assert attribute == attribute.lower()
+    return 'ATTR{%s}=="%s"' % (attribute, value)
+
+
+def compose_udev_setting(key, value):
+    """Return a udev assignment clause, like `NAME="eth0"`."""
+    assert key == key.upper()
+    return '%s="%s"' % (key, value)
+
+
+def compose_udev_rule(interface, mac):
+    """Return a udev rule to set the name of network interface with `mac`.
+
+    The rule ends up as a single line looking something like:
+
+        SUBSYSTEM=="net", ACTION=="add", DRIVERS=="?*",
+        ATTR{address}="ff:ee:dd:cc:bb:aa", NAME="eth0"
+
+    (Note the difference between `=` and `==`: they both occur.)
+    """
+    rule = ', '.join([
+        compose_udev_equality('SUBSYSTEM', 'net'),
+        compose_udev_equality('ACTION', 'add'),
+        compose_udev_equality('DRIVERS', '?*'),
+        compose_udev_attr_equality('address', mac),
+        compose_udev_setting('NAME', interface),
+        ])
+    return '%s\n' % rule
+
+
+def compose_network_interfaces_udev_rules(interfaces):
+    """Return text for a udev persistent-net rules file.
+
+    These rules assign fixed names to network interfaces.  They ensure that
+    the same network interface cards come up with the same interface names on
+    every boot.  Otherwise, the kernel may assign interface names in different
+    orders on every boot, and so network interfaces can "switch identities"
+    every other time the machine reboots.
+
+    :param interfaces: List of tuples of interface name and MAC address.
+    :return: Text to write into a udev rules file.
+    """
+    rules = [
+        compose_udev_rule(interface, mac)
+        for interface, mac in interfaces
+        ]
+    return dedent("""\
+        # MAAS-assigned network interface names.
+        %s
+        # End of MAAS-assigned network interface names.
+        """) % '\n\n'.join(rules)