Refactor failing tests

Author: samwelkanda

msgraphcore/__init__.py

@@ -1,5 +1,5 @@
+from msgraphcore.client_factory import HTTPClientFactory
 from msgraphcore.constants import SDK_VERSION
 from msgraphcore.graph_client import GraphClient
-from msgraphcore.client_factory import HTTPClientFactory
 
 __version__ = SDK_VERSION

msgraphcore/graph_client.py

@@ -1,11 +1,11 @@
-from msgraphcore.middleware.request_context import RequestContext
 from typing import List, Optional
 
 from requests import Request, Session
 
 from msgraphcore.client_factory import HTTPClientFactory
 from msgraphcore.middleware.abc_token_credential import TokenCredential
 from msgraphcore.middleware.middleware import BaseMiddleware
+from msgraphcore.middleware.request_context import RequestContext
 
 supported_options = ['scopes', 'custom_option']
 

msgraphcore/middleware/middleware.py

@@ -25,11 +25,11 @@ def add_middleware(self, middleware):
             self._middleware = middleware
 
     def send(self, request, **kwargs):
-        
+
         if not hasattr(request, 'context'):
             headers = request.headers
             request.context = RequestContext(dict(), headers)
-        
+
         if self._middleware_present():
             return self._middleware.send(request, **kwargs)
         # No middleware in pipeline, call superclass' send

tests/integration/test_graphclient.py

@@ -49,7 +49,7 @@ def test_graph_client_with_custom_settings():
     assert response.status_code == 200
 
 
-def test_client_factory_with_custom_middleware():
+def test_graph_client_with_custom_middleware():
     """
     Test client factory works with user provided middleware
     """
@@ -62,3 +62,34 @@ def test_client_factory_with_custom_middleware():
         'https://proxy.apisandbox.msdn.microsoft.com/svc?url=https://graph.microsoft.com/v1.0/me'
     )
     assert response.status_code == 200
+
+
+def test_graph_client_adds_context_to_request():
+    """
+    Test the graph client adds a context object to a request
+    """
+    credential = _CustomTokenCredential()
+    scopes = ['User.Read.All']
+    client = GraphClient(credential=credential)
+    response = client.get(
+        'https://proxy.apisandbox.msdn.microsoft.com/svc?url=https://graph.microsoft.com/v1.0/me',
+        scopes=scopes
+    )
+    assert response.status_code == 200
+    assert hasattr(response.request, 'context')
+
+
+def test_graph_client_picks_options_from_kwargs():
+    """
+    Test the graph client picks middleware options from kwargs and sets them in the context
+    """
+    credential = _CustomTokenCredential()
+    scopes = ['User.Read.All']
+    client = GraphClient(credential=credential)
+    response = client.get(
+        'https://proxy.apisandbox.msdn.microsoft.com/svc?url=https://graph.microsoft.com/v1.0/me',
+        scopes=scopes
+    )
+    assert response.status_code == 200
+    assert 'scopes' in response.request.context.middleware_control.keys()
+    assert response.request.context.middleware_control['scopes'] == scopes

tests/integration/test_http_client_factory.py

@@ -64,3 +64,36 @@ def test_client_factory_with_custom_middleware():
         'https://proxy.apisandbox.msdn.microsoft.com/svc?url=https://graph.microsoft.com/v1.0/me'
     )
     assert response.status_code == 200
+
+
+def test_context_object_is_attached_to_requests_from_client_factory():
+    """
+    Test that requests from a native HTTP client have a context object attached
+    """
+    credential = _CustomTokenCredential()
+    middleware = [
+        AuthorizationHandler(credential),
+    ]
+    client = HTTPClientFactory().create_with_custom_middleware(middleware)
+    response = client.get(
+        'https://proxy.apisandbox.msdn.microsoft.com/svc?url=https://graph.microsoft.com/v1.0/me'
+    )
+    assert response.status_code == 200
+    assert hasattr(response.request, 'context')
+
+
+def test_middleware_control_is_empty_for_requests_from_client_factory():
+    """
+    Test that requests from a native HTTP client have no middlware options in the middleware
+    control
+    """
+    credential = _CustomTokenCredential()
+    middleware = [
+        AuthorizationHandler(credential),
+    ]
+    client = HTTPClientFactory().create_with_custom_middleware(middleware)
+    response = client.get(
+        'https://proxy.apisandbox.msdn.microsoft.com/svc?url=https://graph.microsoft.com/v1.0/me'
+    )
+    assert response.status_code == 200
+    assert response.request.context.middleware_control == {}

tests/unit/test_auth_handler.py

@@ -1,28 +1,31 @@
-import unittest
+import pytest
 
-from msgraphcore.constants import AUTH_MIDDLEWARE_OPTIONS
 from msgraphcore.middleware.authorization import AuthorizationHandler
-from msgraphcore.middleware.options.auth_middleware_options import AuthMiddlewareOptions
-from msgraphcore.middleware.options.middleware_control import middleware_control
+from msgraphcore.middleware.request_context import RequestContext
 
 
-class TestAuthorizationHandler(unittest.TestCase):
-    def test_auth_options_override_default_scopes(self):
-        auth_option = ['email.read']
-        default_scopes = ['.default']
+def test_context_options_override_default_scopes():
+    """ Test scopes found in the request context override default scopes"""
+    default_scopes = ['.default']
+    middleware_control = {
+        'scopes': ['email.read'],
+    }
+    request_context = RequestContext(middleware_control, {})
 
-        middleware_control.set(AUTH_MIDDLEWARE_OPTIONS, AuthMiddlewareOptions(auth_option))
-        auth_handler = AuthorizationHandler(None, scopes=default_scopes)
+    auth_handler = AuthorizationHandler(None, scopes=default_scopes)
 
-        auth_handler_scopes = auth_handler.get_scopes()
-        self.assertEqual(auth_option, auth_handler_scopes)
+    auth_handler_scopes = auth_handler.get_scopes(request_context)
+    assert auth_handler_scopes == middleware_control['scopes']
 
-    def test_auth_handler_get_scopes_does_not_overwrite_default_scopes(self):
-        auth_option = ['email.read']
-        default_scopes = ['.default']
 
-        middleware_control.set(AUTH_MIDDLEWARE_OPTIONS, AuthMiddlewareOptions(auth_option))
-        auth_handler = AuthorizationHandler(None, scopes=default_scopes)
-        auth_handler.get_scopes()
+def test_auth_handler_get_scopes_does_not_overwrite_default_scopes():
+    default_scopes = ['.default']
+    middleware_control = {
+        'scopes': ['email.read'],
+    }
+    request_context = RequestContext(middleware_control, {})
+    auth_handler = AuthorizationHandler(None, scopes=default_scopes)
 
-        self.assertEqual(auth_handler.scopes, default_scopes)
+    auth_handler_scopes = auth_handler.get_scopes(request_context)
+
+    assert auth_handler.scopes == default_scopes