Merge ~adam-collard/maas:3.1-relax-custom-image-validation into maas:3.1

[Adam Collard]

LP:1978154: Don't require netplan for custom CentOS images

We erroneously checked custom CentOS images for netplan, remove that.

Switch to using `rpm -q` for package installation (a more reaonable
translation of `dpkq-query -s`)

Validate RHEL based custom images too.

(cherry picked from commit 9877850af9d3ba9d281b5de9518c9997d0d25dc9 )

[Adam Collard (adam-collard)]

self-approve backport

review: Approve

[MAAS Lander (maas-lander)]

UNIT TESTS
-b 3.1-relax-custom-image-validation lp:~adam-collard/maas/+git/maas into -b 3.1 lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/13091/console
COMMIT: aa80d2c2ad01d91b4b9052758e938559e36ae9d7

review: Needs Fixing

faa15ce... by Adam Collard on 2022-06-28

Fix use of undefined LINUX_OSYSTEMS

Signed-off-by: Adam Collard <email address hidden>

[MAAS Lander (maas-lander)]

UNIT TESTS
-b 3.1-relax-custom-image-validation lp:~adam-collard/maas/+git/maas into -b 3.1 lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/13092/console
COMMIT: b2a26962d2cec71bfc178b46322558d33d344870

review: Needs Fixing

[MAAS Lander (maas-lander)]

UNIT TESTS
-b 3.1-relax-custom-image-validation lp:~adam-collard/maas/+git/maas into -b 3.1 lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/13094/console
COMMIT: faa15ce62428ef64a79fe99bfcd759619ce23175

review: Needs Fixing

diff --git a/src/maasserver/preseed.py b/src/maasserver/preseed.py
index 4ea3beb..90102aa 100644
--- a/src/maasserver/preseed.py
+++ b/src/maasserver/preseed.py
@@ -7,8 +7,10 @@ from collections import namedtuple
 import json
 import os.path
 from pipes import quote
+import typing
 from urllib.parse import urlencode, urlparse
 
+import attr
 from crochet import TimeoutError
 from curtin.config import merge_config
 from curtin.pack import pack_install
@@ -595,6 +597,20 @@ def get_curtin_config(request, node, base_osystem=None, base_series=None):
     return yaml.safe_dump(config)
 
 
+@attr.s(auto_attribs=True)
+class PackageManager:
+
+    package_tool: str
+    deps: typing.List[str]
+
+
+PACKAGE_MANAGER_PER_OS = {
+    "ubuntu": PackageManager("dpkg-query -s", ["cloud-init", "netplan.io"]),
+    "centos": PackageManager("rpm -q", ["cloud-init"]),
+    "rhel": PackageManager("rpm -q", ["cloud-init"]),
+}
+
+
 def get_custom_image_dependency_validation(node, base_osystem):
     if node.get_osystem() != "custom":
         return None
@@ -602,33 +618,18 @@ def get_custom_image_dependency_validation(node, base_osystem):
     cmd = {}
     err_msg = "not detected, MAAS will not be able to configure this machine properly"
 
-    deps = ["cloud-init", "netplan.io"]
-    for i, dep in enumerate(deps):
-        in_target = None
-        if base_osystem == "ubuntu":
-            in_target = 'dpkg-query -s {dep} || (echo "{dep} {err_msg}" && exit 1)'.format(
-                dep=dep, err_msg=err_msg
-            )
-        if base_osystem == "centos":
-            in_target = (
-                'dnf list {dep} || (echo "{dep} {err_msg}" && exit 1)'.format(
-                    dep=dep, err_msg=err_msg
-                )
-            )
-
-        if in_target is not None:
-            cmd[
-                "{priority}-validate-custom-image-has-{dep}".format(
-                    priority=98 + i, dep=dep
-                )
-            ] = [
-                "curtin",
-                "in-target",
-                "--",
-                "bash",
-                "-c",
-                in_target,
-            ]
+    package_manager = PACKAGE_MANAGER_PER_OS[base_osystem]
+
+    for priority, dep in enumerate(package_manager.deps, start=98):
+        in_target = f'{package_manager.package_tool} {dep} || (echo "{dep} {err_msg}" && exit 1)'
+        cmd[f"{priority}-validate-custom-image-has-{dep}"] = [
+            "curtin",
+            "in-target",
+            "--",
+            "bash",
+            "-c",
+            in_target,
+        ]
     return cmd
 
 
diff --git a/src/maasserver/tests/test_preseed.py b/src/maasserver/tests/test_preseed.py
index 6239aaf..2ddca2f 100644
--- a/src/maasserver/tests/test_preseed.py
+++ b/src/maasserver/tests/test_preseed.py
@@ -322,20 +322,20 @@ class TestGetPreseedTemplate(MAASServerTestCase):
 class TestGetCustomImageDependencyValidation(MAASServerTestCase):
     """Tests for 'get_custom_image_dependency_validation"""
 
-    def test_get_custom_image_dependency_validation_for_custom_ubuntu(self):
+    def test_validation_for_custom_ubuntu(self):
+        distro_series = factory.make_name("ubuntu")
         boot_resource = factory.make_BootResource(
-            name="custom/%s" % factory.make_name("ubuntu"),
+            name=f"custom/{distro_series}",
             base_image="ubuntu/focal",
             architecture="amd64/generic",
         )
