Merge lp:~canonical-platform-qa/gallery-app/clean_delete_autopilot_tests into lp:~artmello/gallery-app/gallery-app-fix_autopilot_tests

[Leo Arias]

Added an autopilot test to check the deletion of a photo.

Please note a couple of things from this branch:

1. The helpers are split into classes that represent the parts of the screen that we are interacting with: all the helpers related to the PopupPhotoViewer are written in the respective class.

2. The public methods of the classes are named after actions that a user does: delete_current_photo, click_yes.

3. The public methods are annotated so they leave a log trace when they are called. In case of error, you can read the log and see what the test was excecutiong when an error was found.

4. A test does a single action and has a single check at the end:
delete a photo and check that it no longer exists in the filesystem.

I left an XXX comment on the old delete test because it has to be split in smaller tests. And as those smaller tests are not representing a user goal, they should be written in QML. Arthur said he was going to start writing those tests, when he is done the old delete autopilot test can be removed.

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

1193. By Leo Arias on 2015-04-16

Updated the logs, removed unused method.

[Arthur Mello (artmello)]

review: Approve

=== modified file 'tests/autopilot/gallery_app/emulators/photo_viewer.py'
--- tests/autopilot/gallery_app/emulators/photo_viewer.py	2015-04-15 17:45:14 +0000
+++ tests/autopilot/gallery_app/emulators/photo_viewer.py	2015-04-16 22:02:22 +0000
@@ -5,28 +5,62 @@
 # under the terms of the GNU General Public License version 3, as published
 # by the Free Software Foundation.
 
+import logging
+
+import autopilot.logging
+import ubuntuuitoolkit
+
+from gallery_app.emulators import main_screen
 from gallery_app.emulators.gallery_utils import(
     GalleryAppException,
     GalleryUtils
 )
 
 
+logger = logging.getLogger(__name__)
+
+
+class PopupPhotoViewer(ubuntuuitoolkit.UbuntuUIToolkitCustomProxyObjectBase):
+
+    @autopilot.logging.log_action(logger.info)
+    def delete_current_photo(self, confirm=True):
+        header = self.get_root_instance().select_single(
+            main_screen.MainScreen).get_header()
+        header.click_action_button("deleteButton")
+        if confirm:
+            self.confirm_delete_photo()
+        else:
+            self.cancel_delete_photo()
+
+    @autopilot.logging.log_action(logger.debug)
+    def confirm_delete_photo(self):
+        self._click_delete_dialog_button("Yes")
+
+    def _click_delete_dialog_button(self, name):
+        delete_dialog = self._get_delete_dialog()
+        button = delete_dialog.wait_select_single(
+            "Button", objectName="deletePhotoDialog" + name, visible=True)
+        self.pointing_device.click_object(button)
+        delete_dialog.wait_until_destroyed()
+
+    def _get_delete_dialog(self):
+        delete_dialog = self.get_root_instance().wait_select_single(
+            objectName="deletePhotoDialog")
+        delete_dialog.visible.wait_for(True)
+        delete_dialog.opacity.wait_for(1)
+        return delete_dialog
+
+    @autopilot.logging.log_action(logger.debug)
+    def cancel_delete_photo(self):
+        self._click_delete_dialog_button('No')
+
+
 class PhotoViewer(GalleryUtils):
 
     def __init__(self, app):
         super(PhotoViewer, self).__init__(self)
         self.app = app
 
