Merge ~waveform/ubuntu-release-upgrader:rewrite-fkms-overlay into ubuntu-release-upgrader:ubuntu/master

[Dave Jones]

[Brian Murray (brian-murray)]

review: Approve

diff --git a/DistUpgrade/DistUpgradeQuirks.py b/DistUpgrade/DistUpgradeQuirks.py
index ed4534d..17ae602 100644
--- a/DistUpgrade/DistUpgradeQuirks.py
+++ b/DistUpgrade/DistUpgradeQuirks.py
@@ -142,6 +142,9 @@ class DistUpgradeQuirks(object):
         if cache['snapd'].is_installed and \
                 self._snap_list:
             self._replaceDebsAndSnaps()
+        if 'ubuntu-desktop-raspi' in cache:
+            if cache['ubuntu-desktop-rapsi'].is_installed:
+                self._replace_fkms_overlay()
 
     # individual quirks handler when the dpkg run is finished ---------
     def PostCleanup(self):
@@ -1110,3 +1113,54 @@ class DistUpgradeQuirks(object):
 
                 self._snap_list[snap] = snap_object
         return self._snap_list
+
+    def _replace_fkms_overlay(self, boot_dir='/boot/firmware'):
+        failure_action = (
+            "you may need to replace the vc4-fkms-v3d overlay with "
+            "vc4-kms-v3d in config.txt on your boot partition")
+
+        try:
+            boot_config_filename = os.path.join(boot_dir, 'config.txt')
+            with open(boot_config_filename, 'r', encoding='utf-8') as f:
+                boot_config = f.read()
+        except FileNotFoundError:
+            logging.error("failed to open boot configuration in %s; %s",
+                          boot_config_filename, failure_action)
+            return
+
+        new_config = ''.join(
+            # startswith and replace used to cope with (and preserve) any
+            # trailing d-t parameters, and any use of the -pi4 suffix
+            '# changed by do-release-upgrade (LP: #1923673)\n#' + line +
+            line.replace('dtoverlay=vc4-fkms-v3d', 'dtoverlay=vc4-kms-v3d')
+            if line.startswith('dtoverlay=vc4-fkms-v3d') else
+            # camera firmware disabled due to incompatibility with "full" kms
+            # overlay; without the camera firmware active it's also better to
+            # disable gpu_mem leaving the default (64MB) to allow as much as
+            # possible for the KMS driver
+            '# disabled by do-release-upgrade (LP: #1923673)\n#' + line
+            if line.startswith('gpu_mem=') or line.rstrip() == 'start_x=1' else
+            line
+            for line in boot_config.splitlines(keepends=True)
+        )
+
+        if new_config == boot_config:
+            logging.warning("no fkms overlay or camera firmware line found "
+                            "in %s", boot_config_filename)
+            return
+
+        try:
+            boot_backup_filename = os.path.join(
+                boot_dir, 'config.txt.distUpgrade')
+            with open(boot_backup_filename, 'w', encoding='utf-8') as f:
+                f.write(boot_config)
+        except IOError as exc:
+            logging.error("unable to write boot config backup to %s: %s; %s",
+                          boot_backup_filename, exc, failure_action)
+            return
+        try:
+            with open(boot_config_filename, 'w', encoding='utf-8') as f:
+                f.write(new_config)
+        except IOError as exc:
+            logging.error("unable to write new boot config to %s: %s; %s",
+                          boot_config_filename, exc, failure_action)
diff --git a/debian/changelog b/debian/changelog
index a006a24..d7af5c7 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,11 @@
+ubuntu-release-upgrader (1:21.04.9) hirsute; urgency=medium
+
+  * DistUpgrade/DistUpgradeQuirks.py: Add quirk to rewrite references to fkms
+    overlay in Raspberry Pi boot configuration to kms overlay (and disable the
+    related camera firmware lines). (LP: #1923673)
+
+ -- Dave Jones <[e-mail]>  Tue, 13 Apr 2021 23:34:22 +0100
+
 ubuntu-release-upgrader (1:21.04.8) hirsute; urgency=medium
 
   * DistUpgrade/DistUpgradeQuirks.py: Modify the deb-to-snap quirk to also
diff --git a/tests/test_quirks.py b/tests/test_quirks.py
index 30f83d5..cc4c8f1 100644
--- a/tests/test_quirks.py
+++ b/tests/test_quirks.py
@@ -446,6 +446,79 @@ class TestQuirks(unittest.TestCase):
         q._test_and_fail_on_aufs()
         self.assertTrue(len(mock_controller.abort.mock_calls))
 
+    def test_replace_fkms_overlay_no_config(self):
+        with tempfile.TemporaryDirectory() as boot_dir:
+            mock_controller = mock.Mock()
+
+            q = DistUpgradeQuirks(mock_controller, mock.Mock())
+
+            q._replace_fkms_overlay(boot_dir)
+            self.assertFalse(os.path.exists(os.path.join(
+                boot_dir, 'config.txt.distUpgrade')))
+
+    def test_replace_fkms_overlay_no_changes(self):
+        with tempfile.TemporaryDirectory() as boot_dir:
+            demo_config = ("# This is a demo boot config\n"
+                           "[pi4\n"
+                           "max_framebuffers=2\n"
+                           "[all]\n"
+                           "arm_64bit=1\n"
+                           "kernel=vmlinuz\n"
+                           "initramfs initrd.img followkernel\n")
+            with open(os.path.join(boot_dir, 'config.txt'), 'w') as f:
+                f.write(demo_config)
+
+            mock_controller = mock.Mock()
+
+            q = DistUpgradeQuirks(mock_controller, mock.Mock())
+
+            q._replace_fkms_overlay(boot_dir)
+            self.assertFalse(os.path.exists(os.path.join(
+                boot_dir, 'config.txt.distUpgrade')))
+            with open(os.path.join(boot_dir, 'config.txt')) as f:
+                self.assertTrue(f.read() == demo_config)
+
+    def test_replace_fkms_overlay_with_changes(self):
+        with tempfile.TemporaryDirectory() as boot_dir:
+            demo_config = (
+                "# This is a demo boot config\n"
+                "[pi4\n"
+                "max_framebuffers=2\n"
+                "[all]\n"
+                "arm_64bit=1\n"
+                "kernel=vmlinuz\n"
+                "initramfs initrd.img followkernel\n"
+                "dtoverlay=vc4-fkms-v3d,cma-256\n"
+                "start_x=1\n"
+                "gpu_mem=256\n")
+            expected_config = (
+                "# This is a demo boot config\n"
+                "[pi4\n"
+                "max_framebuffers=2\n"
+                "[all]\n"
+                "arm_64bit=1\n"
+                "kernel=vmlinuz\n"
+                "initramfs initrd.img followkernel\n"
+                "# changed by do-release-upgrade (LP: #1923673)\n"
+                "#dtoverlay=vc4-fkms-v3d,cma-256\n"
+                "dtoverlay=vc4-kms-v3d,cma-256\n"
+                "# disabled by do-release-upgrade (LP: #1923673)\n"
+                "#start_x=1\n"
+                "# disabled by do-release-upgrade (LP: #1923673)\n"
+                "#gpu_mem=256\n")
+            with open(os.path.join(boot_dir, 'config.txt'), 'w') as f:
+                f.write(demo_config)
+
+            mock_controller = mock.Mock()
+
+            q = DistUpgradeQuirks(mock_controller, mock.Mock())
+
+            q._replace_fkms_overlay(boot_dir)
+            self.assertTrue(os.path.exists(os.path.join(
+                boot_dir, 'config.txt.distUpgrade')))
+            with open(os.path.join(boot_dir, 'config.txt')) as f:
+                self.assertTrue(f.read() == expected_config)
+
 
 class TestSnapQuirks(unittest.TestCase):