Merge ~renanrodrigo/ubuntu/+source/update-notifier:no-esm-motd-bionic into ubuntu/+source/update-notifier:ubuntu/bionic-updates

[Renan Rodrigo]

This fixes #2015420 by adding a flag that hides esm-related messages from the human readable output of data/apt_check.py

[Nick Rosbrook (enr0n)]

I merged this, but into https://git.launchpad.net/update-notifier/log/?h=bionic, and uploaded to the bionic unapproved queue.

review: Approve

Unmerged commits

4e30f81... by Renan Rodrigo on 2024-01-31

update changelog entry for version 3.192.1.20

Signed-off-by: Renan Rodrigo <email address hidden>

15e63f7... by Renan Rodrigo on 2024-01-31

apt_check: add option to hide esm messages from human-readable output

Users want to be able to see the regular updates + security updates on
MOTDs, but without mentions to ESM.

LP: #2015420

Signed-off-by: Renan Rodrigo <email address hidden>

diff --git a/data/apt_check.py b/data/apt_check.py
index 164b2f9..7a35ba8 100755
--- a/data/apt_check.py
+++ b/data/apt_check.py
@@ -242,21 +242,23 @@ def write_human_readable_summary(outstream, upgrades, security_updates,
                                  esm_infra_updates, esm_apps_updates,
                                  have_esm_infra, have_esm_apps,
                                  disabled_esm_infra_updates,
-                                 disabled_esm_apps_updates):
+                                 disabled_esm_apps_updates,
+                                 hide_esm_messages=False):
 
     " write out human summary to outstream "
     esm_distro = is_esm_distro()
     lts_distro = is_lts_distro()
 
-    if have_esm_infra is not None and esm_distro:
-        _output_esm_service_status(
-            outstream, have_esm_infra, service_type="Infrastructure"
-        )
+    if not hide_esm_messages:
+        if have_esm_infra is not None and esm_distro:
+            _output_esm_service_status(
+                outstream, have_esm_infra, service_type="Infrastructure"
+            )
 
-    if have_esm_apps is not None and lts_distro and not esm_distro:
-        _output_esm_service_status(
-            outstream, have_esm_apps, service_type="Applications"
-        )
+        if have_esm_apps is not None and lts_distro and not esm_distro:
+            _output_esm_service_status(
+                outstream, have_esm_apps, service_type="Applications"
+            )
 
     outstream.write(
         gettext.dngettext("update-notifier",
@@ -265,10 +267,11 @@ def write_human_readable_summary(outstream, upgrades, security_updates,
                           upgrades) % upgrades
     )
 
-    _output_esm_package_count(
-        outstream, service_type="Infra", esm_pkg_count=esm_infra_updates)
-    _output_esm_package_count(
-        outstream, service_type="Apps", esm_pkg_count=esm_apps_updates)
+    if not hide_esm_messages:
+        _output_esm_package_count(
+            outstream, service_type="Infra", esm_pkg_count=esm_infra_updates)
+        _output_esm_package_count(
+            outstream, service_type="Apps", esm_pkg_count=esm_apps_updates)
 
     if security_updates > 0:
         outstream.write("\n")
@@ -291,14 +294,22 @@ def write_human_readable_summary(outstream, upgrades, security_updates,
             have_esm_apps is not None,
             not have_esm_apps,
             lts_distro,
-            not esm_distro
+            not esm_distro,
+            not hide_esm_messages,
         ]
     ):
         _output_esm_package_alert(
             outstream, service_type="Apps",
             disabled_pkg_count=disabled_esm_apps_updates)
 
-    if have_esm_infra is not None and not have_esm_infra and esm_distro:
+    if all(
+        [
+            have_esm_infra is not None,
+            not have_esm_infra,
+            esm_distro,
+            not hide_esm_messages,
+        ]
+    ):
         _output_esm_package_alert(
             outstream, service_type="Infra",
             disabled_pkg_count=disabled_esm_infra_updates,
@@ -493,7 +504,8 @@ def run(options=None):
                                      esm_infra_updates, esm_apps_updates,
                                      have_esm_infra, have_esm_apps,
                                      disabled_esm_infra_updates,
-                                     disabled_esm_apps_updates)
+                                     disabled_esm_apps_updates,
+                                     options.hide_esm_messages)
     else:
         # print the number of regular upgrades and the number of
         # security upgrades
