def test_read_only_mode(self, method):
"""
Saving is disabled on the data set.
"""
api_data_set = APIDataSet(url=TEST_URL, method=method)
with pytest.raises(DataSetError, match="is a read only data set type"):
api_data_set.save({})
def test_socket_error(self, requests_mocker, method):
api_data_set = APIDataSet(
url=TEST_URL, method=method, params=TEST_PARAMS, headers=TEST_HEADERS
)
requests_mocker.register_uri(method, TEST_URL_WITH_PARAMS, exc=socket.error)
with pytest.raises(DataSetError, match="Failed to connect"):
api_data_set.load()
def test_http_error(self, requests_mocker, method):
api_data_set = APIDataSet(
url=TEST_URL, method=method, params=TEST_PARAMS, headers=TEST_HEADERS
)
requests_mocker.register_uri(
method,
TEST_URL_WITH_PARAMS,
headers=TEST_HEADERS,
text="Nope, not found",
status_code=requests.codes.FORBIDDEN,
)
with pytest.raises(DataSetError, match="Failed to fetch data"):
api_data_set.load()
def test_successfully_load_with_response(self, requests_mocker, method):
api_data_set = APIDataSet(
url=TEST_URL, method=method, params=TEST_PARAMS, headers=TEST_HEADERS
)
requests_mocker.register_uri(
method,
TEST_URL_WITH_PARAMS,
headers=TEST_HEADERS,
text=TEST_TEXT_RESPONSE_DATA,
)
response = api_data_set.load()
assert isinstance(response, requests.Response)
assert response.text == TEST_TEXT_RESPONSE_DATA
def test_credentials_auth_error(self, method):
"""
If ``auth`` and ``credentials`` are both provided,
the constructor should raise a ValueError.
"""
with pytest.raises(ValueError, match="both auth and credentials"):
APIDataSet(url=TEST_URL, method=method, auth=[], credentials=[])
def test_exists_ok(self, requests_mocker, method):
"""
If the file actually exists and server responds 200,
``exists()`` should return True
"""
api_data_set = APIDataSet(
url=TEST_URL, method=method, params=TEST_PARAMS, headers=TEST_HEADERS
)
requests_mocker.register_uri(
method,
TEST_URL_WITH_PARAMS,
headers=TEST_HEADERS,
text=TEST_TEXT_RESPONSE_DATA,
)
assert api_data_set.exists()
def test_exists_http_error(self, requests_mocker, method):
"""
In case of an unexpected HTTP error,
``exists()`` should not silently catch it.
"""
api_data_set = APIDataSet(
url=TEST_URL, method=method, params=TEST_PARAMS, headers=TEST_HEADERS
)
requests_mocker.register_uri(
method,
TEST_URL_WITH_PARAMS,
headers=TEST_HEADERS,
text="Nope, not found",
status_code=requests.codes.FORBIDDEN,
)
with pytest.raises(DataSetError, match="Failed to fetch data"):
api_data_set.exists()
def test_successful_json_load_with_response(self, requests_mocker, method):
api_data_set = APIDataSet(
url=TEST_URL,
method=method,
json=TEST_JSON_RESPONSE_DATA,
headers=TEST_HEADERS,
)
requests_mocker.register_uri(
method,
TEST_URL,
headers=TEST_HEADERS,
text=json.dumps(TEST_JSON_RESPONSE_DATA),
)
response = api_data_set.load()
assert isinstance(response, requests.Response)
assert response.json() == TEST_JSON_RESPONSE_DATA
def test_auth_sequence(self, requests_mocker, method, auth_seq, auth_kwarg):
"""
``auth`` and ``credentials`` should be able to be any Iterable.
"""
kwargs = {
"url": TEST_URL,
"method": method,
"params": TEST_PARAMS,
"headers": TEST_HEADERS,
auth_kwarg: auth_seq,
}
api_data_set = APIDataSet(**kwargs)
requests_mocker.register_uri(
method,
TEST_URL_WITH_PARAMS,
headers=TEST_HEADERS,
text=TEST_TEXT_RESPONSE_DATA,
)
response = api_data_set.load()
assert isinstance(response, requests.Response)
assert response.text == TEST_TEXT_RESPONSE_DATA