Merge lp:~mandel/ubuntu-sso-client/fix-webclient-tests into lp:ubuntu-sso-client

[Manuel de la Peña]

- Added the use of the new added webserver that cleans resources correctly (LP: #960436).

- Added the use of the new added webserver that cleans resources correctly (LP: #960436).

[lp:~mandel/ubuntu-sso-client/fix-webclient-tests]

959. By Manuel de la Peña on 2012-04-11

Link bug.

960. By Manuel de la Peña on 2012-04-11

Use connetionLost to get a deferred when we cleaned everything.

961. By Manuel de la Peña on 2012-04-11

Merged fix-broken-tests into fix-webclient-tests.

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

[lp:~mandel/ubuntu-sso-client/fix-webclient-tests]

962. By Manuel de la Peña on 2012-04-12

Merged fix-broken-tests into fix-webclient-tests.

963. By Manuel de la Peña on 2012-04-12

Use the correct namespaces.

[Brian Curtin (brian.curtin)]

60 + # TODO: why do we need to use localhost and not just use the webserver
61 + # get_uri???

What does get_uri give? localhost does work work fine here.

review: Needs Information

[lp:~mandel/ubuntu-sso-client/fix-webclient-tests]

964. By Manuel de la Peña on 2012-04-16

Merged fix-broken-tests into fix-webclient-tests.

965. By Manuel de la Peña on 2012-04-16

Updated branch to use the new API.

966. By Manuel de la Peña on 2012-04-17

Merged fix-broken-tests into fix-webclient-tests.

967. By Manuel de la Peña on 2012-04-17

Updated to use the new API.

[Brian Curtin (brian.curtin)]

review: Approve

=== modified file 'ubuntu_sso/utils/tests/test_common.py'
--- ubuntu_sso/utils/tests/test_common.py	2012-04-09 17:38:24 +0000
+++ ubuntu_sso/utils/tests/test_common.py	2012-04-17 20:34:24 +0000
@@ -33,11 +33,11 @@
 import sys
 import time
 
-from twisted.application import internet, service
 from twisted.internet import defer
 from twisted.internet.threads import deferToThread
-from twisted.web import server, resource
+from twisted.web import resource
 from ubuntuone.devtools.handlers import MementoHandler
+from ubuntuone.devtools.testing.txwebserver import HTTPWebServer
 
 from ubuntu_sso import utils
 from ubuntu_sso.tests import TestCase, EMAIL, TOKEN
@@ -306,30 +306,14 @@
         return ""
 
 
-class MockWebServer(object):
+class MockWebServer(HTTPWebServer):
     """A mock webserver for testing."""
 
     def __init__(self):
         """Start up this instance."""
         # pylint: disable=E1101
-        self.root = RootResource()
-        site = server.Site(self.root)
-        application = service.Application('web')
-        self.service_collection = service.IServiceCollection(application)
-        self.tcpserver = internet.TCPServer(0, site)
-        self.tcpserver.setServiceParent(self.service_collection)
-        self.service_collection.startService()
-
-    def get_url(self):
-        """Build the url for this mock server."""
-        # pylint: disable=W0212
-        port_num = self.tcpserver._port.getHost().port
-        return "http://localhost:%d/" % port_num
-
-    def stop(self):
-        """Shut it down."""
-        # pylint: disable=E1101
-        self.service_collection.stopService()
+        root = RootResource()
+        super(MockWebServer, self).__init__(root)
 
 
 class FakedError(Exception):
@@ -344,8 +328,9 @@
         """Initialize a fake webserver."""
         yield super(TimestampCheckerTestCase, self).setUp()
         self.ws = MockWebServer()
+        self.ws.start()
         self.addCleanup(self.ws.stop)
-        self.patch(SyncTimestampChecker, "SERVER_URL", self.ws.get_url())
+        self.patch(SyncTimestampChecker, "SERVER_URL", self.ws.get_iri())
 
     @defer.inlineCallbacks
     def test_returned_value_is_int(self):

=== modified file 'ubuntu_sso/utils/webclient/tests/__init__.py'
--- ubuntu_sso/utils/webclient/tests/__init__.py	2012-04-09 17:38:24 +0000
+++ ubuntu_sso/utils/webclient/tests/__init__.py	2012-04-17 20:34:24 +0000
@@ -28,14 +28,6 @@
 # files in the program, then also delete it here.
 """Tests for the proxy-aware webclient."""
 
-from twisted.application import internet, service
-from twisted.internet import ssl
-from twisted.web import http, server
-
-
-# Some settings are not used as described in:
-# https://bugzilla.gnome.org/show_bug.cgi?id=648237
-
 TEMPLATE_GSETTINGS_OUTPUT = """\
 org.gnome.system.proxy autoconfig-url '{autoconfig_url}'
 org.gnome.system.proxy ignore-hosts {ignore_hosts:s}
@@ -69,89 +61,3 @@
     "socks_host": "",
     "socks_port": 0,
 }
-
-
-class SaveHTTPChannel(http.HTTPChannel):
-    """A save protocol to be used in tests."""
-
-    protocolInstance = None
-
-    # pylint: disable=C0103
-    def connectionMade(self):
-        """Keep track of the given protocol."""
-        SaveHTTPChannel.protocolInstance = self
-        http.HTTPChannel.connectionMade(self)
-
-
-class SaveSite(server.Site):
-    """A site that let us know when it closed."""
-
-    protocol = SaveHTTPChannel
-
-    def __init__(self, *args, **kwargs):
-        """Create a new instance."""
-        server.Site.__init__(self, *args, **kwargs)
-        # we disable the timeout in the tests, we will deal with it manually.
-        # pylint: disable=C0103
-        self.timeOut = None
-
-
-class BaseMockWebServer(object):
-    """A mock webserver for testing"""
-
-    def __init__(self, ssl_settings=None):
-        """Start up this instance."""
-        self.root = self.get_root_resource()
-        self.site = SaveSite(self.root)
-        application = service.Application('web')
-        self.service_collection = service.IServiceCollection(application)
-        #pylint: disable=E1101
-        ssl_context = None
-        if (ssl_settings is not None
-                and 'key' in ssl_settings
-                and 'cert' in ssl_settings):
-            ssl_context = ssl.DefaultOpenSSLContextFactory(ssl_settings['key'],
-                                                         ssl_settings['cert'])
-            self.ssl_server = internet.SSLServer(0, self.site, ssl_context)
-        else:
-            self.ssl_server = None
-        self.server = internet.TCPServer(0, self.site)
-        self.server.setServiceParent(self.service_collection)
-        if self.ssl_server:
-            self.ssl_server.setServiceParent(self.service_collection)
-        self.service_collection.startService()
-
-    def get_root_resource(self):
-        """Get the root resource with all the children."""
-        raise NotImplementedError
-
-    def get_iri(self):
-        """Build the iri for this mock server."""
-        url = u"http://127.0.0.1:%d/"
-        return url % self.get_port()
-
-    def get_ssl_iri(self):
-        """Build the ssl iri for this mock server."""
-        if self.ssl_server:
-            url = u"https://127.0.0.1:%d/"
-            return url % self.get_ssl_port()
-
-    def get_port(self):
-        """Return the port where we are listening."""
-        # pylint: disable=W0212
-        return self.server._port.getHost().port
-        # pylint: enable=W0212
-
-    def get_ssl_port(self):
-        """Return the ssl port where we are listening."""
-        # pylint: disable=W0212
-        if self.ssl_server:
-            return self.ssl_server._port.getHost().port
-        # pylint: enable=W0212
-
-    def stop(self):
-        """Shut it down."""
-        #pylint: disable=E1101
-        if self.site.protocol.protocolInstance:
-            self.site.protocol.protocolInstance.timeoutConnection()
-        return self.service_collection.stopService()

=== modified file 'ubuntu_sso/utils/webclient/tests/test_timestamp.py'
--- ubuntu_sso/utils/webclient/tests/test_timestamp.py	2012-04-09 17:38:24 +0000
+++ ubuntu_sso/utils/webclient/tests/test_timestamp.py	2012-04-17 20:34:24 +0000
@@ -32,8 +32,9 @@
 from twisted.trial.unittest import TestCase
 from twisted.web import resource
 
+from ubuntuone.devtools.testing.txwebserver import HTTPWebServer
+
 from ubuntu_sso.utils.webclient import timestamp, webclient_module
-from ubuntu_sso.utils.webclient.tests import BaseMockWebServer
 
 
 class FakedError(Exception):
@@ -59,12 +60,12 @@
         return ""
 
 
-class MockWebServer(BaseMockWebServer):
+class MockWebServer(HTTPWebServer):
     """A mock webserver for testing."""
 
-    def get_root_resource(self):
-        """Get the root resource with all the children."""
-        return RootResource()
+    def __init__(self):
+        """Create a new server."""
+        super(MockWebServer, self).__init__(RootResource())
 
 
 class TimestampCheckerTestCase(TestCase):
@@ -76,6 +77,7 @@
     def setUp(self):
         yield super(TimestampCheckerTestCase, self).setUp()
         self.ws = MockWebServer()
+        self.ws.start()
         self.addCleanup(self.ws.stop)
         self.webclient_class = webclient_module().WebClient
         self.patch(timestamp.TimestampChecker, "SERVER_IRI", self.ws.get_iri())

=== modified file 'ubuntu_sso/utils/webclient/tests/test_webclient.py'
--- ubuntu_sso/utils/webclient/tests/test_webclient.py	2012-04-12 12:07:46 +0000
+++ ubuntu_sso/utils/webclient/tests/test_webclient.py	2012-04-17 20:34:24 +0000
@@ -42,6 +42,11 @@
 
 from ubuntuone.devtools.testcases import TestCase
 from ubuntuone.devtools.testcases.squid import SquidTestCase
+from ubuntuone.devtools.testing.txwebserver import (
+    HTTPWebServer,
+    HTTPSWebServer,
+)
+
 
 from ubuntu_sso import (
     keyring,
@@ -53,7 +58,6 @@
 from ubuntu_sso.utils.ui import SSL_DETAILS_TEMPLATE
 from ubuntu_sso.utils.webclient import gsettings, txweb
 from ubuntu_sso.utils.webclient.common import BaseWebClient, HeaderDict, oauth
-from ubuntu_sso.utils.webclient.tests import BaseMockWebServer
 
 ANY_VALUE = object()
 SAMPLE_KEY = "result"
@@ -182,34 +186,49 @@
         return "ERROR: Expected OAuth header not present."
 
 
-class MockWebServer(BaseMockWebServer):
-    """A mock webserver for the webclient tests."""
-
-    def get_root_resource(self):
-        """Get the root resource with all the children."""
-        root = resource.Resource()
-        root.putChild(SIMPLERESOURCE, SimpleResource())
-        root.putChild(BYTEZERORESOURCE, ByteZeroResource())
-        root.putChild(POSTABLERESOURCE, PostableResource())
-
-        root.putChild(THROWERROR, resource.NoResource())
-
-        unauthorized_resource = resource.ErrorPage(resource.http.UNAUTHORIZED,
+def get_root_resource():
+    """Get the root resource with all the children."""
+    root = resource.Resource()
+    root.putChild(SIMPLERESOURCE, SimpleResource())
+    root.putChild(BYTEZERORESOURCE, ByteZeroResource())
+    root.putChild(POSTABLERESOURCE, PostableResource())
+
+    root.putChild(THROWERROR, resource.NoResource())
+
+    unauthorized_resource = resource.ErrorPage(resource.http.UNAUTHORIZED,
                                                 "Unauthorized", "Unauthorized")
-        root.putChild(UNAUTHORIZED, unauthorized_resource)
-        root.putChild(HEADONLY, HeadOnlyResource())
-        root.putChild(VERIFYHEADERS, VerifyHeadersResource())
-        root.putChild(VERIFYPOSTPARAMS, VerifyPostParameters())
-        root.putChild(OAUTHRESOURCE, OAuthCheckerResource())
+    root.putChild(UNAUTHORIZED, unauthorized_resource)
+    root.putChild(HEADONLY, HeadOnlyResource())
+    root.putChild(VERIFYHEADERS, VerifyHeadersResource())
+    root.putChild(VERIFYPOSTPARAMS, VerifyPostParameters())
+    root.putChild(OAUTHRESOURCE, OAuthCheckerResource())
 
-        db = checkers.InMemoryUsernamePasswordDatabaseDontUse()
-        db.addUser(SAMPLE_USERNAME, SAMPLE_PASSWORD)
-        test_portal = portal.Portal(SimpleRealm(), [db])
-        cred_factory = guard.BasicCredentialFactory("example.org")
-        guarded_resource = guard.HTTPAuthSessionWrapper(test_portal,
+    db = checkers.InMemoryUsernamePasswordDatabaseDontUse()
+    db.addUser(SAMPLE_USERNAME, SAMPLE_PASSWORD)
+    test_portal = portal.Portal(SimpleRealm(), [db])
+    cred_factory = guard.BasicCredentialFactory("example.org")
+    guarded_resource = guard.HTTPAuthSessionWrapper(test_portal,
                                                         [cred_factory])
-        root.putChild(GUARDED, guarded_resource)
-        return root
+    root.putChild(GUARDED, guarded_resource)
+    return root
+
+
+class HTTPMockWebServer(HTTPWebServer):
+    """A mock webserver for the webclient tests."""
+
+    def __init__(self):
+        """Create a new instance."""
+        root = get_root_resource()
+        super(HTTPMockWebServer, self).__init__(root)
+
+
+class HTTPSMockWebServer(HTTPSWebServer):
+    """A mock webserver for the webclient tests."""
+
+    def __init__(self, ssl_settings):
+        """Create a new instance."""
+        root = get_root_resource()
+        super(HTTPSMockWebServer, self).__init__(root, ssl_settings)
 
 
 class FakeQApplication(object):
@@ -264,11 +283,12 @@
     @defer.inlineCallbacks
     def setUp(self):
         yield super(WebClientTestCase, self).setUp()
-        self.ws = MockWebServer()
-        self.addCleanup(self.ws.stop)
-        self.base_iri = self.ws.get_iri()
         self.wc = self.webclient_factory()
         self.addCleanup(self.wc.shutdown)
+        self.ws = HTTPMockWebServer()
+        self.ws.start()
+        self.addCleanup(self.ws.stop)
+        self.base_iri = self.ws.get_iri()
 
     @defer.inlineCallbacks
     def test_request_takes_an_iri(self):
@@ -420,6 +440,52 @@
 
     webclient_factory = txweb.WebClient
 
+    @defer.inlineCallbacks
+    def setUp(self):
+        """Set the diff tests."""
+        # delay import, otherwise a default reactor gets installed
+        from twisted.web import client
+        self.factory = client.HTTPClientFactory
+        # set the factory to be used
+        # Hook the server's buildProtocol to make the protocol instance
+        # accessible to tests and ensure that the reactor is clean!
+        build_protocol = self.factory.buildProtocol
+        self.serverProtocol = None
+
+        def remember_protocol_instance(my_self, addr):
+            """Remember the protocol used in the test."""
+            protocol = build_protocol(my_self, addr)
+            self.serverProtocol = protocol
+            on_connection_lost = defer.Deferred()
+            connection_lost = protocol.connectionLost
+
+            def defer_connection_lost(protocol, *a):
+                """Lost connection."""
+                if not on_connection_lost.called:
+                    on_connection_lost.callback(None)
+                connection_lost(protocol, *a)
+
+            self.patch(protocol, 'connectionLost', defer_connection_lost)
+
+            def cleanup():
+                """Clean the connection."""
+                if self.serverProtocol.transport is not None:
+                    self.serverProtocol.transport.loseConnection()
+                return on_connection_lost
+
+            self.addCleanup(cleanup)
+            return protocol
+
+        self.factory.buildProtocol = remember_protocol_instance
+        self.addCleanup(self.set_build_protocol, build_protocol)
+        txweb.WebClient.client_factory = self.factory
+
+        yield super(TxWebClientTestCase, self).setUp()
+
+    def set_build_protocol(self, method):
+        """Set the method back."""
+        self.factory.buildProtocol = method
+
 
 class TxWebClientReactorReplaceableTestCase(TestCase):
     """In the txweb client the reactor is replaceable."""
@@ -478,7 +544,8 @@
     @defer.inlineCallbacks
     def setUp(self):
         yield super(BasicProxyTestCase, self).setUp()
-        self.ws = MockWebServer()
+        self.ws = HTTPMockWebServer()
+        self.ws.start()
         self.addCleanup(self.ws.stop)
         self.base_iri = self.ws.get_iri()
         self.wc = webclient.webclient_factory()
@@ -891,10 +958,10 @@
                                                              self.cert_details)
         self.addCleanup(self._clean_ssl_certificate_files)
 
-        self.ws = MockWebServer(self.ssl_settings)
+        self.ws = HTTPSMockWebServer(self.ssl_settings)
+        self.ws.start()
         self.addCleanup(self.ws.stop)
         self.base_iri = self.ws.get_iri()
-        self.base_ssl_iri = self.ws.get_ssl_iri()
 
     def _clean_ssl_certificate_files(self):
         """Remove the certificate files."""
@@ -995,7 +1062,7 @@
         """
         # we fail due to the fake ssl cert
         yield self.failUnlessFailure(self.wc.request(
-                                     self.base_ssl_iri + SIMPLERESOURCE),
+                                     self.base_iri + SIMPLERESOURCE),
                                      webclient.WebClientError)
         # https requests do not use the auth proxy therefore called should be
         # empty. This asserts that we are using the correct settings for the
@@ -1062,7 +1129,7 @@
         self.return_code = USER_SUCCESS
         if proxy_settings:
             self.wc.force_use_proxy(proxy_settings)
-        yield self.wc.request(self.base_ssl_iri + SIMPLERESOURCE)
+        yield self.wc.request(self.base_iri + SIMPLERESOURCE)
         details = SSL_DETAILS_TEMPLATE % self.cert_details
         self.assertIn(('_launch_ssl_dialog', gethostname(), details),
                       self.called)