gallery-app

Merge lp:~vrruiz/gallery-app/test-share-photo into lp:gallery-app

test-share-photo
Merge into trunk

Proposed by Víctor R. Ruiz on 2014-07-08

Status:

Superseded

Proposed branch:

lp:~vrruiz/gallery-app/test-share-photo

Merge into:

lp:gallery-app

Diff against target:

284 lines (+242/-0)

4 files modified

debian/control (+2/-0)
tests/autopilot/gallery_app/credentials.py (+117/-0)
tests/autopilot/gallery_app/emulators/photo_viewer.py (+18/-0)
tests/autopilot/gallery_app/tests/test_share.py (+105/-0)

To merge this branch:

bzr merge lp:~vrruiz/gallery-app/test-share-photo

Undecided

In Progress

Link a bug report

Reviewer	Review Type	Date Requested	Status
PS Jenkins bot	continuous-integration		Needs Fixing on 2014-07-16
Leo Arias (community)	code review	2014-07-14	Needs Fixing on 2014-07-14
Ubuntu Phablet Team		2014-07-08	Pending
Review via email: mp+225947@code.launchpad.net

This proposal has been superseded by a proposal from 2014-07-16.

Commit message

Autopilot: Test for share photo.

Description of the change

Autopilot: Test for share photo.

Revision history for this message

Víctor R. Ruiz (vrruiz) wrote on 2014-07-08:

Work in progress (there is a problem with Friends and python-dbusmock).

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-07-08:

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

review: Needs Fixing (continuous-integration)

lp:~vrruiz/gallery-app/test-share-photo updated on 2014-07-14

1006. By Víctor R. Ruiz on 2014-07-09: Autopilot: Fix dbus object names
1007. By Víctor R. Ruiz on 2014-07-14: Autopilot: Create fake Facebook account to share photos

Revision history for this message

Víctor R. Ruiz (vrruiz) wrote on 2014-07-14:

Ready for review.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-07-14:

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

review: Needs Fixing (continuous-integration)

lp:~vrruiz/gallery-app/test-share-photo updated on 2014-07-14

1008. By Víctor R. Ruiz on 2014-07-14: Dependency for autopilot tests - python3-dbusmock

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-07-14:

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Leo Arias (elopio) wrote on 2014-07-14:

202 + def post_button(self):
214 + def do_share_photo(self):
206 + def share_panel(self):

These shouldn't be part of the test case. They should be custom proxy objects or used in methods of the parent custom proxy object.

43 +class AccountManager(object):
159 +class FakeFriendsService(object):

Please talk with Richard and Brendan. They are working with the devs to move a fake dbus service like this one to the right project. In their case URLDispatcher, in your case the friends service. We agreed that it's ok to duplicate the code in the project like you are doing here just if we are working at the same time to put it in the right place. Maybe one of them can help you talking with your devs to see how easy would it be to get this done in the right way.

254 + sleep(5)

You should use Eventually instead of a sleep.

249 + def test_facebook(self):

You need a better name for this test. Something like test_share_with_facebook_must_call_friends_service.

Finally, all your FIXMEs look really weird. I don't understand how you are creating the account without starting the main loop, as it's asynchronous. It seems though that you don't need to store any credentials, just create the account. That's really nice, you can probably remove a lot of the code in Account Manager. If you can get mardy to help you with this it would be great. If not, maybe I can give you a hand later on the week.

Thanks Victor. This test is great.

review: Needs Fixing (code review)

lp:~vrruiz/gallery-app/test-share-photo updated on 2014-07-16

1009. By Víctor R. Ruiz on 2014-07-16: Autopilot: test_share refactor
1010. By Víctor R. Ruiz on 2014-07-16: Missing dependency

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-07-16:

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-07-16:

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

review: Needs Fixing (continuous-integration)

Unmerged revisions

1010. By Víctor R. Ruiz on 2014-07-16: Missing dependency
1009. By Víctor R. Ruiz on 2014-07-16: Autopilot: test_share refactor
1008. By Víctor R. Ruiz on 2014-07-14: Dependency for autopilot tests - python3-dbusmock
1007. By Víctor R. Ruiz on 2014-07-14: Autopilot: Create fake Facebook account to share photos
1006. By Víctor R. Ruiz on 2014-07-09: Autopilot: Fix dbus object names
1005. By Víctor R. Ruiz on 2014-06-23: Autopilot: Move UI code to helper function
1004. By Víctor R. Ruiz on 2014-06-23: Autopilot: Fix dbus path
1003. By Víctor R. Ruiz on 2014-06-20: Fix typos
1002. By Víctor R. Ruiz on 2014-06-20: Autopilot: Test for share photo

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:

