Merge lp:~azzar1/update-manager/canonical-livepatch into lp:update-manager

[Andrea Azzarone]

Add Canonical LivePatch status to update-manager.

Add Canonical LivePatch status to update-manager as per https://wiki.ubuntu.com/SoftwareUpdates?action=recall&rev=221

[Brian Murray (brian-murray)]

How will these changes allow a message like "7 Livepatch updates applied since the last restart. 1 other update failed to apply.”, from the specification, to be displayed? Does set_desc allow both the failure and success messages to be displayed?

review: Needs Fixing

[Andrea Azzarone (azzar1)]

That's a problem with the specification. With livepatch you either get all
the patches correctly applied or none.

Il 26 ago 2017 00:29, "Brian Murray" <email address hidden> ha scritto:

> Review: Needs Fixing
>
> How will these changes allow a message like "7 Livepatch updates applied
> since the last restart. 1 other update failed to apply.”, from the
> specification, to be displayed? Does set_desc allow both the failure and
> success messages to be displayed?
>
> Diff comments:
>
> >
> > === modified file 'UpdateManager/Dialogs.py'
> > --- UpdateManager/Dialogs.py 2017-08-07 20:54:58 +0000
> > +++ UpdateManager/Dialogs.py 2017-08-23 14:09:35 +0000
> > @@ -142,6 +144,45 @@
> > self.main_container.add(content_widget)
> > self.main_container.set_visible(bool(content_widget))
> >
> > + def on_livepatch_status_ready(self, active, check_state,
> patch_state, fixes):
> > + self.set_desc(None)
> > +
> > + if not active:
> > + return
> > +
> > + needs_reschedule = False
> > +
> > + if check_state == "needs-check":
> > + needs_reschedule = True
> > + elif check_state == "check-failed":
> > + pass
> > + elif check_state == "checked":
> > + if patch_state == "unapplied" or patch_state == "applying":
> > + needs_reschedule = True
> > + elif patch_state == "applied":
> > + patched_fixes = [fix for fix in fixes if fix.patched]
> > + if len(patched_fixes) == 1:
> > + self.set_desc(_("1 Livepatch update applied since
> the last restart."))
> > + elif len(patched_fixes) > 1:
> > + self.set_desc(_("%d Livepatch updates applied since
> the last restart." % len(patched_fixes)))
> > + elif patch_state == "applied-with-bug" or patch_state ==
> "apply-failed":
> > + patched_fixes = [fix for fix in fixes if fix.patched]
> > + if len(patched_fixes) == 1:
> > + self.set_desc(_("1 update failed to apply since
> the last restart"))
>
> The other calls to set_desc end with a period so lets have this one also
> end with a period.
>
> > + elif len(patched_fixes) > 1:
> > + self.set_desc(_("%d updates failed to apply since
> the last restart" % len(patched_fixes)))
>
> The other calls to set_desc end with a period so lets have this one also
> end with a period.
>
> > + elif patch_state == "nothing-to-apply":
> > + pass
> > + elif patch_state == "unknown":
> > + pass
> > +
> > + if needs_reschedule:
> > + self.lp_socket.get_status(self.on_livepatch_status_ready)
> > +
> > + def check_livepatch_status(self):
> > + self.lp_socket = LivePatchSocket()
> > + self.lp_socket.get_status(self.on_livepatch_status_ready)
> > +
> >
> > class StoppedUpdatesDialog(InternalDialog):
> > def __init__(self, window_main):
>
>
> --
> https://code.launchpad.net/~azzar1/update-manager/
> canonical-livepatch/+merge/329452
> You are the owner of lp:~azzar1/update-manager/canonical-livepatch.
>...

[Brian Murray (brian-murray)]

Andrea - I'd also made a couple of in-line comments in my review. If you make those changes, I'll get this merged and uploaded.

[Andrea Azzarone (azzar1)]

Fixed.

[Brian Murray (brian-murray)]

As I was getting ready to upload this I discovered there are a fair number of pep8 failures with the added code.

 $ xvfb-run nosetests3
............................................................./home/bdmurray/source-trees/update-manager/trunk/tests/../tests/test_livepatch_socket.py:62:80: E501 line too long (127 > 79 characters)
/home/bdmurray/source-trees/update-manager/trunk/tests/../tests/test_livepatch_socket.py:83:80: E501 line too long (98 > 79 characters)
/home/bdmurray/source-trees/update-manager/trunk/tests/../tests/test_livepatch_socket.py:136:80: E501 line too long (94 > 79 characters)
/home/bdmurray/source-trees/update-manager/trunk/tests/../tests/test_livepatch_socket.py:137:80: E501 line too long (107 > 79 characters)
/home/bdmurray/source-trees/update-manager/trunk/tests/../tests/test_livepatch_socket.py:154:9: E306 expected 1 blank line before a nested definition, found 0
/home/bdmurray/source-trees/update-manager/trunk/tests/../tests/test_livepatch_socket.py:161:80: E501 line too long (80 > 79 characters)
F.F..................................
======================================================================
FAIL: test_pep8_clean (test_pep8.TestPep8Clean)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/bdmurray/source-trees/update-manager/trunk/tests/test_pep8.py", line 33, in test_pep8_clean
    self.assertEqual(0, ret_code)
AssertionError: 0 != 1

======================================================================
FAIL: test_pyflakes_clean (test_pyflakes.TestPyflakesClean)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/bdmurray/source-trees/update-manager/trunk/tests/test_pyflakes.py", line 56, in test_pyflakes_clean
    self.assertEqual(0, len(filtered_contents))
AssertionError: 0 != 8
-------------------- >> begin captured stdout << ---------------------
../tests/test_utils.py:5: 'glob' imported but unused
../tests/test_livepatch_socket.py:18: 'gi' imported but unused
../tests/test_livepatch_socket.py:186: undefined name 'logging'
../tests/test_livepatch_socket.py:186: undefined name 'logging'
../UpdateManager/Dialogs.py:29: 'gi.repository.GObject' imported but unused
../UpdateManager/Dialogs.py:30: 'gi.repository.Pango' imported but unused
../UpdateManager/Core/LivePatchSocket.py:23: 'gi' imported but unused
../UpdateManager/Core/LivePatchSocket.py:115: undefined name 'other'

--------------------- >> end captured stdout << ----------------------

----------------------------------------------------------------------

Sorry about asking for additional fixes, but could you address the ones in the code you've added? Thanks!
/home/bdmurray/source-trees/update-manager/trunk/tests/../tests/test_livepatch_socket.py:162:60: E712 comparison to True should be 'if cond is True:' or 'if cond:'
/home/bdmurray/source-trees/update-manager/trunk/tests/../tests/test_livepatch_socket.py:170:9: E306 expected 1 blank line before a nested definition, found 0
/home/bdmurray/source-trees/update-manager/trunk/tests/../tests/test_livepatch_socket.py:175:80: E501 line too long (173 > 79 char...

review: Needs Fixing

[Andrea Azzarone (azzar1)]

Done!

=== added file 'UpdateManager/Core/LivePatchSocket.py'
--- UpdateManager/Core/LivePatchSocket.py	1970-01-01 00:00:00 +0000
+++ UpdateManager/Core/LivePatchSocket.py	2017-08-31 07:59:52 +0000
@@ -0,0 +1,118 @@
+# LivePatchSocket.py
+# -*- Mode: Python; indent-tabs-mode: nil; tab-width: 4; coding: utf-8 -*-
+#
+#  Copyright (c) 2017 Canonical
+#
+#  Author: Andrea Azzarone <[e-mail]>
+#
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License as
+#  published by the Free Software Foundation; either version 2 of the
+#  License, or (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+#  USA
+
+from gi.repository import GLib
+import http.client
+import socket
+import threading
+import yaml
+
+HOST_NAME = '/var/snap/canonical-livepatch/current/livepatchd.sock'
+
+
+class UHTTPConnection(http.client.HTTPConnection):
+
+    def __init__(self, path):
+        http.client.HTTPConnection.__init__(self, 'localhost')
+        self.path = path
+
+    def connect(self):
+        sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+        sock.connect(self.path)
+        self.sock = sock
+
+
+class LivePatchSocket(object):
+
+    def __init__(self, http_conn=None):
+        if http_conn is None:
+            self.conn = UHTTPConnection(HOST_NAME)
+        else:
+            self.conn = http_conn
+
+    def get_status(self, on_done):
+
+        def do_call():
+            try:
+                self.conn.request('GET', '/status?verbose=True')
+                r = self.conn.getresponse()
+                active = r.status == 200
+                data = yaml.safe_load(r.read())
+            except Exception as e:
+                active = False
+                data = dict()
+            check_state = LivePatchSocket.get_check_state(data)
+            patch_state = LivePatchSocket.get_patch_state(data)
+            fixes = LivePatchSocket.get_fixes(data)
+            GLib.idle_add(lambda: on_done(
+                active, check_state, patch_state, fixes))
+
+        thread = threading.Thread(target=do_call)
+        thread.start()
+
+    @staticmethod
+    def get_check_state(data):
+        try:
+            status = data['status']
+            kernel = next((k for k in status if k['running']), None)
+            return kernel['livepatch']['checkState']
+        except Exception as e:
+            return 'check-failed'
+
+    @staticmethod
+    def get_patch_state(data):
+        try:
+            status = data['status']
+            kernel = next((k for k in status if k['running']), None)
+            return kernel['livepatch']['patchState']
+        except Exception as e:
+            return 'unknown'
+
+    @staticmethod
+    def get_fixes(data):
+        try:
+            status = data['status']
+            kernel = next((k for k in status if k['running']), None)
+            fixes = kernel['livepatch']['fixes']
+            return [LivePatchFix(f)
+                    for f in fixes.replace('* ', '').split('\n') if len(f) > 0]
+        except Exception as e:
+            return list()
+
+
+class LivePatchFix(object):
+
+    def __init__(self, text):
+        patched_pattern = ' (unpatched)'
+        self.patched = text.find(patched_pattern) == -1
+        self.name = text.replace(patched_pattern, '')
+
+    def __eq__(self, other):
+        if isinstance(other, LivePatchFix):
+            return self.name == other.name and self.patched == other.patched
+        return NotImplemented
+
+    def __ne__(self, other):
+        result = self.__eq__(other)
+        if result is NotImplemented:
+            return result
+        return not result

=== modified file 'UpdateManager/Dialogs.py'
--- UpdateManager/Dialogs.py	2017-08-07 20:54:58 +0000
+++ UpdateManager/Dialogs.py	2017-08-31 07:59:52 +0000
@@ -26,7 +26,6 @@
 gi.require_version("Gtk", "3.0")
 from gi.repository import Gtk
 from gi.repository import Gdk
-
 import warnings
 warnings.filterwarnings(
     "ignore", "Accessed deprecated property", DeprecationWarning)
@@ -37,8 +36,10 @@
 import os
 
 import HweSupportStatus.consts
+from .Core.LivePatchSocket import LivePatchSocket
 
 from gettext import gettext as _
+from gettext import ngettext
 
 
 class Dialog(object):
@@ -142,6 +143,49 @@
             self.main_container.add(content_widget)
         self.main_container.set_visible(bool(content_widget))
 
+    def on_livepatch_status_ready(self, active, cs, ps, fixes):
+        self.set_desc(None)
+
+        if not active:
+            return
+
+        needs_reschedule = False
+
+        if cs == "needs-check":
+            needs_reschedule = True
+        elif cs == "check-failed":
+            pass
+        elif cs == "checked":
+            if ps == "unapplied" or ps == "applying":
+                needs_reschedule = True
+            elif ps == "applied":
+                fixes = [fix for fix in fixes if fix.patched]
+                d = ngettext("1 Livepatch update applied since the last "
+                             "restart.",
+                             "%d Livepatch updates applied since the last "
+                             "restart." % len(fixes),
+                             len(fixes))
+                self.set_desc(d)
+            elif ps == "applied-with-bug" or ps == "apply-failed":
+                fixes = [fix for fix in fixes if fix.patched]
+                d = ngettext("1 Livepatch update failed to apply since the "
+                             "last restart.",
+                             "%d Livepatch updates failed to apply since the "
+                             "last restart." % len(fixes),
+                             len(fixes))
+                self.set_desc(d)
+            elif ps == "nothing-to-apply":
+                pass
+            elif ps == "unknown":
+                pass
+
+        if needs_reschedule:
+            self.lp_socket.get_status(self.on_livepatch_status_ready)
+
+    def check_livepatch_status(self):
+        self.lp_socket = LivePatchSocket()
+        self.lp_socket.get_status(self.on_livepatch_status_ready)
+
 
 class StoppedUpdatesDialog(InternalDialog):
     def __init__(self, window_main):
@@ -166,6 +210,7 @@
         self.add_settings_button()
         self.focus_button = self.add_button(Gtk.STOCK_OK,
                                             self.window_main.close)
+        self.check_livepatch_status()
 
 
 class DistUpgradeDialog(InternalDialog):

=== modified file 'debian/control'
--- debian/control	2017-07-18 22:32:49 +0000
+++ debian/control	2017-08-31 07:59:52 +0000
@@ -7,6 +7,7 @@
                python3-distutils-extra (>= 2.38),
                python3-dbus,
                python3-gi (>= 3.8),
+               python3-yaml,
                gir1.2-gtk-3.0,
                lsb-release,
                apt-clone (>= 0.2.3~ubuntu1)
@@ -59,6 +60,7 @@
          policykit-1,
          python3-dbus,
          python3-gi (>= 3.8),
+         python3-yaml,
          gir1.2-gtk-3.0,
          ubuntu-release-upgrader-gtk,
          update-notifier,

=== added file 'tests/test_livepatch_socket.py'
--- tests/test_livepatch_socket.py	1970-01-01 00:00:00 +0000
+++ tests/test_livepatch_socket.py	2017-08-31 07:59:52 +0000
@@ -0,0 +1,200 @@
+#
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License as
+#  published by the Free Software Foundation; either version 2 of the
+#  License, or (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+#  USA
+
+import datetime
+from gi.repository import GLib
+import http.client
+from mock import Mock
+import logging
+import sys
+import unittest
+import yaml
+
+from UpdateManager.Core.LivePatchSocket import LivePatchSocket, LivePatchFix
+
+
+status0 = {'architecture': 'x86_64',
+           'boot-time': datetime.datetime(2017, 6, 27, 11, 16),
+           'client-version': '7.21',
+           'cpu-model': 'Intel(R) Core(TM) i7-6700HQ CPU @ 2.60GHz',
+           'last-check': datetime.datetime(2017, 6, 28, 14, 23, 29, 683361),
+           'machine-id': 123456789,
+           'machine-token': 987654321,
+           'uptime': '27h12m12s'}
+
+status1 = {'architecture': 'x86_64',
+           'boot-time': datetime.datetime(2017, 6, 27, 11, 16),
+           'client-version': '7.21',
+           'cpu-model': 'Intel(R) Core(TM) i7-6700HQ CPU @ 2.60GHz',
+           'last-check': datetime.datetime(2017, 6, 28, 14, 23, 29, 683361),
+           'machine-id': 123456789,
+           'machine-token': 987654321,
+           'status': [{'kernel': '4.4.0-78.99-generic',
+                       'livepatch': {'checkState': 'needs-check',
+                                     'fixes': '',
+                                     'patchState': 'nothing-to-apply',
+                                     'version': '24.2'},
+                       'running': True}],
+           'uptime': '27h12m12s'}
+
+status2 = {'architecture': 'x86_64',
+           'boot-time': datetime.datetime(2017, 6, 27, 11, 16),
+           'client-version': '7.21',
+           'cpu-model': 'Intel(R) Core(TM) i7-6700HQ CPU @ 2.60GHz',
+           'last-check': datetime.datetime(2017, 6, 28, 14, 23, 29, 683361),
+           'machine-id': 123456789,
+           'machine-token': 987654321,
+           'status': [{'kernel': '4.4.0-78.99-generic',
+                       'livepatch': {'checkState': 'checked',
+                                     'fixes': '* CVE-2016-0001\n'
+                                     '* CVE-2016-0002\n'
+                                     '* CVE-2017-0001 (unpatched)\n'
+                                     '* CVE-2017-0001',
+                                     'patchState': 'applied',
+                                     'version': '24.2'},
+                       'running': True}],
+           'uptime': '27h12m12s'}
+
+
+class TestUtils(object):
+
+    @staticmethod
+    def __TimeoutCallback(user_data=None):
+        user_data[0] = True
+        return False
+
+    @staticmethod
+    def __ScheduleTimeout(timeout_reached, timeout_duration=10):
+        return GLib.timeout_add(timeout_duration,
+                                TestUtils.__TimeoutCallback,
+                                timeout_reached)
+
+    @staticmethod
+    def WaitUntilMSec(instance, check_function, expected_result=True,
+                      max_wait=500, error_msg=''):
+        instance.assertIsNotNone(check_function)
+
+        timeout_reached = [False]
+        timeout_id = TestUtils.__ScheduleTimeout(timeout_reached, max_wait)
+
+        result = None
+        while not timeout_reached[0]:
+            result = check_function()
+            if result == expected_result:
+                break
+            GLib.MainContext.default().iteration(True)
+
+        if result == expected_result:
+            GLib.Source.remove(timeout_id)
+
+        instance.assertEqual(expected_result, result, error_msg)
+
+
+class MockResponse():
+
+    def __init__(self, status, data):
+        self.status = status
+        self.data = data
+
+    def read(self):
+        return yaml.dump(self.data)
+
+
+class TestLivePatchSocket(unittest.TestCase):
+
+    def test_get_check_state(self):
+        check_state = LivePatchSocket.get_check_state(status0)
+        self.assertEqual(check_state, 'check-failed')
+        check_state = LivePatchSocket.get_check_state(status1)
+        self.assertEqual(check_state, 'needs-check')
+        check_state = LivePatchSocket.get_check_state(status2)
+        self.assertEqual(check_state, 'checked')
+
+    def test_get_patch_state(self):
+        patch_state = LivePatchSocket.get_patch_state(status0)
+        self.assertEqual(patch_state, 'unknown')
+        patch_state = LivePatchSocket.get_patch_state(status1)
+        self.assertEqual(patch_state, 'nothing-to-apply')
+        patch_state = LivePatchSocket.get_patch_state(status2)
+        self.assertEqual(patch_state, 'applied')
+
+    def test_get_fixes(self):
+        fixes = LivePatchSocket.get_fixes(status0)
+        self.assertEqual(fixes, [])
+        fixes = LivePatchSocket.get_fixes(status1)
+        self.assertEqual(fixes, [])
+        fixes = LivePatchSocket.get_fixes(status2)
+        self.assertEqual(fixes, [LivePatchFix('CVE-2016-0001'),
+                                 LivePatchFix('CVE-2016-0002'),
+                                 LivePatchFix('CVE-2017-0001 (unpatched)'),
+                                 LivePatchFix('CVE-2017-0001')])
+
+    def test_livepatch_fix(self):
+        fix = LivePatchFix('CVE-2016-0001')
+        self.assertEqual(fix.name, 'CVE-2016-0001')
+        self.assertTrue(fix.patched)
+
+        fix = LivePatchFix('CVE-2016-0001 (unpatched)')
+        self.assertEqual(fix.name, 'CVE-2016-0001')
+        self.assertFalse(fix.patched)
+
+    def test_callback_not_active(self):
+        mock_http_conn = Mock(spec=http.client.HTTPConnection)
+        attrs = {'getresponse.return_value': MockResponse(400, None)}
+        mock_http_conn.configure_mock(**attrs)
+
+        cb_called = [False]
+
+        def on_done(active, check_state, patch_state, fixes):
+            cb_called[0] = True
+            self.assertFalse(active)
+
+        lp = LivePatchSocket(mock_http_conn)
+        lp.get_status(on_done)
+
+        mock_http_conn.request.assert_called_with(
+            'GET', '/status?verbose=True')
+        TestUtils.WaitUntilMSec(self, lambda: cb_called[0] is True)
+
+    def test_callback_active(self):
+        mock_http_conn = Mock(spec=http.client.HTTPConnection)
+        attrs = {'getresponse.return_value': MockResponse(200, status2)}
+        mock_http_conn.configure_mock(**attrs)
+
+        cb_called = [False]
+
+        def on_done(active, check_state, patch_state, fixes):
+            cb_called[0] = True
+            self.assertTrue(active)
+            self.assertEqual(check_state, 'checked')
+            self.assertEqual(patch_state, 'applied')
+            self.assertEqual(fixes, [LivePatchFix('CVE-2016-0001'),
+                                     LivePatchFix('CVE-2016-0002'),
+                                     LivePatchFix('CVE-2017-0001 (unpatched)'),
+                                     LivePatchFix('CVE-2017-0001')])
+
+        lp = LivePatchSocket(mock_http_conn)
+        lp.get_status(on_done)
+
+        mock_http_conn.request.assert_called_with(
+            'GET', '/status?verbose=True')
+        TestUtils.WaitUntilMSec(self, lambda: cb_called[0] is True)
+
+
+if __name__ == '__main__':
+    if len(sys.argv) > 1 and sys.argv[1] == "-v":
+        logging.basicConfig(level=logging.DEBUG)
+    unittest.main()

=== modified file 'tests/test_utils.py'
--- tests/test_utils.py	2017-08-09 23:21:06 +0000
+++ tests/test_utils.py	2017-08-31 07:59:52 +0000
@@ -2,7 +2,6 @@
 # -*- Mode: Python; indent-tabs-mode: nil; tab-width: 4; coding: utf-8 -*-
 
 import logging
-import glob
 import mock
 import sys
 import unittest