Merge lp:~chris.gagnon/ubuntu-system-settings/barebones-autopilot-emulator-for-updates-page into lp:ubuntu-system-settings

[Chris Gagnon]

barebones emulator for system updates page, add objectNames that were needed for testing

I am trying to use the updates page in the system settings app to do upgrade testing for images that have not been released.

We use a custom proxy object/autopilot emulator in the autopilot tests so all projects can reuse the custom proxy objects.

This will be used to save time when there are changes made to the system-settings app, as we will not have also make changes to all the tests that might check or use something in system-settings with autopilot.

To test the changes there should be an in memory backend that changes the state of the updates page.

There should also be a mock update that does not reboot the phone.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:641
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/685/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/3763
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/3351
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-trusty-amd64-ci/201
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-trusty-armhf-ci/189
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-trusty-i386-ci/188
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/3309
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3771
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3771/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/3353
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/3353/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/5722
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/4597

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-system-settings-ci/685/rebuild

review: Approve (continuous-integration)

[Sebastien Bacher (seb128)]

Thank you for the work, I've no reviewed it yet but could you write a short summary of the intend of those changes? What issues are you trying to resolve? How do you recommend testing the changes?

review: Needs Information

[Chris Gagnon (chris.gagnon)]

I am trying to use the updates page in the system settings app to do upgrade testing for images that have not been released.

We use a custom proxy object/autopilot emulator in the autopilot tests so all projects can reuse the custom proxy objects.

This will be used to save time when there are changes made to the system-settings app, as we will not have also make changes to all the tests that might check or use something in system-settings with autopilot.

To test the changes there should be an in memory backend that changes the state of the updates page.

There should also be a mock update that does not reboot the phone.

[Sebastien Bacher (seb128)]

> To test the changes there should be an in memory backend that changes the state of the updates page.
> There should also be a mock update that does not reboot the phone.

Those are not done there though, so it means the current changes should be tested by just checking that tests keep being green with the update?

Some extra changes landed to trunk since you submitted that work and they create conflicts, could you rebase on trunk?

review: Needs Fixing

[Sebastien Bacher (seb128)]

setting to "work in progress", change it back to "needs review" when the issue pointed before are resolved

Unmerged revisions

641. By Chris Gagnon on 2014-03-08

barebones start on emulator for system-settings

640. By Chris Gagnon on 2014-03-06

add objectNames, create emulator for system updates

=== modified file 'plugins/system-update/PageComponent.qml'
--- plugins/system-update/PageComponent.qml	2014-02-26 11:39:47 +0000
+++ plugins/system-update/PageComponent.qml	2014-03-08 00:11:20 +0000
@@ -369,6 +369,7 @@
 
     ListItem.Standard {
         id: notification
+        objectName: "notification"
         visible: false
         anchors.bottom: configuration.top
     }
