Merge lp:~elopio/ubuntuone-credentials/fixtured_fake_server into lp:ubuntuone-credentials

[Leo Arias]

Refactor the fake servers to be a thread on the same process, started from a fixture on the test setup.

This change was requested by dobey in order to package the autopilot tests. It's nice because now it follows the same style we use on the click scope.
We need the autopilot helpers of ubuntuone-credentials to be packaged in order to use them on the click scope tests.

[lp:~elopio/ubuntuone-credentials/fixtured_fake_server]

87. By Leo Arias on 2014-01-24

Rename

88. By Leo Arias on 2014-01-24

Updated the copyright year.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:88
http://jenkins.qa.ubuntu.com/job/ubuntuone-credentials-ci/78/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntuone-credentials-trusty-amd64-ci/8
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntuone-credentials-trusty-armhf-ci/8
        deb: http://jenkins.qa.ubuntu.com/job/ubuntuone-credentials-trusty-armhf-ci/8/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntuone-credentials-ci/78/rebuild

review: Approve (continuous-integration)

[dobey (dobey)]

390 +# Copyright (C) 2013, 2014 Canonical Ltd.

Please use - instead of a list of years, like 2013-2014, for the copyright headers.

Also, I think maybe online-accounts-provider/tests/CMakeLists.txt has a couple rules for running the autopilot tests that probably need to be updated here as well.

review: Needs Fixing

[lp:~elopio/ubuntuone-credentials/fixtured_fake_server]

89. By Leo Arias on 2014-01-24

Updated the autopilot cmake.

90. By Leo Arias on 2014-01-24

Use year ranges, as suggested by dobey.

