Merge ~chad.smith/ubuntu/+source/update-notifier:ua-motd-bionic into ubuntu/+source/update-notifier:ubuntu/bionic-proposed

[Chad Smith]

Cherry picks of upstream commits to support motd information about ESM Apps and ESM Infra for ubuntu-advantage-tools motd package counts and availability.

Not certain which branch should best be targeted for this merge and from whom to request review.

The following is a list of cherrypicks performed and merged:

cherry-pick/backport upstream/master 770c27fb
cherry-pick upstream/master 7a0458f62

cherry-pick/backport upstream/master 4fdf27ab
cherry-pick 4b2fb30fddf93f14c8e4d505a6ce785ad9a06703
cherry-pick e39789ac632585bb11dc6f1e4fad60ec8361725b

cherry-pick ubuntu/devel commit c065e9ebd957ead33c7afc4d570b0ee0433f7601

This constitutes the following debian/changelog entry:

  [ Julian Andres Klode ]
  * Handle missing cases of LP: #1822340, where we told people ESM is not
    enabled, but not how to enable it.
  * Fix multiple disabled ESM repositories being counted as enabled ones.

  [ Brian Murray ]
  * data/apt_check.py: modify wording and output regarding ESM support.
    (LP: #1842508)

  [ Andreas Hasenack ]
  * data/apt_check.py: Update ESM security pockets names (LP: #1881632)
    - the UbuntuESM pocket was renamed from <distro>-security to
      <distro>-infra-security
    - new origin UbuntuESMApps, with a corresponding pocket of
      <distro>-apps-security

[Brian Murray (brian-murray)]

Uploaded https://launchpad.net/ubuntu/bionic/+queue?queue_state=1&queue_text=update-notifier

review: Approve

diff --git a/data/apt_check.py b/data/apt_check.py
index 100faac..6bb716f 100755
--- a/data/apt_check.py
+++ b/data/apt_check.py
@@ -16,6 +16,8 @@ DISTRO = subprocess.check_output(
     ["lsb_release", "-c", "-s"],
     universal_newlines=True).strip()
 
+ESM_ORIGINS = ("UbuntuESM", "UbuntuESMApps")
+
 
 def _(msg):
     return gettext.dgettext("update-notifier", msg)
@@ -45,6 +47,8 @@ def saveDistUpgrade(cache, depcache):
 def isSecurityUpgrade(ver):
     " check if the given version is a security update (or masks one) "
     security_pockets = [("Ubuntu", "%s-security" % DISTRO),
+                        ("UbuntuESM", "%s-infra-security" % DISTRO),
+                        ("UbuntuESMApps", "%s-apps-security" % DISTRO),
                         ("gNewSense", "%s-security" % DISTRO),
                         ("Debian", "%s-updates" % DISTRO)]
     for (file, index) in ver.file_list:
@@ -54,6 +58,14 @@ def isSecurityUpgrade(ver):
     return False
 
 
+def isESMUpgrade(ver):
+    " check if the given version is a security update (or masks one) "
+    for (file, index) in ver.file_list:
+        if file.origin in ESM_ORIGINS and file.archive.startswith(DISTRO):
+            return True
+    return False
+
+
 def write_package_names(outstream, cache, depcache):
     " write out package names that change to outstream "
     pkgs = [pkg for pkg in cache.packages if depcache.marked_install(pkg) or
@@ -61,20 +73,92 @@ def write_package_names(outstream, cache, depcache):
     outstream.write("\n".join([p.name for p in pkgs]))
 
 
-def write_human_readable_summary(outstream, upgrades, security_updates):
+def write_human_readable_summary(outstream, upgrades, security_updates,
+                                 esm_updates, have_esm, disabled_esm_updates):
     " write out human summary summary to outstream "
+    if have_esm is not None:
+        if have_esm:
+            outstream.write(gettext.dgettext("update-notifier",
+                                             "UA Infrastructure Extended "
+                                             "Security Maintenance (ESM) is "
+                                             "enabled."))
+        else:
+            outstream.write(gettext.dgettext("update-notifier",
+                                             "UA Infrastructure Extended "
+                                             "Security Maintenance (ESM) is "
+                                             "not enabled."))
+        outstream.write("\n\n")
+
     outstream.write(gettext.dngettext("update-notifier",
                                       "%i package can be updated.",
                                       "%i packages can be updated.",
                                       upgrades) % upgrades)
     outstream.write("\n")
+    if esm_updates > 0:
+        outstream.write(gettext.dngettext("update-notifier",
+                                          "%i of these updates is provided "
+                                          "through UA Infrastructure ESM.",
+                                          "%i of these updates are "
+                                          "provided through UA "
+                                          "Infrastructure ESM.",
+                                          esm_updates) %
+                        esm_updates)
+        outstream.write("\n")
     outstream.write(gettext.dngettext("update-notifier",
-                                      "%i update is a security update.",
-                                      "%i updates are security updates.",
-                                      security_updates) % security_updates)
+                                      "%i of these updates is a "
+                                      "security update.",
+                                      "%i of these updates are "
+                                      "security updates.",
+                                      security_updates) %
+                    security_updates)
+    if upgrades > 0 or security_updates > 0 or esm_updates > 0:
+        outstream.write("\n")
+        outstream.write(gettext.dgettext("update-notifier",
+                                         "To see these additional updates "
+                                         "run: apt list --upgradable"))
+    if have_esm is not None and not have_esm:
+        outstream.write("\n")
+        if disabled_esm_updates > 0:
+            outstream.write("\n")
+            outstream.write(gettext.dngettext("update-notifier",
+                                              "Enable UA Infrastructure ESM "
+                                              "to receive %i additional "
+                                              "security update.",
+                                              "Enable UA Infrastructure ESM "
+                                              "to receive %i additional "
+                                              "security updates.",
+                                              disabled_esm_updates) %
+                            disabled_esm_updates)
+        else:
+            outstream.write("\n")
+            outstream.write(gettext.dgettext("update-notifier",
+                                             "Enable UA Infrastructure ESM to "
+                                             "receive additional future "
+                                             "security updates."))
+        outstream.write("\n")
+        outstream.write(gettext.dgettext("update-notifier",
+                                         "See https://ubuntu.com/esm "
+                                         "or run: sudo ua status"))
     outstream.write("\n")
 
 
+def has_disabled_esm_security_update(depcache, pkg):
+    " check if we have a disabled ESM security update "
+    inst_ver = pkg.current_ver
+    if not inst_ver:
+        return False
+
+    for ver in pkg.version_list:
+        if ver == inst_ver:
+            break
+
+        for (file, index) in ver.file_list:
+            if (file.origin in ESM_ORIGINS and file.archive.startswith(DISTRO)
+                    and depcache.policy.get_priority(file) == -32768):
+                return True
+    return False
+
+
 def init():
     " init the system, be nice "
     # FIXME: do a ionice here too?
@@ -115,13 +199,34 @@ def run(options=None):
         sys.stderr.write("E: " + _("Error: Marking the upgrade (%s)") % e)
         sys.exit(-1)
 
+    # Check if we have ESM enabled or disabled; and if it exists in the
+    # first place.
+    have_esm = None        # None == does not exist
+    for file in cache.file_list:
+        if file.origin in ESM_ORIGINS and file.archive.startswith(DISTRO):
+            # In case of multiple ESM repos, one enabled is sufficient.
+            if depcache.policy.get_priority(file) == -32768:
+                # We found a disabled ESM repository, but we'll only count
+                # ESM as disabled here if we have not found any other ESM
+                # repo, so one ESM repo being enabled means ESM is enabled.
+                if have_esm is None:
+                    have_esm = False
+            else:
+                have_esm = True
+                break
+
     # analyze the ugprade
     upgrades = 0
     security_updates = 0
+    esm_updates = 0
+    disabled_esm_updates = 0
 
     # we need another cache that has more pkg details
     with apt.Cache() as aptcache:
         for pkg in cache.packages:
+            if has_disabled_esm_security_update(depcache, pkg):
+                disabled_esm_updates += 1
+
             # skip packages that are not marked upgraded/installed
             if not (depcache.marked_install(pkg) or
                     depcache.marked_upgrade(pkg)):
@@ -134,6 +239,8 @@ def run(options=None):
                 continue
             # check for security upgrades
             if isSecurityUpgrade(cand_ver):
+                if isESMUpgrade(cand_ver):
+                    esm_updates += 1
                 upgrades += 1
                 security_updates += 1
                 continue
@@ -160,6 +267,8 @@ def run(options=None):
                         0):
                     # print("skipping '%s' " % ver.VerStr)
                     continue
