Merge lp:~jtv/maas/add-curtin-network-preseed-to-osystems-rpc-layer into lp:~maas-committers/maas/trunk

[Jeroen T. Vermeulen]

Add a missing piece to the RPC layercake for the compose_curtin_network_preseed call: a wrapper in maasserver.clusterrpc.osystems.

This follows the patterns I see in the other OS-related RPC code. It looks like this is also where the documentation for parameters goes, so I moved it from the definition of the call itself (where none of the other definitions had this documentation).

Jeroen

[Raphaël Badin (rvb)]

Looks good.

review: Approve

[Jeroen T. Vermeulen (jtv)]

All done. Thanks for the review. It's hateful how many places need this documentation copied around, or go undocumented, all for *one* call site passing through the whole chain...

=== modified file 'src/maasserver/clusterrpc/osystems.py'
--- src/maasserver/clusterrpc/osystems.py	2014-09-27 12:55:30 +0000
+++ src/maasserver/clusterrpc/osystems.py	2014-10-02 04:17:00 +0000
@@ -13,6 +13,7 @@
 
 __metaclass__ = type
 __all__ = [
+    "compose_curtin_network_preseed",
     "gen_all_known_operating_systems",
     "get_preseed_data",
     "validate_license_key",
@@ -32,6 +33,7 @@
 from maasserver.utils import async
 from maasserver.utils.orm import get_one
 from provisioningserver.rpc.cluster import (
+    ComposeCurtinNetworkPreseed,
     GetOSReleaseTitle,
     GetPreseedData,
     ListOperatingSystems,
@@ -135,6 +137,30 @@
 
 
 @synchronous
+def compose_curtin_network_preseed(node, config):
+    """Generate a Curtin network preseed for a node.
+
+    :param node: A `Node`.
+    :param config: A dict detailing the network configuration:
+        `interfaces` maps to a list of pairs of interface name and MAC address.
+        `auto_interfaces` maps to a list of MAC addresses for those network
+        interfaces that should come up automatically on node boot.
+        `ips_mapping` maps to a dict which maps MAC addresses to lists of
+        IP addresses (at most one IPv4 and one IPv6 each) to be assigned to the
+        corresponding network interfaces.
+        `gateways_mapping` maps to a dict which maps MAC addresses to lists of
+        gateway IP addresses (at most one IPv4 and one IPv6) to be used by the
+        corresponding network interfaces.
+    :param disable_ipv4: Should IPv4 networking be disabled on the node?
+    """
+    client = getClientFor(node.nodegroup.uuid)
+    call = client(
+        ComposeCurtinNetworkPreseed, osystem=node.get_osystem(), config=config,
+        disable_ipv4=node.disable_ipv4)
+    return call.wait(30).get("data")
+
+
+@synchronous
 def validate_license_key_for(nodegroup, osystem, release, key):
     """Validate license key for the given nodegroup, OS, and release.
 

=== modified file 'src/maasserver/clusterrpc/tests/test_osystems.py'
--- src/maasserver/clusterrpc/tests/test_osystems.py	2014-09-27 04:40:39 +0000
+++ src/maasserver/clusterrpc/tests/test_osystems.py	2014-10-02 04:17:00 +0000
@@ -20,6 +20,7 @@
     )
 
 from maasserver.clusterrpc.osystems import (
+    compose_curtin_network_preseed,
     gen_all_known_operating_systems,
     get_os_release_title,
     get_preseed_data,
@@ -242,6 +243,26 @@
             metadata_url=factory.make_url())
 
 
+class TestComposeCurtinPreseedData(MAASServerTestCase):
+
+    def make_config(self):
+        mac = factory.make_mac_address()
+        return {
+            'interfaces': [(factory.make_name('eth'), mac)],
+            'auto_interfaces': [mac],
+            'ips_mapping': {},
+            'gateways_mapping': {mac: [factory.make_ipv6_address()]},
+            }
+
+    def test__returns_preseed_data(self):
+        node = factory.make_Node()
+        node.nodegroup.accept()
+        self.useFixture(RunningClusterRPCFixture())
+        config = self.make_config()
+        preseed = compose_curtin_network_preseed(node, config)
+        self.assertIsInstance(preseed, list)
+
+
 class TestValidateLicenseKeyFor(MAASServerTestCase):
     """Tests for `validate_license_key_for`."""
 

=== modified file 'src/provisioningserver/rpc/cluster.py'
--- src/provisioningserver/rpc/cluster.py	2014-10-01 03:58:43 +0000
+++ src/provisioningserver/rpc/cluster.py	2014-10-02 04:17:00 +0000
@@ -16,6 +16,7 @@
 
 __metaclass__ = type
 __all__ = [
+    "ComposeCurtinNetworkPreseed",
     "ConfigureDHCPv4",
     "ConfigureDHCPv6",
     "CreateHostMaps",
@@ -188,18 +189,6 @@
 class ComposeCurtinNetworkPreseed(amp.Command):
     """Generate Curtin network preseed for a node.
 
-    :param osystem: Operating system identifier, e.g. `ubuntu`.
-    :param config: A dict detailing the network configuration:
-        `interfaces` maps to a list of pairs of interface name and MAC address.
-        `auto_interfaces` maps to a list of MAC addresses for those network
-        interfaces that should come up automatically on node boot.
-        `ips_mapping` maps to a dict which maps MAC addresses to lists of
-        IP addresses (at most one IPv4 and one IPv6 each) to be assigned to the
-        corresponding network interfaces.
-        `gateways_mapping` maps to a dict which maps MAC addresses to lists of
-        gateway IP addresses (at most one IPv4 and one IPv6) to be used by the
-        corresponding network interfaces.
-    :param disable_ipv4: Should IPv4 networking be disabled on the node?
     :since: 1.7
     """