-    def get_delete_dialog(self):
-        """Returns the photo viewer delete dialog."""
-        return self.app.wait_select_single("Dialog",
-                                           objectName="deletePhotoDialog")
-
-    def delete_dialog_shown(self):
-        dialog = self.app.select_many("Dialog",
-                                      objectName="deletePhotoDialog")
-        return len(dialog) >= 1
-
     def get_popup_album_picker(self):
         """Returns the photo viewer album pickers."""
         return self.app.wait_select_single("PopupAlbumPicker",
@@ -118,12 +152,6 @@
         """Returns the 'auto enhance' menu item in the edit dialog."""
         return self.app.select_single("Standard", objectName='enhanceListItem')
 
-    def get_delete_popover_delete_item(self):
-        """Returns the delete button of the delete popover."""
-        return self.app.wait_select_single("Button",
-                                           objectName="deletePhotoDialogYes",
-                                           visible=True)
-
     def get_delete_popover_cancel_item(self):
         """Returns the cancel button of the delete popover."""
         return self.app.wait_select_single("Button",

=== modified file 'tests/autopilot/gallery_app/tests/test_photo_viewer.py'
--- tests/autopilot/gallery_app/tests/test_photo_viewer.py	2015-04-15 17:45:14 +0000
+++ tests/autopilot/gallery_app/tests/test_photo_viewer.py	2015-04-16 22:02:22 +0000
@@ -8,12 +8,12 @@
 
 """Tests the Photo editor of the gallery app."""
 
-from testtools.matchers import Equals, NotEquals, GreaterThan, Is
+from testtools.matchers import Equals, NotEquals, GreaterThan
 from autopilot.matchers import Eventually
 from testtools import skipIf
 from autopilot.platform import model
 
-from gallery_app.emulators.photo_viewer import PhotoViewer
+from gallery_app.emulators import photo_viewer
 from gallery_app.emulators.media_viewer import MediaViewer
 from gallery_app.emulators.events_view import EventsView
 from gallery_app.tests import GalleryTestCase
@@ -31,7 +31,7 @@
 class TestMediaViewerBase(GalleryTestCase):
     @property
     def photo_viewer(self):
-        return PhotoViewer(self.app)
+        return photo_viewer.PhotoViewer(self.app)
 
     @property
     def events_view(self):
@@ -93,16 +93,6 @@
         photo_viewer_loader = self.photo_viewer.get_main_photo_viewer_loader()
         self.assertThat(photo_viewer_loader.source, Equals(""))
 
-    def get_delete_dialog(self):
-        delete_dialog = self.photo_viewer.get_delete_dialog()
-        self.assertThat(delete_dialog.visible, Eventually(Equals(True)))
-        self.assertThat(delete_dialog.opacity, Eventually(Equals(1)))
-        return delete_dialog
-
-    def ensure_closed_delete_dialog(self):
-        self.assertThat(self.photo_viewer.delete_dialog_shown,
-                        Eventually(Is(False)))
-
     def test_nav_bar_back_button(self):
         """Clicking the back button must close the photo."""
         self.main_view.get_header().click_custom_back_button()
@@ -120,38 +110,40 @@
         self.click_item(cancel_button)
         self.assertThat(share_picker.visible, Eventually(Equals(False)))
 
-    def delete_one_picture(self):
-        self.main_view.get_header().click_action_button("deleteButton")
-        self.get_delete_dialog()
-        delete_item = self.photo_viewer.get_delete_popover_delete_item()
-        self.click_item(delete_item)
-        self.ensure_closed_delete_dialog()
+    def test_delete_photo_must_remove_it_from_filesystem(self):
+        photo_component = self.main_view.select_single('GalleryPhotoComponent')
+        source = photo_component.source
+        file_path = source[len('image://thumbnailer/file://'):]
+        self.assertTrue(os.path.exists(file_path))
+
+        photo_viewer_popup = self.main_view.select_single(
+            photo_viewer.PopupPhotoViewer)
+        photo_viewer_popup.delete_current_photo()
+
+        self.assertFalse(os.path.exists(file_path))
 
     def test_photo_delete_works(self):
         """Clicking the trash button must show the delete dialog."""
-        self.main_view.get_header().click_action_button("deleteButton")
-        self.get_delete_dialog()
-
-        photo_viewer = self.photo_viewer.get_main_photo_viewer()
-
-        cancel_item = self.photo_viewer.get_delete_popover_cancel_item()
-        self.click_item(cancel_item)
-        self.ensure_closed_delete_dialog()
+        # XXX This test must be split into multiple QML tests.
+        # --elopio - 2015-14-16
+        photo_viewer_popup = self.main_view.select_single(
+            photo_viewer.PopupPhotoViewer)
+        photo_viewer_popup.delete_current_photo(confirm=False)
 
         self.assertThat(lambda: os.path.exists(self.sample_file),
                         Eventually(Equals(True)))
 
-        self.delete_one_picture()
+        photo_viewer_popup.delete_current_photo()
         self.assertThat(lambda: os.path.exists(self.sample_file),
                         Eventually(Equals(False)))
 
         # Delete all other pictures and make sure the photo viewer closes
-        self.delete_one_picture()
-        self.delete_one_picture()
-        self.delete_one_picture()
-        self.delete_one_picture()
+        photo_viewer_popup.delete_current_photo()
+        photo_viewer_popup.delete_current_photo()
+        photo_viewer_popup.delete_current_photo()
+        photo_viewer_popup.delete_current_photo()
 
-        self.assertThat(photo_viewer.visible, Eventually(Equals(False)))
+        self.assertThat(photo_viewer_popup.visible, Eventually(Equals(False)))
 
     def test_nav_bar_album_picker_button(self):
         """Clicking the album picker must show the picker dialog."""