Merge lp:~canonical-platform-qa/ubuntu-system-settings/main_window_objectName into lp:ubuntu-system-settings

[Leo Arias]

On the autopilot tests, select the main window by object name.
Added a proxy object for the application.
Cleaned up the launching methods.

In order to test the integration between system settings and other applications, we need to assign a unique name to the MainWindow.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1317
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/1984/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1434
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/254
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1271
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1432
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1432/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/18189

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1318
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/1985/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1437
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/255
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1273
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1435
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1435/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/18191

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

review: Needs Fixing (continuous-integration)

[Brendan Donegan (brendan-donegan)]

LGTM but obviously the jenkins issues need to be fixed before merging

review: Approve

[Sebastien Bacher (seb128)]

That changeset seems to do more than changing the name of the mainview object, can you update the description/commit message to give some details?b

review: Needs Information

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1319
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/1986/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1443
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/256
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1278
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1441
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1441/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/18201

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1320
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/1987/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1447/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/257
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1282/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1445
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1445/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/18206

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1320
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/1988/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1452
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/258
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1287
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1450
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1450/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/18212

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1321
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/1990/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1455
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/260
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1289
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1453
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1453/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/18215

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1322
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/1995/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1470
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/265
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1305
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1468
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1468/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/18244

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

review: Approve (continuous-integration)

[Leo Arias (elopio)]

I finally found my mistake that was causing errors in jenkins.
I added more info to the commit message, and this is ready for a new review.

[Jonas G. Drange (jonas-drange)]

Tests run fine on unity7 and 8, changes look good. If you have time you could maybe roughly explain ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase?

WFM

review: Approve

[Leo Arias (elopio)]

> If you have time you could
> maybe roughly explain ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase?

When autopilot returns a qml element with select single, what it returns is a default proxy object. What this default proxy does is to make it easier the access to qml properties and adds some handy things like waits and methods to inspect the element and its children.

We can extend the default proxy object with a custom proxy object. We link a custom proxy object to a specific QML component, so we can put in that object methods that will make it easier to write tests using that component. For example, a custom proxy object for a check box will have a method "check" and a method "uncheck" that will take care of moving the pointer to the right point and do the click.

We defined a class ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase to contain all the things that will be common to all custom proxy objects for ubuntu apps. Currently, it has a "pointing_device" property that is used to do clicks and drags in a touch screen or with a mouse, depending on what you have available. It also has some methods for swiping, and we will probably add some more.

In here, we are using the toolkit base for the application proxy. The application has some properties that no other QML component has, so at some point we will probably make a specific base class for applications. For now, this one is good for everything.

