Merge lp:~canonical-platform-qa/ubuntu-system-tests/global_test_context into lp:ubuntu-system-tests

[Sergio Cazzolato]

Creating context module used to store a shared dictionary with common objects

The shared context can be used list:
1. Import module: from ubuntu_system_tests.helpers import context
2. Access to any shared object: dash = context.shared.dash
3. Set a shared object = context.shared.dash = self.get_dash_proxy()

The base test class is in charge of cleaning this context on the test setup and add the unity and dash proxies in the unity8 launch method.

[Sergio Cazzolato (sergio-j-cazzolato)]

In the clock app this change will be used to avoid going to the root class to access the main view.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:216
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sanity-tests-ci/878/
Executed test runs:
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sanity-tests-wily-amd64-ci/606
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sanity-tests-wily-armhf-ci/607
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sanity-tests-wily-i386-ci/606

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sanity-tests-ci/878/rebuild

review: Approve (continuous-integration)

[platform-qa-bot (platform-qa-bot)]

FAILED: Continuous integration, rev:216
https://platform-qa-jenkins.ubuntu.com/job/ubuntu-system-tests-ci/9/
Executed test runs:
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-wily-amd64-package/31/console
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-wily-i386-package/32/console
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/36/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/ubuntu-system-tests-ci/9/rebuild

review: Needs Fixing (continuous-integration)

[platform-qa-bot (platform-qa-bot)]

FAILED: Continuous integration, rev:216
https://platform-qa-jenkins.ubuntu.com/job/ubuntu-system-tests-ci/1105/
Executed test runs:
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-amd64-package/350/console
    FAILURE: https://platform-qa-jenkins.ubuntu.com/job/build-xenial-i386-package/348/console
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1826/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/ubuntu-system-tests-ci/1105/rebuild

review: Needs Fixing (continuous-integration)

[platform-qa-bot (platform-qa-bot)]

FAILED: Continuous integration, rev:216
https://platform-qa-jenkins.ubuntu.com/job/ubuntu-system-tests-ci/1143/
Executed test runs:
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/1918/console

Click here to trigger a rebuild:
https://platform-qa-jenkins.ubuntu.com/job/ubuntu-system-tests-ci/1143/rebuild

review: Needs Fixing (continuous-integration)

Unmerged revisions

216. By Sergio Cazzolato on 2015-09-24

Creating context module used to store a shared disctionary with common objects

=== modified file 'ubuntu_system_tests/helpers/__init__.py'
--- ubuntu_system_tests/helpers/__init__.py	2014-12-10 01:36:09 +0000
+++ ubuntu_system_tests/helpers/__init__.py	2015-09-24 17:40:06 +0000
@@ -0,0 +1,27 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+
+#
+# Ubuntu System Tests
+# Copyright (C) 2015 Canonical
+#
+# 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 3 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, see <http://www.gnu.org/licenses/>.
+#
+
+
+class AttrDict(dict):
+    """ Class used to access to the dict keys as parameters """
+
+    def __init__(self, *args, **kwargs):
+        super(AttrDict, self).__init__(*args, **kwargs)
+        self.__dict__ = self

=== added file 'ubuntu_system_tests/helpers/context.py'
--- ubuntu_system_tests/helpers/context.py	1970-01-01 00:00:00 +0000
+++ ubuntu_system_tests/helpers/context.py	2015-09-24 17:40:06 +0000
@@ -0,0 +1,24 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+
+#
+# Ubuntu System Tests
+# Copyright (C) 2015 Canonical
+#
+# 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 3 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, see <http://www.gnu.org/licenses/>.
+#
+
+from ubuntu_system_tests.helpers import AttrDict
+
+
+shared = AttrDict()

=== modified file 'ubuntu_system_tests/helpers/data.py'
--- ubuntu_system_tests/helpers/data.py	2015-09-04 20:57:11 +0000
+++ ubuntu_system_tests/helpers/data.py	2015-09-24 17:40:06 +0000
@@ -21,6 +21,7 @@
 from json import (load, JSONDecoder)
 from os import path, walk
 