Ubuntu Phablet Team

Víctor R. Ruiz

 === modified file 'debian/control'
 --- debian/control	2014-05-09 16:08:13 +0000
 +++ debian/control	2014-07-16 11:37:08 +0000
@@ -51,6 +51,8 @@
           unity8-autopilot,
           python3-pkg-resources,
           python3-autopilot,
++         python3-dbusmock,
++         python3-fixtures,
  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/credentials.py'
 --- tests/autopilot/gallery_app/credentials.py	1970-01-01 00:00:00 +0000
 +++ tests/autopilot/gallery_app/credentials.py	2014-07-16 11:37:08 +0000
@@ -0,0 +1,117 @@
++# -*- 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 General Public License version 3, as published
++# by the Free Software Foundation.
++#
++# 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 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 threading
++
++from gi.repository import Accounts, GLib, Signon
++
++
++class CredentialsException(Exception):
++    """Exception for credentials problems."""
++
++
++class AccountManager(object):
++
++    def __init__(self):
++        self._manager = Accounts.Manager()
++
++    def _start_main_loop(self):
++        self.error = None
++        self._main_loop = GLib.MainLoop()
++        self._main_loop_thread = threading.Thread(
++            target=self._main_loop.run)
++        self._main_loop_thread.start()
++
++    def _join_main_loop(self):
++        self._main_loop_thread.join()
++        if self.error is not None:
++            raise CredentialsException(self.error.message)
++
++    def add_credentials(self, user_name, password):
++        ## FIXME: If enabled, the application gets hanged
++        # self._start_main_loop()
++
++        account = self._create_fb_account()
++
++        ## FIXME: If enabled, this code returns a ref count error
++        # info = self._get_identity_info(user_name, password)
++        # identity = Signon.Identity.new()
++        # identity.store_credentials_with_info(
++        #     info, self._set_credentials_id_to_account, account)
++
++        ## FIXME: If enabled, the application gets hanged
++        # self._join_main_loop()
++        return account
++
++    def _create_fb_account(self):
++        account = self._manager.create_account('facebook')
++        account.set_enabled(True)
++        account.store(self._on_account_created, None)
++        return account
++
++    def _on_account_created(self, account, error, _):
++        if error:
++            self.error = error
++            self._main_loop.quit()
++
++    def _get_identity_info(self, user_name, password):
++        info = Signon.IdentityInfo.new()
++        info.set_username(user_name)
++        info.set_caption(user_name)
++        info.set_secret(password, True)
++        return info
++
++    def _set_credentials_id_to_account(self, identity, id, error, account):
++        if error:
++            self.error = error
++            self._main_loop.quit()
++
++        account.set_variant('CredentialsId', GLib.Variant('u', id))
++        account.store(self._process_session, None)
++
++    def _process_session(self, account, error, _):
++        if error:
++            self.error = error
++            self._main_loop.quit()
++
++        account_service = Accounts.AccountService.new(account, None)
++        auth_data = account_service.get_auth_data()
++        identity = auth_data.get_credentials_id()
++        method = auth_data.get_method()
++        mechanism = auth_data.get_mechanism()
++        session_data = auth_data.get_parameters()
++        session = Signon.AuthSession.new(identity, method)
++        session.process(
++            session_data, mechanism, self._on_login_processed, None)
++
++    def _on_login_processed(self, session, reply, error, userdata):
++        if error:
++            self.error = error
++
++        self._main_loop.quit()
++
++    def delete_account(self, account):
++        self._start_main_loop()
++        account.delete()
++        account.store(self._on_account_deleted, None)
++        self._join_main_loop()
++
++    def _on_account_deleted(self, account, error, userdata):
++        if error:
++            self.error = error
++
++        self._main_loop.quit()
 === modified file 'tests/autopilot/gallery_app/emulators/photo_viewer.py'
 --- tests/autopilot/gallery_app/emulators/photo_viewer.py	2014-06-20 15:25:14 +0000
 +++ tests/autopilot/gallery_app/emulators/photo_viewer.py	2014-07-16 11:37:08 +0000
@@ -6,6 +6,7 @@
  # by the Free Software Foundation.
  from gallery_app.emulators.gallery_utils import GalleryUtils
++from gallery_app.emulators.main_screen import MainScreen
  class PhotoViewer(GalleryUtils):
@@ -123,6 +124,12 @@
          return self.app.wait_select_single("EditPreview",
                                             objectName="editPreview")