[dobey (dobey)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:90
http://jenkins.qa.ubuntu.com/job/ubuntuone-credentials-ci/79/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntuone-credentials-trusty-amd64-ci/9
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntuone-credentials-trusty-armhf-ci/9
        deb: http://jenkins.qa.ubuntu.com/job/ubuntuone-credentials-trusty-armhf-ci/9/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntuone-credentials-ci/79/rebuild

review: Approve (continuous-integration)

=== modified file 'online-accounts-provider/tests/CMakeLists.txt'
--- online-accounts-provider/tests/CMakeLists.txt	2013-10-23 17:58:21 +0000
+++ online-accounts-provider/tests/CMakeLists.txt	2014-01-24 15:43:44 +0000
@@ -1,12 +1,16 @@
 SET (TESTS_TARGET test-online-accounts-provider)
 
+set (AUTOPILOT_PACKAGE ubuntuone_credentials)
+
 add_custom_target(online-accounts-provider-autopilot-tests
-    COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/autopilot/run ${CMAKE_CURRENT_BINARY_DIR}
+    COMMAND autopilot run ${AUTOPILOT_PACKAGE}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/autopilot
     DEPENDS ${QML_PLUGIN_NAME}
 )
 
 add_custom_target(online-accounts-provider-autopilot-tests-local
-    COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/autopilot/run ${CMAKE_CURRENT_BINARY_DIR} local
+    COMMAND SSO_AUTH_BASE_URL=fake SSO_UONE_BASE_URL=fake autopilot run ${AUTOPILOT_PACKAGE}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/autopilot
     DEPENDS ${QML_PLUGIN_NAME}
 )
 

=== removed file 'online-accounts-provider/tests/autopilot/run'
--- online-accounts-provider/tests/autopilot/run	2013-10-25 23:26:53 +0000
+++ online-accounts-provider/tests/autopilot/run	1970-01-01 00:00:00 +0000
@@ -1,26 +0,0 @@
-#!/bin/bash
-
-if [[ -z `which autopilot` ]]; then
-  echo "Autopilot is not installed. Skip"
-  exit
-fi
-
-SCRIPTPATH=`dirname $0`
-pushd ${SCRIPTPATH}
-
-if [ "x$2" == "xlocal" ]; then
-  echo "Using server at localhost:8080"
-  export SSO_AUTH_BASE_URL=http://localhost:8080
-  export SSO_UONE_BASE_URL=http://localhost:8080
-  python run_mock_server.py &
-fi
-
-export QML2_IMPORT_PATH=/usr/lib/i386-linux-gnu/ubuntu-system-settings/private:$1/../../qml-credentials-service
-export U1_DEBUG=1
-autopilot run UbuntuOneCredentialsProviderAutopilotTests
-popd
-
-if [ "x$2" == "xlocal" ]; then
-  echo "tearing down server"
-  kill -HUP %1
-fi

=== removed file 'online-accounts-provider/tests/autopilot/run_mock_server.py'
--- online-accounts-provider/tests/autopilot/run_mock_server.py	2013-10-29 17:25:31 +0000
+++ online-accounts-provider/tests/autopilot/run_mock_server.py	1970-01-01 00:00:00 +0000
@@ -1,205 +0,0 @@
-# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
-#
-# Copyright (C) 2013 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/>.
-
-"""Mock server for SSO and U1 Ping endpoints."""
-
-import BaseHTTPServer
-import json
-import signal
-import sys
-
-from urlparse import urlparse, parse_qs
-
-SSO_API_PATH = '/api/v2'
-UONE_API_PATH = '/oauth/sso-finished-so-get-tokens/'
-
-
-LOGIN_OK_RESPONSE = """
-{
-    "href": "https://login.ubuntu.com/api/v2/tokens/oauth/the-key",
-    "token_key": "token-key",
-    "token_secret": "token-secret",
-    "token_name": "token-name",
-    "consumer_key": "consumer-key",
-    "consumer_secret": "consumer-secret",
-    "date_created": "2013-01-11 12:43:23",
-    "date_updated": "2013-01-11 12:43:23"
-}
-"""
-
-TWOFACTOR_REQUIRED_RESPONSE = """
-{
-    "code": "TWOFACTOR_REQUIRED",
-    "message": "This account requires 2-factor authentication.",
-    "extra": {}
-}
-"""
-
-LOGIN_ERR_RESPONSE = """
-{
-    "code": "INVALID_CREDENTIALS",
-    "message": "Your email/password isn't correct.",
-    "extra": {}
-}
-"""
-
-TWOFACTOR_ERR_RESPONSE = """
-{
-    "message": "The provided 2-factor key is not recognised.",
-    "code": "TWOFACTOR_FAILURE",
-    "extra": {}
-}
-"""
-
-INVALID_DATA_RESPONSE = """
-{
-    "message": "Invalid request data",
-    "code": "INVALID_DATA",
-    "extra": {
-        "password": [
-            "A real password-specific message would go here."
-        ],
-        "email": [
-            "A real email-specific message would go here."
-        ]
-    }
-}
-"""
-
-REGISTER_CREATED_RESPONSE = """
-{
-    "status": "Active",
-    "openid": "fFcTeSt",
-    "verified": false,
-    "emails": [
-        {
-            "href": "/api/v2/emails/[e-mail]",
-            "verified": false
-        }
-    ],
-    "tokens": [],
-    "href": "/api/v2/accounts/fFcTeSt",
-    "displayname": "Test",
-    "email": "[e-mail]"
-}
-"""
-
-
-class MockSSOAndUOneRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):
-
-    def do_GET(self):
-        """Handle GET as if we were the one.ubuntu.com server
-        """
-        parsedPath = urlparse(self.path)
-        queryDict = parse_qs(parsedPath.query)
-
-        if parsedPath.path.startswith('/oauth/sso-finished-so-get-tokens/'):
-            for k in ['platform', 'platform_version', 'platform_arch']:
-                if k not in queryDict:
-                    print "****** MISSING ", k, " IN ", queryDict, "bailing"
-                    self.send_error(401)
-                    return
-            self.send_response(200)
-            self.end_headers()
-            self.wfile.write("ok 0/0")  # fake format of server's real response
-        else:
-            self.send_error(404)  # real server currently returns 500!
-
-    def do_POST(self):
-        """Handle POST as if we are the login.ubuntu.com server.
-        """
-        length = int(self.headers['Content-Length'])
-        postdata = self.rfile.read(length)
-        if postdata == '':
-            print "NOTE: empty postdata, just dropping the request"
-            return
-
-        try:
-            bodyDict = json.loads(postdata)
-        except ValueError:
-            print "error loading json from postdata: '%s'" % postdata
-            self.send_error(500)
-            return
-
-        if self.path == SSO_API_PATH + '/tokens/oauth':
-            self.handle_login(bodyDict)
-        elif self.path == SSO_API_PATH + '/accounts':
-            self.handle_register(bodyDict)
-        else:
-            print "unknown -- self.path is ", self.path
-            self.send_error(404, 'unknown')
-
-    def send_JSON_reply(self, code, replyJSON):
-        self.send_response(code)
-        self.send_header("Content-Type", "application/json")
-        self.end_headers()
-        self.wfile.write(replyJSON)
-
-    def handle_login(self, bodyDict):
-
-        if 'email' not in bodyDict \
-                or 'password' not in bodyDict or 'token_name' not in bodyDict:
-            self.send_JSON_reply(400, INVALID_DATA_RESPONSE)
-            return
-
-        email = bodyDict['email']
-
-        if email in ["[e-mail]", "[e-mail]"]:
-            self.send_JSON_reply(201, LOGIN_OK_RESPONSE)
-
-        elif email == "[e-mail]":
-            if 'otp' not in bodyDict:
-                self.send_JSON_reply(401, TWOFACTOR_REQUIRED_RESPONSE)
-            else:
-                if len(bodyDict['otp']) != 6:
-                    self.send_JSON_reply(403, TWOFACTOR_ERR_RESPONSE)
-                else:
-                    self.send_JSON_reply(201, LOGIN_OK_RESPONSE)
-
-        else:
-            self.send_JSON_reply(401, LOGIN_ERR_RESPONSE)
-
-    def handle_register(self, bodyDict):
-        if 'email' not in bodyDict \
-                or 'password' not in bodyDict \
-                or 'displayname' not in bodyDict \
-                or bodyDict['email'] == '[e-mail]':
-
-            self.send_JSON_reply(400, INVALID_DATA_RESPONSE)
-            return
-
-        self.send_JSON_reply(201, REGISTER_CREATED_RESPONSE)
-
-
-if __name__ == '__main__':
-
-    server_address = ('', 8080)
-    httpd = BaseHTTPServer.HTTPServer(server_address,
-                                      MockSSOAndUOneRequestHandler)
-
-    def stop_immediately(signum, frame):
-        print "Got signal ", signum, ", stopping server."
-        httpd.socket.close()
-
-    signal.signal(signal.SIGINT, stop_immediately)
-    signal.signal(signal.SIGHUP, stop_immediately)
-
-    print "Mock server running at ", 8080
-
-    try:
-        httpd.serve_forever()
-    except:
-        pass

