Merge lp:~nskaggs/ubuntu-filemanager-app/fix-ap-launch into lp:ubuntu-filemanager-app

[Nicholas Skaggs]

This should resolve the applications failure to launch on the device.

This should resolve the applications failure to launch on the device.

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

PASSED: Continuous integration, rev:299
http://91.189.93.70:8080/job/ubuntu-filemanager-app-ci/344/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/864
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/864/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-filemanager-app-utopic-amd64-ci/142

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

review: Approve (continuous-integration)

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

FAILED: Continuous integration, rev:301
http://91.189.93.70:8080/job/ubuntu-filemanager-app-ci/345/
Executed test runs:
    None: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/867/console
    None: http://91.189.93.70:8080/job/ubuntu-filemanager-app-utopic-amd64-ci/143/console

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

review: Needs Fixing (continuous-integration)

[Nicholas Skaggs (nskaggs)]

This bug prevents fixing the tests to work better on device:

https://bugs.launchpad.net/ubuntu-filemanager-app/+bug/1379943

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

FAILED: Autolanding.
More details in the following jenkins job:
http://91.189.93.70:8080/job/ubuntu-filemanager-app-autolanding/139/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/868/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-filemanager-app-utopic-amd64-autolanding/69/console

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:302
http://91.189.93.70:8080/job/ubuntu-filemanager-app-ci/346/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/869/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-filemanager-app-utopic-amd64-ci/144/console

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

review: Needs Fixing (continuous-integration)

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

FAILED: Autolanding.
More details in the following jenkins job:
http://91.189.93.70:8080/job/ubuntu-filemanager-app-autolanding/140/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/871
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/871/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-filemanager-app-utopic-amd64-autolanding/70

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:303
http://91.189.93.70:8080/job/ubuntu-filemanager-app-ci/348/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/874
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/874/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-filemanager-app-utopic-amd64-ci/146

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

review: Needs Fixing (continuous-integration)

[lp:~nskaggs/ubuntu-filemanager-app/fix-ap-launch]

304. By Nicholas Skaggs on 2014-10-14

fix home_dir

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

PASSED: Continuous integration, rev:304
http://91.189.93.70:8080/job/ubuntu-filemanager-app-ci/349/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/945
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/945/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-filemanager-app-utopic-amd64-ci/147

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

review: Approve (continuous-integration)

=== modified file 'tests/autopilot/filemanager/__init__.py'
--- tests/autopilot/filemanager/__init__.py	2014-09-22 21:52:42 +0000
+++ tests/autopilot/filemanager/__init__.py	2014-10-14 18:53:19 +0000
@@ -25,8 +25,6 @@
 from autopilot.introspection import dbus
 import ubuntuuitoolkit
 
-from filemanager import _common
-
 logger = logging.getLogger(__name__)
 
 
@@ -88,7 +86,8 @@
             self.open_toolbar().click_button('places')
             return self._get_places_popover()
         else:
-            raise _common('The places popover cannot be opened on wide mode.')
+            raise FilemanagerException(
+                'The places popover cannot be opened on wide mode.')
 
     def _get_places_popover(self):
         """Return the Places popover."""

=== removed file 'tests/autopilot/filemanager/_common.py'
--- tests/autopilot/filemanager/_common.py	2014-06-10 02:34:07 +0000
+++ tests/autopilot/filemanager/_common.py	1970-01-01 00:00:00 +0000
@@ -1,21 +0,0 @@
-# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
-#
-# Copyright (C) 2014 Canonical Ltd.
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation; version 3.
-#
-# 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 Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-from ubuntuuitoolkit import emulators as toolkit_emulators
-
-
-class FileManagerException(toolkit_emulators.ToolkitEmulatorException):
-    """Exception raised when there is an error with the File Manager."""

=== modified file 'tests/autopilot/filemanager/tests/__init__.py'
--- tests/autopilot/filemanager/tests/__init__.py	2014-09-30 22:38:30 +0000
+++ tests/autopilot/filemanager/tests/__init__.py	2014-10-14 18:53:19 +0000
@@ -29,7 +29,6 @@
 from autopilot.testcase import AutopilotTestCase
 from testtools.matchers import Equals
 import ubuntuuitoolkit
-from ubuntuuitoolkit import fixture_setup as toolkit_fixtures
 
 import filemanager
 from filemanager import fixture_setup as fm_fixtures
@@ -75,30 +74,8 @@
 
         super(BaseTestCaseWithPatchedHome, self).setUp()
         self.launcher, self.test_type = self.get_launcher_and_type()