@@ -528,6 +540,12 @@ if __name__ == "__main__":
                       dest="readable_output",
                       help=_("Show human readable output on stdout"))
     parser.add_option("",
+                      "--no-esm-messages",
+                      action="store_true",
+                      dest="hide_esm_messages",
+                      help=_("Do not show esm related messages in human "
+                             "readable output"))
+    parser.add_option("",
                       "--security-updates-unattended",
                       action="store_true",
                       help=_("Return the time in days when security updates "
diff --git a/data/update-motd-updates-available b/data/update-motd-updates-available
index 7528b50..095dac5 100755
--- a/data/update-motd-updates-available
+++ b/data/update-motd-updates-available
@@ -2,13 +2,25 @@
 #
 # helper for update-motd
 
+NEED_UPDATE_CHECK="no"
+NO_ESM_MESSAGES=""
 
-# poor mans force
-if [ "$1" = "--force" ]; then
-    NEED_UPDATE_CHECK=yes
-else
-    NEED_UPDATE_CHECK=no
-fi
+while [[ $# -gt 0 ]]; do
+  case $1 in
+    # poor mans force
+    --force)
+      NEED_UPDATE_CHECK="yes"
+      shift
+      ;;
+    --no-esm-messages)
+      NO_ESM_MESSAGES="--no-esm-messages"
+      shift
+      ;;
+    *)
+      shift
+      ;;
+  esac
+done
 
 # check time when we did the last update check
 stamp="/var/lib/update-notifier/updates-available"
@@ -52,7 +64,7 @@ if [ "$NEED_UPDATE_CHECK" = "yes" ]; then
     {
 
         echo ""
-        /usr/lib/update-notifier/apt-check --human-readable
+        /usr/lib/update-notifier/apt-check --human-readable "$NO_ESM_MESSAGES"
         echo ""
     } > "$tmpfile"
     mv "$tmpfile" "$stamp"
diff --git a/debian/changelog b/debian/changelog
index 5732c80..9c0b2bc 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+update-notifier (3.192.1.20) bionic; urgency=medium
+
+  * apt-check: add option to hide ESM messages from the human readable output.
+    (LP: #2015420)
+
+ -- Renan Rodrigo Barbosa <[e-mail]>  Wed, 31 Jan 2024 11:40:02 -0300
+
 update-notifier (3.192.1.19) bionic; urgency=medium
 
   * Isolate creation of the esm apt cache in apt-check (LP: #2008212)
diff --git a/tests/test_motd.py b/tests/test_motd.py
index db62c99..59a080c 100755
--- a/tests/test_motd.py
+++ b/tests/test_motd.py
@@ -29,7 +29,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=False, have_esm_apps=False,
                         disabled_esm_infra_updates=1,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 Expanded Security Maintenance for Infrastructure is not enabled.
@@ -52,7 +52,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=False, have_esm_apps=False,
                         disabled_esm_infra_updates=23,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 Expanded Security Maintenance for Infrastructure is not enabled.
@@ -76,7 +76,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=False, have_esm_apps=False,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 Expanded Security Maintenance for Infrastructure is not enabled.
@@ -99,7 +99,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=False, have_esm_apps=False,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 Expanded Security Maintenance for Infrastructure is not enabled.
@@ -121,7 +121,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=False, have_esm_apps=False,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 Expanded Security Maintenance for Infrastructure is not enabled.
@@ -142,7 +142,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=13, esm_apps_updates=0,
                         have_esm_infra=True, have_esm_apps=False,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 Expanded Security Maintenance for Infrastructure is enabled.
@@ -162,7 +162,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=13, esm_apps_updates=0,
                         have_esm_infra=True, have_esm_apps=False,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 Expanded Security Maintenance for Infrastructure is enabled.
@@ -183,7 +183,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=True, have_esm_apps=False,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=10),
+                        disabled_esm_apps_updates=10, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 Expanded Security Maintenance for Infrastructure is enabled.
@@ -201,7 +201,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=15, esm_apps_updates=15,
                         have_esm_infra=True, have_esm_apps=True,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """
                 Expanded Security Maintenance for Infrastructure is enabled.
@@ -222,7 +222,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=15,
                         have_esm_infra=False, have_esm_apps=True,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """
                 Expanded Security Maintenance for Infrastructure is not enabled.
@@ -247,7 +247,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=1,
                         have_esm_infra=False, have_esm_apps=True,
                         disabled_esm_infra_updates=40,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """
                 Expanded Security Maintenance for Infrastructure is not enabled.
@@ -272,7 +272,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=1,
                         have_esm_infra=False, have_esm_apps=True,
                         disabled_esm_infra_updates=40,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """
                 Expanded Security Maintenance for Applications is enabled.
@@ -293,7 +293,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=False, have_esm_apps=False,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=40),
+                        disabled_esm_apps_updates=40, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 Expanded Security Maintenance for Infrastructure is not enabled.
@@ -316,7 +316,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=None, have_esm_apps=None,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 30 updates can be applied immediately.
@@ -334,7 +334,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=None, have_esm_apps=None,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 30 updates can be applied immediately.
@@ -352,7 +352,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=False, have_esm_apps=False,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=40),
+                        disabled_esm_apps_updates=40, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 30 updates can be applied immediately.
@@ -375,7 +375,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=False, have_esm_apps=False,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=40),
+                        disabled_esm_apps_updates=40, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 30 updates can be applied immediately.
@@ -393,7 +393,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=False, have_esm_apps=False,
                         disabled_esm_infra_updates=10,