=== renamed directory 'online-accounts-provider/tests/autopilot/UbuntuOneCredentialsProviderAutopilotTests' => 'online-accounts-provider/tests/autopilot/ubuntuone_credentials'
=== modified file 'online-accounts-provider/tests/autopilot/ubuntuone_credentials/__init__.py'
--- online-accounts-provider/tests/autopilot/UbuntuOneCredentialsProviderAutopilotTests/__init__.py	2013-10-10 02:39:50 +0000
+++ online-accounts-provider/tests/autopilot/ubuntuone_credentials/__init__.py	2014-01-24 15:43:44 +0000
@@ -1,6 +1,6 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
 #
-# Copyright (C) 2013 Canonical Ltd.
+# Copyright (C) 2013-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
@@ -20,14 +20,18 @@
 import subprocess
 import tempfile
 
+import fixtures
 from autopilot import input
 from autopilot.matchers import Eventually
 from testtools.matchers import Equals
 from ubuntuuitoolkit import (
     base,
     emulators as toolkit_emulators,
+    tests as toolkit_tests
 )
 
+from ubuntuone_credentials import fixture_setup
+
 
 def _get_module_include_path():
     return _get_path_to_source_root()
@@ -39,19 +43,6 @@
             os.path.dirname(__file__), '..', '..', '..'))
 
 
