Merge lp:~nskaggs/reminders-app/setup-ap-env into lp:~elopio/reminders-app/test_with_account

[Nicholas Skaggs]

Properly setup environment for autopilot testing by using a faked /home directory on phablet and desktop

[lp:~nskaggs/reminders-app/setup-ap-env]

125. By Nicholas Skaggs on 2014-05-08

add _copy_xauthority_file rename setup env

Unmerged revisions

125. By Nicholas Skaggs on 2014-05-08

add _copy_xauthority_file rename setup env

124. By Nicholas Skaggs on 2014-05-08

switch to fixtures

123. By Nicholas Skaggs on 2014-05-08

setup env properly for test run

=== modified file 'tests/autopilot/reminders/tests/__init__.py'
--- tests/autopilot/reminders/tests/__init__.py	2014-04-04 06:09:17 +0000
+++ tests/autopilot/reminders/tests/__init__.py	2014-05-08 17:05:14 +0000
@@ -17,7 +17,7 @@
 """Reminders app autopilot tests."""
 
 import os
-import os.path
+import shutil
 import logging
 
 import fixtures
@@ -25,7 +25,10 @@
 from autopilot.input import Mouse, Touch, Pointer
 from autopilot.platform import model
 from autopilot.testcase import AutopilotTestCase
-from ubuntuuitoolkit import emulators as toolkit_emulators
+from ubuntuuitoolkit import (
+    emulators as toolkit_emulators,
+    fixture_setup as toolkit_fixtures
+)
 
 import reminders
 
@@ -41,22 +44,67 @@
     else:
         scenarios = [('with touch', dict(input_device_class=Touch))]
 
-    local_location_binary = '../../src/app/reminders'
+    local_location = os.path.dirname(os.path.dirname(os.getcwd()))
+    local_location_qml = local_location + "/reminders.qml"
+    local_location_binary = os.path.join(local_location, 'src/app/reminders')
     installed_location_binary = '/usr/bin/reminders'
     installed_location_qml = '/usr/share/reminders/qml/reminders.qml'
 
+    def get_launcher_and_type(self):
+        if os.path.exists(self.local_location_qml):
+            launcher = self.launch_test_local
+            test_type = 'local'
+        elif os.path.exists(self.installed_location_qml):
+            launcher = self.launch_test_installed
+            test_type = 'deb'
+        else:
+            launcher = self.launch_test_click
+            test_type = 'click'
+        return launcher, test_type
+
     def setUp(self):
+        launcher, self.test_type = self.get_launcher_and_type()
+        self.home_dir = self._patch_home()
         self.pointing_device = Pointer(self.input_device_class.create())
         super(RemindersAppTestCase, self).setUp()
 
-        if os.path.exists(self.local_location_binary):
-            app_proxy = self.launch_test_local()
-        elif os.path.exists(self.installed_location_binary):
-            app_proxy = self.launch_test_installed()
+        self.app = reminders.RemindersApp(launcher())
+
+    def _copy_xauthority_file(self, directory):
+        """ Copy .Xauthority file to directory, if it exists in /home
+        """
+        xauth = os.path.expanduser(os.path.join('~', '.Xauthority'))
+        if os.path.isfile(xauth):
+            logger.debug("Copying .Xauthority to " + directory)
+            shutil.copyfile(
+                os.path.expanduser(os.path.join('~', '.Xauthority')),
+                os.path.join(directory, '.Xauthority'))
+
+    def _patch_home(self):
+        """ mock /home for testing purposes to preserve user data
+        """
+        temp_dir_fixture = fixtures.TempDir()
+        self.useFixture(temp_dir_fixture)
+        temp_dir = temp_dir_fixture.path
+
+        #If running under xvfb, as jenkins does,
+        #xsession will fail to start without xauthority file
+        #Thus if the Xauthority file is in the home directory
+        #make sure we copy it to our temp home directory
+        self._copy_xauthority_file(temp_dir)
+
+        #click requires using initctl env (upstart), but the desktop can set
+        #an environment variable instead
+        if self.test_type == 'click':
+            self.useFixture(toolkit_fixtures.InitctlEnvironmentVariable(
+                            HOME=temp_dir))
         else:
-            app_proxy = self.launch_test_click()
-
-        self.app = reminders.RemindersApp(app_proxy)
+            self.useFixture(fixtures.EnvironmentVariable('HOME',
+                                                         newvalue=temp_dir))
+
+        logger.debug("Patched home to fake home directory " + temp_dir)
+
+        return temp_dir
 
     @autopilot_logging.log_action(logger.info)
     def launch_test_local(self):
@@ -64,6 +112,7 @@
             'QML2_IMPORT_PATH', newvalue='../../src/plugin'))
         return self.launch_test_application(
             self.local_location_binary,
+            '-q', self.local_location_qml,
             app_type='qt',
             emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
 
@@ -80,5 +129,5 @@
     @autopilot_logging.log_action(logger.info)
     def launch_test_click(self):
         return self.launch_click_package(
-            'com.ubuntu.reminders-app',
+            'com.ubuntu.reminders',
             emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)