Add ability to forward request kwargs (#48)

* For example, if trying to get feature toggles from on-prem Unleash server, being able to pass `verify=False` to requests would allow for bypassing self-signed certificate verification
* Also, refactored unit test to reduce code duplication

Author: briandcho

UnleashClient/__init__.py

@@ -28,6 +28,7 @@ def __init__(self,
                  disable_metrics: bool = False,
                  disable_registration: bool = False,
                  custom_headers: dict = {},
+                 custom_options: dict = {},
                  custom_strategies: dict = {},
                  cache_directory: str = None) -> None:
         """
@@ -41,6 +42,7 @@ def __init__(self,
         :param metrics_interval: Metrics refresh interval in ms, optional & defaults to 60 seconds
         :param disable_metrics: Disables sending metrics to unleash server, optional & defaults to false.
         :param custom_headers: Default headers to send to unleash server, optional & defaults to empty.
+        :param custom_options: Default requests parameters, optional & defaults to empty.
         :param custom_strategies: Dictionary of custom strategy names : custom strategy objects
         :param cache_directory: Location of the cache directory. When unset, FCache will determine the location
         """
@@ -54,6 +56,7 @@ def __init__(self,
         self.unleash_disable_metrics = disable_metrics
         self.unleash_disable_registration = disable_registration
         self.unleash_custom_headers = custom_headers
+        self.unleash_custom_options = custom_options
         self.unleash_static_context = {
             "appName": self.unleash_app_name,
             "environment": self.unleash_environment
@@ -101,6 +104,7 @@ def initialize_client(self) -> None:
             "app_name": self.unleash_app_name,
             "instance_id": self.unleash_instance_id,
             "custom_headers": self.unleash_custom_headers,
+            "custom_options": self.unleash_custom_options,
             "cache": self.cache,
             "features": self.features,
             "strategy_mapping": self.strategy_mapping
@@ -111,14 +115,16 @@ def initialize_client(self) -> None:
             "app_name": self.unleash_app_name,
             "instance_id": self.unleash_instance_id,
             "custom_headers": self.unleash_custom_headers,
+            "custom_options": self.unleash_custom_options,
             "features": self.features,
             "ondisk_cache": self.cache
         }
 
         # Register app
         if not self.unleash_disable_registration:
             register_client(self.unleash_url, self.unleash_app_name, self.unleash_instance_id,
-                            self.unleash_metrics_interval, self.unleash_custom_headers, self.strategy_mapping)
+                            self.unleash_metrics_interval, self.unleash_custom_headers,
+                            self.unleash_custom_options, self.strategy_mapping)
 
         fetch_and_load_features(**fl_args)
 

UnleashClient/api/features.py

@@ -7,7 +7,8 @@
 def get_feature_toggles(url: str,
                         app_name: str,
                         instance_id: str,
-                        custom_headers: dict) -> dict:
+                        custom_headers: dict,
+                        custom_options: dict) -> dict:
     """
     Retrieves feature flags from unleash central server.
 
@@ -19,6 +20,7 @@ def get_feature_toggles(url: str,
     :param app_name:
     :param instance_id:
     :param custom_headers:
+    :param custom_options:
     :return: Feature flags if successful, empty dict if not.
     """
     try:
@@ -31,7 +33,7 @@ def get_feature_toggles(url: str,
 
         resp = requests.get(url + FEATURES_URL,
                             headers={**custom_headers, **headers},
-                            timeout=REQUEST_TIMEOUT)
+                            timeout=REQUEST_TIMEOUT, **custom_options)
 
         if resp.status_code != 200:
             LOGGER.warning("unleash feature fetch failed!")

UnleashClient/api/metrics.py

@@ -7,7 +7,8 @@
 # pylint: disable=broad-except
 def send_metrics(url: str,
                  request_body: dict,
-                 custom_headers: dict) -> bool:
+                 custom_headers: dict,
+                 custom_options: dict) -> bool:
     """
     Attempts to send metrics to Unleash server
 
@@ -19,6 +20,7 @@ def send_metrics(url: str,
     :param instance_id:
     :param metrics_interval:
     :param custom_headers:
+    :param custom_options:
     :return: true if registration successful, false if registration unsuccessful or exception.
     """
     try:
@@ -28,7 +30,7 @@ def send_metrics(url: str,
         resp = requests.post(url + METRICS_URL,
                              data=json.dumps(request_body),
                              headers={**custom_headers, **APPLICATION_HEADERS},
-                             timeout=REQUEST_TIMEOUT)
+                             timeout=REQUEST_TIMEOUT, **custom_options)
 
         if resp.status_code != 202:
             LOGGER.warning("unleash metrics submission failed.")

UnleashClient/api/register.py

@@ -11,6 +11,7 @@ def register_client(url: str,
                     instance_id: str,
                     metrics_interval: int,
                     custom_headers: dict,
+                    custom_options: dict,
                     supported_strategies: dict) -> bool:
     """
     Attempts to register client with unleash server.
@@ -24,6 +25,7 @@ def register_client(url: str,
     :param instance_id:
     :param metrics_interval:
     :param custom_headers:
+    :param custom_options:
     :param supported_strategies:
     :return: true if registration successful, false if registration unsuccessful or exception.
     """
