Merge ~lamoura/update-notifier:treat-security-updates-as-separate-bucket into update-notifier:master

[Lucas Albuquerque Medeiros de Moura]

Currently, we display packaging count for both ESM and security updates. However, if the package upgrade comes from ESM, we still count it as a security update. This can provide confusing messages to users, since we don't say in that message that security updates contain both source of packages. To better handle that, we are now only treating as security updates only security upgrades
that are not related to ESM packages.

For example, this will turn this message:
5 updates can be installed immediately.
5 of these updates are UA Apps: ESM security updates.
5 of these updates are security updates

Into:
5 updates can be installed immediately.
5 of these updates are UA Apps: ESM security updates.

Another example, we turn this message from:
8 updates can be installed immediately.
5 of these updates are UA Apps: ESM security updates.
8 of these updates are security updates

to:
8 updates can be installed immediately.
5 of these updates are UA Apps: ESM security updates.
3 of these updates are standard security updates

[Chad Smith (chad.smith)]

Looks really good. Just a nit about the commit message and don't we also need a second commit with a new debian/changelog entry explaining this change? via dch -i

review: Needs Fixing

[Chad Smith (chad.smith)]

Thanks for the commit message update here. +1. I'll let you sort debian/changelog requirements separately

review: Approve

diff --git a/data/apt_check.py b/data/apt_check.py
index f984e45..2f2bb3d 100755
--- a/data/apt_check.py
+++ b/data/apt_check.py
@@ -70,10 +70,12 @@ def _isESMUpgrade(ver, esm_origin):
 
 
 def isESMAppsUpgrade(ver):
+    " check if the given version is a ESM Apps upgrade "
     return _isESMUpgrade(ver, esm_origin=ESM_APPS_ORIGIN)
 
 
 def isESMInfraUpgrade(ver):
+    " check if the given version is a ESM Infra upgrade "
     return _isESMUpgrade(ver, esm_origin=ESM_INFRA_ORIGIN)
 
 
@@ -85,6 +87,7 @@ def write_package_names(outstream, cache, depcache):
 
 
 def is_esm_distro():
