gallery-app

In order to remove the backups, we need to stop deleting the real folders.
In order to stop deleting the real folders, we need a better hierarchy of test cases and a fixture to launch the app.
I will start with the fixture.

lp:~canonical-platform-qa/gallery-app/fix1376423-no_backup updated on 2014-10-20

1103. By Leonardo Arias Fonseca on 2014-10-15: Merged with prerequisite.
1104. By Leonardo Arias Fonseca on 2014-10-15: Fixed the method definition.
1105. By Leonardo Arias Fonseca on 2014-10-15: Keep the database patching for now.
1106. By Leonardo Arias Fonseca on 2014-10-20: Make the pictures dir location and configuration independent.
1107. By Leonardo Arias Fonseca on 2014-10-20: Reverted to use the hardcoded path. The phone doesn't have xdg-user-dir.
1108. By Leonardo Arias Fonseca on 2014-10-20: Raise an exception if the pictures directory is not empty.
1109. By Leonardo Arias Fonseca on 2014-10-20: Clean the pictures directory.
1110. By Leonardo Arias Fonseca on 2014-10-20: Clean the pictures directory.

Unmerged revisions

1110. By Leonardo Arias Fonseca on 2014-10-20: Clean the pictures directory.
1109. By Leonardo Arias Fonseca on 2014-10-20: Clean the pictures directory.
1108. By Leonardo Arias Fonseca on 2014-10-20: Raise an exception if the pictures directory is not empty.
1107. By Leonardo Arias Fonseca on 2014-10-20: Reverted to use the hardcoded path. The phone doesn't have xdg-user-dir.
1106. By Leonardo Arias Fonseca on 2014-10-20: Make the pictures dir location and configuration independent.
1105. By Leonardo Arias Fonseca on 2014-10-15: Keep the database patching for now.
1104. By Leonardo Arias Fonseca on 2014-10-15: Fixed the method definition.
1103. By Leonardo Arias Fonseca on 2014-10-15: Merged with prerequisite.
1102. By Leonardo Arias Fonseca on 2014-10-14: Do not backup existing files during autopilot tests. We will assume a clean environment from now on.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Canonical Platform QA Team

Ubuntu Phablet Team

 === modified file 'debian/control'
 --- debian/control	2014-07-26 03:12:53 +0000
 +++ debian/control	2014-10-15 04:41:38 +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.
 === 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-15 04:41:38 +0000
@@ -0,0 +1,136 @@
++# -*- 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):
++ """Initialize the fixture.
++
++ :param type_: The type of the launcher to use.
++ :type type_: One of the values of the Launcher enum.
++ :param str binary_path: The path to use with the
++ Launcher.installed_binary type. Not used for the other types.
++
++ """
++ super().__init__()
++ if type_ is Launcher.local_binary:
++ self.launcher = _LaunchLocalBinaryGalleryApp(binary_path)
++ elif type_ is Launcher.installed_binary:
++ self.launcher = _LaunchInstalledBinaryGalleryApp()
++ elif type_ is Launcher.installed_click:
++ self.launcher = _LaunchInstalledClickGalleryApp()
++ 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):
++ super().__init__()
++ self.binary_path = binary_path
++
++ 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,
++ 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 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')
++ return application_proxy
++
++
++class _LaunchInstalledClickGalleryApp(fixtures.Fixture):
++
++ """Fixture to launch the Gallery App from the installed click package."""
++
++ 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))
++ application_proxy = application_launcher.launch('com.ubuntu.gallery')
++ return application_proxy
 === modified file 'tests/autopilot/gallery_app/tests/__init__.py'
 --- tests/autopilot/gallery_app/tests/__init__.py	2014-09-19 04:22:12 +0000
 +++ tests/autopilot/gallery_app/tests/__init__.py	2014-10-15 04:41:38 +0000
@@ -1,9 +1,20 @@
  # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
--# Copyright 2012 Canonical
--#
--# This program is free software: you can redistribute it and/or modify it
--# under the terms of the GNU General Public License version 3, as published
--# by the Free Software Foundation.
++#
++# Copyright (C) 2012, 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/>.
  """gallery autopilot tests."""
@@ -18,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
@@ -28,12 +40,6 @@
  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
@@ -41,14 +47,12 @@
  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'
-- _default_sample_destination_dir = "/tmp/gallery-ap_sd"
--
  ARGS = []
  @property
@@ -64,39 +68,18 @@
  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, env_type):
-- if env_type == EnvironmentTypes.click:
-- pic_dir = os.path.expanduser("~/Pictures")
-- pic_bak_dir = pic_dir + '.apbak'
-- # Only save and restore if it previously existed
-- if os.path.exists(pic_dir):
-- shutil.move(pic_dir, pic_bak_dir)
-- self.addCleanup(
-- logger.debug, "Restoring backed up pics to %s" % pic_dir)
-- self.addCleanup(shutil.move, pic_bak_dir, pic_dir)
-- return pic_dir
-- else:
-- return self._default_sample_destination_dir
++ return os.path.expanduser("~/Pictures")
  def configure_db(self):
  db = os.path.expanduser(self._db)
-- db_bak = db + '.apbak'
-- # Only save and restore if it previously existed
-- if os.path.exists(db):
-- shutil.move(db, db_bak)
-- 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',
@@ -105,11 +88,6 @@
  def configure_thumbnails(self):
  thumbs = os.path.expanduser(self._thumbs)
-- thumbs_bak = thumbs + '.apbak'
-- # Only save and restore if it previously existed
-- if os.path.exists(thumbs):
-- shutil.move(thumbs, thumbs_bak)
-- 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')
@@ -117,8 +95,7 @@
  def configure_sample_files(self, env_type):
  self.sample_dir = resource_filename('gallery_app', 'data')
-- self.sample_destination_dir = \
-- self._get_sample_destination_dir(env_type)
++ self.sample_destination_dir = self._get_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))
@@ -137,7 +114,7 @@
  self.sample_file_source = \
  default_data_dir + self.sample_file_source
-- if env_type == EnvironmentTypes.click:
++ if env_type is fixture_setup.Launcher.installed_click:
  self.configure_db()
  self.configure_thumbnails()
@@ -169,56 +146,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.ARGS.append(self.sample_destination_dir)
-- 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.ARGS.append(self.sample_destination_dir)
-- 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.ARGS.append(self.sample_destination_dir)
-- 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.useFixture(launch_fixture)
++ self.app = launch_fixture.application_proxy
  def ui_update(self):
  """ Gives the program the time to update the UI"""

gallery-app

Merge lp:~canonical-platform-qa/gallery-app/fix1376423-no_backup into lp:gallery-app

Commit message

Description of the change

Unmerged revisions

Preview Diff

Subscribers