Merge ~ltrager/maas:grub_debug_2.7 into maas:2.7

[Lee Trager]

Enable GRUB debug when rackd debug is enabled.

Backport of 20566cd

[Lee Trager (ltrager)]

review: Approve

[MAAS Lander (maas-lander)]

LANDING
-b grub_debug_2.7 lp:~ltrager/maas/+git/maas into -b 2.7 lp:~maas-committers/maas

STATUS: FAILED BUILD
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/10037/consoleText

[MAAS Lander (maas-lander)]

UNIT TESTS
-b grub_debug_2.7 lp:~ltrager/maas/+git/maas into -b 2.7 lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/10038/console
COMMIT: 2b5fa28cebff55095d9f717cf0bf32dee4bc486b

review: Needs Fixing

767e74d... by Lee Trager on 2021-05-11

Merge branch '2.7' into grub_debug_2.7

diff --git a/src/provisioningserver/boot/__init__.py b/src/provisioningserver/boot/__init__.py
index bee94fc..26ce6ef 100644
--- a/src/provisioningserver/boot/__init__.py
+++ b/src/provisioningserver/boot/__init__.py
@@ -18,6 +18,7 @@ from twisted.internet.defer import inlineCallbacks, returnValue
 from zope.interface import implementer
 
 from provisioningserver.boot.tftppath import compose_image_path
+from provisioningserver.config import debug_enabled
 from provisioningserver.events import EVENT_TYPES, try_send_rack_event
 from provisioningserver.kernel_opts import compose_kernel_command_line
 from provisioningserver.logger import get_maas_logger
@@ -419,6 +420,7 @@ class BootMethod(metaclass=ABCMeta):
             "kernel_path": kernel_path,
             "kernel_name": kernel_name,
             "dtb_path": dtb_path,
+            "debug": debug_enabled(),
         }
 
         return namespace
diff --git a/src/provisioningserver/boot/tests/test_boot.py b/src/provisioningserver/boot/tests/test_boot.py
index 1aa3216..52130f3 100644
--- a/src/provisioningserver/boot/tests/test_boot.py
+++ b/src/provisioningserver/boot/tests/test_boot.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).
 
 """Tests for `provisioningserver.boot`."""
@@ -31,6 +31,7 @@ from provisioningserver.boot.tftppath import compose_image_path
 from provisioningserver.kernel_opts import compose_kernel_command_line
 from provisioningserver.rpc import region
 from provisioningserver.rpc.testing import MockLiveClusterToRegionRPCFixture
+from provisioningserver.testing.config import ClusterConfigurationFixture
 from provisioningserver.tests.test_kernel_opts import make_kernel_parameters
 from provisioningserver.utils.fs import atomic_symlink, tempdir
 
@@ -332,6 +333,18 @@ class TestBootMethod(MAASTestCase):
             template_namespace["dtb_path"](kernel_params),
         )
 
+    def test_compose_template_namespace_include_debug(self):
+        debug = factory.pick_bool()
+        boot.debug_enabled.cache_clear()
+        self.addCleanup(boot.debug_enabled.cache_clear)
+        self.useFixture(ClusterConfigurationFixture(debug=debug))
+        kernel_params = make_kernel_parameters()
+        method = FakeBootMethod()
+
+        template_namespace = method.compose_template_namespace(kernel_params)
+
+        self.assertEqual(debug, template_namespace["debug"])
+
 
 class TestGetArchiveUrl(MAASTestCase):
 