-def _get_local_desktop_file_directory():
-    return os.path.join(os.environ['HOME'], '.local', 'share', 'applications')
-
-
-def _get_qmlscene_launch_command():
-    """Return the command to launch qmlscene for autopilot tests."""
-    # TODO replace this with the one from the ubuntu-ui-toolkit, that has just
-    # been merged to trunk. --elopio - 2013-10-08
-    arch = subprocess.check_output(
-        ["dpkg-architecture", "-qDEB_HOST_MULTIARCH"]).strip()
-    return '/usr/lib/' + arch + '/qt5/bin/qmlscene'
-
-
 class TestCaseWithQMLWrapper(base.UbuntuUIToolkitAppTestCase):
 
     _DESKTOP_FILE_CONTENTS = ("""[Desktop Entry]
@@ -67,15 +58,35 @@
     def setUp(self):
         super(TestCaseWithQMLWrapper, self).setUp()
         self.pointing_device = input.Pointer(self.input_device_class.create())
+        self.use_qml2_import_path_for_fake_wrapper()
         self.launch_application()
 
+    def use_fake_servers(self):
+        fake_sso_and_u1_server = fixture_setup.FakeSSOAndU1ServersRunning()
+        self.useFixture(fake_sso_and_u1_server)
+        self.useFixture(fixtures.EnvironmentVariable(
+            'SSO_AUTH_BASE_URL', newvalue=fake_sso_and_u1_server.url))
+        self.useFixture(fixtures.EnvironmentVariable(
+            'SSO_UONE_BASE_URL', newvalue=fake_sso_and_u1_server.url))
+
+    def use_qml2_import_path_for_fake_wrapper(self):
+        arch = subprocess.check_output(
+            ["dpkg-architecture", "-qDEB_HOST_MULTIARCH"]).strip()
+        system_settings_path = (
+            '/usr/lib/{}/ubuntu-system-settings/private'.format(arch))
+        qml_credentials_path = os.path.join(
+            _get_path_to_source_root(), 'qml-credentials-service')
+        self.useFixture(fixtures.EnvironmentVariable(
+            'QML2_IMPORT_PATH',
+            newvalue=':'.join([system_settings_path, qml_credentials_path])))
+
     def launch_application(self):
         qml_file_path = os.path.join(
             os.path.dirname(__file__), self.test_qml_wrapper_file_name)
         desktop_file_path = self._write_test_desktop_file()
         self.addCleanup(os.remove, desktop_file_path)
         self.app = self.launch_test_application(
-            _get_qmlscene_launch_command(),
+            base.get_qmlscene_launch_command(),
             '-I' + _get_module_include_path(),
             qml_file_path,
             '--desktop_file_hint={0}'.format(desktop_file_path),
@@ -86,7 +97,7 @@
             self.main_view.visible, Eventually(Equals(True)))
 
     def _write_test_desktop_file(self):
-        desktop_file_dir = _get_local_desktop_file_directory()
+        desktop_file_dir = toolkit_tests.get_local_desktop_file_directory()
         if not os.path.exists(desktop_file_dir):
             os.makedirs(desktop_file_dir)
         desktop_file = tempfile.NamedTemporaryFile(

=== modified file 'online-accounts-provider/tests/autopilot/ubuntuone_credentials/test_existing_account.py'
--- online-accounts-provider/tests/autopilot/UbuntuOneCredentialsProviderAutopilotTests/test_existing_account.py	2013-10-08 23:45:57 +0000
+++ online-accounts-provider/tests/autopilot/ubuntuone_credentials/test_existing_account.py	2014-01-24 15:43:44 +0000
@@ -1,6 +1,6 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
 #
-# Copyright (C) 2013 Canonical Ltd.
+# Copyright (C) 2013-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
@@ -14,17 +14,25 @@
 # 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 os
+
 from autopilot.matchers import Eventually
 from testtools.matchers import Equals
 
-import UbuntuOneCredentialsProviderAutopilotTests
-
-
-class ExistingUOAAccountTests(
-        UbuntuOneCredentialsProviderAutopilotTests.TestCaseWithQMLWrapper):
+import ubuntuone_credentials
+
+
+class ExistingUOAAccountTestCase(ubuntuone_credentials.TestCaseWithQMLWrapper):
 
     test_qml_wrapper_file_name = 'TestWrapperExisting.qml'
 
+    def setUp(self):
+        # Start the fake server before launching the application.
+        if (os.environ.get('SSO_AUTH_BASE_URL') == 'fake' and
+                os.environ.get('SSO_UONE_BASE_URL') == 'fake'):
+            self.use_fake_servers()
+        super(ExistingUOAAccountTestCase, self).setUp()
+
     def test_show_remove_account_dialog(self):
         remove_account_button = self.main_view.select_single(
             objectName='removeAccountButton')

=== modified file 'online-accounts-provider/tests/autopilot/ubuntuone_credentials/test_new_account.py'
--- online-accounts-provider/tests/autopilot/UbuntuOneCredentialsProviderAutopilotTests/test_new_account.py	2013-10-29 17:25:31 +0000
+++ online-accounts-provider/tests/autopilot/ubuntuone_credentials/test_new_account.py	2014-01-24 15:43:44 +0000
@@ -1,6 +1,6 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
 #
-# Copyright (C) 2013 Canonical Ltd.
+# Copyright (C) 2013-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
@@ -14,12 +14,16 @@
 # 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 os
+
 from autopilot.matchers import Eventually
 from testtools.matchers import Equals, Not
 from ubuntuuitoolkit import emulators as toolkit_emulators
 
-from UbuntuOneCredentialsProviderAutopilotTests import (emulators,
-                                                        TestCaseWithQMLWrapper)
+from ubuntuone_credentials import (
+    emulators,
+    TestCaseWithQMLWrapper
+)
 
 
 class NewUbuntuOneOnlineAccountTestCase(TestCaseWithQMLWrapper):
@@ -78,6 +82,13 @@
         ('failure',
          dict(email='[e-mail]', password='password', success=False))]
 
+    def setUp(self):
+        # Start the fake server before launching the application.
+        if (os.environ.get('SSO_AUTH_BASE_URL') == 'fake' and
+                os.environ.get('SSO_UONE_BASE_URL') == 'fake'):
+            self.use_fake_servers()
+        super(SimpleLogInTestCase, self).setUp()
+
     def test_simple_login(self):
         """Test that success pops the NewAccount main page, and
         failure shows the error label.
@@ -103,6 +114,13 @@
               twoFactorCode='bad', success=False))
         ]
 
+    def setUp(self):
+        # Start the fake server before launching the application.
+        if (os.environ.get('SSO_AUTH_BASE_URL') == 'fake' and
+                os.environ.get('SSO_UONE_BASE_URL') == 'fake'):
+            self.use_fake_servers()
+        super(TwoFactorLogInTestCase, self).setUp()
+
     def test_twofactor_login(self):
         "Test that success pops the NewAccount main page."
 
@@ -158,6 +176,13 @@
                              success=False))
         ]
 
+    def setUp(self):
+        # Start the fake server before launching the application.
+        if (os.environ.get('SSO_AUTH_BASE_URL') == 'fake' and
+                os.environ.get('SSO_UONE_BASE_URL') == 'fake'):
+            self.use_fake_servers()
+        super(RegisterNewU1AccountTestCase, self).setUp()
+
     def test_register_new_account(self):
         "Test that registering a new account pops the main page."