++    def get_post_button(self):
++        return self.app.wait_select_single(objectName="postButton")
++
++    def get_share_panel(self):
++        return self.app.wait_select_single(objectName="shareComponent")
++
      def _click_item(self, item):
          self.pointing_device.click_object(item)
@@ -149,3 +156,14 @@
      def click_enhance_item(self):
          enhance_item = self.get_auto_enhance_menu_item()
          self._click_item(enhance_item)
++
++    def do_share_photo(self):
++        """Click on a photo and share it"""
++        # Tab on share button
++        main_view = self.app.select_single(MainScreen)
++        main_view.open_toolbar().click_button("shareButton")
++        # Ensure that the share panel is opened
++        self.get_share_panel()
++        post_button = self.get_post_button()
++        # Click on "Post" button to upload image to Facebook fake service
++        self.pointing_device.click_object(post_button)
 === added file 'tests/autopilot/gallery_app/tests/test_share.py'
 --- tests/autopilot/gallery_app/tests/test_share.py	1970-01-01 00:00:00 +0000
 +++ tests/autopilot/gallery_app/tests/test_share.py	2014-07-16 11:37:08 +0000
@@ -0,0 +1,105 @@
++# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
++# Copyright 2013 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.
++
++"""Tests the Photos share options of the gallery app."""
++
++import dbus
++import dbusmock
++import fixtures
++
++from time import sleep
++from testtools.matchers import Equals, GreaterThan
++
++from gallery_app import credentials
++from gallery_app.tests.test_photo_viewer import TestPhotoViewerBase
++
++
++class FakeFriendsService(object):
++    """Fake Friends service"""
++
++    def __init__(self, dbus_connection):
++        super(FakeFriendsService, self).__init__()
++        self.dbus_connection = dbus_connection
++        self.mock = self._get_mock_interface()
++        self._add_methods()
++
++    def get_calls(self):
++        return self.mock.GetCalls()
++
++    def _add_methods(self):
++        self.mock.AddMethod(
++            'com.canonical.Friends.Dispatcher',
++            'Upload',
++            'sss',
++            's',
++            'ret = "https://www.facebook.com/649348222_10152546147613223"'
++            )
++
++    def _get_mock_interface(self):
++        return dbus.Interface(
++            self.dbus_connection.get_object(
++                'com.canonical.Friends.Dispatcher',
++                '/com/canonical/friends/Dispatcher',
++                ),
++            dbusmock.MOCK_IFACE)
++
++
++class FakeFriendsServiceFixture(fixtures.Fixture, dbusmock.DBusTestCase):
++    """Fixture for the Fake Friends Service"""
++
++    def setUp(self):
++        super(FakeFriendsServiceFixture, self).setUp()
++        self._use_fake_friends_service()
++
++    def _use_fake_friends_service(self):
++        """Starts a fake Friends service"""
++        self._spawn_fake_friends_service()
++        dbus_connection = self.get_dbus(system_bus=False)
++        self.fake_friends_service = FakeFriendsService(dbus_connection)
++
++    def _spawn_fake_friends_service(self):
++        self.friends_service_mock = self.spawn_server(
++            'com.canonical.Friends.Dispatcher',
++            '/com/canonical/friends/Dispatcher',
++            'com.canonical.Friends.Dispatcher',
++            system_bus=False,
++            )
++        self.addCleanup(self._terminate_process)
++
++    def _terminate_process(self):
++        """Finish the fake Friends service"""
++        self.friends_service_mock.terminate()
++        self.friends_service_mock.wait()
++
++
++class ShareTestCase(TestPhotoViewerBase):
++    """Test Facebook share"""
++
++    def setUp(self):
++        # Create Facebook account
++        self._create_account()
++        # Use the fake friends service
++        self.friends_service_fixture = FakeFriendsServiceFixture()
++        self.useFixture(self.friends_service_fixture)
++        super(ShareTestCase, self).setUp()
++
++    def _create_account(self):
++        """Creates a fake Facebook account in Online Accounts"""
++        account_manager = credentials.AccountManager()
++        account = account_manager.add_credentials('dummy@example.com', '****')
++        self.addCleanup(account_manager.delete_account, account)
++
++    def test_share_photo_to_facebook(self):
++        """Test share photo to Facebook"""
++        # Click on a photo and share it
++        self.photo_viewer.do_share_photo()
++        # Wait a little bit
++        sleep(5)
++        # Check that the call to fake service was correctly done
++        calls = self.friends_service_fixture.fake_friends_service.get_calls()
++        self.assertThat(len(calls), GreaterThan(0))
++        self.assertThat(calls[0][1], Equals('Upload'))