Merge lp:~nskaggs/reminders-app/setup-ap-env into lp:reminders-app

[Nicholas Skaggs]

setup safe AP env for testing

Properly setup environment for autopilot testing by using a faked /home directory on phablet and desktop

[lp:~nskaggs/reminders-app/setup-ap-env]

125. By Nicholas Skaggs on 2014-05-08

add _copy_xauthority_file rename setup env

Unmerged revisions

125. By Nicholas Skaggs on 2014-05-08

add _copy_xauthority_file rename setup env

124. By Nicholas Skaggs on 2014-05-08

switch to fixtures

123. By Nicholas Skaggs on 2014-05-08

setup env properly for test run

=== added file 'tests/autopilot/reminders/credentials.py'
--- tests/autopilot/reminders/credentials.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/reminders/credentials.py	2014-05-08 16:40:22 +0000
@@ -0,0 +1,131 @@
+# -*- 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_evernote_credentials(self, user_name, password):
+        self._start_main_loop()
+
+        account = self._create_account()
+
+        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)
+
+        self._join_main_loop()
+
+        self._enable_evernote_service(account)
+
+        return account
+
+    def _create_account(self):
+        account = self._manager.create_account('evernote')
+        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()
+        oauth_token = (
+            'S=s1:U=8e6bf:E=14d08e375ff:C=145b1324a03:P=1cd:A=en-devtoken:'
+            'V=2:H=79b946c32b4515ee52b387f7b68baa69')
+        session_data['ProvidedTokens'] = GLib.Variant('a{sv}', {
+            'TokenSecret': GLib.Variant('s', 'dummy'),
+            'AccessToken': GLib.Variant('s', oauth_token),
+        })
+        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 _enable_evernote_service(self, account):
+        service = self._manager.get_service('evernote')
+        account.select_service(service)
+        account.set_enabled(True)
+        account.store(self._on_account_created, None)
+
+    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/reminders/tests/__init__.py'
--- tests/autopilot/reminders/tests/__init__.py	2014-04-25 15:57:50 +0000
+++ tests/autopilot/reminders/tests/__init__.py	2014-05-08 16:40:22 +0000
@@ -17,7 +17,7 @@
 """Reminders app autopilot tests."""
 
 import os
-import os.path
+import shutil
 import logging
 
 import fixtures
@@ -25,7 +25,10 @@
 from autopilot.input import Mouse, Touch, Pointer
 from autopilot.platform import model
 from autopilot.testcase import AutopilotTestCase
-from ubuntuuitoolkit import emulators as toolkit_emulators
+from ubuntuuitoolkit import (
+    emulators as toolkit_emulators,
+    fixture_setup as toolkit_fixtures
+)
 
 import reminders
 
@@ -41,22 +44,62 @@
     else:
         scenarios = [('with touch', dict(input_device_class=Touch))]
 
-    local_location_binary = '../../src/app/reminders'
+    local_location = os.path.dirname(os.path.dirname(os.getcwd()))
+    local_location_qml = local_location + "/reminders.qml"
+    local_location_binary = os.path.join(local_location, 'src/app/reminders')
     installed_location_binary = '/usr/bin/reminders'
     installed_location_qml = '/usr/share/reminders/qml/reminders.qml'
 
+    def setup_environment(self):
+        if os.path.exists(self.local_location_qml):
+            launch = self.launch_test_local
+            test_type = 'local'
+        elif os.path.exists(self.installed_location_qml):
+            launch = self.launch_test_installed
+            test_type = 'deb'
+        else:
+            launch = self.launch_test_click
+            test_type = 'click'
+        return launch, test_type
+
     def setUp(self):
+        launch, self.test_type = self.setup_environment()
+        self.home_dir = self._patch_home()
         self.pointing_device = Pointer(self.input_device_class.create())
         super(RemindersAppTestCase, self).setUp()
 
