Merge lp:~juliank/update-notifier/esm into lp:update-notifier/ubuntu

[Julian Andres Klode]

[Brian Murray (brian-murray)]

Nothing critical but a few comments appear in-line.

[Joshua Powers (powersj)]

one in-line

[lp:~juliank/update-notifier/esm]

960. By Julian Andres Klode on 2019-04-01

apt-check: Count enabled ESM upgrades

[Brian Murray (brian-murray)]

A few more comments, thanks for addressing the other ones.

[lp:~juliank/update-notifier/esm]

961. By Julian Andres Klode on 2019-04-02

apt-check: Tell people to enable ESM if ESM updates are available

962. By Julian Andres Klode on 2019-04-02

Add changelog entry and test case

=== modified file 'data/apt_check.py'
--- data/apt_check.py	2018-11-13 20:53:28 +0000
+++ data/apt_check.py	2019-04-02 13:17:38 +0000
@@ -45,6 +45,7 @@
 def isSecurityUpgrade(ver):
     " check if the given version is a security update (or masks one) "
     security_pockets = [("Ubuntu", "%s-security" % DISTRO),
+                        ("UbuntuESM", "%s-security" % DISTRO),
                         ("gNewSense", "%s-security" % DISTRO),
                         ("Debian", "%s-updates" % DISTRO)]
     for (file, index) in ver.file_list:
@@ -54,6 +55,14 @@
     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 == "UbuntuESM" 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)
@@ -61,19 +70,77 @@
     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",
+                                             "Extended Security Maintenance "
+                                             "(ESM) is enabled."))
+        else:
+            outstream.write(gettext.dgettext("update-notifier",
+                                             "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.",
+                                      "%i update can be installed "
+                                      "immediately.",
+                                      "%i updates can be installed "
+                                      "immediately.",
                                       upgrades) % upgrades)
     outstream.write("\n")
+    if esm_updates > 0:
+        outstream.write(gettext.dngettext("update-notifier",
+                                          "%i of these updates is "
+                                          "provided through ESM.",
+                                          "%i of these updates are "
+                                          "provided through 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)
     outstream.write("\n")
 
+    if disabled_esm_updates > 0:
+        outstream.write("\n")
+        outstream.write(gettext.dngettext("update-notifier",
+                                          "Enable ESM to receive %i additional "
+                                          "security update.",
+                                          "Enable ESM to receive %i additional "
+                                          "security updates.",
+                                          disabled_esm_updates) %
+                        disabled_esm_updates)
+        outstream.write("\n")
+        outstream.write(gettext.dgettext("update-notifier",
+                                         "See 'ua enable esm' or "
+                                         "https://ubuntu.com/esm"))
+        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 == "UbuntuESM" and file.archive.startswith(DISTRO)
+                    and depcache.policy.get_priority(file) == -32768):
+                return True
+    return False
+
 
 def init():
     " init the system, be nice "
@@ -115,13 +182,30 @@
         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 == "UbuntuESM" and file.archive.startswith(DISTRO):
+            # In case of multiple ESM repos, one enabled is sufficient.
+            if have_esm is None and depcache.policy.get_priority(file) == -32768:
+                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 +218,8 @@
                 continue
             # check for security upgrades
             if isSecurityUpgrade(cand_ver):
+                if isESMUpgrade(cand_ver):
+                    esm_updates += 1
                 upgrades += 1
                 security_updates += 1
                 continue
@@ -159,6 +245,8 @@
                         and apt_pkg.version_compare(ver.ver_str,
                                                     inst_ver.ver_str) <= 0):
                     continue
+                if isESMUpgrade(ver):
+                    esm_updates += 1
                 if isSecurityUpgrade(ver):
                     security_updates += 1
                     break
@@ -167,7 +255,9 @@
     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
 
=== modified file 'debian/changelog'
--- debian/changelog	2019-03-19 10:27:07 +0000
+++ debian/changelog	2019-04-02 13:17:38 +0000
@@ -1,3 +1,10 @@
+update-notifier (3.192.16) UNRELEASED; urgency=medium
+
+  * Rewrite and extend motd messaging (LP: #1822340)
+  * Count ESM security updates as security updates
+
+ -- Julian Andres Klode <[e-mail]>  Fri, 29 Mar 2019 16:26:45 +0100
+
 update-notifier (3.192.15) disco; urgency=medium
 
   * debian/control:
 
=== modified file 'debian/rules'
--- debian/rules	2018-05-09 10:59:08 +0000
+++ debian/rules	2019-04-02 13:17:38 +0000
@@ -13,3 +13,5 @@
 
 override_dh_auto_test:
 	cd tests && python3 test_package-data-downloader.py
+	cd tests && python3 test_motd.py
+
 
=== added symlink 'tests/apt_check.py'
=== target is u'../data/apt_check.py'
=== added file 'tests/test_motd.py'
--- tests/test_motd.py	1970-01-01 00:00:00 +0000
+++ tests/test_motd.py	2019-04-02 13:17:38 +0000
@@ -0,0 +1,137 @@
+#!/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(
+                """
+                Extended Security Maintenance (ESM) is not enabled.
+
+                0 updates can be installed immediately.
+                0 of these updates are security updates.
+
+                Enable ESM to receive 23 additional security updates.
+                See 'ua enable esm' or https://ubuntu.com/esm
+                """).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(
+                """
+                Extended Security Maintenance (ESM) is not enabled.
+
+                15 updates can be installed immediately.
+                7 of these updates are security updates.
+
+                Enable ESM to receive 23 additional security updates.
+                See 'ua enable esm' or https://ubuntu.com/esm
+                """).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(
+                """
+                Extended Security Maintenance (ESM) is not enabled.
+
+                15 updates can be installed immediately.
+                7 of these updates are security updates.
+                """).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(
+                """
+                Extended Security Maintenance (ESM) is not enabled.
+
+                15 updates can be installed immediately.
+                0 of these updates are security updates.
+                """).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(
+                """
+                Extended Security Maintenance (ESM) is not enabled.
+
+                0 updates can be installed immediately.
+                0 of these updates are security updates.
+                """).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(
+                """
+                Extended Security Maintenance (ESM) is enabled.
+
+                35 updates can be installed immediately.
+                13 of these updates are provided through ESM.
+                0 of these updates are security updates.
+                """).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(
+                """
+                Extended Security Maintenance (ESM) is enabled.
+
+                47 updates can be installed immediately.
+                13 of these updates are provided through ESM.
+                7 of these updates are security updates.
+                """).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(
+                """
+                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()