+    " check if the current distro is ESM or not "
     ubuntu_distro = distro_info.UbuntuDistroInfo()
 
     is_esm_supported = bool(
@@ -99,16 +102,18 @@ def is_esm_distro():
 
 
 def is_lts_distro():
+    " check if the current distro is LTS or not"
     return distro_info.UbuntuDistroInfo().is_lts(DISTRO)
 
 
 def _output_esm_package_count(outstream, service_type, esm_pkg_count):
+    " output the number of packages upgrades related to esm service "
     if esm_pkg_count > 0:
         outstream.write("\n")
         outstream.write(gettext.dngettext("update-notifier",
                                           "%d of these updates "
-                                          "are UA %s: ESM "
-                                          "security updates.",
+                                          "is an UA %s: ESM "
+                                          "security update.",
                                           "%d of these updates "
                                           "are UA %s: ESM "
                                           "security updates.",
@@ -119,12 +124,13 @@ def _output_esm_package_count(outstream, service_type, esm_pkg_count):
 def _output_esm_package_alert(
     outstream, service_type, disabled_pkg_count
 ):
+    " output the number of upgradable packages if esm service was enabled "
     outstream.write("\n")
     if disabled_pkg_count > 0:
         outstream.write("\n")
         outstream.write(gettext.dngettext("update-notifier",
                                           "%i additional security "
-                                          "updates can be applied "
+                                          "update can be applied "
                                           "with UA %s: ESM\nLearn "
                                           "more about enabling UA "
                                           "%s: ESM service at "
@@ -159,9 +165,9 @@ def write_human_readable_summary(outstream, upgrades, security_updates,
                                  disabled_esm_infra_updates,
                                  disabled_esm_apps_updates):
 
+    " write out human summary summary to outstream "
     esm_distro = is_esm_distro()
     lts_distro = is_lts_distro()
-    " write out human summary summary to outstream "
     if have_esm_infra is not None and esm_distro:
         if have_esm_infra:
             outstream.write(gettext.dgettext("update-notifier",
@@ -173,28 +179,30 @@ def write_human_readable_summary(outstream, upgrades, security_updates,
                                              "UA Infra: Extended "
                                              "Security Maintenance (ESM) is "
                                              "not enabled."))
-        outstream.write("\n\n")
-
-    outstream.write(
-        gettext.dngettext("update-notifier",
-                          "%i updates can be installed immediately.",
-                          "%i updates can be installed immediately.",
-                          upgrades) % upgrades
-    )
+        if upgrades > 0:
+            outstream.write("\n\n")
+    if upgrades > 0:
+        outstream.write(
+            gettext.dngettext("update-notifier",
+                              "%i update can be applied immediately.",
+                              "%i updates can be applied immediately.",
+                              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)
 
-    outstream.write("\n")
-    outstream.write(gettext.dngettext("update-notifier",
-                                      "%i of these updates is a "
-                                      "security update.",
-                                      "%i of these updates are "
-                                      "security updates.",
-                                      security_updates) %
-                    security_updates)
+    if security_updates > 0:
+        outstream.write("\n")
+        outstream.write(gettext.dngettext("update-notifier",
+                                          "%i of these updates is a "
+                                          "standard security update.",
+                                          "%i of these updates are "
+                                          "standard security updates.",
+                                          security_updates) %
+                        security_updates)
 
     if any([upgrades, security_updates, esm_infra_updates, esm_apps_updates]):
         outstream.write("\n")
@@ -233,14 +241,17 @@ def has_disabled_esm_security_update(depcache, pkg, esm_origin):
 
 
 def has_disabled_esm_apps_security_update(depcache, pkg):
+    " check if we have a disabled ESM Apps security update "
     return has_disabled_esm_security_update(depcache, pkg, ESM_APPS_ORIGIN)
 
 
 def has_disabled_esm_infra_security_update(depcache, pkg):
+    " check if we have a disabled ESM Infra security update "
     return has_disabled_esm_security_update(depcache, pkg, ESM_INFRA_ORIGIN)
 
 
 def has_esm_service(cache, depcache, esm_origin):
+    " check if we have an enabled ESM service in the machine "
     have_esm = None
     for file in cache.file_list:
         origin = file.origin
@@ -338,8 +349,10 @@ def run(options=None):
                     esm_apps_updates += 1
                 elif have_esm_infra and isESMInfraUpgrade(cand_ver):
                     esm_infra_updates += 1
+                else:
+                    security_updates += 1
+
                 upgrades += 1
-                security_updates += 1
                 continue
 
             # check to see if the update is a phased one
@@ -367,8 +380,7 @@ def run(options=None):
                     esm_apps_updates += 1
                 elif have_esm_infra and isESMInfraUpgrade(cand_ver):
                     esm_infra_updates += 1
-
-                if isSecurityUpgrade(ver):
+                elif isSecurityUpgrade(ver):
                     security_updates += 1
                     break
 
diff --git a/debian/changelog b/debian/changelog
index 5d860ba..0383f94 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -5,6 +5,10 @@ update-notifier (3.192.41) hirsute; urgency=medium
       and only display alerts if the distro is ESM. (LP: #1924766)
     - Do not display a count of ESM packages if the system does not have ESM
       enabled. (LP: #1883315)
+    - Make distinction between standard security updates and ESM updates
+      when performing package counts. (LP: #1926208)
+    - use 'applied' instead of 'installed', redact 0 of these updates are
+      security updates, and correct singular messages
   * debian/control: Add a dependency on python3-distro-info.
 
  -- Brian Murray <[e-mail]>  Mon, 19 Apr 2021 13:47:41 -0700
diff --git a/tests/test_motd.py b/tests/test_motd.py
index f3b982c..335adce 100755
--- a/tests/test_motd.py
+++ b/tests/test_motd.py
@@ -27,19 +27,16 @@ class TestMotd(unittest.TestCase):
             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=23,
+                        disabled_esm_infra_updates=1,
                         disabled_esm_apps_updates=0),
             textwrap.dedent(
                 """\
                 UA Infra: Extended Security Maintenance (ESM) is not enabled.
 
-                0 updates can be installed immediately.
-                0 of these updates are security updates.
-
                 Enable UA Apps: ESM to receive additional future security updates.
                 See https://ubuntu.com/esm or run: sudo ua status
 
-                23 additional security updates can be applied with UA Infra: ESM
+                1 additional security update can be applied with UA Infra: ESM
                 Learn more about enabling UA Infra: ESM service at https://ubuntu.com/esm
                 """))
 
@@ -49,7 +46,7 @@ class TestMotd(unittest.TestCase):
         self, _m_esm_distro, _m_is_lts
     ):
         self.assertEqual(
-            get_message(upgrades=15, security_updates=7,
+            get_message(upgrades=15, security_updates=1,
                         esm_infra_updates=0, esm_apps_updates=0,
                         have_esm_infra=False, have_esm_apps=False,
                         disabled_esm_infra_updates=23,
@@ -58,8 +55,8 @@ class TestMotd(unittest.TestCase):
                 """\
                 UA Infra: Extended Security Maintenance (ESM) is not enabled.
 
-                15 updates can be installed immediately.
-                7 of these updates are security updates.
+                15 updates can be applied immediately.
+                1 of these updates is a standard security update.
                 To see these additional updates run: apt list --upgradable
 
                 Enable UA Apps: ESM to receive additional future security updates.
@@ -84,8 +81,8 @@ class TestMotd(unittest.TestCase):
                 """\
                 UA Infra: Extended Security Maintenance (ESM) is not enabled.
 
-                15 updates can be installed immediately.
-                7 of these updates are security updates.
+                15 updates can be applied immediately.
+                7 of these updates are standard security updates.
                 To see these additional updates run: apt list --upgradable
 
                 Enable UA Apps: ESM to receive additional future security updates.
@@ -110,8 +107,7 @@ class TestMotd(unittest.TestCase):
                 """\
                 UA Infra: Extended Security Maintenance (ESM) is not enabled.
 
-                15 updates can be installed immediately.
-                0 of these updates are security updates.
+                15 updates can be applied immediately.
                 To see these additional updates run: apt list --upgradable
 
                 Enable UA Apps: ESM to receive additional future security updates.
@@ -136,9 +132,6 @@ class TestMotd(unittest.TestCase):
                 """\
                 UA Infra: Extended Security Maintenance (ESM) is not enabled.
 
-                0 updates can be installed immediately.
-                0 of these updates are security updates.
-
                 Enable UA Apps: ESM to receive additional future security updates.
                 See https://ubuntu.com/esm or run: sudo ua status
 
@@ -161,9 +154,8 @@ class TestMotd(unittest.TestCase):
                 """\
                 UA Infra: Extended Security Maintenance (ESM) is enabled.
 
-                35 updates can be installed immediately.
+                35 updates can be applied immediately.
                 13 of these updates are UA Infra: ESM security updates.
-                0 of these updates are security updates.
                 To see these additional updates run: apt list --upgradable
 
                 Enable UA Apps: ESM to receive additional future security updates.
@@ -185,9 +177,9 @@ class TestMotd(unittest.TestCase):
                 """\
                 UA Infra: Extended Security Maintenance (ESM) is enabled.
 
-                47 updates can be installed immediately.
+                47 updates can be applied immediately.
                 13 of these updates are UA Infra: ESM security updates.
-                7 of these updates are security updates.
+                7 of these updates are standard security updates.
                 To see these additional updates run: apt list --upgradable
 
                 Enable UA Apps: ESM to receive additional future security updates.
@@ -209,9 +201,6 @@ class TestMotd(unittest.TestCase):
                 """\
                 UA Infra: Extended Security Maintenance (ESM) is enabled.
 
-                0 updates can be installed immediately.
-                0 of these updates are security updates.
-
                 10 additional security updates can be applied with UA Apps: ESM
                 Learn more about enabling UA Apps: ESM service at https://ubuntu.com/esm
                 """))
@@ -222,7 +211,7 @@ class TestMotd(unittest.TestCase):
         self, _m_esm_distro, _m_is_lts
     ):
         self.assertEqual(
-            get_message(upgrades=30, security_updates=18,
+            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,
@@ -231,10 +220,9 @@ class TestMotd(unittest.TestCase):
                 """
                 UA Infra: Extended Security Maintenance (ESM) is enabled.
 
-                30 updates can be installed immediately.
+                30 updates can be applied immediately.
                 15 of these updates are UA Infra: ESM security updates.
                 15 of these updates are UA Apps: ESM security updates.
-                18 of these updates are security updates.
                 To see these additional updates run: apt list --upgradable
                 """).lstrip())
 
@@ -244,7 +232,7 @@ class TestMotd(unittest.TestCase):
         self, _m_esm_distro, _m_is_lts
     ):
         self.assertEqual(
-            get_message(upgrades=30, security_updates=18,
+            get_message(upgrades=30, security_updates=12,
                         esm_infra_updates=0, esm_apps_updates=15,
                         have_esm_infra=False, have_esm_apps=True,
                         disabled_esm_infra_updates=0,
@@ -253,9 +241,9 @@ class TestMotd(unittest.TestCase):
                 """
                 UA Infra: Extended Security Maintenance (ESM) is not enabled.
 
-                30 updates can be installed immediately.
+                30 updates can be applied immediately.
                 15 of these updates are UA Apps: ESM security updates.
-                18 of these updates are security updates.
+                12 of these updates are standard security updates.
                 To see these additional updates run: apt list --upgradable
 
                 Enable UA Infra: ESM to receive additional future security updates.
@@ -268,8 +256,8 @@ class TestMotd(unittest.TestCase):
         self, _m_esm_distro, _m_is_lts
     ):
         self.assertEqual(
-            get_message(upgrades=30, security_updates=18,
-                        esm_infra_updates=0, esm_apps_updates=15,
+            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),
@@ -277,9 +265,9 @@ class TestMotd(unittest.TestCase):
                 """
                 UA Infra: Extended Security Maintenance (ESM) is not enabled.
 
-                30 updates can be installed immediately.
-                15 of these updates are UA Apps: ESM security updates.
-                18 of these updates are security updates.
+                30 updates can be applied immediately.
+                1 of these updates is an UA Apps: ESM security update.
+                15 of these updates are standard security updates.
                 To see these additional updates run: apt list --upgradable
 
                 40 additional security updates can be applied with UA Infra: ESM
@@ -301,8 +289,8 @@ class TestMotd(unittest.TestCase):
                 """\
                 UA Infra: Extended Security Maintenance (ESM) is not enabled.
 
-                30 updates can be installed immediately.
-                18 of these updates are security updates.
+                30 updates can be applied immediately.
+                18 of these updates are standard security updates.
                 To see these additional updates run: apt list --upgradable
 
                 40 additional security updates can be applied with UA Apps: ESM
@@ -325,8 +313,8 @@ class TestMotd(unittest.TestCase):
                         disabled_esm_apps_updates=0),
             textwrap.dedent(
                 """\
-                30 updates can be installed immediately.
-                18 of these updates are security updates.
+                30 updates can be applied immediately.
+                18 of these updates are standard security updates.
                 To see these additional updates run: apt list --upgradable
                 """))
 
@@ -343,8 +331,8 @@ class TestMotd(unittest.TestCase):
                         disabled_esm_apps_updates=0),
             textwrap.dedent(
                 """\
-                30 updates can be installed immediately.
-                18 of these updates are security updates.
+                30 updates can be applied immediately.
+                18 of these updates are standard security updates.
                 To see these additional updates run: apt list --upgradable
                 """))
 
@@ -361,8 +349,8 @@ class TestMotd(unittest.TestCase):
                         disabled_esm_apps_updates=40),
             textwrap.dedent(
                 """\
-                30 updates can be installed immediately.
-                18 of these updates are security updates.
+                30 updates can be applied immediately.
+                18 of these updates are standard security updates.
                 To see these additional updates run: apt list --upgradable
                 """))
 
@@ -384,8 +372,8 @@ class TestMotd(unittest.TestCase):
                         disabled_esm_apps_updates=40),
             textwrap.dedent(
                 """\
-                30 updates can be installed immediately.
-                18 of these updates are security updates.
+                30 updates can be applied immediately.
+                18 of these updates are standard security updates.
                 To see these additional updates run: apt list --upgradable
                 """))
 
@@ -402,8 +390,8 @@ class TestMotd(unittest.TestCase):
                         disabled_esm_apps_updates=40),
             textwrap.dedent(
                 """\
-                30 updates can be installed immediately.
-                18 of these updates are security updates.
+                30 updates can be applied immediately.
+                18 of these updates are standard security updates.
                 To see these additional updates run: apt list --upgradable
 
                 40 additional security updates can be applied with UA Apps: ESM