Merge ~ack/maas:1862514-drop-hpdsa-driver-2.7 into maas:2.7

[Alberto Donato]

LP: #1862514 - filter third party drivers by series

[Alberto Donato (ack)]

We don't want to backport this to 2.7

review: Disapprove

diff --git a/etc/maas/drivers.yaml b/etc/maas/drivers.yaml
index a7461f6..2d3724c 100644
--- a/etc/maas/drivers.yaml
+++ b/etc/maas/drivers.yaml
@@ -19,6 +19,8 @@ drivers:
   module: hpvsa
   package: hpvsa
   repository: http://ppa.launchpad.net/hp-iss-team/hpvsa-update/ubuntu
+  series:
+    - trusty
 - comment: Cisco snic DKMS driver
   key_binary: !!binary |
          mQINBFRjf2EBEADVD60xGOaZj8ahKJNRoi6rtzfjzwzTLzntzeXj8rLM99cca9mxsObGMKfHz9PP
@@ -46,6 +48,8 @@ drivers:
   module: snic
   package: snic-dkms
   repository: http://ppa.launchpad.net/cisco-ucs-team/snic-stable/ubuntu
+  series:
+    - trusty
 - blacklist: ahci
   comment: HPDSA driver
   key_binary: !!binary |
@@ -76,3 +80,5 @@ drivers:
   module: hpdsa
   package: hpdsa-dkms
   repository: http://downloads.linux.hpe.com/SDR/repo/ubuntu-hpdsa
+  series:
+    - trusty
diff --git a/src/maasserver/preseed.py b/src/maasserver/preseed.py
index fd545dd..36c6567 100644
--- a/src/maasserver/preseed.py
+++ b/src/maasserver/preseed.py
@@ -854,7 +854,7 @@ def get_node_preseed_context(request, node, osystem="", release=""):
         reverse("metadata-node-by-id", args=["latest", node.system_id])
     )
     node_disable_pxe_data = urlencode({"op": "netboot_off"})