+from ubuntu_system_tests.helpers import AttrDict
 from ubuntu_system_tests.helpers import file_system as fs
 
 
@@ -38,14 +39,6 @@
             return d
 
 
-class AttrDict(dict):
-    """ Class used to access to the dict keys as parameters """
-
-    def __init__(self, *args, **kwargs):
-        super(AttrDict, self).__init__(*args, **kwargs)
-        self.__dict__ = self
-
-
 _full_dict = AttrDict()
 
 

=== modified file 'ubuntu_system_tests/helpers/media.py'
--- ubuntu_system_tests/helpers/media.py	2015-07-27 15:31:09 +0000
+++ ubuntu_system_tests/helpers/media.py	2015-09-24 17:40:06 +0000
@@ -23,8 +23,8 @@
 from unity8.process_helpers import start_job, stop_job, is_job_running
 
 from ubuntu_system_tests.helpers import backup_restore_fixture as brf
+from ubuntu_system_tests.helpers import context
 from ubuntu_system_tests.helpers.file_system import get_media_folder_list
-from ubuntu_system_tests.helpers.unity8.dash import get_dash
 
 MEDIA_SCANNER = 'mediascanner-2.0'
 
@@ -34,7 +34,7 @@
     if is_job_running(MEDIA_SCANNER):
         stop_job(MEDIA_SCANNER)
     start_job(MEDIA_SCANNER)
-    dash = get_dash()
+    dash = context.shared.dash
     dash.wait_for_dash_loaded()
     dash.wait_for_processing_to_complete()
 

=== modified file 'ubuntu_system_tests/helpers/scopes/__init__.py'
--- ubuntu_system_tests/helpers/scopes/__init__.py	2015-09-14 15:52:45 +0000
+++ ubuntu_system_tests/helpers/scopes/__init__.py	2015-09-24 17:40:06 +0000
@@ -26,11 +26,11 @@
 from collections import namedtuple
 
 from autopilot import exceptions
+from ubuntu_system_tests.helpers import context
 from ubuntu_system_tests.helpers import file_system
 from ubuntu_system_tests.helpers import timedate
 from ubuntu_system_tests.helpers.autopilot import order_by_y_coord
 from ubuntu_system_tests.helpers.ubuntuuitoolkit.pageheader import PageHeader
-from ubuntu_system_tests.helpers.unity8.dash import get_dash
 
 SCOPES_FILE = os.path.join(file_system.DIR_TEST_DATA_SCOPES, 'scopes.json')
 KEY_DEFAULT_CONDITION = 'default_condition'
