tests: remove real MongoDB dependency (#422)

OIDC integration tests now use mongomock instead of launching a full
mongodb server, which may not be available in a development
environment.

Author: bajnokk

tests/conftest.py

@@ -361,88 +361,3 @@ def consent_module_config(signing_key_path):
         }
     }
     return consent_config
-
-
-import atexit
-import random
-import shutil
-import subprocess
-import tempfile
-import time
-
-import pymongo
-import pytest
-
-
-class MongoTemporaryInstance(object):
-    """Singleton to manage a temporary MongoDB instance
-
-    Use this for testing purpose only. The instance is automatically destroyed
-    at the end of the program.
-
-    """
-    _instance = None
-
-    @classmethod
-    def get_instance(cls):
-        if cls._instance is None:
-            cls._instance = cls()
-            atexit.register(cls._instance.shutdown)
-        return cls._instance
-
-    def __init__(self):
-        self._tmpdir = tempfile.mkdtemp()
-        self._port = 27017
-        self._process = subprocess.Popen(['mongod', '--bind_ip', 'localhost',
-                                          '--port', str(self._port),
-                                          '--dbpath', self._tmpdir,
-                                          '--nojournal',
-                                          '--noauth',
-                                          '--syncdelay', '0'],
-                                         stdout=open('/tmp/mongo-temp.log', 'wb'),
-                                         stderr=subprocess.STDOUT)
-
-        # XXX: wait for the instance to be ready
-        #      Mongo is ready in a glance, we just wait to be able to open a
-        #      Connection.
-        for i in range(10):
-            time.sleep(0.2)
-            try:
-                self._conn = pymongo.MongoClient('localhost', self._port)
-            except pymongo.errors.ConnectionFailure:
-                continue
-            else:
-                break
-        else:
-            self.shutdown()
-            assert False, 'Cannot connect to the mongodb test instance'
-
-    @property
-    def conn(self):
-        return self._conn
-
-    @property
-    def port(self):
-        return self._port
-
-    def shutdown(self):
-        if self._process:
-            self._process.terminate()
-            self._process.wait()
-            self._process = None
-            shutil.rmtree(self._tmpdir, ignore_errors=True)
-
-    def get_uri(self):
-        """
-        Convenience function to get a mongodb URI to the temporary database.
-
-        :return: URI
-        """
-        return 'mongodb://localhost:{port!s}'.format(port=self.port)
-
-
-@pytest.fixture
-def mongodb_instance():
-    tmp_db = MongoTemporaryInstance()
-    yield tmp_db
-    tmp_db.shutdown()

tests/flows/test_oidc-saml.py

@@ -3,11 +3,12 @@
 import base64
 from urllib.parse import urlparse, urlencode, parse_qsl
 
+import mongomock
 import pytest
 from jwkest.jwk import rsa_load, RSAKey
 from jwkest.jws import JWS
 from oic.oic.message import ClaimsRequest, Claims
-from pyop.storage import MongoWrapper
+from pyop.storage import StorageBase
 from saml2 import BINDING_HTTP_REDIRECT
 from saml2.config import IdPConfig
 from werkzeug.test import Client
@@ -25,6 +26,7 @@
 CLIENT_SECRET = "secret"
 CLIENT_REDIRECT_URI = "https://client.example.com/cb"
 REDIRECT_URI = "https://client.example.com/cb"
+DB_URI = "mongodb://localhost/satosa"
 
 @pytest.fixture(scope="session")
 def client_db_path(tmpdir_factory):
@@ -45,26 +47,19 @@ def client_db_path(tmpdir_factory):
     return path
 
 @pytest.fixture
-def oidc_frontend_config(signing_key_path, mongodb_instance):
+def oidc_frontend_config(signing_key_path):
     data = {
         "module": "satosa.frontends.openid_connect.OpenIDConnectFrontend",
         "name": "OIDCFrontend",
         "config": {
             "issuer": "https://proxy-op.example.com",
             "signing_key_path": signing_key_path,
             "provider": {"response_types_supported": ["id_token"]},
-            "client_db_uri": mongodb_instance.get_uri(),  # use mongodb for integration testing
-            "db_uri": mongodb_instance.get_uri()  # use mongodb for integration testing
+            "client_db_uri": DB_URI,  # use mongodb for integration testing
+            "db_uri": DB_URI  # use mongodb for integration testing
         }
     }
 
-    # insert client in mongodb
-    cdb = MongoWrapper(mongodb_instance.get_uri(), "satosa", "clients")
-    cdb[CLIENT_ID] = {
-        "redirect_uris": [REDIRECT_URI],
-        "response_types": ["id_token"]
-    }
-
     return data
 
 
@@ -87,8 +82,20 @@ def oidc_stateless_frontend_config(signing_key_path, client_db_path):
     return data
 
 
+@mongomock.patch(servers=(('localhost', 27017),))
 class TestOIDCToSAML:
+    def _client_setup(self):
+        """Insert client in mongodb."""
+        self._cdb = StorageBase.from_uri(
+            DB_URI, db_name="satosa", collection="clients", ttl=None
+        )
+        self._cdb[CLIENT_ID] = {
+            "redirect_uris": [REDIRECT_URI],
+            "response_types": ["id_token"]
+        }
+
     def test_full_flow(self, satosa_config_dict, oidc_frontend_config, saml_backend_config, idp_conf):
+        self._client_setup()
         subject_id = "testuser1"
 
         # proxy config

tests/satosa/scripts/test_satosa_saml_metadata.py

@@ -1,6 +1,7 @@
 import glob
 import os
 
+import mongomock
 import pytest
 from saml2.config import Config
 from saml2.mdstore import MetaDataFile
@@ -10,7 +11,7 @@
 
 
 @pytest.fixture
-def oidc_frontend_config(signing_key_path, mongodb_instance):
+def oidc_frontend_config(signing_key_path):
     data = {
         "module": "satosa.frontends.openid_connect.OpenIDConnectFrontend",
         "name": "OIDCFrontend",
@@ -23,6 +24,7 @@ def oidc_frontend_config(signing_key_path, mongodb_instance):
     return data
 
 
+@mongomock.patch(servers=(('localhost', 27017),))
 class TestConstructSAMLMetadata:
     def test_saml_saml(self, tmpdir, cert_and_key, satosa_config_dict, saml_frontend_config,
                        saml_backend_config):

tests/test_requirements.txt

@@ -2,3 +2,4 @@ pytest
 responses
 beautifulsoup4
 ldap3
+mongomock