Merge lp:~nskaggs/ubuntu-calculator-app/drop-fixtures into lp:~ubuntu-calculator-dev/ubuntu-calculator-app/old_trunk

[Nicholas Skaggs]

This drops support for patching home via fixtures; instead the current user's home directory is assumed properly setup

This drops support for patching home via fixtures, and instead waits for a better fix from https://bugs.launchpad.net/ubuntu-app-launch/+bug/1376423.

If you run these tests without a test runner to setup the environment, these tests will modify the current user's home folder.

[lp:~nskaggs/ubuntu-calculator-app/drop-fixtures]

337. By Nicholas Skaggs on 2014-10-09

add autopilot readme

[Nicholas Skaggs (nskaggs)]

Confirming no apparmor errors present on RTM, image 92, using only these changes.

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Continuous integration, rev:337
http://91.189.93.70:8080/job/ubuntu-calculator-app-ci/267/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/814
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/814/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-calculator-app-utopic-amd64-ci/62

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-calculator-app-ci/267/rebuild

review: Needs Fixing (continuous-integration)

[lp:~nskaggs/ubuntu-calculator-app/drop-fixtures]

338. By Nicholas Skaggs on 2014-10-09

switch to mocking on desktop only

339. By Nicholas Skaggs on 2014-10-09

update readme

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Continuous integration, rev:338
http://91.189.93.70:8080/job/ubuntu-calculator-app-ci/268/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/815
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/815/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-calculator-app-utopic-amd64-ci/63

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-calculator-app-ci/268/rebuild

review: Needs Fixing (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Continuous integration, rev:339
http://91.189.93.70:8080/job/ubuntu-calculator-app-ci/269/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/816
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/816/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-calculator-app-utopic-amd64-ci/64

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-calculator-app-ci/269/rebuild

review: Needs Fixing (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Continuous integration, rev:337
http://91.189.93.70:8080/job/ubuntu-calculator-app-ci/270/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/817
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/817/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-calculator-app-utopic-amd64-ci/65

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-calculator-app-ci/270/rebuild

review: Needs Fixing (continuous-integration)

[Riccardo Padovani (rpadovani)]

Didn't test on a device, but sounds reasonable. Anyway, there is a little type (see inline comment)

review: Needs Fixing

[lp:~nskaggs/ubuntu-calculator-app/drop-fixtures]

340. By Nicholas Skaggs on 2014-10-09

fix typo

[Riccardo Padovani (rpadovani)]

lgtm

review: Approve

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

review: Approve (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

PASSED: Continuous integration, rev:337
http://91.189.93.70:8080/job/ubuntu-calculator-app-ci/271/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/821
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/821/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-calculator-app-utopic-amd64-ci/66

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-calculator-app-ci/271/rebuild

review: Approve (continuous-integration)

=== added file 'README.autopilot'
--- README.autopilot	1970-01-01 00:00:00 +0000
+++ README.autopilot	2014-10-09 21:48:24 +0000
@@ -0,0 +1,61 @@
+# Running Autopilot tests
+
+Ubuntu Calculator App follows a test driven development where autopilot tests are run before every merge into trunk. If you are submitting your bugfix/patch to the calculator app, please follow the following steps below to ensure that all tests pass before proposing a merge request.
+
+If you are looking for more info about Autopilot or writing AP tests for the calculator app, here are some useful links to help you,
+
+- http://developer.ubuntu.com/api/devel/ubuntu-14.10/python/autopilot/
+- http://developer.ubuntu.com/api/devel/ubuntu-14.10/python/autopilot-emulator/
+
+## Prerequisites
+
+Install the following autopilot packages required to run the tests,
+$ sudo apt-get install python-autopilot libautopilot-qt ubuntu-ui-toolkit-autopilot python3-autopilot-vis
+
+NOTE, running the autopilot tests as yourself will run and modify your home directory on confined platforms (like the phone). For now, the desktop will still run inside a mocked /home.
+
+
+## Running tests on the desktop
+
+Using terminal:
+
+*  Branch the calculator app code,
+    $ bzr branch lp:ubuntu-calculator-app
+
+*  Navigate to the tests/autopilot directory.
+    $ cd ubuntu-calculator-app/tests/autopilot
+
+*  run all tests.
+    $ autopilot3 run -v ubuntu_calculator_app
+
+    to list all tests:
+    $ autopilot3 list ubuntu_calculator_app
+
+    To run only one test, pass the full testname (as shown in autopilot3 list)
+
+    Debugging tests using autopilot vis
+    $ autopilot3 launch -i Qt qmlscene ../../ubuntu-calculator-app.qml
+    $ autopilot3 vis
+
+
+## Running tests on device or emulator:
+
+Note, using adt-run from autopkgtest will setup an isolated environment on the device to safely run tests. It's recommended you use this to run tests on your device.
+
+Using autopkgtest:
+
+If you have local modifications you want to run, make sure to pass the root folder containing the modifications to adt-run. So,
+
+*  Branch the calculator app code,
+    $ bzr branch lp:ubuntu-calculator-app
+*  Make your modifications
+*  Navigate to the directory where the ubuntu-calculator-app branch is and run:
+  $ adt-run ubuntu-calculator-app --click=com.ubuntu.calculator --- ssh -s adb
+
+If you simply want to run the tests for the application as it is installed on the device, you can run
+
+$ adt-run --click=com.ubuntu.calculator --- ssh -s adb
+
+from anywhere. This will grab the version of the tests corresponding to the version of the click package installed on the device.
+
+For more help on autopkg, see https://people.debian.org/~mpitt/autopkgtest/README.running-tests.html

=== modified file 'tests/autopilot/ubuntu_calculator_app/tests/__init__.py'
--- tests/autopilot/ubuntu_calculator_app/tests/__init__.py	2014-09-05 20:56:31 +0000
+++ tests/autopilot/ubuntu_calculator_app/tests/__init__.py	2014-10-09 21:48:24 +0000
@@ -20,17 +20,14 @@
 import shutil
 import logging
 
-import fixtures
 import ubuntu_calculator_app
 
 from autopilot.testcase import AutopilotTestCase
 from autopilot import logging as autopilot_logging
 
+import fixtures
 import ubuntuuitoolkit
-from ubuntuuitoolkit import (
-    base,
-    fixture_setup as toolkit_fixtures
-)
+from ubuntuuitoolkit import base
 
 logger = logging.getLogger(__name__)
 
@@ -63,12 +60,12 @@
     def setUp(self):
         super(BaseTestCaseWithPatchedHome, self).setUp()
         self.launcher, self.test_type = self.get_launcher_and_type()
-        self.home_dir = self._patch_home()
+        self.patch_home()
 
         # Unset the current locale to ensure locale-specific data
         # (day and month names, first day of the week, …) doesn’t get
         # in the way of test expectations.
-        self.useFixture(fixtures.EnvironmentVariable('LC_ALL', newvalue='C'))
+        self.patch_environment('LC_ALL', 'C')
 
     @autopilot_logging.log_action(logger.info)
     def launch_test_local(self):
@@ -109,60 +106,15 @@
                                    '.Xauthority')),
                 os.path.join(directory, '.Xauthority'))
 
