-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* TDL-16368 ad request timeout * added coverage * resolved pylint * added connectionerror in backoff * updated readme * Update README.md Co-authored-by: Umang Agrawal <80704207+umangagrawal-crest@users.noreply.github.com> * added factor in backoff * resolved commets * resolved comments * resolved comments Co-authored-by: Umang Agrawal <80704207+umangagrawal-crest@users.noreply.github.com>
- Loading branch information
1 parent
a3adb6d
commit d195b4b
Showing
5 changed files
with
191 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| from tap_recharge.client import RechargeClient | ||
| import unittest | ||
| from unittest import mock | ||
| from requests.exceptions import Timeout, ConnectionError | ||
|
|
||
| class TestBackoffError(unittest.TestCase): | ||
| ''' | ||
| Test that backoff logic works properly. | ||
| ''' | ||
| @mock.patch('tap_recharge.client.requests.Session.request') | ||
| @mock.patch('tap_recharge.client.RechargeClient.check_access_token') | ||
| def test_request_timeout_and_backoff(self, mock_get_token, mock_request): | ||
| """ | ||
| Check whether the request backoffs properly for request() for 5 times in case of Timeout error. | ||
| """ | ||
| mock_request.side_effect = Timeout | ||
| client = RechargeClient("dummy_access_token", "dummy_user_agent", 300) | ||
| with self.assertRaises(Timeout): | ||
| client.request("GET") | ||
| self.assertEquals(mock_request.call_count, 5) | ||
|
|
||
| @mock.patch('tap_recharge.client.requests.Session.request') | ||
| def test_check_access_token_timeout_and_backoff(self, mocked_request): | ||
| """ | ||
| Check whether the request backoffs properly for __enter__() for 5 times in case of Timeout error. | ||
| """ | ||
| mocked_request.side_effect = Timeout | ||
|
|
||
| config = { | ||
| "access_token": "dummy_at", | ||
| "user_agent": "dummy_ua" | ||
| } | ||
| # initialize 'RechargeClient' | ||
| try: | ||
| with RechargeClient( | ||
| config['access_token'], | ||
| config['user_agent'], | ||
| config.get('request_timeout')) as client: | ||
| pass | ||
| except Timeout: | ||
| pass | ||
| # verify that we backoff for 5 times | ||
| self.assertEquals(mocked_request.call_count, 5) | ||
|
|
||
| @mock.patch('tap_recharge.client.requests.Session.request') | ||
| def test_check_access_token_connection_error_and_backoff(self, mocked_request): | ||
| """ | ||
| Check whether the request backoffs properly for __enter__() for 5 times in case of Timeout error. | ||
| """ | ||
| mocked_request.side_effect = ConnectionError | ||
|
|
||
| config = { | ||
| "access_token": "dummy_at", | ||
| "user_agent": "dummy_ua" | ||
| } | ||
| # initialize 'RechargeClient' | ||
| try: | ||
| with RechargeClient( | ||
| config['access_token'], | ||
| config['user_agent'], | ||
| config.get('request_timeout')) as client: | ||
| pass | ||
| except ConnectionError: | ||
| pass | ||
| # verify that we backoff for 5 times | ||
| self.assertEquals(mocked_request.call_count, 5) | ||
|
|
||
| class MockResponse(): | ||
| ''' | ||
| Mock response object for the requests call | ||
| ''' | ||
| def __init__(self, resp, status_code, content=[""], headers=None, raise_error=False, text={}, links=""): | ||
| self.json_data = resp | ||
| self.status_code = status_code | ||
| self.content = content | ||
| self.headers = headers | ||
| self.raise_error = raise_error | ||
| self.text = text | ||
| self.reason = "error" | ||
| self.links = links | ||
|
|
||
| def prepare(self): | ||
| return (self.json_data, self.status_code, self.content, self.headers, self.raise_error) | ||
|
|
||
| def json(self): | ||
| return self.text | ||
|
|
||
| class TestRequestTimeoutValue(unittest.TestCase): | ||
| ''' | ||
| Test that request timeout parameter works properly in various cases | ||
| ''' | ||
| @mock.patch('tap_recharge.client.requests.Session.request', return_value = MockResponse("", status_code=200)) | ||
| @mock.patch('tap_recharge.client.RechargeClient.check_access_token') | ||
| def test_config_provided_request_timeout(self, mock_get, mock_request): | ||
| """ | ||
| Unit tests to ensure that request timeout is set based on config value | ||
| """ | ||
| config = {"access_token": "dummy_at", "user_agent": "dummy_ua", "request_timeout": 100} | ||
| client = RechargeClient(**config) | ||
| client.request("GET", "dummy_path") | ||
|
|
||
| mock_request.assert_called_with('GET', 'https://api.rechargeapps.com/dummy_path', stream=True, timeout=100.0, headers={'X-Recharge-Access-Token': 'dummy_at', 'Accept': 'application/json', 'User-Agent': 'dummy_ua'}) | ||
|
|
||
| @mock.patch('tap_recharge.client.requests.Session.request', return_value = MockResponse("", status_code=200)) | ||
| @mock.patch('tap_recharge.client.RechargeClient.check_access_token') | ||
| def test_default_value_request_timeout(self, mock_get, mock_request): | ||
| """ | ||
| Unit tests to ensure that request timeout is set based default value | ||
| """ | ||
| config = {"access_token": "dummy_at", "user_agent": "dummy_ua"} | ||
| client = RechargeClient(**config) | ||
| client.request("GET", "dummy_path") | ||
|
|
||
| mock_request.assert_called_with('GET', 'https://api.rechargeapps.com/dummy_path', stream=True, timeout=300, headers={'X-Recharge-Access-Token': 'dummy_at', 'Accept': 'application/json', 'User-Agent': 'dummy_ua'}) | ||
|
|
||
| @mock.patch('tap_recharge.client.requests.Session.request', return_value = MockResponse("", status_code=200)) | ||
| @mock.patch('tap_recharge.client.RechargeClient.check_access_token') | ||
| def test_config_provided_empty_request_timeout(self, mock_get, mock_request): | ||
| """ | ||
| Unit tests to ensure that request timeout is set based on default value if empty value is given in config | ||
| """ | ||
| config = {"access_token": "dummy_at", "user_agent": "dummy_ua", "request_timeout": ""} | ||
| client = RechargeClient(**config) | ||
| client.request("GET", "dummy_path") | ||
|
|
||
| mock_request.assert_called_with('GET', 'https://api.rechargeapps.com/dummy_path', stream=True, timeout=300.0, headers={'X-Recharge-Access-Token': 'dummy_at', 'Accept': 'application/json', 'User-Agent': 'dummy_ua'}) | ||
|
|
||
| @mock.patch('tap_recharge.client.requests.Session.request', return_value = MockResponse("", status_code=200)) | ||
| @mock.patch('tap_recharge.client.RechargeClient.check_access_token') | ||
| def test_config_provided_string_request_timeout(self, mock_get, mock_request): | ||
| """ | ||
| Unit tests to ensure that request timeout is set based on config string value | ||
| """ | ||
| config = {"access_token": "dummy_at", "user_agent": "dummy_ua", "request_timeout": "100"} | ||
| client = RechargeClient(**config) | ||
| client.request("GET", "dummy_path") | ||
|
|
||
| mock_request.assert_called_with('GET', 'https://api.rechargeapps.com/dummy_path', stream=True, timeout=100.0, headers={'X-Recharge-Access-Token': 'dummy_at', 'Accept': 'application/json', 'User-Agent': 'dummy_ua'}) | ||
|
|
||
| @mock.patch('tap_recharge.client.requests.Session.request', return_value = MockResponse("", status_code=200)) | ||
| @mock.patch('tap_recharge.client.RechargeClient.check_access_token') | ||
| def test_config_provided_float_request_timeout(self, mock_get, mock_request): | ||
| """ | ||
| Unit tests to ensure that request timeout is set based on config float value | ||
| """ | ||
| config = {"access_token": "dummy_at", "user_agent": "dummy_ua", "request_timeout": 100.8} | ||
| client = RechargeClient(**config) | ||
| client.request("GET", "dummy_path") | ||
|
|
||
| mock_request.assert_called_with('GET', 'https://api.rechargeapps.com/dummy_path', stream=True, timeout=100.8, headers={'X-Recharge-Access-Token': 'dummy_at', 'Accept': 'application/json', 'User-Agent': 'dummy_ua'}) |