@@ -43,7 +45,7 @@ def register_client(url: str,
         resp = requests.post(url + REGISTER_URL,
                              data=json.dumps(registation_request),
                              headers={**custom_headers, **APPLICATION_HEADERS},
-                             timeout=REQUEST_TIMEOUT)
+                             timeout=REQUEST_TIMEOUT, **custom_options)
 
         if resp.status_code != 202:
             LOGGER.warning("unleash client registration failed.")

UnleashClient/periodic_tasks/fetch_and_load.py

@@ -9,10 +9,11 @@ def fetch_and_load_features(url: str,
                             app_name: str,
                             instance_id: str,
                             custom_headers: dict,
+                            custom_options: dict,
                             cache: FileCache,
                             features: dict,
                             strategy_mapping: dict) -> None:
-    feature_provisioning = get_feature_toggles(url, app_name, instance_id, custom_headers)
+    feature_provisioning = get_feature_toggles(url, app_name, instance_id, custom_headers, custom_options)
 
     if feature_provisioning:
         cache[FEATURES_URL] = feature_provisioning

UnleashClient/periodic_tasks/send_metrics.py

@@ -9,6 +9,7 @@ def aggregate_and_send_metrics(url: str,
                                app_name: str,
                                instance_id: str,
                                custom_headers: dict,
+                               custom_options: dict,
                                features: dict,
                                ondisk_cache: fcache.cache
                                ) -> None:
@@ -35,6 +36,6 @@ def aggregate_and_send_metrics(url: str,
         }
     }
 
-    send_metrics(url, metrics_request, custom_headers)
+    send_metrics(url, metrics_request, custom_headers, custom_options)
     ondisk_cache[METRIC_LAST_SENT_TIME] = datetime.now(timezone.utc)
     ondisk_cache.sync()

tests/unit_tests/api/test_feature.py

@@ -1,6 +1,7 @@
 import responses
+from pytest import mark, param
 from tests.utilities.mocks.mock_features import MOCK_FEATURE_RESPONSE
-from tests.utilities.testing_constants import URL, APP_NAME, INSTANCE_ID, CUSTOM_HEADERS
+from tests.utilities.testing_constants import URL, APP_NAME, INSTANCE_ID, CUSTOM_HEADERS, CUSTOM_OPTIONS
 from UnleashClient.constants import FEATURES_URL
 from UnleashClient.api import get_feature_toggles
 
@@ -9,26 +10,18 @@
 
 
 @responses.activate
-def test_get_feature_toggle_success():
-    responses.add(responses.GET, FULL_FEATURE_URL, json=MOCK_FEATURE_RESPONSE, status=200)
+@mark.parametrize("response,status,expected", (
+    param(MOCK_FEATURE_RESPONSE, 200, lambda result: result["version"] == 1, id="success"),
+    param({}, 500, lambda result: not result, id="failure"),
+))
+def test_get_feature_toggle(response, status, expected):
+    responses.add(responses.GET, FULL_FEATURE_URL, json=response, status=status)
 
     result = get_feature_toggles(URL,
                                  APP_NAME,
                                  INSTANCE_ID,
-                                 CUSTOM_HEADERS)
+                                 CUSTOM_HEADERS,
+                                 CUSTOM_OPTIONS)
 
     assert len(responses.calls) == 1
-    assert result["version"] == 1
-
-
-@responses.activate
-def test_get_feature_toggle_failure():
-    responses.add(responses.GET, FULL_FEATURE_URL, json={}, status=500)
-
-    result = get_feature_toggles(URL,
-                                 APP_NAME,
-                                 INSTANCE_ID,
-                                 CUSTOM_HEADERS)
-
-    assert len(responses.calls) == 1
-    assert not result
+    assert expected(result)

tests/unit_tests/api/test_metrics.py

@@ -1,6 +1,7 @@
 import responses
+from pytest import mark, param
 from requests import ConnectionError
-from tests.utilities.testing_constants import URL, CUSTOM_HEADERS
+from tests.utilities.testing_constants import URL, CUSTOM_HEADERS, CUSTOM_OPTIONS
 from tests.utilities.mocks.mock_metrics import MOCK_METRICS_REQUEST
 from UnleashClient.constants import METRICS_URL
 from UnleashClient.api import send_metrics
@@ -10,30 +11,15 @@
 
 
 @responses.activate
-def test_send_metrics_success():
-    responses.add(responses.POST, FULL_METRICS_URL, json={}, status=202)
+@mark.parametrize("payload,status,expected", (
+    param({"json": {}}, 202, lambda result: result, id="success"),
+    param({"json": {}}, 500, lambda result: not result, id="failure"),
+    param({"body": ConnectionError("Test connection error.")}, 200, lambda result: not result, id="exception"),
+))
+def test_send_metrics(payload, status, expected):
+    responses.add(responses.POST, FULL_METRICS_URL, **payload, status=status)
 
