Merge lp:~canonical-platform-qa/gallery-app/fix1381259-launch_fixture into lp:~canonical-platform-qa/gallery-app/clean_autopilot_setup

[Leo Arias]

Use a fixture to launch the app on autopilot tests.

[lp:~canonical-platform-qa/gallery-app/fix1381259-launch_fixture]

1104. By Leo Arias on 2014-10-15

Link to the bug.

1105. By Leo Arias on 2014-10-15

Reverted the po changes.

1106. By Leo Arias on 2014-10-21

Pass arguments to the app.

1107. By Leo Arias on 2014-10-21

Fixed the db backup.

1108. By Leo Arias on 2014-10-21

Fixed typo.

1109. By Leo Arias on 2014-10-22

Fixed the fixture.

1110. By Leo Arias on 2014-10-22

Always configure the db.

1111. By Leo Arias on 2014-10-22

Fixed the path.

1112. By Leo Arias on 2014-10-22

Do not hide the folders.

1113. By Leo Arias on 2014-10-22

Copy instead of move.

1114. By Leo Arias on 2014-10-22

Fixed the copy.

1115. By Leo Arias on 2014-10-22

Do not copy database and thumbs to pictures.

Unmerged revisions

1115. By Leo Arias on 2014-10-22

Do not copy database and thumbs to pictures.

1114. By Leo Arias on 2014-10-22

Fixed the copy.

1113. By Leo Arias on 2014-10-22

Copy instead of move.

1112. By Leo Arias on 2014-10-22

Do not hide the folders.

1111. By Leo Arias on 2014-10-22

Fixed the path.

1110. By Leo Arias on 2014-10-22

Always configure the db.

1109. By Leo Arias on 2014-10-22

Fixed the fixture.

1108. By Leo Arias on 2014-10-21

Fixed typo.

1107. By Leo Arias on 2014-10-21

Fixed the db backup.

1106. By Leo Arias on 2014-10-21

Pass arguments to the app.

=== modified file 'debian/control'
--- debian/control	2014-07-26 03:12:53 +0000
+++ debian/control	2014-10-22 17:53:30 +0000
@@ -49,10 +49,12 @@
          gallery-app (>= ${source:Version}),
          libautopilot-qt (>= 1.4),
          libqt5test5,
+         python3-autopilot,
+         python3-enum34,
+         python3-fixtures,
+         python3-pkg-resources,
          ubuntu-ui-toolkit-autopilot,
          unity8-autopilot,
-         python3-pkg-resources,
-         python3-autopilot,
 Description: Autopilot tests for the photo gallery for Ubuntu
  gallery-app is a photo gallery for the Ubuntu platform. This package contains
  autopilot tests for it.
 