@@ -224,7 +224,7 @@
         """
         self.scroll_to_bottom()
         self._press_skip_setup_button()
-        get_dash().get_current_page_header().go_back()
+        context.shared.dash.get_current_page_header().go_back()
 
     def scroll_to_bottom(self):
         """ Scroll to the bottom of the scope """
@@ -267,7 +267,7 @@
 
     def wait_for_processing_to_complete(self):
         """Wait for the processing indicator to disappear."""
-        get_dash().wait_for_processing_to_complete()
+        context.shared.dash.wait_for_processing_to_complete()
 
 
 class ScopeData(object):

=== modified file 'ubuntu_system_tests/helpers/scopes/music.py'
--- ubuntu_system_tests/helpers/scopes/music.py	2015-09-16 15:16:00 +0000
+++ ubuntu_system_tests/helpers/scopes/music.py	2015-09-24 17:40:06 +0000
@@ -22,9 +22,9 @@
 
 from autopilot import exceptions
 
+from ubuntu_system_tests.helpers import context
 from ubuntu_system_tests.helpers.scopes import Scope
 from ubuntu_system_tests.helpers.ubuntuuitoolkit import pageheader
-from ubuntu_system_tests.helpers.unity8.dash import get_dash
 
 ARTISTS_LABEL = 'Artists'
 ALBUMS_LABEL = 'Albums'
@@ -202,7 +202,7 @@
 
 
 def get_page_header():
-    return get_dash().get_current_page_header(header_class=PageHeader)
+    return context.shared.dash.get_current_page_header(header_class=PageHeader)
 
 
 def get_artists(songs):

=== modified file 'ubuntu_system_tests/helpers/unity8/dash.py'
--- ubuntu_system_tests/helpers/unity8/dash.py	2015-09-16 13:27:44 +0000
+++ ubuntu_system_tests/helpers/unity8/dash.py	2015-09-24 17:40:06 +0000
@@ -18,28 +18,13 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-import ubuntuuitoolkit
-
 from retrying import retry
 
-from autopilot import introspection
-
 from ubuntu_system_tests.helpers.autopilot import order_by_x_coord
 from ubuntu_system_tests.helpers.ubuntuuitoolkit.pageheader import PageHeader
-from unity8 import process_helpers
 from unity8.shell.emulators import dash as unity8_dash
 
 
-def get_dash():
-    """Return the Unity8 Dash autopilot custom proxy object."""
-    pid = process_helpers.get_job_pid('unity8-dash')
-    dash_proxy = introspection.get_proxy_object_for_existing_process(
-        pid=pid,
-        emulator_base=ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase,
-    )
-    return dash_proxy.select_single(Dash)
-
-
 class Dash(unity8_dash.Dash):
 
     def wait_for_processing_to_complete(self):

=== modified file 'ubuntu_system_tests/tests/base.py'
--- ubuntu_system_tests/tests/base.py	2015-09-18 08:09:44 +0000
+++ ubuntu_system_tests/tests/base.py	2015-09-24 17:40:06 +0000
@@ -43,13 +43,13 @@
 from unity8 import process_helpers
 from unity8.sensors import FakePlatformSensors
 
+from ubuntu_system_tests.helpers import context
 from ubuntu_system_tests.helpers import click
 from ubuntu_system_tests.helpers import images
 from ubuntu_system_tests.helpers import mir
 from ubuntu_system_tests.helpers import unity8
 from ubuntu_system_tests.helpers import autopilot as autopilot_helpers
 from ubuntu_system_tests.helpers.processes import ensure_application_closed
-from ubuntu_system_tests.helpers.unity8.dash import get_dash
 from ubuntu_system_tests.helpers.unity8.shell import Unity8  # NOQA
 
 # Any test name ending with this will leave device locked
@@ -95,6 +95,9 @@
         super().setUp()
         self._reset_autopilot_registry()
 
+        # The shared context is reset for each test
+        context.shared.clear()
+
     @autopilot_logging.log_action(logger.info)
     def launch_unity(self, fake_sensors=False):
         """Launch Unity8 with testability enabled.
@@ -124,6 +127,11 @@
         self._reset_keyboard()
         # Workaround for bug lp:1474444
         self.useFixture(OSKAlwaysEnabled())
+
+        # Save the unity8 and dash in the shared context
+        context.shared.unity = unity
+        context.shared.dash = self.get_dash_proxy()
+
         return unity
 
     def _start_unity_with_testability(self):
@@ -185,7 +193,7 @@
         unity_proxy = self.launch_unity(fake_sensors=fake_sensors)
         if self.device_unlock_required():
             unity_proxy.unlock()
-            get_dash().wait_for_dash_loaded()
+            context.shared.dash.wait_for_dash_loaded()
         return unity_proxy
 
     def device_unlock_required(self):
@@ -199,7 +207,7 @@
 
     def get_scree_size(self):
         """ Calculate the screen size base on the unity8 size """
-        unity = self.get_job_proxy_object('unity8')
+        unity = context.shared.unity
         return unity.get_width(), unity.get_height()
 
     def get_screenshot_image(self):
