Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom auth httpclient #516

Open
wants to merge 2 commits into
base: custom-auth-decorator-class
Choose a base branch
from
Open

Custom auth httpclient #516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54d31ad
updated httpclient class
Mar 22, 2024
7c3a564
updated test
Mar 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
TESTS_REQUIRES = [
'flake8',
'pytest==7.0.1',
'pytest-mock>=3.5.1',
'pytest-mock==3.13.0',
'coverage==6.2',
'pytest-cov',
'importlib-metadata==4.2',
Expand Down
17 changes: 14 additions & 3 deletions splitio/api/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@ class HttpClient(object):
AUTH_URL = 'https://auth.split.io/api'
TELEMETRY_URL = 'https://telemetry.split.io/api'

def __init__(self, timeout=None, sdk_url=None, events_url=None, auth_url=None, telemetry_url=None):
def __init__(self, request_decorator, timeout=None, sdk_url=None, events_url=None, auth_url=None, telemetry_url=None):
"""
Class constructor.

:param request_decorator: RequestDecorator instance
:type request_decorator: splitio.api.request_decorator.RequestDecorator
:param timeout: How many milliseconds to wait until the server responds.
:type timeout: int
:param sdk_url: Optional alternative sdk URL.
Expand All @@ -50,6 +52,7 @@ def __init__(self, timeout=None, sdk_url=None, events_url=None, auth_url=None, t
'auth': auth_url if auth_url is not None else self.AUTH_URL,
'telemetry': telemetry_url if telemetry_url is not None else self.TELEMETRY_URL,
}
self._request_decorator = request_decorator

def _build_url(self, server, path):
"""
Expand Down Expand Up @@ -101,7 +104,9 @@ def get(self, server, path, sdk_key, query=None, extra_headers=None): # pylint:
headers.update(extra_headers)

try:
response = requests.get(
session = requests.Session()
session = self._request_decorator.decorate_headers(session)
response = session.get(
self._build_url(server, path),
params=query,
headers=headers,
Expand All @@ -110,6 +115,8 @@ def get(self, server, path, sdk_key, query=None, extra_headers=None): # pylint:
return HttpResponse(response.status_code, response.text)
except Exception as exc: # pylint: disable=broad-except
raise HttpClientException('requests library is throwing exceptions') from exc
finally:
session.close()

def post(self, server, path, sdk_key, body, query=None, extra_headers=None): # pylint: disable=too-many-arguments
"""
Expand Down Expand Up @@ -137,7 +144,9 @@ def post(self, server, path, sdk_key, body, query=None, extra_headers=None): #
headers.update(extra_headers)

try:
response = requests.post(
session = requests.Session()
session = self._request_decorator.decorate_headers(session)
response = session.post(
self._build_url(server, path),
json=body,
params=query,
Expand All @@ -147,3 +156,5 @@ def post(self, server, path, sdk_key, body, query=None, extra_headers=None): #
return HttpResponse(response.status_code, response.text)
except Exception as exc: # pylint: disable=broad-except
raise HttpClientException('requests library is throwing exceptions') from exc
finally:
session.close()
88 changes: 80 additions & 8 deletions tests/api/test_httpclient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
"""HTTPClient test module."""
import pytest

from splitio.api import client
from splitio.api.request_decorator import RequestDecorator, NoOpHeaderDecorator, UserCustomHeaderDecorator

class HttpClientTests(object):
"""Http Client test cases."""
Expand All @@ -12,8 +14,9 @@ def test_get(self, mocker):
response_mock.text = 'ok'
get_mock = mocker.Mock()
get_mock.return_value = response_mock
mocker.patch('splitio.api.client.requests.get', new=get_mock)
httpclient = client.HttpClient()
mocker.patch('splitio.api.client.requests.Session.get', new=get_mock)

httpclient = client.HttpClient(RequestDecorator(NoOpHeaderDecorator()))
response = httpclient.get('sdk', '/test1', 'some_api_key', {'param1': 123}, {'h1': 'abc'})
call = mocker.call(
client.HttpClient.SDK_URL + '/test1',
Expand Down Expand Up @@ -44,8 +47,8 @@ def test_get_custom_urls(self, mocker):
response_mock.text = 'ok'
get_mock = mocker.Mock()
get_mock.return_value = response_mock
mocker.patch('splitio.api.client.requests.get', new=get_mock)
httpclient = client.HttpClient(sdk_url='https://sdk.com', events_url='https://events.com')
mocker.patch('splitio.api.client.requests.Session.get', new=get_mock)
httpclient = client.HttpClient(RequestDecorator(NoOpHeaderDecorator()), sdk_url='https://sdk.com', events_url='https://events.com')
response = httpclient.get('sdk', '/test1', 'some_api_key', {'param1': 123}, {'h1': 'abc'})
call = mocker.call(
'https://sdk.com/test1',
Expand All @@ -69,6 +72,40 @@ def test_get_custom_urls(self, mocker):
assert response.body == 'ok'
assert get_mock.mock_calls == [call]

def test_get_custom_headers(self, mocker):
"""Test HTTP GET verb requests."""
response_mock = mocker.Mock()
response_mock.status_code = 200
response_mock.text = 'ok'
get_mock = mocker.Mock()
get_mock.return_value = response_mock
mocker.patch('splitio.api.client.requests.Session.get', new=get_mock)

class MyCustomDecorator(UserCustomHeaderDecorator):
def get_header_overrides(self):
return {"UserCustomHeader": "value", "AnotherCustomHeader": "val"}

global current_session
current_session = None
class RequestDecoratorWrapper(RequestDecorator):
def decorate_headers(self, session):
global current_session
current_session = session
return RequestDecorator.decorate_headers(self, session)

httpclient = client.HttpClient(RequestDecoratorWrapper(MyCustomDecorator()))
response = httpclient.get('sdk', '/test1', 'some_api_key', {'param1': 123}, {'h1': 'abc'})
call = mocker.call(
client.HttpClient.SDK_URL + '/test1',
headers={'Authorization': 'Bearer some_api_key', 'h1': 'abc', 'Content-Type': 'application/json'},
params={'param1': 123},
timeout=None
)
assert current_session.headers["UserCustomHeader"] == "value"
assert current_session.headers["AnotherCustomHeader"] == "val"
assert response.status_code == 200
assert response.body == 'ok'
assert get_mock.mock_calls == [call]

def test_post(self, mocker):
"""Test HTTP GET verb requests."""
Expand All @@ -77,8 +114,8 @@ def test_post(self, mocker):
response_mock.text = 'ok'
get_mock = mocker.Mock()
get_mock.return_value = response_mock
mocker.patch('splitio.api.client.requests.post', new=get_mock)
httpclient = client.HttpClient()
mocker.patch('splitio.api.client.requests.Session.post', new=get_mock)
httpclient = client.HttpClient(RequestDecorator(NoOpHeaderDecorator()))
response = httpclient.post('sdk', '/test1', 'some_api_key', {'p1': 'a'}, {'param1': 123}, {'h1': 'abc'})
call = mocker.call(
client.HttpClient.SDK_URL + '/test1',
Expand Down Expand Up @@ -111,8 +148,8 @@ def test_post_custom_urls(self, mocker):
response_mock.text = 'ok'
get_mock = mocker.Mock()
get_mock.return_value = response_mock
mocker.patch('splitio.api.client.requests.post', new=get_mock)
httpclient = client.HttpClient(sdk_url='https://sdk.com', events_url='https://events.com')
mocker.patch('splitio.api.client.requests.Session.post', new=get_mock)
httpclient = client.HttpClient(RequestDecorator(NoOpHeaderDecorator()), sdk_url='https://sdk.com', events_url='https://events.com')
response = httpclient.post('sdk', '/test1', 'some_api_key', {'p1': 'a'}, {'param1': 123}, {'h1': 'abc'})
call = mocker.call(
'https://sdk.com' + '/test1',
Expand All @@ -137,3 +174,38 @@ def test_post_custom_urls(self, mocker):
assert response.status_code == 200
assert response.body == 'ok'
assert get_mock.mock_calls == [call]

def test_post_custom_headers(self, mocker):
"""Test HTTP GET verb requests."""
response_mock = mocker.Mock()
response_mock.status_code = 200
response_mock.text = 'ok'
get_mock = mocker.Mock()
get_mock.return_value = response_mock
mocker.patch('splitio.api.client.requests.Session.post', new=get_mock)
class MyCustomDecorator(UserCustomHeaderDecorator):
def get_header_overrides(self):
return {"UserCustomHeader": "value", "AnotherCustomHeader": "val"}

global current_session
current_session = None
class RequestDecoratorWrapper(RequestDecorator):
def decorate_headers(self, session):
global current_session
current_session = session
return RequestDecorator.decorate_headers(self, session)

httpclient = client.HttpClient(RequestDecoratorWrapper(MyCustomDecorator()))
response = httpclient.post('sdk', '/test1', 'some_api_key', {'p1': 'a'}, {'param1': 123}, {'h1': 'abc'})
call = mocker.call(
client.HttpClient.SDK_URL + '/test1',
json={'p1': 'a'},
headers={'Authorization': 'Bearer some_api_key', 'h1': 'abc', 'Content-Type': 'application/json'},
params={'param1': 123},
timeout=None
)
assert current_session.headers["UserCustomHeader"] == "value"
assert current_session.headers["AnotherCustomHeader"] == "val"
assert response.status_code == 200
assert response.body == 'ok'
assert get_mock.mock_calls == [call]