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

[Leo Arias]

Do not backup existing files during autopilot tests. We will assume a clean environment from now on.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1102
http://jenkins.qa.ubuntu.com/job/gallery-app-ci/1065/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gallery-app-utopic-amd64-ci/240
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gallery-app-utopic-armhf-ci/240
        deb: http://jenkins.qa.ubuntu.com/job/gallery-app-utopic-armhf-ci/240/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gallery-app-utopic-i386-ci/240
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-click-autopilot-utopic-touch/488
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic/4088
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-click-autopilot-runner-mako/631
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-click-builder-utopic-armhf/810
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/14684
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic/3450
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/4417
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/4417/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/gallery-app-ci/1065/rebuild

review: Needs Fixing (continuous-integration)

[Leo Arias (elopio)]

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]

1104. By Leo Arias on 2014-10-15

Fixed the method definition.

1105. By Leo Arias on 2014-10-15

Keep the database patching for now.

1106. By Leo Arias on 2014-10-20

Make the pictures dir location and configuration independent.

1107. By Leo Arias on 2014-10-20

Reverted to use the hardcoded path. The phone doesn't have xdg-user-dir.

1108. By Leo Arias on 2014-10-20

Raise an exception if the pictures directory is not empty.

1109. By Leo Arias on 2014-10-20

Clean the pictures directory.

1110. By Leo Arias on 2014-10-20

Clean the pictures directory.

Unmerged revisions

1110. By Leo Arias on 2014-10-20

Clean the pictures directory.

1109. By Leo Arias on 2014-10-20

Clean the pictures directory.

1108. By Leo Arias on 2014-10-20

Raise an exception if the pictures directory is not empty.

1107. By Leo Arias on 2014-10-20

Reverted to use the hardcoded path. The phone doesn't have xdg-user-dir.

1106. By Leo Arias on 2014-10-20

Make the pictures dir location and configuration independent.

1105. By Leo Arias on 2014-10-15

Keep the database patching for now.

1104. By Leo Arias on 2014-10-15

Fixed the method definition.

1103. By Leo Arias on 2014-10-15

Merged with prerequisite.

1102. By Leo Arias on 2014-10-14

Do not backup existing files during autopilot tests. We will assume a clean environment from now on.

=== modified file 'tests/autopilot/gallery_app/tests/__init__.py'
--- tests/autopilot/gallery_app/tests/__init__.py	2014-10-20 19:50:32 +0000
+++ tests/autopilot/gallery_app/tests/__init__.py	2014-10-20 19:50:32 +0000
@@ -1,6 +1,6 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
 #
-# Copyright (C) 2014 Canonical Ltd.
+# Copyright (C) 2012, 2014 Canonical Ltd.
 #
 # This file is part of gallery-app.
 #
@@ -22,6 +22,7 @@
 import logging
 import shutil
 import signal
+from time import sleep
 
 from testtools.matchers import Equals, NotEquals, GreaterThan
 from autopilot.matchers import Eventually
@@ -35,11 +36,13 @@
 from gallery_app.emulators import main_screen
 from gallery_app.emulators.gallery_utils import GalleryUtils
 
-from time import sleep
-
 logger = logging.getLogger(__name__)
 
 
+class GalleryException(Exception):
+    pass
+
+
 class GalleryTestCase(AutopilotTestCase):
 
     """A common test case class that provides several useful methods for
@@ -76,24 +79,13 @@
             return fixture_setup.Launcher.installed_click
 
     def _get_sample_destination_dir(self):
-        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
+        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.remove(db)
+        elif 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')
@@ -101,12 +93,9 @@
 
     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)):
+            shutil.rmtree(thumbs)
+        elif 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)
@@ -114,9 +103,14 @@
     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)):
-            shutil.rmtree(self.sample_destination_dir)
-        self.assertFalse(os.path.exists(self.sample_destination_dir))
+        if os.path.exists(self.sample_destination_dir):
+            try:
+                os.rmdir(self.sample_destination_dir)
+            except OSError:
+                raise GalleryException('The pictures directory is not empty.')
+
+        self.addCleanup(shutil.rmtree, self.sample_destination_dir)
+        self.addCleanup(os.mkdir, self.sample_destination_dir)
 
         self.sample_file = os.path.join(
             self.sample_destination_dir,
@@ -132,9 +126,8 @@
         self.sample_file_source = \
             default_data_dir + self.sample_file_source
 
-        if env_type is fixture_setup.Launcher.installed_click:
-            self.configure_db()
-            self.configure_thumbnails()
+        self.configure_db()
+        self.configure_thumbnails()
 
     def do_reset_config(self):
         config = os.path.expanduser(