@@ -241,7 +249,7 @@
         :return: Proxy object for application.
 
         """
-        apps_scope = get_dash().open_apps_scope()
+        apps_scope = context.shared.dash.open_apps_scope()
         apps_scope.click_scope_item(category, app_name)
 
     def _get_proxy_object_for_existing_app(self, process_name,
@@ -435,3 +443,9 @@
         from ubuntu_system_tests.helpers.webbrowser import _cpo  # NOQA
         proxy = self._get_proxy_object_for_existing_app('webbrowser-app')
         return proxy.main_window
+
+    def get_dash_proxy(self):
+        """Return the Unity8 Dash autopilot custom proxy object."""
+        from ubuntu_system_tests.helpers.unity8.dash import Dash
+        proxy = self.get_job_proxy_object('unity8-dash')
+        return proxy.select_single(Dash)

=== modified file 'ubuntu_system_tests/tests/base_messaging.py'
--- ubuntu_system_tests/tests/base_messaging.py	2015-09-11 11:09:06 +0000
+++ ubuntu_system_tests/tests/base_messaging.py	2015-09-24 17:40:06 +0000
@@ -22,12 +22,12 @@
 from datetime import datetime
 
 from ubuntu_system_tests.helpers.addressbook import Contact
+from ubuntu_system_tests.helpers import context
 from ubuntu_system_tests.helpers import file_system as fs
 from ubuntu_system_tests.helpers.messaging import fixture_setup
 from ubuntu_system_tests.helpers import messaging as messaging_helpers
 from ubuntu_system_tests.helpers import system_settings
 from ubuntu_system_tests.helpers.system_settings import SETTINGS_PROCESS
-from ubuntu_system_tests.helpers.unity8 import dash
 from ubuntu_system_tests.tests import base
 from ubuntu_system_tests.tests.base_telephony import BaseTelephonyTestCase
 
@@ -56,7 +56,6 @@
                                  number=self.get_telephony_service_number2(),
                                  expected_reply=REPLY_2)
         self.create_temporary_contact(self.contact_1)
-        self.dash = dash.get_dash()
 
     def launch_messaging(self):
         """Launch the messaging app from apps scope."""
@@ -394,5 +393,5 @@
         selector = cellular.get_default_sim_for_messages_selector(value)
         settings.scroll_to_and_click(selector)
         selector.selected.wait_for(True)
-        dash.get_dash().swipe_screen_from_left()
+        context.shared.dash.swipe_screen_from_left()
         self.addCleanup(self.ensure_application_closed, SETTINGS_PROCESS)

=== modified file 'ubuntu_system_tests/tests/test_app_store.py'
--- ubuntu_system_tests/tests/test_app_store.py	2015-09-02 11:19:54 +0000
+++ ubuntu_system_tests/tests/test_app_store.py	2015-09-24 17:40:06 +0000
@@ -48,9 +48,9 @@
 from testtools.matchers import Equals
 from ubuntu_system_tests.helpers import (
     click,
+    context,
     ubuntuone_credentials
 )
-from ubuntu_system_tests.helpers.unity8 import dash
 from ubuntu_system_tests.tests import base
 
 # XXX Imported to load the custom proxy objects. We need to import the dash
@@ -91,7 +91,7 @@
         """Create U1 account and install application from store (OSMTouch)"""
         unity_proxy = self.restart_unity()
 
-        dash_proxy = dash.get_dash()
+        dash_proxy = context.shared.dash
         apps_scope = dash_proxy.open_apps_scope()
 
         store_scope = apps_scope.go_to_store()

=== modified file 'ubuntu_system_tests/tests/test_html5_application.py'
--- ubuntu_system_tests/tests/test_html5_application.py	2015-07-01 05:13:40 +0000
+++ ubuntu_system_tests/tests/test_html5_application.py	2015-09-24 17:40:06 +0000
@@ -31,7 +31,7 @@
 
 from testtools.matchers import GreaterThan
 
-from ubuntu_system_tests.helpers.unity8.dash import get_dash
+from ubuntu_system_tests.helpers import context
 from ubuntu_system_tests.tests import base
 
 DEFAULT_WEBVIEW_INSPECTOR_IP = '127.0.0.1'
@@ -67,7 +67,7 @@
             UBUNTU_WEBVIEW_DEVTOOLS_PORT=str(DEFAULT_WEBVIEW_INSPECTOR_PORT)))
 
     def launch_webapp(self, app_name):
-        apps_scope = get_dash().open_apps_scope()
+        apps_scope = context.shared.dash.open_apps_scope()
         apps_scope.click_scope_item('local', app_name)
 
         self.addCleanup(ensure_webapp_closed)

=== modified file 'ubuntu_system_tests/tests/test_mtp.py'
--- ubuntu_system_tests/tests/test_mtp.py	2015-09-04 20:57:11 +0000
+++ ubuntu_system_tests/tests/test_mtp.py	2015-09-24 17:40:06 +0000
@@ -22,13 +22,13 @@
 import os
 
 from testtools import skipUnless
+from ubuntu_system_tests.helpers import context
 from ubuntu_system_tests.helpers.data import load_test_metadata
 from ubuntu_system_tests.helpers import file_system as fs
 from ubuntu_system_tests.helpers.mtp import MTPObjFactory, MTPHelper
 from ubuntu_system_tests.helpers import ssh
 from ubuntu_system_tests.helpers import media
 from ubuntu_system_tests.helpers.scopes import music
-from ubuntu_system_tests.helpers.unity8.dash import get_dash
 
 from ubuntu_system_tests.tests import base
 
@@ -63,7 +63,7 @@
         :param album: The name ob the desired album
         :return: True is there is an artist with the desired name
         """
