From 6d76a4cb2a534e8da4832def7c03ea4b830a97e2 Mon Sep 17 00:00:00 2001
From: "Kali Kaneko (leap communications)" <kali@leap.se>
Date: Thu, 8 Dec 2016 10:33:47 +0100
Subject: [tests] add some tests for the api

---
 tests/unit/core/test_web_api.py | 95 ++++++++++++++++++++++++++++++++++++-----
 1 file changed, 84 insertions(+), 11 deletions(-)

diff --git a/tests/unit/core/test_web_api.py b/tests/unit/core/test_web_api.py
index f440417..ae10ec4 100644
--- a/tests/unit/core/test_web_api.py
+++ b/tests/unit/core/test_web_api.py
@@ -1,30 +1,38 @@
 import base64
 
+from twisted.application import service
 from twisted.cred import portal
 from twisted.trial import unittest
 from twisted.web.test.test_web import DummyRequest
 from twisted.web import resource
+from twisted.web.server import Site
 
-from leap.bitmask.core import _web
+from leap.bitmask.core import dispatcher
+from leap.bitmask.core import web
+from leap.bitmask.core.dummy import mail_services
+from leap.bitmask.core.dummy import BonafideService
 
 
 def b64encode(s):
     return base64.b64encode(s).strip()
 
 
-class APIMixin:
+class SimpleAPIMixin:
     """
     L{TestCase} mixin class which defines a number of tests for
     L{basic.BasicCredentialFactory}.  Because this mixin defines C{setUp}, it
     must be inherited before L{TestCase}.
+
+    The API resource in this case is just a very simple dummy request, doesn't
+    implement any command dispatch.
     """
     def setUp(self):
         self.request = self.makeRequest()
 
         api = AuthTestResource()
-        self.realm = _web.HttpPasswordRealm(api)
+        self.realm = web._auth.HttpPasswordRealm(api)
         tokens = {'testuser': 'token'}
-        checker = _web.TokenDictChecker(tokens)
+        checker = web._auth.TokenDictChecker(tokens)
         self.portal = portal.Portal(self.realm, [checker])
 
     def makeRequest(self, method=b'GET', clientAddress=None):
@@ -37,7 +45,7 @@ class APIMixin:
                                   self.__class__,))
 
 
-class WhitelistedResourceTests(APIMixin, unittest.TestCase):
+class WhitelistedResourceTests(SimpleAPIMixin, unittest.TestCase):
 
     def makeRequest(self, method=b'GET', clientAddress=None, path='/'):
         """
@@ -56,9 +64,9 @@ class WhitelistedResourceTests(APIMixin, unittest.TestCase):
         a I{WWW-Authenticate} header and puts a simple unauthorized message
         into the response body.
         """
-        protected = _web.WhitelistHTTPAuthSessionWrapper(
+        protected = web._auth.WhitelistHTTPAuthSessionWrapper(
             self.portal,
-            [_web.TokenCredentialFactory('localhost')])
+            [web._auth.TokenCredentialFactory('localhost')])
         request = self.makeRequest(method='POST', path='/')
         request.render(protected)
         assert request.responseCode == 401
@@ -69,18 +77,18 @@ class WhitelistedResourceTests(APIMixin, unittest.TestCase):
         assert b'Unauthorized' == b''.join(request.written)
 
     def test_whitelisted_resource_does_render(self):
-        protected = _web.WhitelistHTTPAuthSessionWrapper(
+        protected = web._auth.WhitelistHTTPAuthSessionWrapper(
             self.portal,
-            [_web.TokenCredentialFactory('localhost')],
+            [web._auth.TokenCredentialFactory('localhost')],
             whitelist=['/whitelisted'])
         request = self.makeRequest(method='GET', path='/whitelisted')
         request.render(protected)
         assert b'dummyGET' == b''.join(request.written)
 
     def test_good_token_authenticates(self):
-        protected = _web.WhitelistHTTPAuthSessionWrapper(
+        protected = web._auth.WhitelistHTTPAuthSessionWrapper(
             self.portal,
-            [_web.TokenCredentialFactory('localhost')],
+            [web._auth.TokenCredentialFactory('localhost')],
             whitelist=[])
         request = self.makeRequest(method='GET', path='/')
         authorization = b64encode(b'testuser:token')
@@ -94,6 +102,71 @@ class WhitelistedResourceTests(APIMixin, unittest.TestCase):
         pass
 
 
+class RESTApiMixin:
+    def setUp(self):
+        self.request = self.makeRequest()
+
+        dispatcher = dummyDispatcherFactory()
+        api = web.api.Api(dispatcher)
+        self.site = Site(api)
+
+    def makeRequest(self, method=b'GET', clientAddress=None):
+        """
+        Create a request object to be passed to
+        TokenCredentialFactory.decode along with a response value.
+        Override this in a subclass.
+        """
+        raise NotImplementedError("%r did not implement makeRequest" % (
+                                  self.__class__,))
+
+
+class RESTApiTests(RESTApiMixin, unittest.TestCase):
+    """
+    Tests that involve checking the routing between the REST api and the
+    command dispatcher.
+    """
+
+    def test_simple_api_request(self):
+        # FIXME -- check the requests to the API
+        assert 1 == 1
+
+    def makeRequest(self, method='GET', clientAddress=None):
+        pass
+
+
+class DummyCore(service.MultiService):
+    """
+    A minimal core that uses the dummy backend modules.
+    """
+
+    def __init__(self):
+        service.MultiService.__init__(self)
+        mail = mail_services.StandardMailService
+        self.init('mail', mail)
+
+        km = mail_services.KeymanagerService
+        self.init('keymanager', km)
+
+        sol = mail_services.SoledadService
+        self.init('soledad', sol)
+
+        bf = BonafideService
+        self.init('bonafide', bf, '/tmp/')
+
+    def init(self, label, service, *args, **kw):
+        s = service(*args, **kw)
+        s.setName(label)
+        s.setServiceParent(self)
+
+
+def dummyDispatcherFactory():
+    """
+    Returns a CommandDispatcher that uses the dummy backend
+    """
+    dummy_core = DummyCore()
+    return dispatcher.CommandDispatcher(dummy_core)
+
+
 class AuthTestResource(resource.Resource):
 
     isLeaf = True
-- 
cgit v1.2.3