-        self.real_home_dir = os.environ.get('HOME')
-        self.home_dir = self._patch_home()
-
-        self.original_file_count = \
-            len([i for i in os.listdir(self.home_dir)
-                 if not i.startswith('.')])
-        logger.debug('Directory Listing for HOME\n%s' %
-                     os.listdir(self.home_dir))
-        logger.debug('File count in HOME is %s' % self.original_file_count)
-
-    def _get_build_dir(self):
-        """
-        Returns the build dir after having parsed the CMake config file
-        generated by Qt Creator. If it cannot find it or it cannot be parsed,
-        an in-tree build is assumed and thus returned.
-        """
-        try:
-            cmake_config = CMakePluginParser.CMakePluginParser(os.path.join(
-                self.source_dir, 'CMakeLists.txt.user'))
-            build_dir = cmake_config.active_build_dir
-        except:
-            build_dir = self.source_dir
-
-        return build_dir
+        self.real_home_dir = os.getenv('HOME')
+        self.patch_home()
 
     @autopilot_logging.log_action(logger.info)
     def launch_test_local(self):
@@ -195,119 +172,74 @@
                                    '.Xauthority')),
                 os.path.join(directory, '.Xauthority'))
 
-    def _patch_home(self):
+    def patch_home(self):
         """ mock /home for testing purposes to preserve user data
         """
 
-        original_home = os.environ.get('HOME')
-        original_app_launch = os.environ.get('UBUNTU_APP_LAUNCH_LINK_FARM')
-        original_xdg_config_home = os.environ.get('XDG_CONFIG_HOME')
-
-        # 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)
-        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()
-
-        # setup fixture paths
-        self.useFixture(temp_dir_fixture)
-        temp_dir = temp_dir_fixture.path
-        temp_xdg_config_home = os.path.join(temp_dir, '.config')
-        temp_app_launch = os.path.join(temp_dir, '.cache',
-                                       'ubuntu-app-launch', 'desktop')
-
-        # create the needed directores
-        if not os.path.exists(temp_xdg_config_home):
-            os.makedirs(temp_xdg_config_home)
-        if not os.path.exists(temp_app_launch):
-            os.makedirs(temp_app_launch)
-
-        # for click, we need to create additional directories
-        # apparmor doesn't allow the app to create needed directories,
-        # so we create them now
-        if self.test_type == 'click':
-            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)
-
-        # set the fixture
-        # for click, use initctl, otherwise set env directly
-        if self.test_type == 'click':
-            self.useFixture(toolkit_fixtures.InitctlEnvironmentVariable(
-                            HOME=temp_dir))
-            self.useFixture(toolkit_fixtures.InitctlEnvironmentVariable(
-                            XDG_CONFIG_HOME=temp_xdg_config_home))
-            self.useFixture(toolkit_fixtures.InitctlEnvironmentVariable(
-                            UBUNTU_APP_LAUNCH_LINK_FARM=temp_app_launch))
-
-        else:
+            self.useFixture(temp_dir_fixture)
+            temp_dir = temp_dir_fixture.path
+
+            # before we set fixture, copy xauthority if needed
+            self._copy_xauthority_file(temp_dir)
             self.useFixture(fixtures.EnvironmentVariable('HOME',
                                                          newvalue=temp_dir))
-            self.useFixture(fixtures.EnvironmentVariable(
-                'XDG_CONFIG_HOME', newvalue=temp_xdg_config_home))
-            self.useFixture(fixtures.EnvironmentVariable(
-                'UBUNTU_APP_LAUNCH_LINK_FARM', newvalue=temp_app_launch))
-
-        # For now, blow away actual env vars and restore
-        # TODO: Remove code once pad.lv/1370800 is fixed
-        def undo_patch(key, value):
+
+            logger.debug("Patched home to fake home directory %s" % temp_dir)
+
+    def patch_environment(self, key, value):
+        def patch_var(key, value):
             logging.info(
-                "Resetting environment variable '%s' to '%s'",
+                "Setting environment variable '%s' to '%s'",
                 key,
                 value
             )
 
             os.environ[key] = value
 
-        os.environ['HOME'] = temp_dir
-        os.environ['XDG_CONFIG_HOME'] = temp_xdg_config_home
-        os.environ['UBUNTU_APP_LAUNCH_LINK_FARM'] = temp_app_launch
-
-        self.addCleanup(undo_patch, 'HOME', original_home)
-        self.addCleanup(undo_patch, 'UBUNTU_APP_LAUNCH_LINK_FARM',
-                        original_app_launch or '')
-        self.addCleanup(undo_patch, 'XDG_CONFIG_HOME',
-                        original_xdg_config_home or '')
-
-        logger.debug("Patched home to fake home directory %s" % temp_dir)
-        return temp_dir
+        original = os.getenv(key)
+        if original is None:
+            original = ''
+        patch_var(key, value)
+        # on click, we should cleanup
+        if self.test_type is 'click':
+            self.addCleanup(patch_var, key, original)
+
+    def _get_build_dir(self):
+        """
+        Returns the build dir after having parsed the CMake config file
+        generated by Qt Creator. If it cannot find it or it cannot be parsed,
+        an in-tree build is assumed and thus returned.
+        """
+        try:
+            cmake_config = CMakePluginParser.CMakePluginParser(os.path.join(
+                self.source_dir, 'CMakeLists.txt.user'))
+            build_dir = cmake_config.active_build_dir
+        except:
+            build_dir = self.source_dir
+
+        return build_dir
+
+
+class FileManagerTestCase(BaseTestCaseWithPatchedHome):
+
+    """Base test case that launches the filemanager-app."""
+
+    def setUp(self):
+        super(FileManagerTestCase, self).setUp()
+        self.fakehome = os.getenv('HOME')
+        self.original_file_count = \
+            len([i for i in os.listdir(self.fakehome)
+                 if not i.startswith('.')])
+        logger.debug('Directory Listing for HOME\n%s' %
+                     os.listdir(self.fakehome))
+        logger.debug('File count in HOME is %s' % self.original_file_count)
+        self.app = filemanager.Filemanager(self.launcher(), self.test_type)
 
     def make_file_in_home(self):
         return self.make_content_in_home('file')
