Merge ~ack/maas:deprecation-notifications into maas:master

[Alberto Donato]

LP #1874439 - create notifications for active deprecation notices

[MAAS Lander (maas-lander)]

UNIT TESTS
-b deprecation-notifications lp:~ack/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: a34ff7e0828bf7800e14f0e199975e758e6320b8

review: Approve

[Dougal Matthews (d0ugal)]

Thanks for the clarifications!

review: Approve

diff --git a/src/maasserver/deprecations.py b/src/maasserver/deprecations.py
index dbeefae..e87fad3 100644
--- a/src/maasserver/deprecations.py
+++ b/src/maasserver/deprecations.py
@@ -46,3 +46,37 @@ def log_deprecations(logger=None):
 
     for d in get_deprecations():
         logger.msg("Deprecation {id} ({url}): {description}".format(**d))
+
+
+def sync_deprecation_notifications():
+    from maasserver.models import Notification
+
+    notifications = set(
+        Notification.objects.filter(
+            ident__startswith="deprecation_"
+        ).values_list("ident", flat=True)
+    )
+    for deprecation in get_deprecations():
+        dep_id = deprecation["id"]
+        for kind in ("users", "admins"):
+            dep_ident = f"deprecation_{dep_id}_{kind}"
+            if dep_ident in notifications:
+                notifications.remove(dep_ident)
+                continue
+            message = f"{deprecation['description']}"
+            if kind == "users":
+                message += "<br>Please contact your MAAS administrator."
+            message += (
+                f"<br><a class='p-link--external' href='{deprecation['url']}'>"
+                f"{deprecation['link-text']}...</a>"
+            )
+            Notification(
+                ident=dep_ident,
+                category="warning",
+                message=message,
+                **{kind: True},
+            ).save()
+
+    # delete other deprecation notifications
+    if notifications:
+        Notification.objects.filter(ident__in=notifications).delete()
diff --git a/src/maasserver/start_up.py b/src/maasserver/start_up.py
index c104ef3..52235f8 100644
--- a/src/maasserver/start_up.py
+++ b/src/maasserver/start_up.py
@@ -13,6 +13,7 @@ from twisted.internet import reactor
 from twisted.internet.defer import inlineCallbacks
 
 from maasserver import locks, security
+from maasserver.deprecations import sync_deprecation_notifications
 from maasserver.fields import register_mac_type
 from maasserver.models.config import Config
 from maasserver.models.domain import dns_kms_setting_changed
@@ -140,6 +141,9 @@ def inner_start_up(master=False):
                 ident="commissioning_release_deprecated",
             )
 
+        # Update deprecation notifications if needed
+        sync_deprecation_notifications()
+
         # Refresh soon after this transaction is in.
         post_commit_do(reactor.callLater, 0, refreshRegion, region)
 
diff --git a/src/maasserver/tests/test_deprecations.py b/src/maasserver/tests/test_deprecations.py
index 7725162..2fdc6df 100644
--- a/src/maasserver/tests/test_deprecations.py
+++ b/src/maasserver/tests/test_deprecations.py
@@ -2,7 +2,13 @@ from pathlib import Path
 
 from fixtures import EnvironmentVariable
 
-from maasserver.deprecations import get_deprecations, log_deprecations
+from maasserver.deprecations import (
+    get_deprecations,
+    log_deprecations,
+    sync_deprecation_notifications,
+)
+from maasserver.models import Notification
+from maasserver.testing.testcase import MAASServerTestCase
 from maastesting.testcase import MAASTestCase
 from provisioningserver.logger import LegacyLogger
 
@@ -54,3 +60,41 @@ class TestLogDeprecations(MAASTestCase):
             "The setup for this MAAS is deprecated and not suitable for production "
             "environments, as the database is running inside the snap.",
         )
+
+
+class TestSyncDeprecationNotifications(MAASServerTestCase):
+    def test_create_notifications(self):
+        self.useFixture(EnvironmentVariable("SNAP", "/snap/maas/current"))
+        snap_common_path = Path(self.make_dir())
+        self.useFixture(
+            EnvironmentVariable("SNAP_COMMON", str(snap_common_path))
+        )
+        snap_common_path.joinpath("snap_mode").write_text("all", "utf-8")
+
+        sync_deprecation_notifications()
+        notification1, notification2 = Notification.objects.order_by("ident")
+        self.assertEqual(notification1.ident, "deprecation_MD1_admins")
+        self.assertEqual(notification1.category, "warning")
+        self.assertTrue(notification1.admins)
+        self.assertFalse(notification1.users)
+        self.assertIn(
+            "https://maas.io/deprecations/MD1", notification1.message
+        )
+        self.assertNotIn(
+            "Please contact your MAAS administrator.", notification1.message
+        )
+        self.assertEqual(notification2.ident, "deprecation_MD1_users")
+        self.assertEqual(notification2.category, "warning")
+        self.assertFalse(notification2.admins)
+        self.assertTrue(notification2.users)
+        self.assertIn(
+            "Please contact your MAAS administrator.", notification2.message
+        )
+
+    def test_remove_deprecations(self):
+        Notification(
+            ident="deprecation_MD1_admins", message="some text"
+        ).save()
+        sync_deprecation_notifications()
+        # the notification is removed since there is no active deprecation
+        self.assertFalse(Notification.objects.exists())
diff --git a/src/maasserver/tests/test_start_up.py b/src/maasserver/tests/test_start_up.py
index 71ceec7..4f10d31 100644
--- a/src/maasserver/tests/test_start_up.py
+++ b/src/maasserver/tests/test_start_up.py
@@ -5,9 +5,11 @@
 
 __all__ = []
 
+from pathlib import Path
 import random
 from unittest.mock import call
 
+from fixtures import EnvironmentVariable
 from testtools.matchers import HasLength, Is, IsInstance, Not
 from twisted.internet import reactor
 from twisted.internet.defer import Deferred
@@ -196,6 +198,23 @@ class TestInnerStartUp(MAASServerTestCase):
         uuid = Config.objects.get_config("uuid")
         self.assertThat(uuid, Not(Is(None)))
 
+    def test__syncs_deprecation_notifications(self):
+        self.useFixture(EnvironmentVariable("SNAP", "/snap/maas/current"))
+        snap_common_path = Path(self.make_dir())
+        self.useFixture(
+            EnvironmentVariable("SNAP_COMMON", str(snap_common_path))
+        )
+        snap_common_path.joinpath("snap_mode").write_text("all", "utf-8")
+
+        with post_commit_hooks:
+            start_up.inner_start_up(master=True)
+        self.assertEqual(
+            Notification.objects.filter(
+                ident__startswith="deprecation_"
+            ).count(),
+            2,
+        )
+
 
 class TestFunctions(MAASServerTestCase):
     """Tests for other functions in the `start_up` module."""