-        music_scope = music.MusicScope(get_dash().open_music_scope())
+        music_scope = music.MusicScope(context.shared.dash.open_music_scope())
         self.assertTrue(music_scope.is_artist(artist))
 
     def verify_same_files(self, src_files, dst_files):

=== modified file 'ubuntu_system_tests/tests/test_scopes.py'
--- ubuntu_system_tests/tests/test_scopes.py	2015-09-16 13:27:44 +0000
+++ ubuntu_system_tests/tests/test_scopes.py	2015-09-24 17:40:06 +0000
@@ -24,6 +24,7 @@
 from testtools import skipUnless
 from ubuntu_system_tests.tests import base
 from ubuntu_system_tests.helpers import autopilot
+from ubuntu_system_tests.helpers import context
 from ubuntu_system_tests.helpers.data import load_test_metadata
 from ubuntu_system_tests.helpers import media
 from ubuntu_system_tests.helpers import music
@@ -37,7 +38,6 @@
 from ubuntu_system_tests.helpers.scopes.music import MusicScope
 from ubuntu_system_tests.helpers.scopes.video import VideoScope
 from ubuntu_system_tests.helpers.scopes import timedate
-from ubuntu_system_tests.helpers.unity8.dash import get_dash
 from ubuntu_system_tests.helpers import web
 from ubuntu_system_tests.helpers import webbrowser
 
@@ -91,7 +91,7 @@
     def setUp(self):
         super().setUp()
         self.unity_proxy = self.restart_unity()
-        self.dash = get_dash()
+        self.dash = context.shared.dash
         logger.info('Running test using channel: {c} and device: {d}'.format(
             c=channel, d=device))
         self.assertTrue(

=== modified file 'ubuntu_system_tests/tests/test_uninstall_application.py'
--- ubuntu_system_tests/tests/test_uninstall_application.py	2015-06-23 04:06:08 +0000
+++ ubuntu_system_tests/tests/test_uninstall_application.py	2015-09-24 17:40:06 +0000
@@ -26,7 +26,7 @@
 import ubuntu_system_tests
 from ubuntu_system_tests.tests import base
 from ubuntu_system_tests.helpers import click
-from ubuntu_system_tests.helpers.unity8.dash import get_dash
+from ubuntu_system_tests.helpers import context
 
 # Imported to load the custom proxy objects.
 import ubuntu_system_tests.helpers.unityclickscope  # NOQA
@@ -39,7 +39,7 @@
             ubuntu_system_tests.__name__, 'data/simpleclick.qa_0.1_all.click')
         self.useFixture(click.ClickPackageInstalled(click_file_path))
         self.restart_unity()
-        apps_scope = get_dash().open_apps_scope()
+        apps_scope = context.shared.dash.open_apps_scope()
         self.assertIn('simpleclick', apps_scope.get_applications('local'))
 
         preview = apps_scope.open_preview(