-                        disabled_esm_apps_updates=40),
+                        disabled_esm_apps_updates=40, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 Expanded Security Maintenance for Applications is not enabled.
@@ -416,7 +416,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=None, have_esm_apps=None,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 0 updates can be applied immediately.
@@ -432,7 +432,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=None, have_esm_apps=None,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 1 update can be applied immediately.
@@ -449,7 +449,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=None, have_esm_apps=None,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 1 update can be applied immediately.
@@ -467,7 +467,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=None, have_esm_apps=None,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 0 updates can be applied immediately.
@@ -483,7 +483,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=False, have_esm_apps=False,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 Expanded Security Maintenance for Applications is not enabled.
@@ -504,7 +504,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=None, have_esm_apps=None,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 1 update can be applied immediately.
@@ -521,7 +521,7 @@ class TestMotd(unittest.TestCase):
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=None, have_esm_apps=None,
                         disabled_esm_infra_updates=0,
-                        disabled_esm_apps_updates=0),
+                        disabled_esm_apps_updates=0, hide_esm_messages=False),
             textwrap.dedent(
                 """\
                 1 update can be applied immediately.
@@ -529,6 +529,94 @@ class TestMotd(unittest.TestCase):
                 To see these additional updates run: apt list --upgradable
                 """))
 
+    @mock.patch("apt_check.is_lts_distro", return_value=True)
+    @mock.patch("apt_check.is_esm_distro", return_value=False)
+    def test_message_no_upgrades_lts_distro_with_esm_sources_hide_esm(
+        self, _m_is_esm, _m_is_lts
+    ):
+        self.assertEqual(
+            get_message(upgrades=0, security_updates=0,
+                        esm_infra_updates=0, esm_apps_updates=0,
+                        have_esm_infra=False, have_esm_apps=False,
+                        disabled_esm_infra_updates=0,
+                        disabled_esm_apps_updates=0, hide_esm_messages=True),
+            textwrap.dedent(
+                """\
+                0 updates can be applied immediately.
+                """))
+
+    @mock.patch("apt_check.is_lts_distro", return_value=True)
+    @mock.patch("apt_check.is_esm_distro", return_value=False)
+    def test_message_for_lts_distro_not_in_esm_mode_yet_hide_esm(
+        self, _m_is_esm, _m_is_lts
+    ):
+        self.assertEqual(
+            get_message(upgrades=30, security_updates=18,
+                        esm_infra_updates=0, esm_apps_updates=0,
+                        have_esm_infra=False, have_esm_apps=False,
+                        disabled_esm_infra_updates=10,
+                        disabled_esm_apps_updates=40, hide_esm_messages=True),
+            textwrap.dedent(
+                """\
+                30 updates can be applied immediately.
+                18 of these updates are standard security updates.
+                To see these additional updates run: apt list --upgradable
+                """))
+
+    @mock.patch("apt_check.is_lts_distro", return_value=True)
+    @mock.patch("apt_check.is_esm_distro", return_value=False)
+    def test_esm_infra_disabled_wih_pkgs_and_esm_apps_on_lts_distro_hide_esm(
+        self, _m_esm_distro, _m_is_lts
+    ):
+        self.assertEqual(
+            get_message(upgrades=30, security_updates=15,
+                        esm_infra_updates=0, esm_apps_updates=1,
+                        have_esm_infra=False, have_esm_apps=True,
+                        disabled_esm_infra_updates=40,
+                        disabled_esm_apps_updates=0, hide_esm_messages=True),
+            textwrap.dedent(
+                """
+                30 updates can be applied immediately.
+                15 of these updates are standard security updates.
+                To see these additional updates run: apt list --upgradable
+                """).lstrip())
+
+    @mock.patch("apt_check.get_distro_version", return_value="16.04")
+    @mock.patch("apt_check.is_lts_distro", return_value=True)
+    @mock.patch("apt_check.is_esm_distro", return_value=True)
+    def test_esm_infra_disabled_wih_pkgs_and_esm_apps_enabled_hide_esm(
+        self, _m_esm_distro, _m_is_lts, _m_distro_version
+    ):
+        self.assertEqual(
+            get_message(upgrades=30, security_updates=15,
+                        esm_infra_updates=0, esm_apps_updates=1,
+                        have_esm_infra=False, have_esm_apps=True,
+                        disabled_esm_infra_updates=40,
+                        disabled_esm_apps_updates=0, hide_esm_messages=True),
+            textwrap.dedent(
+                """
+                30 updates can be applied immediately.
+                15 of these updates are standard security updates.
+                To see these additional updates run: apt list --upgradable
+                """).lstrip())
+
+    @mock.patch("apt_check.is_lts_distro", return_value=True)
+    @mock.patch("apt_check.is_esm_distro", return_value=True)
+    def test_esm_infra_and_esm_apps_enabled_hide_esm(
+        self, _m_esm_distro, _m_is_lts
+    ):
+        self.assertEqual(
+            get_message(upgrades=30, security_updates=0,
+                        esm_infra_updates=15, esm_apps_updates=15,
+                        have_esm_infra=True, have_esm_apps=True,
+                        disabled_esm_infra_updates=0,
+                        disabled_esm_apps_updates=0, hide_esm_messages=True),
+            textwrap.dedent(
+                """
+                30 updates can be applied immediately.
+                To see these additional updates run: apt list --upgradable
+                """).lstrip())
+
 
 class TestGetDistro(unittest.TestCase):
     @mock.patch("os.path.exists", return_value=True)