Merge ~ack/maas:1890468-snap-images-keyring-path into maas:master

[Alberto Donato]

LP: #1890468 - update the default keyrings path in the db for deb-to-snap transitions

[Dougal Matthews (d0ugal)]

lgtm

review: Approve

[MAAS Lander (maas-lander)]

UNIT TESTS
-b 1890468-snap-images-keyring-path lp:~ack/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 2f21438e8c65e12156746e248fd55ee0c0f87c14

review: Approve

[Björn Tillenius (bjornt)]

+1

review: Approve

diff --git a/snap/local/tree/bin/maas-deb-migrate b/snap/local/tree/bin/maas-deb-migrate
index fea33f4..febca85 100755
--- a/snap/local/tree/bin/maas-deb-migrate
+++ b/snap/local/tree/bin/maas-deb-migrate
@@ -68,6 +68,15 @@ apply_db_patches() {
     if maas_snap_mode | grep -q "region"; then
         snap_run "maas-region migrate"
     fi
+
+    # patch the value of the default cloud images keyring to point to the one
+    # in the snap
+    local keyring="/usr/share/keyrings/ubuntu-cloudimage-keyring.gpg"
+    cat <<EOF | pg_do psql maasdb
+UPDATE maasserver_bootsource
+SET keyring_filename = '${MAAS_SNAP}${keyring}'
+WHERE keyring_filename = '${keyring}'
+EOF
 }
 
 configure_supervisord() {
diff --git a/src/maasserver/bootsources.py b/src/maasserver/bootsources.py
index f36e617..9e9d32a 100644
--- a/src/maasserver/bootsources.py
+++ b/src/maasserver/bootsources.py
@@ -79,6 +79,15 @@ def ensure_boot_source_definition():
         )
         return True
     else:
+        # XXX ensure the default keyrings path in the database points to the
+        # right file when running in a snap. (see lp:1890468) The
+        # DEFAULT_KEYRINGS_PATH points to the right file whether running from
+        # deb or snap, but the path stored in the DB might be wrong if a
+        # snap-to-deb transition happened with a script without the fix.
+        if os.environ.get("SNAP"):
+            BootSource.objects.filter(url=DEFAULT_IMAGES_URL).update(
+                keyring_filename=DEFAULT_KEYRINGS_PATH
+            )
         return False
 
 
diff --git a/src/maasserver/tests/test_bootsources.py b/src/maasserver/tests/test_bootsources.py
index 2c4f6ea..01db0c0 100644
--- a/src/maasserver/tests/test_bootsources.py
+++ b/src/maasserver/tests/test_bootsources.py
@@ -11,6 +11,7 @@ import random
 from unittest import skip
 from unittest.mock import ANY, MagicMock
 
+from fixtures import EnvironmentVariableFixture
 from requests.exceptions import ConnectionError
 from testtools.matchers import HasLength
 
@@ -44,6 +45,7 @@ from maasserver.testing.testcase import (
 )
 from maasserver.tests.test_bootresources import SimplestreamsEnvFixture
 from maasserver.utils import get_maas_user_agent
+from maasserver.utils.orm import reload_object
 from maastesting.djangotestcase import count_queries
 from maastesting.matchers import MockCalledOnceWith
 from provisioningserver.config import DEFAULT_IMAGES_URL
@@ -141,6 +143,28 @@ class TestHelpers(MAASServerTestCase):
             },
         )
 
+    def test_ensure_boot_source_definition_updates_default_source_snap(self):
+        BootSource.objects.all().delete()
+        self.assertTrue(ensure_boot_source_definition())
+        source = BootSource.objects.first()
+        self.assertEqual(
+            source.keyring_filename,
+            "/usr/share/keyrings/ubuntu-cloudimage-keyring.gpg",
+        )
+        self.useFixture(
+            EnvironmentVariableFixture("SNAP", "/snap/maas/current")
+        )
+        self.patch(
+            bootsources,
+            "DEFAULT_KEYRINGS_PATH",
+            "/some/other/path/keyring.gpg",
+        )
+        self.assertFalse(ensure_boot_source_definition())
+        source = reload_object(source)
+        self.assertEqual(
+            source.keyring_filename, "/some/other/path/keyring.gpg"
+        )
+
     def test_ensure_boot_source_definition_creates_with_default_arch(self):
         BootSource.objects.all().delete()
         mock_get_architecture = self.patch(bootsources, "get_architecture")