Merge lp:~sbaldassin/ubuntu-system-tests/close_apps into lp:ubuntu-system-tests

[Santiago Baldassin]

Refactor in the way the system tests uses the context and clean the created resources

This change includes:

Moving the shared context from a global variable shared across modules to an object that's initialized for every test class. This allows us to
   - have a context that's independent from class to class
   - change the context values depending on the test class: i.e retry_times

Remove the reference to addCleanup added in the shared context which forced us to duplicate work like cleaning the clean up queue which is already taken care in the TestCase constructor. Moreover that reference brakes the class structure by exposing a class method across python modules

Using the addCleanup method already exposed to the tests by extending from BaseUbuntuSystemTestCase. That way we keep the class definition introduced by unittests and each test can clean the created resources the way they want

Removing the cleanup from the get_proxy methods which had two issues:
if we failed to get the proxy object then the cleanup was never updated
we were manipulating the test context in a method that was just supposed to return a proxy object

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

PASSED: Continuous integration, rev:387
https://platform-qa-jenkins.ubuntu.com/job/ubuntu-system-tests-ci/156/
Executed test runs:
    SUCCESS: https://platform-qa-jenkins.ubuntu.com/job/build-wily-amd64-package/214
        deb: https://platform-qa-jenkins.ubuntu.com/job/build-wily-amd64-package/214/artifact/work/output/*zip*/output.zip
    SUCCESS: https://platform-qa-jenkins.ubuntu.com/job/build-wily-i386-package/214
        deb: https://platform-qa-jenkins.ubuntu.com/job/build-wily-i386-package/214/artifact/work/output/*zip*/output.zip
    None: https://platform-qa-jenkins.ubuntu.com/job/generic-update-mp/188/console

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

review: Approve (continuous-integration)

Unmerged revisions

387. By Santiago Baldassin on 2016-05-17

fixing flake 8 issue

386. By Santiago Baldassin on 2016-05-17

Moving shared context to a context that's independent for every test

=== modified file 'ubuntu_system_tests/helpers/autopilot/__init__.py'
--- ubuntu_system_tests/helpers/autopilot/__init__.py	2016-04-25 18:31:03 +0000
+++ ubuntu_system_tests/helpers/autopilot/__init__.py	2016-05-17 01:57:53 +0000
@@ -25,7 +25,6 @@
 from autopilot import introspection
 from autopilot.exceptions import StateNotFoundError
 
-from ubuntu_system_tests.helpers import context
 from ubuntu_system_tests.helpers import processes
 from ubuntu_system_tests.helpers.timeout import timeout
 from ubuntu_system_tests.helpers import wait_until
@@ -237,26 +236,17 @@
 
 
 def get_proxy_object_for_existing_app(
-        process_name, cleanup_process=None,
+        process_name,
         base=ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase):
     """
     Return proxy object from existing application process.
 
-    Add cleanup action to close the application using cleanup_process
-    parameter. If cleanup_process is None then process_name is used as the
-    cleanup target using ensure_application_closed().
-
-    :param pname: Name of required application process.
-    :param cleanup_process: Name of process to clean up.
+    :param process_name: Name of required application process.
     :param base: custom emulator base for proxy object
     :return: Proxy object for the desired application.
 
     """
-    if not cleanup_process:
-        cleanup_process = process_name
     proxy = get_proxy_object_for_existing_process(process_name, base)
-    context.shared.add_cleanup(processes.ensure_application_closed,
-                               cleanup_process)
     return proxy
 
 
@@ -270,10 +260,6 @@
     """
     Return proxy object from existing qmlscene process.
 
-    Add cleanup action to close the application using cleanup_process
-    parameter. If cleanup_process is None then process_id is used as the
-    cleanup target using processes.stop_qmlscene_process().
-
     :param qmlfile: Thje name of the QML file for the required process
     :return: Proxy object for the desired qmlscene process
 
@@ -283,7 +269,6 @@
         pid=process_id,
         emulator_base=ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase
     )
-    context.shared.add_cleanup(processes.stop_qmlscene_process, qmlfile)
     return proxy
 
 

=== modified file 'ubuntu_system_tests/helpers/context.py'
--- ubuntu_system_tests/helpers/context.py	2016-02-02 20:00:15 +0000
+++ ubuntu_system_tests/helpers/context.py	2016-05-17 01:57:53 +0000
@@ -20,4 +20,10 @@
 
 from ubuntu_system_tests.helpers import AttrDict
 
-shared = AttrDict()
+
+class Context(object):
+
+    def __init__(self, timers, retry_time):
+        self.shared = AttrDict()
+        self.shared.timers = timers
+        self.shared.retry_time = retry_time

=== modified file 'ubuntu_system_tests/tests/base.py'
--- ubuntu_system_tests/tests/base.py	2016-05-09 18:32:36 +0000
+++ ubuntu_system_tests/tests/base.py	2016-05-17 01:57:53 +0000
@@ -40,6 +40,7 @@
 from ubuntu_system_tests.helpers import context
 from ubuntu_system_tests.helpers import images
 from ubuntu_system_tests.helpers import mir
+from ubuntu_system_tests.helpers.context import Context
 from ubuntu_system_tests.helpers.processes import wait_for_job_spawned
 from ubuntu_system_tests.helpers import screen
 from ubuntu_system_tests.helpers.timeout import timeout
@@ -58,6 +59,10 @@
 
 class BaseUbuntuSystemTestCase(testcase.AutopilotTestCase):
 
+    def __init__(self, timers=[], retry_time=10000):
+        self.context = Context(timers, retry_time)
+        super()
+
     @classmethod
     def setUpClass(cls):
         unity8.ensure_unity_stopped()
@@ -71,14 +76,6 @@
     def setUp(self):
         super().setUp()
         self._reset_autopilot_registry()
-        self._init_shared_context()
-
-    def _init_shared_context(self):
-        # The shared context is reset for each test
-        context.shared.clear()
-        context.shared.add_cleanup = self.addCleanup
-        context.shared.timers = []
-        context.shared.retry_time = 10000
 
     def _get_unity8_proxy_object(self):
         return autopilot.get_job_proxy_object('unity8')

=== modified file 'ubuntu_system_tests/tests/test_calculator.py'
--- ubuntu_system_tests/tests/test_calculator.py	2016-02-03 20:45:19 +0000
+++ ubuntu_system_tests/tests/test_calculator.py	2016-05-17 01:57:53 +0000
@@ -27,6 +27,8 @@
         super().setUp()
         self.unity_proxy = self.restart_unity()
         self.calculator = calculator.launch_calculator_app()
+        if self.calculator is not None:
+            self.addCleanup(calculator.close_calculator_app())
 
     def test_simple_multiplication(self):
         """Multiply two numbers."""