Add unit tests for the graph client

Author: samwelkanda

msgraphcore/graph_client.py

@@ -10,12 +10,19 @@
 
 class GraphClient:
     """Constructs a custom HTTPClient to be used for requests against Microsoft Graph"""
+    __instance = None
+
+    def __new__(cls, *args, **kwargs):
+        if not GraphClient.__instance:
+            GraphClient.__instance = object.__new__(cls)
+        return GraphClient.__instance
+
     def __init__(self, **kwargs):
         """
         Class constructor that accepts a session object and kwargs to
         be passed to the HTTPClientFactory
         """
-        self.graph_session = get_graph_session(**kwargs)
+        self.graph_session = self.get_graph_session(**kwargs)
 
     @middleware_control.get_middleware_options
     def get(self, url: str, **kwargs):
@@ -76,25 +83,23 @@ def _graph_url(self, url: str) -> str:
         """
         return self.graph_session.base_url + url if (url[0] == '/') else url
 
+    @staticmethod
+    def get_graph_session(**kwargs):
+        """Method to always return a single instance of a HTTP Client"""
 
-_INSTANCE = None
-
-
-def get_graph_session(**kwargs):
-    """Method to always return a single instance of a HTTP Client"""
-
-    global _INSTANCE
+        session = None
 
-    credential = kwargs.get('credential')
-    middleware = kwargs.get('middleware')
+        credential = kwargs.get('credential')
+        middleware = kwargs.get('middleware')
 
-    if credential and middleware:
-        raise Exception("Invalid parameters! Both TokenCredential and middleware cannot be passed")
-    if not credential and not middleware:
-        raise ValueError("Invalid parameters!. Missing TokenCredential or middleware")
-    if _INSTANCE is None:
+        if credential and middleware:
+            raise Exception(
+                "Invalid parameters! Both TokenCredential and middleware cannot be passed"
+            )
+        if not credential and not middleware:
+            raise ValueError("Invalid parameters!. Missing TokenCredential or middleware")
         if credential:
-            _INSTANCE = HTTPClientFactory(**kwargs).create_with_default_middleware(credential)
+            session = HTTPClientFactory(**kwargs).create_with_default_middleware(credential)
         elif middleware:
-            _INSTANCE = HTTPClientFactory(**kwargs).create_with_custom_middleware(middleware)
-    return _INSTANCE
+            session = HTTPClientFactory(**kwargs).create_with_custom_middleware(middleware)
+        return session

tests/unit/test_client_factory.py

@@ -1,5 +1,3 @@
-import ssl
-
 import pytest
 from requests import Session
 from requests.adapters import HTTPAdapter

tests/unit/test_graph_client.py

@@ -0,0 +1,95 @@
+import pytest
+import responses
+from requests import Session
+from requests.adapters import HTTPAdapter
+
+from msgraphcore.constants import CONNECTION_TIMEOUT, REQUEST_TIMEOUT
+from msgraphcore.enums import APIVersion, NationalClouds
+from msgraphcore.graph_client import GraphClient
+from msgraphcore.middleware.authorization import AuthorizationHandler
+from msgraphcore.middleware.middleware import BaseMiddleware, MiddlewarePipeline
+
+
+def test_graph_client_with_default_middleware():
+    """
+    Test creating a graph client with default middleware works as expected
+    """
+    credential = _CustomTokenCredential()
+    client = GraphClient(credential=credential)
+
+    assert isinstance(client.graph_session, Session)
+    assert isinstance(client.graph_session.get_adapter('https://'), HTTPAdapter)
+    assert client.graph_session.base_url == NationalClouds.Global + '/' + APIVersion.v1
+
+
+def test_graph_client_with_custom_middleware():
+    """
+    Test creating a graph client with custom middleware works as expected
+    """
+    credential = _CustomTokenCredential()
+    middleware = [
+        AuthorizationHandler(credential),
+    ]
+    client = GraphClient(middleware=middleware)
+
+    assert isinstance(client.graph_session, Session)
+    assert isinstance(client.graph_session.get_adapter('https://'), HTTPAdapter)
+    assert client.graph_session.base_url == NationalClouds.Global + '/' + APIVersion.v1
+
+
+def test_graph_client_with_custom_configuration():
+    """
+    Test creating a graph client with custom middleware works as expected
+    """
+    credential = _CustomTokenCredential()
+    client = GraphClient(
+        credential=credential, api_version=APIVersion.beta, cloud=NationalClouds.China
+    )
+
+    assert client.graph_session.base_url == NationalClouds.China + '/' + APIVersion.beta
+
+
+def test_graph_client_uses_same_session():
+    """
+    Test graph client is a singleton class and uses the same session
+    """
+    credential = _CustomTokenCredential()
+    client = GraphClient(credential=credential)
+
+    client2 = GraphClient(credential=credential)
+    assert client is client2
+
+
+@responses.activate
+def test_graph_client_builds_graph_urls():
+    """
+    Test that the graph client builds full urls if supplied with partial
+    """
+    credential = _CustomTokenCredential()
+    client = GraphClient(credential=credential)
+    graph_url = client.graph_session.base_url + '/me'
+
+    responses.add(responses.GET, graph_url, status=200)
+
+    client.get('/me')
+    assert graph_url == responses.calls[0].request.url
+
+
+@responses.activate
+def test_does_not_build_graph_urls_for_full_urls():
+    """
+    Test that the graph client builds full urls if supplied with partial
+    """
+    other_url = 'https://microsoft.com/'
+    responses.add(responses.GET, other_url, status=200)
+
+    credential = _CustomTokenCredential()
+    client = GraphClient(credential=credential)
+    client.get(other_url)
+    request_url = responses.calls[0].request.url
+    assert other_url == request_url
+
+
+class _CustomTokenCredential:
+    def get_token(self, scopes):
+        return ['{token:https://graph.microsoft.com/}']