=== renamed directory 'tests/autopilot/gallery_app/data/default/.database' => 'tests/autopilot/gallery_app/data/database'
=== renamed directory 'tests/autopilot/gallery_app/data/default/.thumbnails' => 'tests/autopilot/gallery_app/data/thumbnails'
=== added file 'tests/autopilot/gallery_app/fixture_setup.py'
--- tests/autopilot/gallery_app/fixture_setup.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/gallery_app/fixture_setup.py	2014-10-22 17:53:30 +0000
@@ -0,0 +1,203 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Copyright (C) 2014 Canonical Ltd.
+#
+# This file is part of gallery-app.
+#
+# gallery-app 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; version 3.
+#
+# gallery-app 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/>.
+
+import enum
+import logging
+import os
+import shutil
+
+import fixtures
+import ubuntuuitoolkit
+from autopilot import application
+
+
+logger = logging.getLogger(__name__)
+
+
+_BASE_CLASS = ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase
+
+
+class Launcher(enum.Enum):
+    local_binary = 1
+    installed_binary = 2
+    installed_click = 3
+
+
+class LaunchGalleryApp(fixtures.Fixture):
+
+    """Fixture to launch the Gallery App."""
+
+    def __init__(self, type_, binary_path=None, arguments=None):
+        """Initialize the fixture.
+
+        :param type_: The type of the launcher to use.
+        :type type_: One of the values of the Launcher enum.
+        :param string binary_path: The path to use with the
+            Launcher.installed_binary type. Not used for the other types.
+        :param arguments: The arguments to pass to the gallery.
+        :type arguments: A list of strings.
+
+        """
+        super().__init__()
+        arguments = [] if arguments is None else arguments
+        if type_ is Launcher.local_binary:
+            self.launcher = _LaunchLocalBinaryGalleryApp(
+                binary_path, arguments)
+        elif type_ is Launcher.installed_binary:
+            self.launcher = _LaunchInstalledBinaryGalleryApp(arguments)
+        elif type_ is Launcher.installed_click:
+            self.launcher = _LaunchInstalledClickGalleryApp(arguments)
+        else:
+            raise TypeError('Unknown launcher type: {}.'.format(type_))
+
+    def setUp(self):
+        super().setUp()
+        self.useFixture(self.launcher)
+        self.application_proxy = self.launcher.application_proxy
+
+
+class _LaunchLocalBinaryGalleryApp(fixtures.Fixture):
+
+    """Fixture to launch the Gallery App from the local binary."""
+
+    def __init__(self, binary_path, arguments):
+        super().__init__()
+        self.binary_path = binary_path
+        self.arguments = arguments
+
+    def setUp(self):
+        """Launch the application when the fixture is used."""
+        super().setUp()
+        self._copy_binary_to_right_location()
+        self.application_proxy = self._launch_application()
+
+    def _copy_binary_to_right_location(self):
+        # XXX workaround for bug http://pad.lv/1381312
+        workaround_binary_directory = os.path.abspath(os.path.join('..', '..'))
+        workaround_binary_path = os.path.join(
+            workaround_binary_directory, os.path.basename(self.binary_path))
+        shutil.copy(self.binary_path, workaround_binary_directory)
+        self.addCleanup(os.remove, workaround_binary_path)
+        self.binary_path = workaround_binary_path
+
+    def _launch_application(self):
+        logger.info('Launching gallery-app using the binary at {}.'.format(
+            self.binary_path))
+        application_launcher = self.useFixture(
+            application.NormalApplicationLauncher(emulator_base=_BASE_CLASS))
+        application_proxy = application_launcher.launch(
+            self.binary_path,
+            *self.arguments,
+            app_type='qt',
+            launch_dir=os.path.dirname(self.binary_path)
+        )
+        return application_proxy
+
+
+class _LaunchInstalledBinaryGalleryApp(fixtures.Fixture):
+
+    """Fixture to launch the Gallery App from the installed binary."""
+
+    def __init__(self, arguments):
+        super().__init__()
+        self.arguments = arguments
+    
+    def setUp(self):
+        super().setUp()
+        """Launch the application when the fixture is used."""
+        self.application_proxy = self._launch_application()
+
+    def _launch_application(self):
+        logger.info('Launching gallery-app using the installed binary.')
+        application_launcher = self.useFixture(
+            application.UpstartApplicationLauncher(emulator_base=_BASE_CLASS))
+        application_proxy = application_launcher.launch(
+            'gallery-app', self.arguments)
+        return application_proxy
+
+
+class _LaunchInstalledClickGalleryApp(fixtures.Fixture):
+
+    """Fixture to launch the Gallery App from the installed click package."""
+
+    def __init__(self, arguments):
+        super().__init__()
+        self.arguments = arguments
+    
+    def setUp(self):
+        super().setUp()
+        self.application_proxy = self._launch_application()
+
+    def _launch_application(self):
+        logger.info('Launching gallery-app using the installed click package.')
+        application_launcher = self.useFixture(
+            application.ClickApplicationLauncher(emulator_base=_BASE_CLASS))
+        if not arguments:
+            application_proxy = application_launcher.launch(
+                'com.ubuntu.gallery')
+        else:
+            application_proxy = self._launch_application_with_arguments(
+                application_launcher)
+
+        return application_proxy
+
+    def _launch_application_with_arguments(self, application_laucher):
+        # XXX We need a better way to start click packages with arguments.
+        # More discussion is required. --elopio - 2014-10-21
+        desktop_file_path = self.write_sandbox_desktop_file()
+        desktop_file_name = os.path.basename(desktop_file_path)
+        application_name, _ = os.path.splitext(desktop_file_name)
+        return application_launcher.launch(application_name) 
+    
+    def write_sandbox_desktop_file(self):
+        desktop_file_dir = self.get_local_desktop_file_directory()
+        desktop_file = tempfile.NamedTemporaryFile(
+            dir=desktop_file_dir, suffix='.desktop', mode='w+t', delete=False)
+        desktop_file.write('[Desktop Entry]\n')
+        version, installed_path = self.get_installed_version_and_directory()
+        gallery_exec = './gallery-app ' + ' '.join(arguments)
+        desktop_file_dict = {
+            'Type': 'Application',
+            'Name': 'gallery',
+            'Exec': gallery_exec,
+            'Icon': 'Not important',
+            'Path': installed_path
+        }
+        for key, value in desktop_file_dict.items():
+            desktop_file.write('{key}={value}\n'.format(key=key, value=value))
+        desktop_file.close()
+        return desktop_file.name
+
+    def get_local_desktop_file_directory(self):
+        return os.path.join(
+            os.environ.get('HOME'), '.local', 'share', 'applications')
+
+    def get_named_temporary_file(
+            self, dir=None, mode='w+t', delete=False, suffix=''):
+        # See https://bugs.launchpad.net/ubuntu-ui-toolkit/+bug/1329141
+        return 
+
+    def get_installed_version_and_directory(self):
+        db = Click.DB()
+        db.read()
+        package_name = 'com.ubuntu.gallery'
+        registry = Click.User.for_user(db, name=os.environ.get('USER'))
+        version = registry.get_version(package_name)
+        directory = registry.get_path(package_name)
+        return version, directory
+
 