diff --git a/src/provisioningserver/boot/tests/test_uefi_amd64.py b/src/provisioningserver/boot/tests/test_uefi_amd64.py
index c90e421..33df035 100644
--- a/src/provisioningserver/boot/tests/test_uefi_amd64.py
+++ b/src/provisioningserver/boot/tests/test_uefi_amd64.py
@@ -20,6 +20,7 @@ from testtools.matchers import (
 from maastesting.factory import factory
 from maastesting.matchers import FileContains, MockAnyCall, MockCalledOnce
 from maastesting.testcase import MAASTestCase
+from provisioningserver import boot
 from provisioningserver.boot import BytesReader
 from provisioningserver.boot import uefi_amd64 as uefi_amd64_module
 from provisioningserver.boot.testing import TFTPPath, TFTPPathAndComponents
@@ -30,6 +31,7 @@ from provisioningserver.boot.uefi_amd64 import (
     UEFIAMD64BootMethod,
     UEFIAMD64HTTPBootMethod,
 )
+from provisioningserver.testing.config import ClusterConfigurationFixture
 from provisioningserver.tests.test_kernel_opts import make_kernel_parameters
 from provisioningserver.utils import typed
 from provisioningserver.utils.fs import tempdir
@@ -69,6 +71,12 @@ class TestUEFIAMD64BootMethodRender(MAASTestCase):
     """Tests for
     `provisioningserver.boot_amd64.uefi.UEFIAMD64BootMethod.render`."""
 
+    def setUp(self):
+        super().setUp()
+        boot.debug_enabled.cache_clear()
+        self.addCleanup(boot.debug_enabled.cache_clear)
+        self.useFixture(ClusterConfigurationFixture(debug=False))
+
     def test_get_reader(self):
         # Given the right configuration options, the UEFI configuration is
         # correctly rendered.
@@ -168,7 +176,7 @@ class TestUEFIAMD64BootMethodRender(MAASTestCase):
             output,
             ContainsAll(
                 [
-                    "menuentry 'Commission'",
+                    "menuentry 'Ephemeral'",
                     "%s/%s/%s" % (params.osystem, params.arch, params.subarch),
                     params.kernel,
                 ]
@@ -186,7 +194,7 @@ class TestUEFIAMD64BootMethodRender(MAASTestCase):
             output,
             ContainsAll(
                 [
-                    "menuentry 'Commission'",
+                    "menuentry 'Ephemeral'",
                     "%s/%s/%s" % (params.osystem, params.arch, params.subarch),
                     params.kernel,
                 ]
diff --git a/src/provisioningserver/boot/uefi_amd64.py b/src/provisioningserver/boot/uefi_amd64.py
index 6d873b1..aed8850 100644
--- a/src/provisioningserver/boot/uefi_amd64.py
+++ b/src/provisioningserver/boot/uefi_amd64.py
@@ -125,7 +125,9 @@ class UEFIAMD64BootMethod(BootMethod):
         # UEFI.  And so we fix it here, instead of in the common code.  See
         # also src/provisioningserver/kernel_opts.py.
         namespace["kernel_command"] = kernel_command
-        return BytesReader(template.substitute(namespace).encode("utf-8"))
+        return BytesReader(
+            template.substitute(namespace).strip().encode("utf-8")
+        )
 
     def _find_and_copy_bootloaders(self, destination, log_missing=True):
         if not super()._find_and_copy_bootloaders(destination, False):
diff --git a/src/provisioningserver/config.py b/src/provisioningserver/config.py
index 2e43e44..a997b5e 100644
--- a/src/provisioningserver/config.py
+++ b/src/provisioningserver/config.py
@@ -1,4 +1,4 @@
-# Copyright 2012-2016 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).
 
 """Configuration for the MAAS cluster.
@@ -113,6 +113,7 @@ __all__ = [
 
 from contextlib import closing, contextmanager
 from copy import deepcopy
+from functools import lru_cache
 from itertools import islice
 import json
 import logging
@@ -823,3 +824,10 @@ def is_dev_environment():
         return False
     else:
         return True
+
+
+@lru_cache(1)
+def debug_enabled():
+    """Return and cache whether debug has been enabled."""
+    with ClusterConfiguration.open() as config:
+        return config.debug
diff --git a/src/provisioningserver/templates/uefi/config.commissioning.template b/src/provisioningserver/templates/uefi/config.commissioning.template
index c860a79..cc3f2fc 100644
--- a/src/provisioningserver/templates/uefi/config.commissioning.template
+++ b/src/provisioningserver/templates/uefi/config.commissioning.template
@@ -1,7 +1,8 @@
+{{if debug}}set debug="all"{{endif}}
 set default="0"
 set timeout=0
 
-menuentry 'Commission' {
+menuentry 'Ephemeral' {
     echo   'Booting under MAAS direction...'
     linux  {{kernel_params | fs_efihost}}{{kernel_params | kernel_path }} {{kernel_params | kernel_command}} BOOTIF=01-${net_default_mac}
     initrd {{kernel_params | fs_efihost}}{{kernel_params | initrd_path }}
diff --git a/src/provisioningserver/templates/uefi/config.local.amd64.template b/src/provisioningserver/templates/uefi/config.local.amd64.template
index c7d3d4c..7cfc382 100644
--- a/src/provisioningserver/templates/uefi/config.local.amd64.template
+++ b/src/provisioningserver/templates/uefi/config.local.amd64.template
@@ -1,3 +1,4 @@
+{{if debug}}set debug="all"{{endif}}
 set default="0"
 set timeout=0
 
diff --git a/src/provisioningserver/templates/uefi/config.local.arm64.template b/src/provisioningserver/templates/uefi/config.local.arm64.template
index cb34b1b..ab10c41 100644
--- a/src/provisioningserver/templates/uefi/config.local.arm64.template
+++ b/src/provisioningserver/templates/uefi/config.local.arm64.template
@@ -1,3 +1,4 @@
+{{if debug}}set debug="all"{{endif}}
 set default="0"
 set timeout=0
 
diff --git a/src/provisioningserver/templates/uefi/config.local.ppc64el.template b/src/provisioningserver/templates/uefi/config.local.ppc64el.template
index b592f26..406451b 100644
--- a/src/provisioningserver/templates/uefi/config.local.ppc64el.template
+++ b/src/provisioningserver/templates/uefi/config.local.ppc64el.template
@@ -1,3 +1,4 @@
+{{if debug}}set debug="all"{{endif}}
 set default="0"
 set timeout=0
 
diff --git a/src/provisioningserver/templates/uefi/config.poweroff.template b/src/provisioningserver/templates/uefi/config.poweroff.template
index 451be03..95016c7 100644
--- a/src/provisioningserver/templates/uefi/config.poweroff.template
+++ b/src/provisioningserver/templates/uefi/config.poweroff.template
@@ -1,3 +1,4 @@
+{{if debug}}set debug="all"{{endif}}
 set default="0"
 set timeout=0
 
diff --git a/src/provisioningserver/templates/uefi/config.xinstall.template b/src/provisioningserver/templates/uefi/config.xinstall.template
deleted file mode 100644
index 7bd9538..0000000
--- a/src/provisioningserver/templates/uefi/config.xinstall.template
+++ /dev/null
@@ -1,8 +0,0 @@
-set default="0"
-set timeout=0
-
-menuentry 'Install' {
-    echo   'Booting under MAAS direction...'
-    linux  {{kernel_params | fs_efihost}}{{kernel_params | kernel_path }} {{kernel_params | kernel_command}} BOOTIF=01-${net_default_mac}
-    initrd {{kernel_params | fs_efihost}}{{kernel_params | initrd_path }}
-}
diff --git a/src/provisioningserver/templates/uefi/config.xinstall.template b/src/provisioningserver/templates/uefi/config.xinstall.template
new file mode 120000
index 0000000..f0f1b87
--- /dev/null
+++ b/src/provisioningserver/templates/uefi/config.xinstall.template
@@ -0,0 +1 @@
+config.commissioning.template
\ No newline at end of file
diff --git a/src/provisioningserver/tests/test_config.py b/src/provisioningserver/tests/test_config.py
index a1dfd1d..9956683 100644
--- a/src/provisioningserver/tests/test_config.py
+++ b/src/provisioningserver/tests/test_config.py
@@ -1,4 +1,4 @@
-# Copyright 2012-2016 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).
 
 """Tests for provisioning configuration."""
@@ -31,6 +31,7 @@ from maastesting.factory import factory
 from maastesting.fixtures import ImportErrorFixture
 from maastesting.matchers import MockCalledOnceWith, MockNotCalled
 from maastesting.testcase import MAASTestCase
+from provisioningserver import config as config_module
 from provisioningserver.config import (
     ClusterConfiguration,
     Configuration,
@@ -39,6 +40,7 @@ from provisioningserver.config import (
     ConfigurationImmutable,
     ConfigurationMeta,
     ConfigurationOption,
+    debug_enabled,
     is_dev_environment,
 )
 from provisioningserver.path import get_data_path
@@ -732,3 +734,30 @@ class TestConfig(MAASTestCase):
 
     def test_is_dev_environment_returns_true(self):
         self.assertTrue(is_dev_environment())
+
+
+class TestDebugEnabled(MAASTestCase):
+    """Tests for `debug_enabled`."""
+
+    def setUp(self):
+        super().setUp()
+        # Make sure things aren't pulled from cache
+        debug_enabled.cache_clear()
+
+    def test_debug_enabled_false(self):
+        # Verifies that the default state of debug is false.
+        self.assertFalse(debug_enabled())
+
+    def test_debug_enabled(self):
+        debug = factory.pick_bool()
+        self.useFixture(ClusterConfigurationFixture(debug=debug))
+        self.assertEqual(debug, debug_enabled())
+
+    def test_debug_enabled_cached(self):
+        debug = factory.pick_bool()
+        self.useFixture(ClusterConfigurationFixture(debug=debug))
+        # Prime cache
+        debug_enabled()
+        mock_open = self.patch(config_module.ClusterConfiguration, "open")
+        self.assertEqual(debug, debug_enabled())
+        mock_open.assert_not_called()