Tests for request helper

Author: Henry Chan

test_requirements.txt

@@ -1,2 +1,7 @@
-pytest==5.3.2
+# Install package deps
+-e .
+
+# Test deps
+pytest==4.6.9
 pytest-cov==2.8.1
+six==1.13.0

tests/conftest.py

@@ -4,9 +4,10 @@
 import workos
 
 class MockResponse(object):
-    def __init__(self, response_dict, status_code):
+    def __init__(self, response_dict, status_code, headers=None):
         self.response_dict = response_dict
         self.status_code = status_code
+        self.headers = {} if headers is None else headers
 
     def json(self):
         return self.response_dict
@@ -25,10 +26,26 @@ def set_api_key_and_project_id(set_api_key, set_project_id):
 
 @pytest.fixture
 def mock_request_method(monkeypatch):
-    def _mock_request_method(method, response_dict, status_code):
-        def mock_response(*args, **kwargs):
-            return MockResponse(response_dict, status_code)
+    def inner(method, response_dict, status_code, headers=None):
+        def mock(*args, **kwargs):
+            return MockResponse(response_dict, status_code, headers=headers)
 
-        monkeypatch.setattr(requests, method, mock_response)
+        monkeypatch.setattr(requests, method, mock)
 
-    return _mock_request_method
+    return inner
+
+@pytest.fixture
+def capture_and_mock_requests(monkeypatch):
+    def inner():
+        captured_requests = []
+
+        def capture(*args, **kwargs):
+            captured_requests.append((args, kwargs))
+            return MockResponse({}, 200)
+
+        monkeypatch.setattr(requests, 'get', capture)
+        monkeypatch.setattr(requests, 'post', capture)
+
+        return captured_requests
+
+    return inner

tests/test_sso.py

@@ -1,11 +1,11 @@
 import json
-from urllib.parse import parse_qsl, urlparse
+from six.moves.urllib.parse import parse_qsl, urlparse
 
 import pytest
 
 import workos
 from workos.sso import SSO
-from workos.utils.requests import RESPONSE_TYPE_CODE
+from workos.utils.request import RESPONSE_TYPE_CODE
 
 class TestSSO(object):
     @pytest.fixture(autouse=True)
@@ -62,7 +62,7 @@ def test_get_profile_returns_expected_workosprofile_object(
         }
 
         mock_request_method('post', response_dict, 200)
-        
+
         profile = self.sso.get_profile(123)
 
         assert profile.to_dict() == mock_profile

tests/utils/__init__.py

@@ -0,0 +1,87 @@
+import pytest
+
+from workos.exceptions import (
+    AuthenticationException, AuthorizationException, BadRequestException,
+    ServerException,
+)
+from workos.utils.request import RequestHelper, BASE_HEADERS
+
+STATUS_CODE_TO_EXCEPTION_MAPPING = {
+    400: BadRequestException,
+    401: AuthenticationException,
+    403: AuthorizationException,
+    500: ServerException,
+}
+
+class TestRequestHelper(object):
+    def test_set_base_api_url(self):
+        pass
+
+    def test_request_raises_expected_exception_for_status_code(
+        self, mock_request_method
+    ):
+        request_helper = RequestHelper()
+
+        for status_code, exception in STATUS_CODE_TO_EXCEPTION_MAPPING.items():
+            mock_request_method('get', {}, status_code)
+
+            with pytest.raises(exception):
+                request_helper.request('bad_place')
+
+    def test_request_exceptions_include_expected_request_data(
+        self, mock_request_method
+    ):
+        request_helper = RequestHelper()
+
+        request_id = 'request-123'
+        response_message = 'stuff happened'
+
+        for status_code, exception in STATUS_CODE_TO_EXCEPTION_MAPPING.items():
+            mock_request_method(
+                'get',
+                {'message': response_message, },
+                status_code,
+                headers={'X-Request-ID': request_id}
+            )
+
+            try:
+                request_helper.request('bad_place')
+            except exception as ex:
+                assert ex.message == response_message
+                assert ex.request_id == request_id
+            except Exception as ex:
+                # This'll fail for sure here but... just using the nice error that'd come up
+                assert ex.__class__ == exception
+
+    def test_request_bad_body_raises_expected_exception_with_request_data(
+        self, mock_request_method
+    ):
+        request_id = 'request-123'
+
+        mock_request_method(
+            'get',
+            'this_isnt_json',
+            200,
+            headers={'X-Request-ID': request_id}
+        )
+
+        try:
+            RequestHelper().request('bad_place')
+        except ServerException as ex:
+            assert ex.message == None
+            assert ex.request_id == request_id
+        except Exception as ex:
+            # This'll fail for sure here but... just using the nice error that'd come up
+            assert ex.__class__ == ServerException
+
+    def test_request_includes_base_headers(self, capture_and_mock_requests):
+        requests = capture_and_mock_requests()
+
+        RequestHelper().request('ok_place')
+
+        assert len(requests) == 1
+
+        base_headers = set(BASE_HEADERS.items()) 
+        headers = set(requests[0][1]['headers'].items())
+
+        assert base_headers.issubset(headers)

tests/utils/test_requests.py

@@ -5,7 +5,7 @@
 import workos
 from workos.exceptions import ConfigurationException
 from workos.resources.sso import WorkOSProfile
-from workos.utils.requests import RequestHelper, RESPONSE_TYPE_CODE, REQUEST_METHOD_POST
+from workos.utils.request import RequestHelper, RESPONSE_TYPE_CODE, REQUEST_METHOD_POST
 
 AUTHORIZATION_PATH = 'sso/authorize'
 TOKEN_PATH = 'sso/token'

workos/sso.py

@@ -44,6 +44,7 @@ def request(self, path, method=REQUEST_METHOD_GET, params=None):
             dict: Response from WorkOS
         '''
         url = self.generate_api_url(path)
+        
         response = getattr(requests, method)(url, headers=BASE_HEADERS, params=params)
 
         status_code = response.status_code