Merge lp:~canonical-platform-qa/address-book-app/main_window_objectName into lp:address-book-app

[Leo Arias]

On autopilot tests, select the main window by object name.
Added a custom proxy object for the application.

In order to test the address book's interactions with other applications, we need to set a unique object name to its MainWindow.

[lp:~canonical-platform-qa/address-book-app/main_window_objectName]

378. By Leo Arias on 2015-02-19

Fixed the copyright headers.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:378
http://jenkins.qa.ubuntu.com/job/address-book-app-ci/747/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/address-book-app-vivid-i386-ci/50
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1435
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-vivid/635
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1270
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1433
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1433/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/18188
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-vivid/510
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/745
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/745/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/747/rebuild

review: Approve (continuous-integration)

[Renato Araujo Oliveira Filho (renatofilho)]

looks good. +1

review: Approve

=== modified file 'src/imports/MainWindow.qml'
--- src/imports/MainWindow.qml	2014-11-11 14:31:23 +0000
+++ src/imports/MainWindow.qml	2015-02-19 07:06:21 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2012-2013 Canonical, Ltd.
+ * Copyright (C) 2012-2015 Canonical, Ltd.
  *
  * 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
@@ -21,6 +21,7 @@
 
 MainView {
     id: mainWindow
+    objectName: "addressBookAppMainWindow"
 
     property string modelErrorMessage: ""
     readonly property bool appActive: Qt.application.active

=== modified file 'tests/autopilot/address_book_app/__init__.py'
--- tests/autopilot/address_book_app/__init__.py	2014-09-02 19:23:05 +0000
+++ tests/autopilot/address_book_app/__init__.py	2015-02-19 07:06:21 +0000
@@ -1,6 +1,6 @@
 # -*- 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 General Public License version 3, as published
@@ -24,7 +24,10 @@
 
 import autopilot.logging
 import ubuntuuitoolkit
-from autopilot.introspection import dbus
+from autopilot import (
+    exceptions,
+    introspection
+)
 
 from address_book_app import pages
 
@@ -32,17 +35,31 @@
 logger = logging.getLogger(__name__)
 
 
-class AddressBookApp(object):
-
-    def __init__(self, app_proxy):
-        super(AddressBookApp, self).__init__()
-        self.app_proxy = app_proxy
-        self.main_window = self.app_proxy.select_single(MainWindow)
-
-
-class MainWindow(ubuntuuitoolkit.MainView):
+class AddressBookApp(ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase):
+
+    """Autopilot custom proxy object for the address book app."""
+
+    @classmethod
+    def validate_dbus_object(cls, path, state):
+        name = introspection.get_classname_from_path(path)
+        return (name == b'webbrowser-app' and
+                state['applicationName'][1] == 'webbrowser-app')
+
+    @property
+    def main_window(self):
+        return self.select_single(objectName='addressBookAppMainWindow')
+
+
+class AddressBookAppMainWindow(ubuntuuitoolkit.MainView):
+
     """An emulator class that makes it easy to interact with the app."""
 
+    @classmethod
+    def validate_dbus_object(cls, path, state):
+        name = introspection.get_classname_from_path(path)
+        return (name == b'MainWindow' and
+                state['objectName'][1] == 'addressBookAppMainWindow')
+
     def get_contact_list_page(self):
         # ContactListPage is the only page that can appears multiple times
         # Ex.: During the pick mode we alway push a new contactListPage, to
@@ -66,9 +83,7 @@
         for p in contact_editor_pages:
             if p.active:
                 return p
-        raise dbus.StateNotFoundError('contactEditorPage not found')
-        return None
-
+        raise exceptions.StateNotFoundError('contactEditorPage not found')
 
     def get_contact_view_page(self):
         return self.wait_select_single("ContactView",

=== modified file 'tests/autopilot/address_book_app/tests/__init__.py'
--- tests/autopilot/address_book_app/tests/__init__.py	2014-09-02 19:23:05 +0000
+++ tests/autopilot/address_book_app/tests/__init__.py	2015-02-19 07:06:21 +0000
@@ -1,9 +1,18 @@
 # -*- 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
+#
+# Copyright (C) 2013, 2014, 2015 Canonical Ltd.
+#
+# 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.
+#
+# 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, see <http://www.gnu.org/licenses/>.
 
 """address-book-app autopilot tests."""
 
@@ -17,7 +26,6 @@
 from testtools.matchers import Equals
 
 import address_book_app
-from address_book_app import MainWindow
 from ubuntuuitoolkit import emulators as toolkit_emulators
 
 
@@ -62,22 +70,21 @@
 
         os.environ["ADDRESS_BOOK_TEST_DATA"] = vcard_data
         os.environ["LANG"] = "en_US.UTF-8"
-        os.environ["LANGUAGE"] ="en_US"
+        os.environ["LANGUAGE"] = "en_US"
         if vcard_data != "":
             print("Using vcard %s" % vcard_data)
         if os.path.exists(self.app_bin):
             print("Running from: %s" % (self.app_bin))
-            self.launch_test_local()
+            self.app = self.launch_test_local()
         elif os.path.exists(self.DEB_LOCALTION):
             print("Running from: %s" % (self.DEB_LOCALTION))
-            self.launch_test_installed()
+            self.app = self.launch_test_installed()
         else:
             print("Running from click package: address-book-app")
-            self.launch_click_installed()
+            self.app = self.launch_click_installed()
 
         AddressBookAppTestCase.ARGS = []
         self.main_window.visible.wait_for(True)
-        self.app = address_book_app.AddressBookApp(self.app_proxy)
 
     def tearDown(self):
         super(AddressBookAppTestCase, self).tearDown()
@@ -87,28 +94,29 @@
             subprocess.check_call(["/sbin/initctl", "start", "maliit-server"])
 
     def launch_test_local(self):
-        self.app_proxy = self.launch_test_application(
+        return self.launch_test_application(
             self.app_bin,
             *AddressBookAppTestCase.ARGS,
             app_type='qt',
-            emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
+            emulator_base=address_book_app.AddressBookApp)
 
     def launch_test_installed(self):
         df = "/usr/share/applications/address-book-app.desktop"
         self.ARGS.append("--desktop_file_hint=" + df)
-        self.app_proxy = self.launch_test_application(
+        return self.launch_test_application(
             "address-book-app",
             *AddressBookAppTestCase.ARGS,
             app_type='qt',
-            emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
+            emulator_base=address_book_app.AddressBookApp)
 
     def launch_click_installed(self):
-        self.app_proxy = self.launch_click_package(
-            "com.ubuntu.address-book")
+        return self.launch_click_package(
+            'com.ubuntu.address-book',
+            emulator_base=address_book_app.AddressBookApp)
 
     @property
     def main_window(self):
-        return self.app_proxy.select_single(MainWindow)
+        return self.app.main_window
 
     def select_a_value(self, field, value_selector, value):
         # Make sure the field has focus
@@ -239,14 +247,14 @@
         self.type_on_field(last_name_field, last_name)
 
         if phone_numbers:
-            phoneGroup = self.main_window.select_single(
+            self.main_window.select_single(
                 "ContactDetailGroupWithTypeEditor",
                 objectName="phones")
             for idx, number in enumerate(phone_numbers):
                 self.set_phone_number(idx, number)
 
         if email_address:
-            emailGroup = self.main_window.select_single(
+            self.main_window.select_single(
                 "ContactDetailGroupWithTypeEditor",
                 objectName="emails")
             for idx, address in enumerate(email_address):