=== modified file 'tests/autopilot/gallery_app/tests/__init__.py'
--- tests/autopilot/gallery_app/tests/__init__.py	2014-10-15 04:39:20 +0000
+++ tests/autopilot/gallery_app/tests/__init__.py	2014-10-22 17:53:30 +0000
@@ -29,8 +29,9 @@
 from autopilot.testcase import AutopilotTestCase
 from autopilot.introspection import get_proxy_object_for_existing_process
 from pkg_resources import resource_filename
-
 from ubuntuuitoolkit import emulators as toolkit_emulators
+
+from gallery_app import fixture_setup
 from gallery_app.emulators import main_screen
 from gallery_app.emulators.gallery_utils import GalleryUtils
 
@@ -39,27 +40,21 @@
 logger = logging.getLogger(__name__)
 
 
-class EnvironmentTypes:
-    installed = "installed"
-    local = "local"
-    click = "click"
-
-
 class GalleryTestCase(AutopilotTestCase):
 
     """A common test case class that provides several useful methods for
        gallery tests."""
 
+    arguments = []
+    
     sample_file_source = "/sample01.jpg"
     tap_press_time = 1
-    local_location = "../../src/gallery-app"
+    local_location = os.path.abspath('../../src/gallery-app')
 
     _db = '~/.local/share/com.ubuntu.gallery/' \
           'database/gallery.sqlite'
     _thumbs = '~/.cache/com.ubuntu.gallery/thumbnails'
 
-    ARGS = []
-
     @property
     def gallery_utils(self):
         return GalleryUtils(self.app)
