Merge lp:~blake-rouse/maas/node-effective-license-key into lp:~maas-committers/maas/trunk

[Blake Rouse]

Adds the effective license key into the node context for the preseed. Allows preseed templates to access the effective license key .

This is the second part of a series of changes to allow a global registry of license key's in MAAS. The end result will allow a user to set a license key for each operating system and series globally. When a booting operating system and series requires a license key, first the node will be check to see if a specific key has been set in the license_key field. If not then this LicenseKey model will be used to see if one is set globally for the selected operating system and series.

This branch includes the logic to return the correct license key for the preseed. get_effective_license_key contains the logic to retrieve the global license key if a license key is not set on the node.

[Jeroen T. Vermeulen (jtv)]

Short and sweet. The explanation of what it means to get an "effective" licence key would go nicely in the docstring for get_effectivel_license_key.

Out of interest, why the calls to both LicenseKey.objects.has_license_key and LicenseKey.objects.get_license_key? Depending on the semantics, they sound a bit as if the combination is effectively one operation on LicenseKey.objects.

review: Approve

[Blake Rouse (blake-rouse)]

At the time it was to make the code read easier, but looking back it doesn't. So I have changed it to just one call with a catch on DoesNotExist.

Updated the docstring as well.

Thanks.

=== modified file 'src/maasserver/models/node.py'
--- src/maasserver/models/node.py	2014-06-26 05:01:45 +0000
+++ src/maasserver/models/node.py	2014-06-27 11:36:23 +0000
@@ -68,6 +68,7 @@
 from maasserver.models.cleansave import CleanSave
 from maasserver.models.config import Config
 from maasserver.models.dhcplease import DHCPLease
+from maasserver.models.licensekey import LicenseKey
 from maasserver.models.staticipaddress import (
     StaticIPAddress,
     StaticIPAddressExhaustion,
@@ -1046,6 +1047,32 @@
         else:
             return self.distro_series
 
+    def get_effective_license_key(self):
+        """Return effective license key.
+
+        This returns the license key that should be used during the
+        installation of the operating system for this node. This method first
+        checks to see if the node has a specific license key set, if not then
+        the license key registry is checked, if neither exists for this node or
+        the booting operating system and release combination then an empty
+        string is returned. An empty string can mean two things, one the
+        operating system does not require a license key, or the installation
+        media already has the license key builtin.
+        """
+        use_global_license_key = (
+            self.license_key is None or
+            self.license_key == '')
+        if use_global_license_key:
+            osystem = self.get_osystem()
+            distro_series = self.get_distro_series()
+            try:
+                return LicenseKey.objects.get_license_key(
+                    osystem, distro_series)
+            except LicenseKey.DoesNotExist:
+                return ''
+        else:
+            return self.license_key
+
     def get_effective_power_parameters(self):
         """Return effective power parameters, including any defaults."""
         if self.power_parameters:

=== modified file 'src/maasserver/models/tests/test_node.py'
--- src/maasserver/models/tests/test_node.py	2014-06-27 02:05:14 +0000
+++ src/maasserver/models/tests/test_node.py	2014-06-27 11:36:23 +0000
@@ -37,6 +37,7 @@
 from maasserver.fields import MAC
 from maasserver.models import (
     Config,
+    LicenseKey,
     MACAddress,
     Node,
     node as node_module,
@@ -296,6 +297,24 @@
         series = Config.objects.get_config('default_distro_series')
         self.assertEqual(series, node.get_distro_series())
 
+    def test_get_effective_license_key_returns_node_value(self):
+        license_key = factory.make_name('license_key')
+        node = factory.make_node(license_key=license_key)
+        self.assertEqual(license_key, node.get_effective_license_key())
+
+    def test_get_effective_license_key_returns_blank(self):
+        node = factory.make_node()
+        self.assertEqual('', node.get_effective_license_key())
+
+    def test_get_effective_license_key_returns_global(self):
+        license_key = factory.make_name('license_key')
+        osystem = factory.make_name('os')
+        series = factory.make_name('series')
+        LicenseKey.objects.create(
+            osystem=osystem, distro_series=series, license_key=license_key)
+        node = factory.make_node(osystem=osystem, distro_series=series)
+        self.assertEqual(license_key, node.get_effective_license_key())
+
     def test_delete_node_deletes_related_mac(self):
         node = factory.make_node()
         mac = node.add_mac_address('AA:BB:CC:DD:EE:FF')

=== modified file 'src/maasserver/preseed.py'
--- src/maasserver/preseed.py	2014-06-25 16:29:11 +0000
+++ src/maasserver/preseed.py	2014-06-27 11:36:23 +0000
@@ -453,6 +453,7 @@
         'preseed_data': compose_preseed(get_preseed_type_for(node), node),
         'node_disable_pxe_url': node_disable_pxe_url,
         'node_disable_pxe_data': node_disable_pxe_data,
+        'license_key': node.get_effective_license_key(),
     }
 
 

=== modified file 'src/maasserver/tests/test_preseed.py'
--- src/maasserver/tests/test_preseed.py	2014-06-25 16:49:53 +0000
+++ src/maasserver/tests/test_preseed.py	2014-06-27 11:36:23 +0000
@@ -499,7 +499,7 @@
         self.assertItemsEqual(
             ['driver', 'driver_package', 'node',
              'node_disable_pxe_data', 'node_disable_pxe_url',
-             'preseed_data', 'third_party_drivers',
+             'preseed_data', 'third_party_drivers', 'license_key',
              ],
             context)