Merge ~ltrager/maas:lp1923268_2.9 into maas:2.9

[Lee Trager]

LP: #1923268 - Make default grub.cfg architecture agnostic.

Backport of f606805

[Lee Trager (ltrager)]

review: Approve

cb8f5f0... by Lee Trager on 2021-05-07

Add GRUB mapping for PPC64EL

9dce8a1... by Lee Trager on 2021-05-07

Merge branch '2.9' into grub_debug_2.9

30ceda5... by Lee Trager on 2021-05-07

Merge branch 'grub_debug_2.9' into lp1923268_2.9

diff --git a/src/provisioningserver/__main__.py b/src/provisioningserver/__main__.py
index 6cf81d9..5f22393 100644
--- a/src/provisioningserver/__main__.py
+++ b/src/provisioningserver/__main__.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright 2012-2017 Canonical Ltd.  This software is licensed under the
+# Copyright 2012-2021 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Command-line interface for the MAAS provisioning component."""
@@ -7,7 +7,6 @@
 import sys
 
 from provisioningserver import security
-import provisioningserver.boot.install_grub
 import provisioningserver.cluster_config_command
 import provisioningserver.dns.commands.edit_named_options
 import provisioningserver.dns.commands.get_named_conf
@@ -39,7 +38,6 @@ RACK_ONLY_COMMANDS = {
     "check-for-shared-secret": security.CheckForSharedSecretScript,
     "config": provisioningserver.cluster_config_command,
     "install-shared-secret": security.InstallSharedSecretScript,
-    "install-uefi-config": provisioningserver.boot.install_grub,
     "register": provisioningserver.register_command,
     "support-dump": provisioningserver.support_dump,
     "upgrade-cluster": provisioningserver.upgrade_cluster,
diff --git a/src/provisioningserver/boot/install_grub.py b/src/provisioningserver/boot/install_grub.py
deleted file mode 100644
index 27ebd36..0000000
--- a/src/provisioningserver/boot/install_grub.py
+++ /dev/null
@@ -1,36 +0,0 @@
-# Copyright 2014-2015 Canonical Ltd.  This software is licensed under the
-# GNU Affero General Public License version 3 (see the file LICENSE).
-
-"""Install a GRUB2 pre-boot loader config for TFTP download."""
-
-
-import os
-
-from provisioningserver.config import ClusterConfiguration
-from provisioningserver.utils.fs import write_text_file
-
-CONFIG_FILE = """
-# MAAS GRUB2 pre-loader configuration file
-
-# Load based on MAC address first.
-configfile /grub/grub.cfg-${net_default_mac}
-
-# Failed to load based on MAC address.
-# Load amd64 by default, UEFI only supported by 64-bit
-configfile /grub/grub.cfg-default-amd64
-"""
-
-
-def add_arguments(parser):
-    pass
-
-
-def run(args):
-    """Install a GRUB2 pre-boot loader config into the TFTP
-    directory structure.
-    """
-    with ClusterConfiguration.open() as config:
-        if not os.path.exists(config.grub_root):
-            os.makedirs(config.grub_root)
-        destination_file = os.path.join(config.grub_root, "grub.cfg")
-    write_text_file(destination_file, CONFIG_FILE)
diff --git a/src/provisioningserver/boot/tests/test_install_grub.py b/src/provisioningserver/boot/tests/test_install_grub.py
deleted file mode 100644
index 6cb876f..0000000
--- a/src/provisioningserver/boot/tests/test_install_grub.py
+++ /dev/null
@@ -1,29 +0,0 @@
-# Copyright 2014-2016 Canonical Ltd.  This software is licensed under the
-# GNU Affero General Public License version 3 (see the file LICENSE).
-
-"""Tests for the install_grub command."""
-
-
-import os.path
-
-from testtools.matchers import FileExists
-
-from maastesting.factory import factory
-from maastesting.testcase import MAASTestCase
-import provisioningserver.boot.install_grub
-from provisioningserver.testing.config import ClusterConfigurationFixture
-from provisioningserver.utils.script import MainScript
-
-
-class TestInstallGrub(MAASTestCase):
-    def test_integration(self):
-        tftproot = self.make_dir()
-        self.useFixture(ClusterConfigurationFixture(tftp_root=tftproot))
-
-        action = factory.make_name("action")
-        script = MainScript(action)
-        script.register(action, provisioningserver.boot.install_grub)
-        script.execute((action,))
-
-        config_filename = os.path.join("grub", "grub.cfg")
-        self.assertThat(os.path.join(tftproot, config_filename), FileExists())
diff --git a/src/provisioningserver/boot/tests/test_uefi_amd64.py b/src/provisioningserver/boot/tests/test_uefi_amd64.py
index a8a23bf..886dca5 100644
--- a/src/provisioningserver/boot/tests/test_uefi_amd64.py
+++ b/src/provisioningserver/boot/tests/test_uefi_amd64.py
@@ -5,6 +5,7 @@
 
 
 import os
+import random
 import re
 from unittest.mock import sentinel
 
@@ -269,6 +270,8 @@ class TestUEFIAMD64BootMethodRegex(MAASTestCase):
         )
 
     def test_re_config_file_does_not_match_default_grub_config_file(self):
+        # The default grub.cfg is on the filesystem let the normal handler
+        # grab it.
         self.assertIsNone(re_config_file.match(b"grub/grub.cfg"))
 
     def test_re_config_file_with_default(self):
@@ -301,6 +304,86 @@ class TestUEFIAMD64BootMethodRegex(MAASTestCase):
 class TestUEFIAMD64BootMethod(MAASTestCase):
     """Tests `provisioningserver.boot.uefi_amd64.UEFIAMD64BootMethod`."""
 
