Merge ~nteodosio/software-properties:ua-attach-tests into software-properties:ubuntu/master

[Nathan Teodosio]

Add tests for gtk/DialogUaAttach.py.

Adds tests for Ubuntu Pro attachment in Software Properties.

PPA build: https://launchpad.net/~nteodosio/+archive/ubuntu/rebuilds/+build/25647866

[Sebastien Bacher (seb128)]

not a review but just a note from a glance on the changes, if the new build-depends are only for tests you should add <!nocheck> next to those

9d3f38f... by Nathan Teodosio on 2023-03-07

Fix missing pin_label.

90017fa... by Nathan Teodosio on 2023-03-07

d/control: nocheck for the new build-depends

Unmerged commits

90017fa... by Nathan Teodosio on 2023-03-07

d/control: nocheck for the new build-depends

9d3f38f... by Nathan Teodosio on 2023-03-07

Fix missing pin_label.

7f7e9e2... by Nathan Teodosio on 2023-03-07

Add handy and ua-tools deps to d/control.

These are required in the source package, else the tests fail to import the modules and the build fails.

9d4c042... by Nathan Teodosio on 2023-03-06

Update dh_auto_test to use xvfb-run.

Needed for GTK, else:

  File "/home/nteodosio/canonical/ubuntu-advantage/software-properties/tests/test_ua_attach.py", line 40, in setUp
      self.d = DialogUaAttach(Gtk.Window(), "data", self.ua_object)

  File "/usr/lib/python3/dist-packages/gi/overrides/Gtk.py", line 519, in __init__
      raise RuntimeError(
      RuntimeError: Gtk couldn't be initialized. Use Gtk.init_check() if you want to handle this case.

20a7057... by Nathan Teodosio on 2023-03-06

Update the internet check, that didn't work

146d506... by Nathan Teodosio on 2023-03-06

Move test_gui_state_after_token_submission to WithoutInternet test suite.

e4ab9e2... by Nathan Teodosio on 2023-03-06

Linters

x

0562e9d... by Nathan Teodosio on 2023-03-06

Check with update_state(pin_validated) instead

1d1144b... by Nathan Teodosio on 2023-03-03

Test that PIN validation waits to update UI until magic radio is selected.

18ddda5... by Nathan Teodosio on 2023-03-03

Test that PIN validation waits until its radio is on.

diff --git a/data/gtkbuilder/dialog-ua-attach.ui b/data/gtkbuilder/dialog-ua-attach.ui
index 1445b82..d8a3dc2 100644
--- a/data/gtkbuilder/dialog-ua-attach.ui
+++ b/data/gtkbuilder/dialog-ua-attach.ui
@@ -49,7 +49,7 @@
             <property name="orientation">horizontal</property>
             <child>
               <object class="GtkLabel" id="pin_label">
-                <property name="label">      </property>
+                <property name="label"></property>
                 <property name="visible">True</property>
                 <property name="selectable">True</property>
                 <property name="can-focus">False</property>
@@ -85,7 +85,7 @@
             <child>
               <object class="GtkLabel" id="pin_status">
                 <property name="margin">3</property>
-                <property name="visible">True</property>
+                <property name="visible">False</property>
                 <property name="valign">center</property>
                 <property name="use-markup">True</property>
               </object>
@@ -147,7 +147,7 @@
             <child>
               <object class="GtkLabel" id="token_status">
                 <property name="margin">3</property>
-                <property name="visible">True</property>
+                <property name="visible">False</property>
                 <property name="valign">center</property>
                 <property name="use-markup">True</property>
               </object>
diff --git a/debian/control b/debian/control
index fcb6123..295d1c7 100644
--- a/debian/control
+++ b/debian/control
@@ -7,6 +7,7 @@ Build-Depends: dbus-x11 <!nocheck>,
                dh-python,
                dh-translations,
                gir1.2-gtk-3.0 <!nocheck>,
+               gir1.2-handy-1 <!nocheck>,
                gpg,
                gpg-agent,
                intltool,
@@ -22,6 +23,7 @@ Build-Depends: dbus-x11 <!nocheck>,
                python3-gi <!nocheck>,
                python3-launchpadlib,
                python3-setuptools,
+               ubuntu-advantage-tools (>= 27.11~) <!nocheck>,
                xauth <!nocheck>,
                xvfb <!nocheck>
 Rules-Requires-Root: no
diff --git a/debian/rules b/debian/rules
index ccc571e..08419e2 100755
--- a/debian/rules
+++ b/debian/rules
@@ -7,4 +7,4 @@ override_dh_missing:
 	dh_missing --list-missing
 
 override_dh_auto_test:
-	dbus-run-session -- dh_auto_test
+	dbus-run-session -- xvfb-run -a dh_auto_test
diff --git a/tests/test_ua_attach.py b/tests/test_ua_attach.py
new file mode 100644
index 0000000..85b57d4
--- /dev/null
+++ b/tests/test_ua_attach.py
@@ -0,0 +1,240 @@
+#!/usr/bin/python3
+# pylint:  disable=E1101
+"""Test cases for DialogUaAttach.py"""
+
+import sys
+import unittest
+from unittest.mock import ANY, Mock, patch
+from uaclient.api.u.pro.attach.magic.initiate.v1 import initiate
+from uaclient.exceptions import MagicAttachTokenError
+from softwareproperties.gtk.DialogUaAttach import DialogUaAttach
+from gi.repository import GLib, Gtk
+
+sys.path.insert(0, "..")
+
+
+class InitiateResponse:
+    """Mock a good response of the Ubuntu Pro API's initiate()"""
+
+    def __init__(self, pin, req_id):
+        self.user_code = pin
+        self.token = req_id
+
+
+class IncompleteInitiateResponse:
+    """Mock a "something has gone wrong" response of the Ubuntu Pro API's
+    initiate()"""
+
+
+class WaitResponse:
+    """Mock a good response of the Ubuntu Pro API's wait()"""
+
+    contract_token = "contract_token"
+
+
+class WithoutInternetAttempt(unittest.TestCase):
+    """Tests in which net_status_changed is patched away."""
+
+    @patch("softwareproperties.gtk.DialogUaAttach.DialogUaAttach.net_status_changed")
+    def setUp(self, net_mock):
+        self.ua_object = Mock()
+        self.d = DialogUaAttach(Gtk.Window(), "data", self.ua_object)
+        net_mock.assert_called()
+
+    def test_clean_init(self):
+        """Test the initial values of the class."""
+
+        self.assertEqual(self.d.pin, "")
+        self.assertEqual(self.d.poll, None)
+        self.assertEqual(self.d.contract_token, None)
+        self.assertEqual(self.d.attaching, False)
+
+    @patch("gi.repository.GLib.Thread.new")
+    @patch("softwareproperties.gtk.DialogUaAttach.DialogUaAttach.start_magic_attach")
+    def test_net_status_changed(self, sma, gtn):
+        """Test net_status_changed."""
+
+        def check_widgets_visibility_and_sensitiviness(net):
+            self.assertEqual(self.d.no_connection.get_visible(), not net)
+            self.assertEqual(self.d.radio_net_control_box.get_sensitive(), net)
+            self.assertEqual(self.d.confirm_net_control_box.get_sensitive(), net)
+
+        # Widgets visibility and sensitiviness are consistent with internet
+        # connection state
+        net = False
+        self.d.net_status_changed(Mock(), net, Mock())
+        check_widgets_visibility_and_sensitiviness(net)
+        net = True
+        self.d.net_status_changed(Mock(), net, Mock())
+        check_widgets_visibility_and_sensitiviness(net)
+
+        def net_status_changed_to(net, pin="", poll=None):
+            sma.reset_mock()
+            gtn.reset_mock()
+            self.d.pin = pin
+            self.d.poll = poll
+            self.d.net_status_changed(Mock(), net, Mock())
+
+        # Internet down, no polling is started or restart
+        net_status_changed_to(False)
+        sma.assert_not_called()
+        gtn.assert_not_called()
+        self.assertIsNone(self.d.poll)
+
+        # Internet up but no PIN, request one and start poll
+        net_status_changed_to(True)
+        sma.assert_called_once()
+        gtn.assert_not_called()
+        self.assertIsNone(self.d.poll)
+
+        # Internet up but no poll, restart poll
+        net_status_changed_to(True, "pin")
+        sma.assert_not_called()
+        gtn.assert_called_once()
+        self.assertIsNotNone(self.d.poll)
+
+        # Internet up; Already have a PIN and is polling for it, do nothing
+        net_status_changed_to(True, "pin", "poll")
+        sma.assert_not_called()
+        gtn.assert_not_called()
+        self.assertIsNotNone(self.d.poll)
+
+    @patch("gi.repository.GLib.idle_add")
+    @patch("softwareproperties.gtk.DialogUaAttach.wait")
+    def test_poll_for_magic_token(self, wait, idle_add):
+        """Test poll_for_magic_token."""
+        wait.side_effect = [WaitResponse, MagicAttachTokenError, AttributeError]
+
+        self.d.req_id = "req_id"
+
+        idle_add.reset_mock()
+        self.d.poll = 1
+        self.d.poll_for_magic_token()
+        idle_add.assert_called_with(ANY, "pin_validated")
+        self.assertIsNone(self.d.poll)
+
+        idle_add.reset_mock()
+        self.d.poll = 1
+        self.d.poll_for_magic_token()
+        idle_add.assert_called_with(ANY, "expired")
+        self.assertIsNone(self.d.poll)
+
+        idle_add.reset_mock()
+        self.d.poll = 1
+        self.d.poll_for_magic_token()
+        idle_add.assert_not_called()
+        self.assertIsNone(self.d.poll)
+
+    @patch("softwareproperties.gtk.DialogUaAttach.initiate")
+    def test_start_magic_attach(self, initiate):
+        """Test start_magic_attach."""
+
+        def start_magic_attach_with(poll, contract_token):
+            self.d.poll = poll
+            self.d.contract_token = contract_token
+            self.d.start_magic_attach()
+
+        # If already polling, magic attach flow is not initiated
+        start_magic_attach_with("poll", None)
+        initiate.assert_not_called()
+
+        # If already have contract_token, magic attach flow is not initiated
+        start_magic_attach_with(None, "contract_token")
+        initiate.assert_not_called()
+
+        pin = "pin"
+        req_id = "req_id"
+        initiate.side_effect = [
+            IncompleteInitiateResponse,
+            InitiateResponse(pin, req_id),
+        ]
+
+        # Incomplete response from initate(): No poll started
+        start_magic_attach_with(None, None)
+        initiate.assert_called()
+        self.assertIsNone(self.d.poll)
+
+        # Appropriate response from initate(): Poll started
+        start_magic_attach_with(None, None)
+        self.assertEqual(pin, self.d.pin)
+        self.assertEqual(req_id, self.d.req_id)
+        self.assertIsNotNone(self.d.poll)
+
+    @patch("gi.repository.GLib.idle_add")
+    @patch("softwareproperties.gtk.DialogUaAttach.initiate")
+    @patch("softwareproperties.gtk.DialogUaAttach.wait")
+    def test_pin_validation_waits_until_magic_radio_active(
+        self, wait, initiate, idle_add
+    ):
+        """PIN verification should not take over GUI if other radio is active
+        Steps performed for verification:
+            Click token radio button.
+            Start polling for magic token.
+            Verify the PIN (mocking ubuntu.com/pro/attach verification).
+            > Assert that nothing happens just yet.
+            Click the first radio button.
+            > Assert that _now_ GUI is updated.
+        """
+        wait.return_value = WaitResponse
+        initiate.return_value = InitiateResponse("pin", "req_id")
+        self.d.token_radio.set_active(True)
+        self.d.update_state = Mock(side_effect=self.d.update_state)
+        self.d.start_magic_attach()
+        GLib.usleep(1_500_000)
+        self.assertEqual(WaitResponse.contract_token, self.d.contract_token)
+        idle_add.assert_not_called()
+        self.d.magic_radio.set_active(True)
+        self.d.update_state.assert_called_once_with("pin_validated")
+
+    @patch("softwareproperties.gtk.DialogUaAttach.DialogUaAttach.finish")
+    def test_gui_state_after_token_submission(self, finish):
+        """Test the interface widgets after submitting an invalid token
+        via the manual token field."""
+        self.d.token_radio.set_active(True)
+        self.d.token_field.set_text("bar")
+        self.d.attach()
+
+        # Test checking token
+        # Unfortunately can't test spinner, get_spinning only available in GTK4
+        self.assertFalse(self.d.confirm.get_sensitive())
+        self.assertFalse(self.d.token_radio.get_sensitive())
+        self.assertFalse(self.d.magic_radio.get_sensitive())
+
+        _first_arg, named_args = self.ua_object.Attach.call_args_list[0]
+
+        # Test invalid token
+        named_args["error_handler"]("foo")
+        self.assertTrue(self.d.token_status.get_visible())
+        self.assertTrue(self.d.token_status_icon.get_visible())
+        icon_name, _icon_size = self.d.token_status_icon.get_icon_name()
+        self.assertEqual(icon_name, "emblem-unreadable")
+
+        # Test valid token
+        finish.assert_not_called()
+        named_args["reply_handler"]()
+        finish.assert_called_once()
+
+
+class WithInternetAttempt(unittest.TestCase):
+    """Tests in which net_status_changed is not patched away."""
+
+    def setUp(self):
+        self.ua_object = Mock()
+        self.d = DialogUaAttach(Gtk.Window(), "data", self.ua_object)
+
+    def test_gui_initial_state(self):
+        """Test the interface widgets initial state."""
+        self.assertTrue(self.d.magic_radio.get_active())
+        self.assertFalse(self.d.token_radio.get_active())
+        self.assertFalse(self.d.token_field.get_sensitive())
+        self.assertFalse(self.d.confirm.get_sensitive())
+        self.assertFalse(self.d.token_status_icon.get_visible())
+        self.assertFalse(self.d.token_status.get_visible())
+        self.assertFalse(self.d.pin_status_icon.get_visible())
+        self.assertFalse(self.d.pin_status.get_visible())
+
+        try:
+            initiate()
+            self.assertTrue(len(self.d.pin_label.get_text()) == 6)
+        except:
+            self.assertEqual(self.d.pin_label.get_text(), "")