-    def _patch_home(self):
+    def patch_home(self):
         """ mock /home for testing purposes to preserve user data
         """
-        # click requires apparmor profile, and writing to special dir
-        # but the desktop can write to a traditional /tmp directory
-        if self.test_type == 'click':
-            env_dir = os.path.join(os.environ.get('HOME'), 'autopilot',
-                                   'fakeenv')
-
-            if not os.path.exists(env_dir):
-                os.makedirs(env_dir)
-
-            temp_dir_fixture = fixtures.TempDir(env_dir)
-            self.useFixture(temp_dir_fixture)
-
-            # apparmor doesn't allow the app to create needed directories,
-            # so we create them now
-            temp_dir = temp_dir_fixture.path
-            temp_dir_cache = os.path.join(temp_dir, '.cache')
-            temp_dir_cache_font = os.path.join(temp_dir_cache, 'fontconfig')
-            temp_dir_cache_media = os.path.join(temp_dir_cache, 'media-art')
-            temp_dir_cache_write = os.path.join(temp_dir_cache,
-                                                'tncache-write-text.null')
-            temp_dir_config = os.path.join(temp_dir, '.config')
-            temp_dir_toolkit = os.path.join(temp_dir_config,
-                                            'ubuntu-ui-toolkit')
-            temp_dir_font = os.path.join(temp_dir_cache, '.fontconfig')
-            temp_dir_local = os.path.join(temp_dir, '.local', 'share')
-            temp_dir_confined = os.path.join(temp_dir, 'confined')
-
-            if not os.path.exists(temp_dir_cache):
-                os.makedirs(temp_dir_cache)
-            if not os.path.exists(temp_dir_cache_font):
-                os.makedirs(temp_dir_cache_font)
-            if not os.path.exists(temp_dir_cache_media):
-                os.makedirs(temp_dir_cache_media)
-            if not os.path.exists(temp_dir_cache_write):
-                os.makedirs(temp_dir_cache_write)
-            if not os.path.exists(temp_dir_config):
-                os.makedirs(temp_dir_config)
-            if not os.path.exists(temp_dir_toolkit):
-                os.makedirs(temp_dir_toolkit)
-            if not os.path.exists(temp_dir_font):
-                os.makedirs(temp_dir_font)
-            if not os.path.exists(temp_dir_local):
-                os.makedirs(temp_dir_local)
-            if not os.path.exists(temp_dir_confined):
-                os.makedirs(temp_dir_confined)
-
-            # before we set fixture, copy xauthority if needed
-            self._copy_xauthority_file(temp_dir)
-            self.useFixture(toolkit_fixtures.InitctlEnvironmentVariable(
-                            HOME=temp_dir))
-        else:
+
+        # if running on non-phablet device,
+        # run in temp folder to avoid mucking up home
+        # bug 1316746
+        # bug 1376423
+        if self.test_type is not 'click':
             temp_dir_fixture = fixtures.TempDir()
             self.useFixture(temp_dir_fixture)
             temp_dir = temp_dir_fixture.path
@@ -172,8 +124,25 @@
             self.useFixture(fixtures.EnvironmentVariable('HOME',
                                                          newvalue=temp_dir))
 
-        logger.debug("Patched home to fake home directory %s" % temp_dir)
-        return temp_dir
+            logger.debug("Patched home to fake home directory %s" % temp_dir)
+
+    def patch_environment(self, key, value):
+        def patch_var(key, value):
+            logging.info(
+                "Setting environment variable '%s' to '%s'",
+                key,
+                value
+            )
+
+            os.environ[key] = value
+
+        orginal = os.getenv(key)
+        if orginal is None:
+            orginal = ''
+        patch_var(key, value)
+        # on click, we should cleanup
+        if self.test_type is 'click':
+            self.addCleanup(patch_var, key, orginal)
 
 
 class CalculatorAppTestCase(BaseTestCaseWithPatchedHome):