@@ -319,16 +251,16 @@
         if type_ != 'file' and type_ != 'directory':
             raise ValueError('Unknown content type: "{0}"', type_)
         if type_ == 'file':
-            temp_file = fm_fixtures.TemporaryFileInDirectory(self.home_dir)
+            temp_file = fm_fixtures.TemporaryFileInDirectory(self.fakehome)
             self.useFixture(temp_file)
             path = temp_file.path
         else:
             temp_dir = fm_fixtures.TemporaryDirectoryInDirectory(
-                self.home_dir)
+                self.fakehome)
             self.useFixture(temp_dir)
             path = temp_dir.path
         logger.debug('Directory Listing for HOME\n%s' %
-                     os.listdir(self.home_dir))
+                     os.listdir(self.fakehome))
         self._assert_number_of_files(1)
         return path
 
@@ -342,12 +274,3 @@
         self.assertThat(
             folder_list_page.get_number_of_files_from_header,
             Eventually(Equals(expected_number_of_files), timeout=60))
-
-
-class FileManagerTestCase(BaseTestCaseWithPatchedHome):
-
-    """Base test case that launches the filemanager-app."""
-
-    def setUp(self):
-        super(FileManagerTestCase, self).setUp()
-        self.app = filemanager.Filemanager(self.launcher(), self.test_type)

=== modified file 'tests/autopilot/filemanager/tests/test_filemanager.py'
--- tests/autopilot/filemanager/tests/test_filemanager.py	2014-09-25 21:51:04 +0000
+++ tests/autopilot/filemanager/tests/test_filemanager.py	2014-10-14 18:53:19 +0000
@@ -281,11 +281,11 @@
 
     def test_copy_directory(self):
         # Set up a directory to copy and a directory to copy it into.
-        destination_dir_path = os.path.join(self.home_dir,
+        destination_dir_path = os.path.join(self.fakehome,
                                             'destination')
         destination_dir_name = os.path.basename(destination_dir_path)
         os.mkdir(destination_dir_path)
-        dir_to_copy_path = os.path.join(self.home_dir, 'to_copy')
+        dir_to_copy_path = os.path.join(self.fakehome, 'to_copy')
         dir_to_copy_name = os.path.basename(dir_to_copy_path)
         os.mkdir(dir_to_copy_path)
 
@@ -327,11 +327,11 @@
 
     def test_cut_directory(self):
         # Set up a directory to cut and a directory to move it into.
-        destination_dir_path = os.path.join(self.home_dir,
+        destination_dir_path = os.path.join(self.fakehome,
                                             'destination')
         destination_dir_name = os.path.basename(destination_dir_path)
         os.mkdir(destination_dir_path)
-        dir_to_cut_path = os.path.join(self.home_dir, 'to_cut')
+        dir_to_cut_path = os.path.join(self.fakehome, 'to_cut')
         dir_to_cut_name = os.path.basename(dir_to_cut_path)
         os.mkdir(dir_to_cut_path)
 
@@ -478,4 +478,4 @@
         folder_list_page = self.app.main_view.get_folder_list_page()
         self.assertThat(
             folder_list_page.get_current_path,
-            Eventually(Equals(self.home_dir)))
+            Eventually(Equals(self.fakehome)))

=== modified file 'tests/autopilot/filemanager/tests/test_places.py'
--- tests/autopilot/filemanager/tests/test_places.py	2014-09-22 21:43:02 +0000
+++ tests/autopilot/filemanager/tests/test_places.py	2014-10-14 18:53:19 +0000
@@ -30,7 +30,7 @@
         folder_list_page = self.app.main_view.get_folder_list_page()
         self.assertThat(
             folder_list_page.get_current_path,
-            Eventually(Equals(self.home_dir)))
+            Eventually(Equals(self.fakehome)))
 
     def test_go_to_root_must_open_the_root_directory(self):
         """Test that opens the Device bookmark from the places section."""