Fix #33: allow connection configuration via environment variables.

The environment variable UMAPI_MOCK controls whether the umapi_client can be used with a mock server: either a `proxy` which accepts http and relays requests to the actual server via https, recording requests and responses; or a `playback` robot which accepts http, doesn't require auth, and simply plays back the server answers from a prior run.  Both these modes are used by the user_sync test_framework.

Author: adobeDan

tests/test_connections.py

@@ -21,15 +21,18 @@
 import time
 from email.utils import formatdate
 
-import six
 import mock
 import pytest
 import requests
+import six
 
 from conftest import mock_connection_params, MockResponse
-from umapi_client import Connection, UnavailableError, ServerError, RequestError, UserAction, GroupTypes, \
-    IdentityTypes, RoleTypes
+
+from umapi_client import Connection
+from umapi_client import ArgumentError, UnavailableError, ServerError, RequestError
+from umapi_client import UserAction, GroupTypes, IdentityTypes, RoleTypes
 from umapi_client import __version__ as umapi_version
+from umapi_client.auth import Auth
 
 
 def test_remote_status_success():
@@ -78,6 +81,35 @@ def test_ua_string_additional():
     assert ua_header.startswith("additional/1.0 umapi-client/" + umapi_version)
 
 
+def test_mock_proxy_get():
+    with mock.patch("umapi_client.connection.requests.Session.get") as mock_get:
+        mock_get.return_value = MockResponse(200, body=["test", "body"])
+        with mock.patch("umapi_client.connection.os.getenv") as mock_getenv:
+            mock_getenv.return_value = "proxy"
+            conn = Connection(**mock_connection_params)
+            conn.make_call("").json()
+            mock_get.assert_called_with('http://test/', auth='N/A', timeout=120.0)
+
+
+def test_mock_playback_get():
+    with mock.patch("umapi_client.connection.requests.Session.get") as mock_get:
+        mock_get.return_value = MockResponse(200, body=["test", "body"])
+        with mock.patch("umapi_client.connection.os.getenv") as mock_getenv:
+            mock_getenv.return_value = "playback"
+            conn = Connection(**mock_connection_params)
+            conn.make_call("").json()
+            assert mock_get.call_args[0][0] == 'http://test/'
+            assert isinstance(mock_get.call_args[1]['auth'], Auth)
+
+
+def test_mock_proxy_get():
+    with mock.patch("umapi_client.connection.requests.Session.get") as mock_get:
+        mock_get.return_value = MockResponse(200, body=["test", "body"])
+        with mock.patch("umapi_client.connection.os.getenv") as mock_getenv:
+            mock_getenv.return_value = "error"
+            pytest.raises(ArgumentError, Connection, tuple(), mock_connection_params)
+
+
 def test_get_success():
     with mock.patch("umapi_client.connection.requests.Session.get") as mock_get:
         mock_get.return_value = MockResponse(200, body=["test", "body"])

umapi_client/connection.py

@@ -20,6 +20,7 @@
 
 import json
 import logging
+import os
 from email.utils import parsedate_tz, mktime_tz
 from platform import python_version, version as platform_version
 from random import randint
@@ -39,6 +40,7 @@ class Connection:
     An org-specific, authorized connection to the UMAPI service.  Each method
     makes a single call on the endpoint and returns the result (or raises an error).
     """
+    mock_env_var = "UMAPI_MOCK"
 
     def __init__(self,
                  org_id,
@@ -98,6 +100,21 @@ def __init__(self,
         Additional keywords are allowed to make it easy to pass a big dictionary with other values
         :param kwargs: any keywords passed that we ignore.
         """
+        # for testing we mock the server, either by using an http relay
+        # which relays and records the requests and responses, or by
+        # using a robot which plays back a previously recorded run.
+        mock_spec = os.getenv(self.mock_env_var, None)
+        if mock_spec:
+            if mock_spec not in ["proxy", "playback"]:
+                raise ArgumentError("Unknown value for %s: %s" % (self.mock_env_var, mock_spec))
+            if logger: logger.warning("%s override specified as '%s'", self.mock_env_var, mock_spec)
+            # mocked servers don't support https
+            if user_management_endpoint.lower().startswith("https://"):
+                user_management_endpoint = "http" + user_management_endpoint[5:]
+            # playback servers don't use authentication/authorization
+            if mock_spec == "playback":
+                auth = Auth("mock", "mock")
+
         self.org_id = str(org_id)
         self.endpoint = user_management_endpoint
         self.test_mode = test_mode