-        base_osystem, _ = boot_resource.split_base_image()
-        machine = factory.make_Machine(status=NODE_STATUS.DEPLOYED)
-        machine.osystem, machine.distro_series = boot_resource.name.split("/")
-        machine.architecture = boot_resource.architecture
-        machine.save()
-        validation = get_custom_image_dependency_validation(
-            machine, base_osystem
+        machine = factory.make_Machine(
+            status=NODE_STATUS.DEPLOYED,
+            architecture=boot_resource.architecture,
+            osystem="custom",
+            distro_series=distro_series,
         )
+        validation = get_custom_image_dependency_validation(machine, "ubuntu")
         expected = {
             "98-validate-custom-image-has-cloud-init": [
                 "curtin",
@@ -354,23 +354,22 @@ class TestGetCustomImageDependencyValidation(MAASServerTestCase):
                 'dpkg-query -s netplan.io || (echo "netplan.io not detected, MAAS will not be able to configure this machine properly" && exit 1)',
             ],
         }
-        for k in expected:
-            self.assertCountEqual(validation[k], expected[k])
+        self.assertEqual(validation, expected)
 
-    def test_get_custom_image_dependency_validation_for_custom_centos(self):
+    def test_validation_for_custom_centos(self):
+        distro_series = factory.make_name("centos7")
         boot_resource = factory.make_BootResource(
-            name="custom/%s" % factory.make_name("centos7"),
+            name=f"custom/{distro_series}",
             base_image="centos/centos7",
             architecture="amd64/generic",
         )
-        base_osystem, _ = boot_resource.split_base_image()
-        machine = factory.make_Machine(status=NODE_STATUS.DEPLOYED)
-        machine.osystem, machine.distro_series = boot_resource.name.split("/")
-        machine.architecture = boot_resource.architecture
-        machine.save()
-        validation = get_custom_image_dependency_validation(
-            machine, base_osystem
+        machine = factory.make_Machine(
+            status=NODE_STATUS.DEPLOYED,
+            architecture=boot_resource.architecture,
+            osystem="custom",
+            distro_series=distro_series,
         )
+        validation = get_custom_image_dependency_validation(machine, "centos")
         expected = {
             "98-validate-custom-image-has-cloud-init": [
                 "curtin",
@@ -378,32 +377,70 @@ class TestGetCustomImageDependencyValidation(MAASServerTestCase):
                 "--",
                 "bash",
                 "-c",
-                'dnf list cloud-init || (echo "cloud-init not detected, MAAS will not be able to configure this machine properly" && exit 1)',
+                'rpm -q cloud-init || (echo "cloud-init not detected, MAAS will not be able to configure this machine properly" && exit 1)',
             ],
-            "99-validate-custom-image-has-netplan.io": [
+        }
+        self.assertEqual(validation, expected)
+
+    def test_validation_for_custom_rhel(self):
+        distro_series = factory.make_name("rhel8")
+        boot_resource = factory.make_BootResource(
+            name=f"custom/{distro_series}",
+            base_image="rhel/rhel8",
+            architecture="amd64/generic",
+        )
+        machine = factory.make_Machine(
+            status=NODE_STATUS.DEPLOYED,
+            architecture=boot_resource.architecture,
+            osystem="custom",
+            distro_series=distro_series,
+        )
+        validation = get_custom_image_dependency_validation(machine, "rhel")
+        expected = {
+            "98-validate-custom-image-has-cloud-init": [
                 "curtin",
                 "in-target",
                 "--",
                 "bash",
                 "-c",
-                'dnf list netplan.io || (echo "netplan.io not detected, MAAS will not be able to configure this machine properly" && exit 1)',
+                'rpm -q cloud-init || (echo "cloud-init not detected, MAAS will not be able to configure this machine properly" && exit 1)',
             ],
         }
-        for k in expected:
-            self.assertCountEqual(validation[k], expected[k])
+        self.assertEqual(validation, expected)
 
-    def test_get_custom_image_dependency_validation_for_non_custom(self):
+    def test_validation_for_non_custom(self):
         boot_resource = factory.make_BootResource(
             name="ubuntu/focal", architecture="amd64/generic"
         )
-        machine = factory.make_Machine(status=NODE_STATUS.DEPLOYED)
-        machine.osystem, machine.distro_series = boot_resource.name.split("/")
-        machine.architecture = boot_resource.architecture
-        machine.save()
+        machine = factory.make_Machine(
+            status=NODE_STATUS.DEPLOYED,
+            architecture=boot_resource.architecture,
+            osystem="ubuntu",
+            distro_series="focal",
+        )
         self.assertIsNone(
             get_custom_image_dependency_validation(machine, boot_resource.name)
         )
 
+    def test_validation_for_linuxes(self):
+        machine = factory.make_Machine(
+            status=NODE_STATUS.DEPLOYED,
+            architecture="amd64/generic",
+            osystem="custom",
+        )
+        for osystem in ("ubuntu", "centos", "rhel"):
+            distro_series = factory.make_name(osystem)
+            factory.make_BootResource(
+                name=f"custom/{distro_series}",
+                base_image=f"{osystem}/{osystem}",
+                architecture="amd64/generic",
+            )
+            machine.distro_series = distro_series
+            machine.save()
+            self.assertIsNotNone(
+                get_custom_image_dependency_validation(machine, osystem)
+            )
+
 
 class TestLoadPreseedTemplate(MAASServerTestCase):
     """Tests for `load_preseed_template`."""