=== modified file 'src/qml/MainWindow.qml'
--- src/qml/MainWindow.qml	2015-02-13 08:57:51 +0000
+++ src/qml/MainWindow.qml	2015-02-20 17:41:08 +0000
@@ -1,7 +1,7 @@
 /*
  * This file is part of system-settings
  *
- * Copyright (C) 2013 Canonical Ltd.
+ * Copyright (C) 2013, 2014, 2015 Canonical Ltd.
  *
  * Contact: Alberto Mardegan <[e-mail]>
  *
@@ -28,7 +28,7 @@
     width: units.gu(50)
     height: units.gu(90)
     applicationName: "ubuntu-system-settings"
-    objectName: "mainView"
+    objectName: "systemSettingsMainView"
     automaticOrientation: true
     useDeprecatedToolbar: false
     anchorToKeyboard: true

=== modified file 'tests/autopilot/ubuntu_system_settings/__init__.py'
--- tests/autopilot/ubuntu_system_settings/__init__.py	2015-02-18 21:00:56 +0000
+++ tests/autopilot/ubuntu_system_settings/__init__.py	2015-02-20 17:41:08 +0000
@@ -1,7 +1,7 @@
 
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
 #
-# Copyright (C) 2014 Canonical Ltd.
+# Copyright (C) 2014, 2015 Canonical Ltd.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published by
@@ -27,70 +27,39 @@
 from autopilot.input import Keyboard
 import autopilot.logging
 import ubuntuuitoolkit
-from autopilot import introspection, platform
+from autopilot import introspection
 from ubuntu_system_settings.utils.i18n import ugettext as _
 
 logger = logging.getLogger(__name__)
 
 
-class SystemSettings():
+class SystemSettings(ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase):
+
     """Helper class for System Settings application"""
 
-    APP_PATH = '/usr/bin/system-settings'
-    DESKTOP_FILE = '/usr/share/applications/ubuntu-system-settings.desktop'
-
-    def __init__(self, testobj, panel=None):
-        """Constructor. Launches system settings application
-
-        :param testobj: An AutopilotTestCase object, needed to call
-        testobj.launch_test_application()
-
-        :param panel: Launch to a specific panel. Default None.
-        """
-        self.testobj = testobj
-        self.panel = panel
-        # Launches application
-        self.app = self.launch(
-            self.testobj,
-            self.APP_PATH,
-            self.DESKTOP_FILE,
-            panel=self.panel)
-
-    def launch(self, testobj, app_path, desktop_file, panel=None):
-        """Launch system settings application
-
-        :param testobj: An AutopilotTestCase object, needed to call
-        testobj.launch_test_application()
-
-        :param panel: Launch to a specific panel. Default None.
-
-        :returns: A proxy object that represents the application. Introspection
-        data is retrievable via this object.
-        """
-        params = [app_path]
-        if platform.model() != 'Desktop':
-            params.append('--desktop_file_hint={}'.format(desktop_file))
-
-        # Launch to a specific panel
-        if panel is not None:
-            params.append(panel)
-
-        app = testobj.launch_test_application(
-            *params,
-            app_type='qt',
-            emulator_base=ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase,
-            capture_output=True)
-
-        return app
+    @classmethod
+    def validate_dbus_object(cls, path, state):
+        name = introspection.get_classname_from_path(path)
+        return ((name == b'SystemSettings' and
+                 state['applicationName'][1] == 'SystemSettings') or
+                (name == b'ubuntu-system-settings' and
+                 state['applicationName'][1] == 'ubuntu-system-settings'))
 
     @property
     def main_view(self):
         """Return main view"""
-        return self.app.select_single(MainWindow)
-
-
-class MainWindow(ubuntuuitoolkit.MainView):
-    """An emulator class that makes it easy to interact with the UI."""
+        return self.select_single(objectName='systemSettingsMainView')
+
+
+class SystemSettingsMainWindow(ubuntuuitoolkit.MainView):
+
+    """Autopilot helper for the Main Window."""
+
+    @classmethod
+    def validate_dbus_object(cls, path, state):
+        name = introspection.get_classname_from_path(path)
+        return (name == b'MainWindow' and
+                state['objectName'][1] == 'systemSettingsMainView')
 
     @autopilot.logging.log_action(logger.debug)
     def click_item(self, object_name):
@@ -788,7 +757,8 @@
             objectName='resetLauncherDialog')
 
     def _wait_and_return_main_system_settins_page(self):
-        main_view = self.get_root_instance().select_single(MainWindow)
+        main_view = self.get_root_instance().select_single(
+            objectName='systemSettingsMainView')
         main_view.system_settings_page.active.wait_for(True)
         return main_view.system_settings_page
 

=== modified file 'tests/autopilot/ubuntu_system_settings/tests/__init__.py'
--- tests/autopilot/ubuntu_system_settings/tests/__init__.py	2015-01-28 15:02:09 +0000
+++ tests/autopilot/ubuntu_system_settings/tests/__init__.py	2015-02-20 17:41:08 +0000
@@ -1,28 +1,39 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
-# Copyright 2013 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.
+# Copyright 2013, 2014, 2015 Canonical
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; version 3.
+#
+# 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 """ Tests for Ubuntu System Settings """
+
 from __future__ import absolute_import
 
-
 import dbus
 import dbusmock
 import os
 import subprocess
+from datetime import datetime
+from time import sleep
+
 import ubuntuuitoolkit
-
+from autopilot import platform
 from autopilot.matchers import Eventually
 from dbusmock.templates.networkmanager import DEVICE_IFACE
-from datetime import datetime
 from fixtures import EnvironmentVariable
+from gi.repository import UPowerGlib
 from testtools.matchers import Equals, NotEquals, GreaterThan
-from time import sleep
-from ubuntu_system_settings import SystemSettings
-from gi.repository import UPowerGlib
+
+import ubuntu_system_settings
+
 
 ACCOUNTS_IFACE = 'org.freedesktop.Accounts'
 ACCOUNTS_USER_IFACE = 'org.freedesktop.Accounts.User'
@@ -61,9 +72,12 @@
 
     """Base class for Ubuntu System Settings."""
 
+    APP_PATH = '/usr/bin/system-settings'
+    DESKTOP_FILE = '/usr/share/applications/ubuntu-system-settings.desktop'
+
     def setUp(self, panel=None):
         super(UbuntuSystemSettingsTestCase, self).setUp()
-        self.system_settings = SystemSettings(self, panel=panel)
+        self.system_settings = self.launch(panel)
         self.main_view = self.system_settings.main_view
         self.assertThat(
             self.main_view.visible,
@@ -75,6 +89,31 @@
             lambda: gsettings.get_value('rotation-lock').get_boolean(),
             Eventually(Equals(value.get_boolean())))
 
+    def launch(self, panel=None):
+        """Launch system settings application
+
+        :param testobj: An AutopilotTestCase object, needed to call
+        testobj.launch_test_application()
+
+        :param panel: Launch to a specific panel. Default None.
+
+        :returns: A proxy object that represents the application. Introspection
+        data is retrievable via this object.
+        """
+        params = [self.APP_PATH]
+        if platform.model() != 'Desktop':
+            params.append('--desktop_file_hint={}'.format(self.DESKTOP_FILE))
+
+        # Launch to a specific panel
+        if panel is not None:
+            params.append(panel)
+
+        return self.launch_test_application(
+            *params,
+            app_type='qt',
+            emulator_base=ubuntu_system_settings.SystemSettings,
+            capture_output=True)
+
 
 class UbuntuSystemSettingsUpowerTestCase(UbuntuSystemSettingsTestCase,
                                          dbusmock.DBusTestCase):