@@ -73,17 +68,12 @@
         gallery-app.
 
         """
-        # Lets assume we are installed system wide if this file is somewhere
-        # in /usr
-        if os.path.realpath(__file__).startswith("/usr/"):
-            return EnvironmentTypes.installed
-        if model() == 'Desktop':
-            return EnvironmentTypes.installed
+        if os.path.exists(self.local_location):
+            return fixture_setup.Launcher.local_binary
+        elif model() == 'Desktop':
+            return fixture_setup.Launcher.installed_binary
         else:
-            if os.path.exists(self.local_location):
-                return EnvironmentTypes.local
-            else:
-                return EnvironmentTypes.click
+            return fixture_setup.Launcher.installed_click
 
     def _get_sample_destination_dir(self):
         pic_dir = os.path.expanduser("~/Pictures")
@@ -105,9 +95,9 @@
             self.addCleanup(shutil.move, db_bak, db)
         if not os.path.exists(os.path.dirname(db)):
             os.makedirs(os.path.dirname(db))
-        mock_db = os.path.join(self.sample_destination_dir, '.database',
-                               'gallery_confined.sqlite')
-        shutil.move(mock_db, db)
+        mock_db = os.path.join(
+            self.sample_dir, 'database', 'gallery_confined.sqlite')
+        shutil.copy(mock_db, db)
 
     def configure_thumbnails(self):
         thumbs = os.path.expanduser(self._thumbs)
@@ -118,13 +108,13 @@
             self.addCleanup(shutil.move, thumbs_bak, thumbs)
         if not os.path.exists(os.path.dirname(thumbs)):
             os.makedirs(os.path.dirname(thumbs))
-        mock_thumbs = os.path.join(self.sample_destination_dir, '.thumbnails')
-        shutil.move(mock_thumbs, thumbs)
+        mock_thumbs = os.path.join(self.sample_dir, 'thumbnails')
+        shutil.copytree(mock_thumbs, thumbs)
 
     def configure_sample_files(self, env_type):
         self.sample_dir = resource_filename('gallery_app', 'data')
         self.sample_destination_dir = self._get_sample_destination_dir()
-        if (os.path.exists(self.sample_destination_dir)):
+        if os.path.exists(self.sample_destination_dir):
             shutil.rmtree(self.sample_destination_dir)
         self.assertFalse(os.path.exists(self.sample_destination_dir))
 
@@ -142,9 +132,8 @@
         self.sample_file_source = \
             default_data_dir + self.sample_file_source
 
-        if env_type == EnvironmentTypes.click:
-            self.configure_db()
-            self.configure_thumbnails()
+        self.configure_db()
+        self.configure_thumbnails()
 
     def do_reset_config(self):
         config = os.path.expanduser(
@@ -174,53 +163,10 @@
         sleep(2)
 
     def launch_gallery_app(self, env_type):
-        if env_type == EnvironmentTypes.installed:
-            self.launch_test_installed()
-        elif env_type == EnvironmentTypes.local:
-            self.launch_test_local()
-        elif env_type == EnvironmentTypes.click:
-            self.launch_test_click()
-        else:
-            raise ValueError("Unknown environment type: %s", env_type)
-
-    def launch_test_local(self):
-        logger.debug("Launching local gallery-app binary.")
-        self.app = self.launch_test_application(
-            self.local_location,
-            *self.ARGS,
-            emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
-
-    def launch_test_installed(self):
-        if model() == 'Desktop':
-            logger.debug(
-                "Launching installed gallery-app binary for desktop."
-            )
-            self.app = self.launch_test_application(
-                "gallery-app",
-                *self.ARGS,
-                emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
-        else:
-            logger.debug(
-                "Launching installed gallery-app binary for device."
-            )
-            self.ARGS.append("--desktop_file_hint="
-                             "/usr/share/applications/gallery-app.desktop")
-            self.app = self.launch_test_application(
-                "gallery-app",
-                *self.ARGS,
-                app_type='qt',
-                emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
-
-    def launch_test_click(self):
-        '''
-        Since this test runs under confinement, the only location photos
-        are searchable in is ~/Pictures.
-        '''
-        logger.debug("Launching gallery-app via click package.")
-        self.app = self.launch_click_package(
-            package_id="com.ubuntu.gallery",
-            app_uris=' '.join(self.ARGS),
-            emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
+        launch_fixture = fixture_setup.LaunchGalleryApp(
+            env_type, self.local_location, self.arguments)
+        self.useFixture(launch_fixture)
+        self.app = launch_fixture.application_proxy
 
     def ui_update(self):
         """ Gives the program the time to update the UI"""
 
=== modified file 'tests/autopilot/gallery_app/tests/test_album_editor.py'
--- tests/autopilot/gallery_app/tests/test_album_editor.py	2014-09-01 18:24:23 +0000
+++ tests/autopilot/gallery_app/tests/test_album_editor.py	2014-10-22 17:53:30 +0000
@@ -30,7 +30,6 @@
         return MediaSelector(self.app)
 
     def setUp(self):
-        self.ARGS = []
         super(TestAlbumEditor, self).setUp()
         self.switch_to_albums_tab()
         self.edit_first_album()
 
=== modified file 'tests/autopilot/gallery_app/tests/test_album_view.py'
--- tests/autopilot/gallery_app/tests/test_album_view.py	2014-09-03 21:13:03 +0000
+++ tests/autopilot/gallery_app/tests/test_album_view.py	2014-10-22 17:53:30 +0000
@@ -43,7 +43,6 @@
         return PhotoViewer(self.app)
 
     def setUp(self):
-        self.ARGS = []
         super(TestAlbumView, self).setUp()
         self.switch_to_albums_tab()
 
 
=== modified file 'tests/autopilot/gallery_app/tests/test_albums_view.py'
--- tests/autopilot/gallery_app/tests/test_albums_view.py	2014-08-27 02:41:33 +0000
+++ tests/autopilot/gallery_app/tests/test_albums_view.py	2014-10-22 17:53:30 +0000
@@ -28,8 +28,6 @@
         return AlbumsView(self.app)
 
     def setUp(self):
-        self.ARGS = []
-
         self.envDesktopMode = env.get("DESKTOP_MODE")
 
         if model() == "Desktop":
 
=== modified file 'tests/autopilot/gallery_app/tests/test_events_view.py'
--- tests/autopilot/gallery_app/tests/test_events_view.py	2014-09-17 13:37:15 +0000
+++ tests/autopilot/gallery_app/tests/test_events_view.py	2014-10-22 17:53:30 +0000
@@ -30,8 +30,6 @@
         return EventsView(self.app)
 
     def setUp(self):
-        self.ARGS = []
-
         self.envDesktopMode = env.get("DESKTOP_MODE")
 
         if model() == "Desktop":
 
=== modified file 'tests/autopilot/gallery_app/tests/test_photo_viewer.py'
--- tests/autopilot/gallery_app/tests/test_photo_viewer.py	2014-09-03 00:14:45 +0000
+++ tests/autopilot/gallery_app/tests/test_photo_viewer.py	2014-10-22 17:53:30 +0000
@@ -37,7 +37,6 @@
         return EventsView(self.app)
 
     def setUp(self):
-        self.ARGS = []
         super(TestPhotoViewerBase, self).setUp()
         self.main_view.switch_to_tab("eventsTab")
         self.open_first_photo()
 
=== modified file 'tests/autopilot/gallery_app/tests/test_photos_view.py'
--- tests/autopilot/gallery_app/tests/test_photos_view.py	2014-08-26 21:54:25 +0000
+++ tests/autopilot/gallery_app/tests/test_photos_view.py	2014-10-22 17:53:30 +0000
@@ -30,7 +30,6 @@
         return PhotosView(self.app)
 
     def setUp(self):
-        self.ARGS = []
         self.envDesktopMode = env.get("DESKTOP_MODE")
 
         if model() == "Desktop":
 
=== modified file 'tests/autopilot/gallery_app/tests/test_picker_mode.py'
--- tests/autopilot/gallery_app/tests/test_picker_mode.py	2014-07-15 09:16:18 +0000
+++ tests/autopilot/gallery_app/tests/test_picker_mode.py	2014-10-22 17:53:30 +0000
@@ -23,7 +23,7 @@
         return self.app.wait_select_single(PickerScreen)
 
     def setUp(self):
-        self.ARGS = ['--pick-mode']
+        self.arguments = ['--pick-mode']
         super(TestPickerMode, self).setUp()
 
     def select_first_event_media(self):