@@ -391,6 +392,7 @@
 
     Rectangle {
         id: updatedNotification
+        objectName: "updateNotification"
         anchors {
             left: parent.left
             right: parent.right

=== added file 'tests/autopilot/ubuntu_system_settings/emulators.py'
--- tests/autopilot/ubuntu_system_settings/emulators.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntu_system_settings/emulators.py	2014-03-08 00:11:20 +0000
@@ -0,0 +1,155 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2013, 2014 Canonical
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+
+""" Autopilot  for Ubuntu System Settings """
+
+from __future__ import absolute_import
+
+import time
+
+from ubuntuuitoolkit import emulators as toolkit_emulators
+
+
+class SystemSettingsEmulatorException(Exception):
+    """Exception raised when there is an error with the emulator."""
+    pass
+
+
+class MainWindow(toolkit_emulators.MainView):
+    def click_obj(self, obj):
+        """Generic way to click an object
+
+        :param obj: The object to click
+        """
+        obj.visible.wait_for(True)
+        self.pointing_device.click_object(obj)
+        return obj
+
+    def _click_entry_component(self, object_name):
+        """Click and return an entry component
+
+        :param object_name: the object name to click and return
+        """
+        return self.click_obj(
+            self.wait_select_single('EntryComponent',
+                                    objectName=object_name))
+
+    def click_updates(self):
+        """Click updates and return the updates page"""
+        self._click_entry_component('entryComponent-system-update')
+        return self.wait_select_single(PageComponent,
+                                       objectName='systemUpdatesPage')
+
+
+class PageComponent(MainWindow):
+    # TODO refactor QT code with page names, so better page object pattern
+    #   can be used
+
+    # updates pages
+    def click_install_all_button(self):
+        """click install all button"""
+        button = self._get_install_all_button()
+        self.click_obj(button)
+        return button
+
+    def get_state(self):
+            """Return state of app"""
+            # TODO make sure this matches design doc
+            # from qml code for system updates page:
+            #
+            # state SEARCHING
+            #    notification visible false
+            #    installAllButton visible false
+            #    checkForUpdatesArea visible true
+            #    updateNotification visiible false
+            # state NOUPDATES
+            #    updateNotification text i18n.tr("Software is up to date")
+            #    updateNotification visible true
+            #    updateList visible false
+            #    installAllButton visible false
+            #    checkForUpdatesArea visible false
+            # state SYSTEMUPDATEFAILED
+            #    notification text i18n.tr("System update has failed.")
+            #    notification progression false
+            #    notification visible true
+            #    installingImageUpdate visible false
+            #    checkForUpdatesArea visible false
+            #    updatedNotifiation visible false
+            # state UPDATE
+            #    notification visible false
+            #    updateList visible true
+            #    installAllButton visible true
+            #    checkForUpdatesArea visible true
+            #    updatedNotification visible false
+
+            updateNotification = self._get_update_notification()
+            if updateNotification.text == 'Software is up to date':
+                return 'NOUPDATES'
+            install_all_button = self._get_install_all_button()
+            if install_all_button.visible:
+                return 'UPDATE'
+            notification = self._get_notification()
+            if notification.text == 'System update has failed.':
+                return 'SYSTEMUPDATEFAILED'
+            return 'SEARCHING'
+
+    def wait_for_state(self, state, timeout=60):
+        """Wait for expected state
+
+        :returns: state
+        :raises: SystemSettingsEmulatorException
+        """
+        for wait in range(timeout):
+            if state == self.get_state():
+                return state
+            time.sleep(1)
+
+        raise SystemSettingsEmulatorException('State not found before '
+                                              'timeout')
+
+    def _get_update_notification(self):
+        """Return update notification"""
+        return self.wait_select_single(objectName='updateNotification')
+
+    def _get_install_all_button(self):
+        """Return install all button"""
+        return self.wait_select_single('Button',
+                                       objectName='installAllButton')
+
+    def _get_notification(self):
+        """Return notification"""
+        return self.wait_select_single(objectName='notification')
+
+    def _get_update_list(self):
+        """Return update list"""
+        return self.wait_select_single(objectName='updateList')
+
+    def _get_check_for_updates_area(self):
+        """Return the check for updates area"""
+        return self.wait_select_single('QQuickItem',
+                                       objectName='checkForUpdatesArea')
+
+    def _get_check_for_updates_label(self):
+        """return label for check updates area"""
+        area = self.get_check_for_updates_area()
+        return area.select_single('Label')
+
+
+class Dialog(MainWindow):
+    # updates page dialog
+    # TODO add object names to qml file
+    def click_not_now(self):
+        """Click not now button"""
+        button = self.click_obj(
+            self.wait_select_single('Button', text='Not Now'))
+        button.wait_for_destroyed()
+
+    def click_install_and_restart(self):
+        """Click install and restart button"""
+        button = self.click_obj(
+            self.wait_select_single('Button', text='Install & Restart'))
+        button.wait_for_destroyed()

=== modified file 'tests/autopilot/ubuntu_system_settings/tests/__init__.py'
--- tests/autopilot/ubuntu_system_settings/tests/__init__.py	2014-02-18 15:42:24 +0000
+++ tests/autopilot/ubuntu_system_settings/tests/__init__.py	2014-03-08 00:11:20 +0000
@@ -10,29 +10,31 @@
 from __future__ import absolute_import
 
 from ubuntu_system_settings.utils.i18n import ugettext as _
+from ubuntu_system_settings import emulators
 
 from autopilot.input import Mouse, Touch, Pointer
 from autopilot.platform import model
+from autopilot.matchers import Eventually
 from autopilot.testcase import AutopilotTestCase
-from autopilot.matchers import Eventually
-from testtools.matchers import Equals, NotEquals, GreaterThan
 
-from ubuntuuitoolkit.base import UbuntuUIToolkitAppTestCase
 from ubuntuuitoolkit import emulators as toolkit_emulators
+from testtools.matchers import Equals, GreaterThan
 
 import dbus
 import dbusmock
 import subprocess
 from time import sleep
 
-class UbuntuSystemSettingsTestCase(UbuntuUIToolkitAppTestCase):
+
+class UbuntuSystemSettingsTestCase(AutopilotTestCase):
     """ Base class for Ubuntu System Settings """
     if model() == 'Desktop':
-        scenarios = [ ('with mouse', dict(input_device_class=Mouse)) ]
+        scenarios = [('with mouse', dict(input_device_class=Mouse))]
     else:
-        scenarios = [ ('with touch', dict(input_device_class=Touch)) ]
+        scenarios = [('with touch', dict(input_device_class=Touch))]
 
     def setUp(self, panel=None):
+        self.panel = panel
         super(UbuntuSystemSettingsTestCase, self).setUp()
         self.launch_system_settings(panel=panel)
         self.assertThat(self.main_view.visible, Eventually(Equals(True)))
@@ -40,7 +42,8 @@
     def launch_system_settings(self, panel=None):
         params = ['/usr/bin/system-settings']
         if (model() != 'Desktop'):
-            params.append('--desktop_file_hint=/usr/share/applications/ubuntu-system-settings.desktop')
+            params.append('--desktop_file_hint=/usr/share/applications/'
+                          'ubuntu-system-settings.desktop')
 
         # Launch to a specific panel
         if panel is not None:
@@ -54,7 +57,7 @@
     @property
     def main_view(self):
         """ Return main view """
-        return self.app.select_single("QQuickView")
+        return self.app.select_single(emulators.MainWindow)
 
     @property
     def pointer(self):
@@ -69,8 +72,8 @@
         page_center_x = int(page_right / 2)
         page_center_y = int(page_bottom / 2)
         while obj.globalRect[1] + obj.height > page_bottom:
-            self.pointer.drag(page_center_x, page_center_y, 
-                    page_center_x, page_center_y - obj.height * 2)
+            self.pointer.drag(page_center_x, page_center_y,
+                              page_center_x, page_center_y - obj.height * 2)
             # avoid a flick
             sleep(0.5)
 
@@ -96,7 +99,12 @@
 
     def add_mock_battery(self):
         """ Make sure we have a battery """
-        self.dbusmock.AddDischargingBattery('mock_BATTERY', 'Battery', 50.0, 10)
+        self.dbusmock.AddDischargingBattery(
+            'mock_BATTERY',
+            'Battery',
+            50.0,
+            10
+        )
 
 
 class UbuntuSystemSettingsBatteryTestCase(UbuntuSystemSettingsUpowerTestCase):
@@ -123,37 +131,47 @@
     def setUp(self, panel=None):
         self.obj_ofono.Reset()
         # Add an available carrier
-        self.dbusmock.AddObject('/ril_0/operator/op2',
-                'org.ofono.NetworkOperator',
-                {
-                    'Name': 'my.cool.telco',
-                    'Status': 'available',
-                    'MobileCountryCode': '777',
-                    'MobileNetworkCode': '22',
-                    'Technologies': ['gsm'],
-                },
-                [
-                    ('GetProperties', '', 'a{sv}',
-                        'ret = self.GetAll("org.ofono.NetworkOperator")'),
-                    ('Register', '', '', ''),
-                ]
-                )
+        self.dbusmock.AddObject(
+            '/ril_0/operator/op2',
+            'org.ofono.NetworkOperator',
+            {
+                'Name': 'my.cool.telco',
+                'Status': 'available',
+                'MobileCountryCode': '777',
+                'MobileNetworkCode': '22',
+                'Technologies': ['gsm'],
+            },
+            [
+                (
+                    'GetProperties',
+                    '',
+                    'a{sv}',
+                    'ret = self.GetAll("org.ofono.NetworkOperator")'
+                ),
+                ('Register', '', '', ''),
+            ]
+        )
         # Add a forbidden carrier
-        self.dbusmock.AddObject('/ril_0/operator/op3',
-                'org.ofono.NetworkOperator',
-                {
-                    'Name': 'my.bad.telco',
-                    'Status': 'forbidden',
-                    'MobileCountryCode': '777',
-                    'MobileNetworkCode': '22',
-                    'Technologies': ['gsm'],
-                },
-                [
-                    ('GetProperties', '', 'a{sv}',
-                        'ret = self.GetAll("org.ofono.NetworkOperator")'),
-                    ('Register', '', '', ''),
-                ]
-                )
+        self.dbusmock.AddObject(
+            '/ril_0/operator/op3',
+            'org.ofono.NetworkOperator',
+            {
+                'Name': 'my.bad.telco',
+                'Status': 'forbidden',
+                'MobileCountryCode': '777',
+                'MobileNetworkCode': '22',
+                'Technologies': ['gsm'],
+            },
+            [
+                (
+                    'GetProperties',
+                    '',
+                    'a{sv}',
+                    'ret = self.GetAll("org.ofono.NetworkOperator")'
+                ),
+                ('Register', '', '', ''),
+            ]
+        )
         super(UbuntuSystemSettingsOfonoTestCase, self).setUp('cellular')
 
     @property
@@ -187,19 +205,15 @@
         super(StorageBaseTestCase, self).setUp()
         # Click on 'Storage' option
         button = self.about_page.select_single(objectName='storageItem')
-        self.assertThat(button, NotEquals(None))
         self.scroll_to_and_click(button)
 
     def assert_space_item(self, object_name, text):
         """ Checks whether an space item exists and returns a value """
         item = self.storage_page.select_single(objectName=object_name)
-        self.assertThat(item, NotEquals(None))
-        label = item.label # Label
-        space = item.value # Disk space (bytes)
+        label = item.label  # Label
         self.assertThat(label, Equals(text))
         # Get item's label
         size_label = item.select_single(objectName='sizeLabel')
-        self.assertThat(size_label, NotEquals(None))
         values = size_label.text.split(' ')  # Format: "00.0 (bytes|MB|GB)"
         self.assertThat(len(values), GreaterThan(1))
 
@@ -217,7 +231,6 @@
         super(LicenseBaseTestCase, self).setUp()
         # Click on 'Software licenses' option
         button = self.main_view.select_single(objectName='licenseItem')
-        self.assertThat(button, NotEquals(None))
         self.assertThat(button.text, Equals(_('Software licenses')))
         self.scroll_to_and_click(button)
 
@@ -234,14 +247,4 @@
         """ Go to SystemUpdates Page """
         super(SystemUpdatesBaseTestCase, self).setUp()
         # Click on 'System Updates' option
-        button = self.main_view.select_single(
-            objectName='entryComponent-system-update')
-        self.assertThat(button, NotEquals(None))
-        self.pointer.move_to_object(button)
-        self.pointer.click()
-
-    @property
-    def updates_page(self):
-        """ Return 'System Update' page """
-        return self.main_view.select_single(
-            objectName='entryComponent-system-update')
+        self.updates_page = self.main_view.click_updates()

=== modified file 'tests/autopilot/ubuntu_system_settings/tests/test_about.py'
--- tests/autopilot/ubuntu_system_settings/tests/test_about.py	2014-01-27 16:17:57 +0000
+++ tests/autopilot/ubuntu_system_settings/tests/test_about.py	2014-03-08 00:11:20 +0000
@@ -20,7 +20,6 @@
 
     def test_about_page(self):
         """ Checks whether About page is available """
-        self.assertThat(self.about_page, NotEquals(None))
         self.assertThat(self.about_page.title, Equals(_('About this phone')))
 
     def test_device(self):

=== modified file 'tests/autopilot/ubuntu_system_settings/tests/test_system_updates.py'
--- tests/autopilot/ubuntu_system_settings/tests/test_system_updates.py	2014-02-04 21:05:28 +0000
+++ tests/autopilot/ubuntu_system_settings/tests/test_system_updates.py	2014-03-08 00:11:20 +0000
@@ -5,17 +5,12 @@
 # under the terms of the GNU General Public License version 3, as published
 # by the Free Software Foundation.
 
-from time import sleep
-
-from autopilot.matchers import Eventually
 from autopilot.introspection.dbus import StateNotFoundError
-from testtools.matchers import Contains, Equals, NotEquals, GreaterThan, raises
-from unittest import skip
+from testtools.matchers import Equals, raises
 
 from ubuntu_system_settings.tests import SystemUpdatesBaseTestCase
 from ubuntu_system_settings.utils.i18n import ugettext as _
 
-
 """ Tests for Ubuntu System Settings """
 
 
@@ -27,15 +22,12 @@
         # Set environment variables
         super(SystemUpdatesTestCases, self).setUp()
 
-    def test_show_updates(self):
-        """ Checks whether Search box actually filters the results """
-        updates = self.updates_page
-        self.assertThat(updates, NotEquals(None))
-        # Move to text field
-        self.pointer.move_to_object(updates)
-        self.pointer.click()
+    def test_page_title(self):
+        """Check the page title is Updates """
+        self.assertThat(self.updates_page.title, Equals(_('Updates')))
 
     def test_updates_not_in_main(self):
         """Check that the updates notification is shown in main."""
         self.assertThat(lambda: self.main_view.select_single(
-            objectName='entryComponent-updates'), raises(StateNotFoundError))
+            objectName='entryComponent-updates'),
+            raises(StateNotFoundError))