-    result = send_metrics(URL, MOCK_METRICS_REQUEST, CUSTOM_HEADERS)
+    result = send_metrics(URL, MOCK_METRICS_REQUEST, CUSTOM_HEADERS, CUSTOM_OPTIONS)
 
     assert len(responses.calls) == 1
-    assert result
-
-
-@responses.activate
-def test_send_metrics_failure():
-    responses.add(responses.POST, FULL_METRICS_URL, json={}, status=500)
-
-    result = send_metrics(URL, MOCK_METRICS_REQUEST, CUSTOM_HEADERS)
-
-    assert len(responses.calls) == 1
-    assert not result
-
-
-@responses.activate
-def test_register_client_exception():
-    responses.add(responses.POST, FULL_METRICS_URL, body=ConnectionError("Test connection error."), status=200)
-
-    result = send_metrics(URL, MOCK_METRICS_REQUEST, CUSTOM_HEADERS)
-
-    assert len(responses.calls) == 1
-    assert not result
+    assert expected(result)

tests/unit_tests/api/test_register.py

@@ -1,53 +1,30 @@
 import responses
+from pytest import mark, param
 from requests import ConnectionError
 from UnleashClient.constants import REGISTER_URL
 from UnleashClient.api import register_client
-from tests.utilities.testing_constants import URL, APP_NAME, INSTANCE_ID, METRICS_INTERVAL, CUSTOM_HEADERS, DEFAULT_STRATEGY_MAPPING
+from tests.utilities.testing_constants import URL, APP_NAME, INSTANCE_ID, METRICS_INTERVAL, CUSTOM_HEADERS, CUSTOM_OPTIONS, DEFAULT_STRATEGY_MAPPING
 
 
 FULL_REGISTER_URL = URL + REGISTER_URL
 
 
 @responses.activate
-def test_register_client_success():
-    responses.add(responses.POST, FULL_REGISTER_URL, json={}, status=202)
+@mark.parametrize("payload,status,expected", (
+    param({"json": {}}, 202, True, id="success"),
+    param({"json": {}}, 500, False, id="failure"),
+    param({"body": ConnectionError("Test connection error")}, 200, False, id="exception"),
+))
+def test_register_client(payload, status, expected):
+    responses.add(responses.POST, FULL_REGISTER_URL, **payload, status=status)
 
     result = register_client(URL,
                              APP_NAME,
                              INSTANCE_ID,
                              METRICS_INTERVAL,
                              CUSTOM_HEADERS,
+                             CUSTOM_OPTIONS,
                              DEFAULT_STRATEGY_MAPPING)
 
     assert len(responses.calls) == 1
-    assert result
-
-
-@responses.activate
-def test_register_client_failure():
-    responses.add(responses.POST, FULL_REGISTER_URL, json={}, status=500)
-
-    result = register_client(URL,
-                             APP_NAME,
-                             INSTANCE_ID,
-                             METRICS_INTERVAL,
-                             CUSTOM_HEADERS,
-                             DEFAULT_STRATEGY_MAPPING)
-
-    assert len(responses.calls) == 1
-    assert not result
-
-
-@responses.activate
-def test_register_client_exception():
-    responses.add(responses.POST, FULL_REGISTER_URL, body=ConnectionError("Test connection error."), status=200)
-
-    result = register_client(URL,
-                             APP_NAME,
-                             INSTANCE_ID,
-                             METRICS_INTERVAL,
-                             CUSTOM_HEADERS,
-                             DEFAULT_STRATEGY_MAPPING)
-
-    assert len(responses.calls) == 1
-    assert not result
+    assert result is expected

tests/unit_tests/periodic/test_aggregate_and_send_metrics.py

@@ -2,7 +2,7 @@
 from datetime import datetime, timezone, timedelta
 import responses
 from fcache.cache import FileCache
-from tests.utilities.testing_constants import URL, APP_NAME, INSTANCE_ID, CUSTOM_HEADERS, IP_LIST
+from tests.utilities.testing_constants import URL, APP_NAME, INSTANCE_ID, CUSTOM_HEADERS, CUSTOM_OPTIONS, IP_LIST
 from UnleashClient.constants import METRICS_URL, METRIC_LAST_SENT_TIME
 from UnleashClient.periodic_tasks import aggregate_and_send_metrics
 from UnleashClient.features import Feature
@@ -31,7 +31,7 @@ def test_aggregate_and_send_metrics():
 
     features = {"My Feature1": my_feature1, "My Feature 2": my_feature2}
 
-    aggregate_and_send_metrics(URL, APP_NAME, INSTANCE_ID, CUSTOM_HEADERS, features, cache)
+    aggregate_and_send_metrics(URL, APP_NAME, INSTANCE_ID, CUSTOM_HEADERS, CUSTOM_OPTIONS, features, cache)
 
     assert len(responses.calls) == 1
     request = json.loads(responses.calls[0].request.body)