+                if isESMUpgrade(ver):
+                    esm_updates += 1
                 if isSecurityUpgrade(ver):
                     security_updates += 1
                     break
@@ -168,7 +277,9 @@ def run(options=None):
     if options and options.show_package_names:
         write_package_names(sys.stderr, cache, depcache)
     elif options and options.readable_output:
-        write_human_readable_summary(sys.stdout, upgrades, security_updates)
+        write_human_readable_summary(sys.stdout, upgrades, security_updates,
+                                     esm_updates, have_esm,
+                                     disabled_esm_updates)
     else:
         # print the number of regular upgrades and the number of
         # security upgrades
diff --git a/debian/changelog b/debian/changelog
index ce2d89e..b688483 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,23 @@
+update-notifier (3.192.1.8) bionic; urgency=medium
+
+  [ Andreas Hasenack ]
+  * data/apt_check.py: Update ESM security pockets names (LP: #1881632)
+    - the UbuntuESM pocket was renamed from <distro>-security to
+      <distro>-infra-security
+    - new origin UbuntuESMApps, with a corresponding pocket of
+      <distro>-apps-security
+
+  [ Brian Murray ]
+  * data/apt_check.py: modify wording and output regarding ESM support.
+    (LP: #1842508)
+
+  [ Julian Andres Klode ]
+  * Handle missing cases of LP: #1822340, where we told people ESM is not
+    enabled, but not how to enable it.
+  * Fix multiple disabled ESM repositories being counted as enabled ones.
+
+ -- Chad Smith <[e-mail]>  Tue, 29 Sep 2020 16:49:23 -0600
+
 update-notifier (3.192.1.7) bionic; urgency=medium
 
   * Backport some fixes for the previous changes, from Andrea Azzarone
diff --git a/tests/test_motd.py b/tests/test_motd.py
 new file mode 100755
index 0000000..2523958
--- /dev/null
+++ b/tests/test_motd.py
@@ -0,0 +1,151 @@
+#!/usr/bin/python3
+# -*- Mode: Python; indent-tabs-mode: nil; tab-width: 4; coding: utf-8 -*-
+
+import apt_check
+import io
+import os
+import subprocess
+import unittest
+import textwrap
+
+
+def get_message(*args, **kwds):
+    with io.StringIO() as stream:
+        apt_check.write_human_readable_summary(stream, *args, **kwds)
+        return stream.getvalue()
+
+
+class TestMotd(unittest.TestCase):
+    """ ensure that the tree is pep8 clean """
+
+    def test_esm_disabled_upto_date_esm_avail(self):
+        self.assertEqual(
+            get_message(upgrades=0, security_updates=0,
+                        esm_updates=0, have_esm=False,
+                        disabled_esm_updates=23),
+            textwrap.dedent(
+                """
+                UA Infrastructure Extended Security Maintenance (ESM) is not enabled.
+
+                0 updates can be installed immediately.
+                0 of these updates are security updates.
+
+                Enable UA Infrastructure ESM to receive 23 additional security updates.
+                See https://ubuntu.com/esm or run: sudo ua status
+                """).lstrip())
+
+    def test_esm_disabled_security_esm_avail(self):
+        self.assertEqual(
+            get_message(upgrades=15, security_updates=7,
+                        esm_updates=0, have_esm=False,
+                        disabled_esm_updates=23),
+            textwrap.dedent(
+                """
+                UA Infrastructure Extended Security Maintenance (ESM) is not enabled.
+
+                15 updates can be installed immediately.
+                7 of these updates are security updates.
+                To see these additional updates run: apt list --upgradable
+
+                Enable UA Infrastructure ESM to receive 23 additional security updates.
+                See https://ubuntu.com/esm or run: sudo ua status
+                """).lstrip())
+
+    def test_esm_disabled_security_no_esm_avail(self):
+        self.assertEqual(
+            get_message(upgrades=15, security_updates=7,
+                        esm_updates=0, have_esm=False,
+                        disabled_esm_updates=0),
+            textwrap.dedent(
+                """
+                UA Infrastructure Extended Security Maintenance (ESM) is not enabled.
+
+                15 updates can be installed immediately.
+                7 of these updates are security updates.
+                To see these additional updates run: apt list --upgradable
+
+                Enable UA Infrastructure ESM to receive additional future security updates.
+                See https://ubuntu.com/esm or run: sudo ua status
+                """).lstrip())
+
+    def test_esm_disabled_nosecurity(self):
+        self.assertEqual(
+            get_message(upgrades=15, security_updates=0,
+                        esm_updates=0, have_esm=False,
+                        disabled_esm_updates=0),
+            textwrap.dedent(
+                """
+                UA Infrastructure Extended Security Maintenance (ESM) is not enabled.
+
+                15 updates can be installed immediately.
+                0 of these updates are security updates.
+                To see these additional updates run: apt list --upgradable
+
+                Enable UA Infrastructure ESM to receive additional future security updates.
+                See https://ubuntu.com/esm or run: sudo ua status
+                """).lstrip())
+
+    def test_esm_disabled_noupdates(self):
+        self.assertEqual(
+            get_message(upgrades=0, security_updates=0,
+                        esm_updates=0, have_esm=False,
+                        disabled_esm_updates=0),
+            textwrap.dedent(
+                """
+                UA Infrastructure Extended Security Maintenance (ESM) is not enabled.
+
+                0 updates can be installed immediately.
+                0 of these updates are security updates.
+
+                Enable UA Infrastructure ESM to receive additional future security updates.
+                See https://ubuntu.com/esm or run: sudo ua status
+                """).lstrip())
+
+    def test_esm_enabled_nosecurity(self):
+        self.assertEqual(
+            get_message(upgrades=35, security_updates=0,
+                        esm_updates=13, have_esm=True,
+                        disabled_esm_updates=0),
+            textwrap.dedent(
+                """
+                UA Infrastructure Extended Security Maintenance (ESM) is enabled.
+
+                35 updates can be installed immediately.
+                13 of these updates are provided through UA Infrastructure ESM.
+                0 of these updates are security updates.
+                To see these additional updates run: apt list --upgradable
+                """).lstrip())
+
+    def test_esm_enabled_somesecurity(self):
+        self.assertEqual(
+            get_message(upgrades=47, security_updates=7,
+                        esm_updates=13, have_esm=True,
+                        disabled_esm_updates=0),
+            textwrap.dedent(
+                """
+                UA Infrastructure Extended Security Maintenance (ESM) is enabled.
+
+                47 updates can be installed immediately.
+                13 of these updates are provided through UA Infrastructure ESM.
+                7 of these updates are security updates.
+                To see these additional updates run: apt list --upgradable
+                """).lstrip())
+
+    def test_esm_enabled_noupdates(self):
+        self.assertEqual(
+            get_message(upgrades=0, security_updates=0,
+                        esm_updates=0, have_esm=True,
+                        disabled_esm_updates=0),
+            textwrap.dedent(
+                """
+                UA Infrastructure Extended Security Maintenance (ESM) is enabled.
+
+                0 updates can be installed immediately.
+                0 of these updates are security updates.
+                """).lstrip())
+
+
+if __name__ == "__main__":
+    import logging
+    logging.basicConfig(level=logging.DEBUG)
+    unittest.main()
diff --git a/tests/test_pep8.py b/tests/test_pep8.py
index a85bf7e..fa6c416 100644
--- a/tests/test_pep8.py
+++ b/tests/test_pep8.py
@@ -16,17 +16,21 @@ class TestPep8Clean(unittest.TestCase):
 
     def test_pep8_clean(self):
         CURDIR = os.path.dirname(os.path.abspath(__file__))
-        py_files = set()
         for dirpath, dirs, files in os.walk(os.path.join(CURDIR, "..")):
             for f in files:
                 if os.path.splitext(f)[1] != ".py":
                     continue
                 if f in IGNORE_FILES:
                     continue
-                py_files.add(os.path.join(dirpath, f))
-        ret_code = subprocess.call(
-            ["pep8", "--ignore={0}".format(IGNORE_PEP8)] + list(py_files))
-        self.assertEqual(0, ret_code)
+                py_file = os.path.join(dirpath, f)
+                if f == 'test_motd.py':
+                    ret_code = subprocess.call(
+                        ["pep8", "--ignore={0}".format(IGNORE_PEP8 + ", E501"),
+                         py_file])
+                else:
+                    ret_code = subprocess.call(
+                        ["pep8", "--ignore={0}".format(IGNORE_PEP8), py_file])
+                self.assertEqual(0, ret_code)
 
 
 if __name__ == "__main__":