+    def test_match_path_none(self):
+        method = UEFIAMD64BootMethod()
+        backend = random.choice(["http", "tftp"])
+        self.assertIsNone(
+            method.match_path(backend, factory.make_string().encode())
+        )
+
+    def test_match_path_mac_colon(self):
+        method = UEFIAMD64BootMethod()
+        backend = random.choice(["http", "tftp"])
+        mac = factory.make_mac_address()
+        self.assertEqual(
+            {"mac": mac.replace(":", "-")},
+            method.match_path(backend, f"/grub/grub.cfg-{mac}".encode()),
+        )
+
+    def test_match_path_mac_dash(self):
+        method = UEFIAMD64BootMethod()
+        backend = random.choice(["http", "tftp"])
+        mac = factory.make_mac_address().replace(":", "-")
+        self.assertEqual(
+            {"mac": mac},
+            method.match_path(backend, f"/grub/grub.cfg-{mac}".encode()),
+        )
+
+    def test_match_path_arch(self):
+        method = UEFIAMD64BootMethod()
+        backend = random.choice(["http", "tftp"])
+        arch = factory.make_string()
+        self.assertEqual(
+            {"arch": arch},
+            method.match_path(
+                backend, f"/grub/grub.cfg-default-{arch}".encode()
+            ),
+        )
+
+    def test_match_path_arch_x86_64(self):
+        method = UEFIAMD64BootMethod()
+        backend = random.choice(["http", "tftp"])
+        self.assertEqual(
+            {"arch": "amd64"},
+            method.match_path(backend, b"/grub/grub.cfg-default-x86_64"),
+        )
+
+    def test_match_path_arch_powerpc(self):
+        method = UEFIAMD64BootMethod()
+        backend = random.choice(["http", "tftp"])
+        self.assertEqual(
+            {"arch": "ppc64el"},
+            method.match_path(backend, b"/grub/grub.cfg-default-powerpc"),
+        )
+
+    def test_match_path_arch_ppc64(self):
+        method = UEFIAMD64BootMethod()
+        backend = random.choice(["http", "tftp"])
+        self.assertEqual(
+            {"arch": "ppc64el"},
+            method.match_path(backend, b"/grub/grub.cfg-default-ppc64"),
+        )
+
+    def test_match_path_arch_ppc64le(self):
+        method = UEFIAMD64BootMethod()
+        backend = random.choice(["http", "tftp"])
+        self.assertEqual(
+            {"arch": "ppc64el"},
+            method.match_path(backend, b"/grub/grub.cfg-default-ppc64le"),
+        )
+
+    def test_match_path_arch_subarch(self):
+        method = UEFIAMD64BootMethod()
+        backend = random.choice(["http", "tftp"])
+        arch = factory.make_string()
+        subarch = factory.make_string()
+        self.assertEqual(
+            {"arch": arch, "subarch": subarch},
+            method.match_path(
+                backend, f"/grub/grub.cfg-default-{arch}-{subarch}".encode()
+            ),
+        )
+
     def test_link_bootloader_creates_grub_cfg(self):
         method = UEFIAMD64BootMethod()
         with tempdir() as tmp:
diff --git a/src/provisioningserver/boot/uefi_amd64.py b/src/provisioningserver/boot/uefi_amd64.py
index 74b007a..1399fa0 100644
--- a/src/provisioningserver/boot/uefi_amd64.py
+++ b/src/provisioningserver/boot/uefi_amd64.py
@@ -1,4 +1,4 @@
-# Copyright 2014-2016 Canonical Ltd.  This software is licensed under the
+# Copyright 2014-2021 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """UEFI AMD64 Boot Method"""
@@ -24,11 +24,11 @@ CONFIG_FILE = dedent(
     # MAAS GRUB2 pre-loader configuration file
 
     # Load based on MAC address first.
-    configfile (pxe)/grub/grub.cfg-${net_default_mac}
+    configfile /grub/grub.cfg-${net_default_mac}
 
-    # Failed to load based on MAC address.
-    # Load amd64 by default, UEFI only supported by 64-bit
-    configfile (pxe)/grub/grub.cfg-default-amd64
+    # Failed to load based on MAC address. Load based on the CPU
+    # architecture.
+    configfile /grub/grub.cfg-default-${grub_cpu}
     """
 )
 
@@ -36,7 +36,7 @@ CONFIG_FILE = dedent(
 # format. Required for UEFI as GRUB2 only presents the MAC address
 # in colon-seperated format.
 re_mac_address_octet = r"[0-9a-f]{2}"
-re_mac_address = re.compile(":".join(repeat(re_mac_address_octet, 6)))
+re_mac_address = re.compile("[:-]".join(repeat(re_mac_address_octet, 6)))
 
 # Match the grub/grub.cfg-* request for UEFI (aka. GRUB2)
 re_config_file = r"""
@@ -48,10 +48,10 @@ re_config_file = r"""
         (?P<mac>{re_mac_address.pattern}) # Capture UEFI MAC.
     | # or "default"
         default
-          (?: # perhaps with specified arch, with a separator of '-'
+            (?: # perhaps with specified arch, with a separator of '-'
             [-](?P<arch>\w+) # arch
             (?:-(?P<subarch>\w+))? # optional subarch
-          )?
+            )?
     )
     $
 """
@@ -90,6 +90,14 @@ class UEFIAMD64BootMethod(BootMethod):
         if mac is not None:
             params["mac"] = mac.replace(":", "-")
 
+        # MAAS uses Debian architectures while GRUB uses standard Linux
+        # architectures.
+        arch = params.get("arch")
+        if arch == "x86_64":
+            params["arch"] = "amd64"
+        elif arch in {"powerpc", "ppc64", "ppc64le"}:
+            params["arch"] = "ppc64el"
+
         return params
 
     def get_reader(self, backend, kernel_params, **extra):