-    driver = get_third_party_driver(node)
+    driver = get_third_party_driver(node, series=release)
     return {
         "third_party_drivers": (
             Config.objects.get_config("enable_third_party_drivers")
diff --git a/src/maasserver/rpc/boot.py b/src/maasserver/rpc/boot.py
index 5fb6b5c..31030cb 100644
--- a/src/maasserver/rpc/boot.py
+++ b/src/maasserver/rpc/boot.py
@@ -518,7 +518,7 @@ def get_config(
         # Add any extra options from a third party driver.
         use_driver = configs["enable_third_party_drivers"]
         if use_driver:
-            driver = get_third_party_driver(machine)
+            driver = get_third_party_driver(machine, series=series)
             driver_kernel_opts = driver.get("kernel_opts", "")
 
             combined_opts = (
diff --git a/src/maasserver/rpc/tests/test_boot.py b/src/maasserver/rpc/tests/test_boot.py
index d45dc99..9055aa0 100644
--- a/src/maasserver/rpc/tests/test_boot.py
+++ b/src/maasserver/rpc/tests/test_boot.py
@@ -160,6 +160,26 @@ class TestGetConfig(MAASServerTestCase):
             hardware_uuid=node.hardware_uuid,
         )
 
+    def test__gets_drivers_for_series(self):
+        rack_controller = factory.make_RackController()
+        local_ip = factory.make_ip_address()
+        remote_ip = factory.make_ip_address()
+        node = self.make_node(status=NODE_STATUS.DEPLOYING)
+        mac = node.get_boot_interface().mac_address
+        mock_get_third_party_driver = self.patch(
+            boot_module, "get_third_party_driver"
+        )
+        Config.objects.set_config("default_distro_series", "focal")
+        self.patch_autospec(boot_module, "event_log_pxe_request")
+        get_config(
+            rack_controller.system_id,
+            local_ip,
+            remote_ip,
+            mac=mac,
+            hardware_uuid=node.hardware_uuid,
+        )
+        mock_get_third_party_driver.assert_called_with(node, series="focal")
+
     def test__returns_success_for_known_node_mac(self):
         rack_controller = factory.make_RackController()
         local_ip = factory.make_ip_address()
diff --git a/src/maasserver/tests/test_third_party_drivers.py b/src/maasserver/tests/test_third_party_drivers.py
index 6e3fe14..030806d 100644
--- a/src/maasserver/tests/test_third_party_drivers.py
+++ b/src/maasserver/tests/test_third_party_drivers.py
@@ -84,7 +84,7 @@ class TestPopulateKernelOpts(MAASServerTestCase):
         self.assertNotIn("kernel_opts", driver)
 
 
-class TestGetThirdPartyCode(MAASServerTestCase):
+class TestGetThirdPartyDriver(MAASServerTestCase):
     def test_finds_match(self):
         node = factory.make_Node()
         mock = self.patch(third_party_drivers, "match_aliases_to_driver")
@@ -105,6 +105,32 @@ class TestGetThirdPartyCode(MAASServerTestCase):
         driver = get_third_party_driver(node)
         self.assertEqual({}, driver)
 
+    def test_matching_series(self):
+        node = factory.make_Node()
+        driver = {"series": ["xenial", "bionic"], "name": "somedriver"}
+        self.patch(
+            third_party_drivers, "match_aliases_to_driver"
+        ).return_value = driver
+        self.assertEqual(get_third_party_driver(node, series="bionic"), driver)
+
+    def test_not_matching_series(self):
+        node = factory.make_Node()
+        driver = {"series": ["xenial", "bionic"], "name": "somedriver"}
+        self.patch(
+            third_party_drivers, "match_aliases_to_driver"
+        ).return_value = driver
+        self.assertEqual(get_third_party_driver(node, series="precise"), {})
+
+    def test_series_without_available_series(self):
+        node = factory.make_Node()
+        driver = {"name": "somedriver"}
+        self.patch(
+            third_party_drivers, "match_aliases_to_driver"
+        ).return_value = driver
+        self.assertEqual(
+            get_third_party_driver(node, series="precise"), driver
+        )
+
 
 class TestDriversConfig(MAASServerTestCase):
     def test_get_defaults_returns_empty_drivers_list(self):
@@ -123,6 +149,7 @@ class TestDriversConfig(MAASServerTestCase):
                     "module",
                     "repository",
                     "package",
+                    "series",
                 ],
                 entry.keys(),
             )
diff --git a/src/maasserver/third_party_drivers.py b/src/maasserver/third_party_drivers.py
index b325512..9401100 100644
--- a/src/maasserver/third_party_drivers.py
+++ b/src/maasserver/third_party_drivers.py
@@ -74,6 +74,8 @@ module - The name of the kernel module to load on the target system.
 repository - The URL of the repository to load packages from. The should
 repository contain both deb and udeb packages for the driver.
 
+series - List of Ubuntu series codenames to install the driver for.
+
 packages - The name of the deb package to retrieve from the repository.
 """
 
@@ -90,6 +92,7 @@ class ConfigDriver(Schema):
     module = String()
     package = String()
     repository = String()
+    series = ForEach(String)
 
 
 class DriversConfigMeta(ConfigMeta):
@@ -127,11 +130,13 @@ def populate_kernel_opts(driver):
     return driver
 
 
-def get_third_party_driver(node, detected_aliases=None):
+def get_third_party_driver(node, detected_aliases=None, series=""):
     """Determine which, if any, third party driver is required.
 
     Use the node's modaliases strings to determine if a third party
     driver is required.
+
+    Drivers are filtered for the specified series.
     """
     if detected_aliases is None:
         detected_aliases = node.modaliases
@@ -144,9 +149,12 @@ def get_third_party_driver(node, detected_aliases=None):
     )
 
     if matched_driver is None:
-        return dict()
+        return {}
+
+    available_series = matched_driver.get("series", [])
+    if available_series and series not in available_series:
+        return {}
 
     driver = deepcopy(matched_driver)
     driver = populate_kernel_opts(driver)
-
     return driver
diff --git a/src/maasserver/websockets/handlers/node.py b/src/maasserver/websockets/handlers/node.py
index 03ce848..943fb40 100644
--- a/src/maasserver/websockets/handlers/node.py
+++ b/src/maasserver/websockets/handlers/node.py
@@ -397,7 +397,11 @@ class NodeHandler(TimestampedModelHandler):
                                 modaliases = script_result.stdout.decode(
                                     "utf-8"
                                 ).splitlines()
-                    driver = get_third_party_driver(obj, modaliases)
+                    driver = get_third_party_driver(
+                        obj,
+                        detected_aliases=modaliases,
+                        series=obj.distro_series,
+                    )
                     if "module" in driver and "comment" in driver:
                         data["third_party_driver"] = {
                             "module": driver["module"],
diff --git a/src/maasserver/websockets/handlers/tests/test_machine.py b/src/maasserver/websockets/handlers/tests/test_machine.py
index 7307c56..0af3a36 100644
--- a/src/maasserver/websockets/handlers/tests/test_machine.py
+++ b/src/maasserver/websockets/handlers/tests/test_machine.py
@@ -98,6 +98,7 @@ from maasserver.websockets.base import (
     HandlerValidationError,
 )
 from maasserver.websockets.handlers import machine as machine_module
+from maasserver.websockets.handlers import node as node_module
 from maasserver.websockets.handlers.event import dehydrate_event_type_level
 from maasserver.websockets.handlers.machine import MachineHandler
 from maasserver.websockets.handlers.machine import Node as node_model
@@ -316,16 +317,17 @@ class TestMachineHandler(MAASServerTestCase):
             "system_id": node.system_id,
             "hardware_uuid": node.hardware_uuid,
             "tags": [tag.name for tag in node.tags.all()],
-            "third_party_driver": {
-                "module": driver["module"] if "module" in driver else "",
-                "comment": driver["comment"] if "comment" in driver else "",
-            },
             "node_type": node.node_type,
             "updated": dehydrate_datetime(node.updated),
             "zone": handler.dehydrate_zone(node.zone),
             "pool": handler.dehydrate_pool(node.pool),
             "default_user": node.default_user,
         }
+        if "module" in driver and "comment" in driver:
+            data["third_party_driver"] = {
+                "module": driver["module"],
+                "comment": driver["comment"],
+            }
         if boot_interface:
             data["vlan"] = handler.dehydrate_vlan(node, boot_interface)
             data["ip_addresses"] = handler.dehydrate_all_ip_addresses(node)
@@ -1939,6 +1941,25 @@ class TestMachineHandler(MAASServerTestCase):
             ),
         )
 
+    def test_get_driver_for_series(self):
+        user = factory.make_User()
+        handler = MachineHandler(user, {}, None)
+        node = factory.make_Node_with_Interface_on_Subnet(
+            with_empty_script_sets=True
+        )
+        node.distro_series = "bionic"
+        node.save()
+        Config.objects.set_config(
+            name="enable_third_party_drivers", value=True
+        )
+        mock_get_third_party_driver = self.patch(
+            node_module, "get_third_party_driver"
+        )
+        handler.dehydrate(node, {})
+        mock_get_third_party_driver.assert_called_with(
+            node, detected_aliases=[], series="bionic"
+        )
+
     def test_get_numa_node_only_physical_interfaces(self):
         user = factory.make_User()
         handler = MachineHandler(user, {}, None)