-        if os.path.exists(self.local_location_binary):
-            app_proxy = self.launch_test_local()
-        elif os.path.exists(self.installed_location_binary):
-            app_proxy = self.launch_test_installed()
+        self.app = reminders.RemindersApp(launch())
+
+    def _patch_home(self):
+        """ mock /home for testing purposes to preserve user data
+        """
+        temp_dir_fixture = fixtures.TempDir()
+        self.useFixture(temp_dir_fixture)
+        temp_dir = temp_dir_fixture.path
+
+        #click requires using initctl env (upstart), but the desktop can set
+        #an environment variable instead
+        if self.test_type == 'click':
+            self.useFixture(toolkit_fixtures.InitctlEnvironmentVariable(
+                            HOME=temp_dir))
         else:
-            app_proxy = self.launch_test_click()
-
-        self.app = reminders.RemindersApp(app_proxy)
+            self.useFixture(fixtures.EnvironmentVariable('HOME',
+                                                         newvalue=temp_dir))
+
+        #If running under xvfb, as jenkins does,
+        #xsession will fail to start without xauthority file
+        #Thus if the Xauthority file is in home directory
+        #make sure we copy it to temp home, otherwise do nothing
+        xauth = os.path.expanduser(os.path.join('~', '.Xauthority'))
+        if os.path.isfile(xauth):
+            logger.debug("Copying .Xauthority to fake home " + temp_dir)
+            shutil.copyfile(
+                os.path.expanduser(os.path.join('~', '.Xauthority')),
+                os.path.join(temp_dir, '.Xauthority'))
+
+        logger.debug("Patched home to fake home directory " + temp_dir)
+
+        return temp_dir
 
     @autopilot_logging.log_action(logger.info)
     def launch_test_local(self):
@@ -64,6 +107,7 @@
             'QML2_IMPORT_PATH', newvalue='../../src/plugin'))
         return self.launch_test_application(
             self.local_location_binary,
+            '-q', self.local_location_qml,
             app_type='qt',
             emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
 
 
=== modified file 'tests/autopilot/reminders/tests/test_reminders.py'
--- tests/autopilot/reminders/tests/test_reminders.py	2014-04-24 19:33:26 +0000
+++ tests/autopilot/reminders/tests/test_reminders.py	2014-05-08 16:40:22 +0000
@@ -23,9 +23,10 @@
 from autopilot import platform
 from autopilot.matchers import Eventually
 from testtools.matchers import Equals
+from testtools import ExpectedException
 
 import reminders
-from reminders import fixture_setup, tests
+from reminders import credentials, fixture_setup, tests
 
 
 logger = logging.getLogger(__name__)
@@ -40,7 +41,7 @@
     def test_go_to_account_settings(self):
         """Test that the Go to account settings button calls url-dispatcher."""
         if platform.model() == 'Desktop':
-             self.skipTest("URL dispatcher doesn't work on the desktop.")
+            self.skipTest("URL dispatcher doesn't work on the desktop.")
         url_dispatcher = fixture_setup.FakeURLDispatcher()
         self.useFixture(url_dispatcher)
 
@@ -56,3 +57,21 @@
         self.assertThat(
             get_last_dispatch_url_call_parameter,
             Eventually(Equals('settings:///system/online-accounts')))
+
+
+class RemindersTestCaseWithAccount(tests.RemindersAppTestCase):
+
+    def setUp(self):
+        self.add_evernote_credentials()
+        super(RemindersTestCaseWithAccount, self).setUp()
+
+    def add_evernote_credentials(self):
+        account_manager = credentials.AccountManager()
+        account = account_manager.add_evernote_credentials(
+            '[e-mail]', 'password')
+        self.addCleanup(account_manager.delete_account, account)
+
+    def test_open_application_with_account(self):
+        """Test that the No account dialog is not visible."""
+        with ExpectedException(reminders.RemindersAppException):
+            self.app.main_view.no_account_dialog