Update the caller class

- has now ErrorResponse return values instead of None on errors
- changed parameter cafile to ca_file and its position in the init method
- Proxy has ProxyConfig Typed Dict format

Tests updates to reflect those changes
This commit is contained in:
Clemens Schwaighofer
2026-01-30 18:17:41 +09:00
parent 163b8c4018
commit 5319a059ad
2 changed files with 116 additions and 81 deletions

View File

@@ -45,14 +45,14 @@ class Caller:
def __init__( def __init__(
self, self,
header: dict[str, str], header: dict[str, str],
verify: bool = True,
timeout: int = 20, timeout: int = 20,
proxy: ProxyConfig | None = None, proxy: ProxyConfig | None = None,
cafile: str | None = None verify: bool = True,
ca_file: str | None = None
): ):
self.headers = header self.headers = header
self.timeout: int = timeout self.timeout: int = timeout
self.cafile = cafile self.ca_file = ca_file
self.verify = verify self.verify = verify
self.proxy = cast(dict[str, str], proxy) if proxy is not None else None self.proxy = cast(dict[str, str], proxy) if proxy is not None else None
@@ -93,7 +93,7 @@ class Caller:
timeout=self.__timeout(timeout), timeout=self.__timeout(timeout),
verify=self.verify, verify=self.verify,
proxies=self.proxy, proxies=self.proxy,
cert=self.cafile cert=self.ca_file
) )
if action == "post": if action == "post":
return requests.post( return requests.post(
@@ -104,7 +104,7 @@ class Caller:
timeout=self.__timeout(timeout), timeout=self.__timeout(timeout),
verify=self.verify, verify=self.verify,
proxies=self.proxy, proxies=self.proxy,
cert=self.cafile cert=self.ca_file
) )
if action == "put": if action == "put":
return requests.put( return requests.put(
@@ -115,7 +115,7 @@ class Caller:
timeout=self.__timeout(timeout), timeout=self.__timeout(timeout),
verify=self.verify, verify=self.verify,
proxies=self.proxy, proxies=self.proxy,
cert=self.cafile cert=self.ca_file
) )
if action == "patch": if action == "patch":
return requests.patch( return requests.patch(
@@ -126,7 +126,7 @@ class Caller:
timeout=self.__timeout(timeout), timeout=self.__timeout(timeout),
verify=self.verify, verify=self.verify,
proxies=self.proxy, proxies=self.proxy,
cert=self.cafile cert=self.ca_file
) )
if action == "delete": if action == "delete":
return requests.delete( return requests.delete(
@@ -136,7 +136,7 @@ class Caller:
timeout=self.__timeout(timeout), timeout=self.__timeout(timeout),
verify=self.verify, verify=self.verify,
proxies=self.proxy, proxies=self.proxy,
cert=self.cafile cert=self.ca_file
) )
return ErrorResponse( return ErrorResponse(
100, 100,

View File

@@ -2,11 +2,10 @@
PyTest: requests_handling/caller PyTest: requests_handling/caller
""" """
from typing import Any
from unittest.mock import Mock, patch from unittest.mock import Mock, patch
import pytest import pytest
import requests import requests
from corelibs.requests_handling.caller import Caller from corelibs.requests_handling.caller import Caller, ErrorResponse, ProxyConfig
class TestCallerInit: class TestCallerInit:
@@ -21,13 +20,17 @@ class TestCallerInit:
assert caller.timeout == 20 assert caller.timeout == 20
assert caller.verify is True assert caller.verify is True
assert caller.proxy is None assert caller.proxy is None
assert caller.cafile is None assert caller.ca_file is None
def test_init_with_all_params(self): def test_init_with_all_params(self):
"""Test Caller initialization with all parameters""" """Test Caller initialization with all parameters"""
header = {"Authorization": "Bearer token", "Content-Type": "application/json"} header = {"Authorization": "Bearer token", "Content-Type": "application/json"}
proxy = {"http": "http://proxy.example.com:8080", "https": "https://proxy.example.com:8080"} proxy: ProxyConfig = {
caller = Caller(header=header, verify=False, timeout=30, proxy=proxy) "type": "socks5",
"host": "proxy.example.com:8080",
"port": "8080"
}
caller = Caller(header=header, timeout=30, proxy=proxy, verify=False)
assert caller.headers == header assert caller.headers == header
assert caller.timeout == 30 assert caller.timeout == 30
@@ -58,7 +61,7 @@ class TestCallerInit:
ca_file_path = "/path/to/ca/cert.pem" ca_file_path = "/path/to/ca/cert.pem"
caller = Caller(header={}, ca_file=ca_file_path) caller = Caller(header={}, ca_file=ca_file_path)
assert caller.cafile == ca_file_path assert caller.ca_file == ca_file_path
class TestCallerGet: class TestCallerGet:
@@ -81,7 +84,8 @@ class TestCallerGet:
headers={"Authorization": "Bearer token"}, headers={"Authorization": "Bearer token"},
timeout=20, timeout=20,
verify=True, verify=True,
proxies=None proxies=None,
cert=None
) )
@patch('corelibs.requests_handling.caller.requests.get') @patch('corelibs.requests_handling.caller.requests.get')
@@ -101,7 +105,8 @@ class TestCallerGet:
headers={}, headers={},
timeout=20, timeout=20,
verify=True, verify=True,
proxies=None proxies=None,
cert=None
) )
@patch('corelibs.requests_handling.caller.requests.get') @patch('corelibs.requests_handling.caller.requests.get')
@@ -134,7 +139,11 @@ class TestCallerGet:
mock_response = Mock(spec=requests.Response) mock_response = Mock(spec=requests.Response)
mock_get.return_value = mock_response mock_get.return_value = mock_response
proxy = {"http": "http://proxy.example.com:8080"} proxy: ProxyConfig = {
"type": "socks5",
"host": "proxy.example.com:8080",
"port": "8080"
}
caller = Caller(header={}, proxy=proxy) caller = Caller(header={}, proxy=proxy)
caller.get("https://api.example.com/data") caller.get("https://api.example.com/data")
@@ -142,40 +151,46 @@ class TestCallerGet:
assert mock_get.call_args[1]["proxies"] == proxy assert mock_get.call_args[1]["proxies"] == proxy
@patch('corelibs.requests_handling.caller.requests.get') @patch('corelibs.requests_handling.caller.requests.get')
def test_get_invalid_schema_returns_none(self, mock_get: Mock, capsys: Any): def test_get_invalid_schema_returns_none(self, mock_get: Mock):
"""Test GET request with invalid URL schema returns None""" """Test GET request with invalid URL schema returns ErrorResponse"""
mock_get.side_effect = requests.exceptions.InvalidSchema("Invalid URL") mock_get.side_effect = requests.exceptions.InvalidSchema("Invalid URL")
caller = Caller(header={}) caller = Caller(header={})
response = caller.get("invalid://example.com") response = caller.get("invalid://example.com")
assert response is None assert isinstance(response, ErrorResponse)
captured = capsys.readouterr() assert response.code == 200
assert "Invalid URL during 'get'" in captured.out assert "Invalid URL during 'get'" in response.message
assert response.action == "get"
assert response.url == "invalid://example.com"
@patch('corelibs.requests_handling.caller.requests.get') @patch('corelibs.requests_handling.caller.requests.get')
def test_get_timeout_returns_none(self, mock_get: Mock, capsys: Any): def test_get_timeout_returns_none(self, mock_get: Mock):
"""Test GET request timeout returns None""" """Test GET request timeout returns ErrorResponse"""
mock_get.side_effect = requests.exceptions.ReadTimeout("Timeout") mock_get.side_effect = requests.exceptions.ReadTimeout("Timeout")
caller = Caller(header={}) caller = Caller(header={})
response = caller.get("https://api.example.com/data") response = caller.get("https://api.example.com/data")
assert response is None assert isinstance(response, ErrorResponse)
captured = capsys.readouterr() assert response.code == 300
assert "Timeout (20s) during 'get'" in captured.out assert "Timeout (20s) during 'get'" in response.message
assert response.action == "get"
assert response.url == "https://api.example.com/data"
@patch('corelibs.requests_handling.caller.requests.get') @patch('corelibs.requests_handling.caller.requests.get')
def test_get_connection_error_returns_none(self, mock_get: Mock, capsys: Any): def test_get_connection_error_returns_none(self, mock_get: Mock):
"""Test GET request connection error returns None""" """Test GET request connection error returns ErrorResponse"""
mock_get.side_effect = requests.exceptions.ConnectionError("Connection failed") mock_get.side_effect = requests.exceptions.ConnectionError("Connection failed")
caller = Caller(header={}) caller = Caller(header={})
response = caller.get("https://api.example.com/data") response = caller.get("https://api.example.com/data")
assert response is None assert isinstance(response, ErrorResponse)
captured = capsys.readouterr() assert response.code == 400
assert "Connection error during 'get'" in captured.out assert "Connection error during 'get'" in response.message
assert response.action == "get"
assert response.url == "https://api.example.com/data"
class TestCallerPost: class TestCallerPost:
@@ -200,7 +215,8 @@ class TestCallerPost:
headers={"Content-Type": "application/json"}, headers={"Content-Type": "application/json"},
timeout=20, timeout=20,
verify=True, verify=True,
proxies=None proxies=None,
cert=None
) )
@patch('corelibs.requests_handling.caller.requests.post') @patch('corelibs.requests_handling.caller.requests.post')
@@ -234,40 +250,46 @@ class TestCallerPost:
assert mock_post.call_args[1]["json"] == data assert mock_post.call_args[1]["json"] == data
@patch('corelibs.requests_handling.caller.requests.post') @patch('corelibs.requests_handling.caller.requests.post')
def test_post_invalid_schema_returns_none(self, mock_post: Mock, capsys: Any): def test_post_invalid_schema_returns_none(self, mock_post: Mock):
"""Test POST request with invalid URL schema returns None""" """Test POST request with invalid URL schema returns ErrorResponse"""
mock_post.side_effect = requests.exceptions.InvalidSchema("Invalid URL") mock_post.side_effect = requests.exceptions.InvalidSchema("Invalid URL")
caller = Caller(header={}) caller = Caller(header={})
response = caller.post("invalid://example.com", data={"test": "data"}) response = caller.post("invalid://example.com", data={"test": "data"})
assert response is None assert isinstance(response, ErrorResponse)
captured = capsys.readouterr() assert response.code == 200
assert "Invalid URL during 'post'" in captured.out assert "Invalid URL during 'post'" in response.message
assert response.action == "post"
assert response.url == "invalid://example.com"
@patch('corelibs.requests_handling.caller.requests.post') @patch('corelibs.requests_handling.caller.requests.post')
def test_post_timeout_returns_none(self, mock_post: Mock, capsys: Any): def test_post_timeout_returns_none(self, mock_post: Mock):
"""Test POST request timeout returns None""" """Test POST request timeout returns ErrorResponse"""
mock_post.side_effect = requests.exceptions.ReadTimeout("Timeout") mock_post.side_effect = requests.exceptions.ReadTimeout("Timeout")
caller = Caller(header={}) caller = Caller(header={})
response = caller.post("https://api.example.com/data", data={"test": "data"}) response = caller.post("https://api.example.com/data", data={"test": "data"})
assert response is None assert isinstance(response, ErrorResponse)
captured = capsys.readouterr() assert response.code == 300
assert "Timeout (20s) during 'post'" in captured.out assert "Timeout (20s) during 'post'" in response.message
assert response.action == "post"
assert response.url == "https://api.example.com/data"
@patch('corelibs.requests_handling.caller.requests.post') @patch('corelibs.requests_handling.caller.requests.post')
def test_post_connection_error_returns_none(self, mock_post: Mock, capsys: Any): def test_post_connection_error_returns_none(self, mock_post: Mock):
"""Test POST request connection error returns None""" """Test POST request connection error returns ErrorResponse"""
mock_post.side_effect = requests.exceptions.ConnectionError("Connection failed") mock_post.side_effect = requests.exceptions.ConnectionError("Connection failed")
caller = Caller(header={}) caller = Caller(header={})
response = caller.post("https://api.example.com/data", data={"test": "data"}) response = caller.post("https://api.example.com/data", data={"test": "data"})
assert response is None assert isinstance(response, ErrorResponse)
captured = capsys.readouterr() assert response.code == 400
assert "Connection error during 'post'" in captured.out assert "Connection error during 'post'" in response.message
assert response.action == "post"
assert response.url == "https://api.example.com/data"
class TestCallerPut: class TestCallerPut:
@@ -292,7 +314,8 @@ class TestCallerPut:
headers={"Content-Type": "application/json"}, headers={"Content-Type": "application/json"},
timeout=20, timeout=20,
verify=True, verify=True,
proxies=None proxies=None,
cert=None
) )
@patch('corelibs.requests_handling.caller.requests.put') @patch('corelibs.requests_handling.caller.requests.put')
@@ -311,16 +334,18 @@ class TestCallerPut:
assert mock_put.call_args[1]["params"] == params assert mock_put.call_args[1]["params"] == params
@patch('corelibs.requests_handling.caller.requests.put') @patch('corelibs.requests_handling.caller.requests.put')
def test_put_timeout_returns_none(self, mock_put: Mock, capsys: Any): def test_put_timeout_returns_none(self, mock_put: Mock):
"""Test PUT request timeout returns None""" """Test PUT request timeout returns ErrorResponse"""
mock_put.side_effect = requests.exceptions.ReadTimeout("Timeout") mock_put.side_effect = requests.exceptions.ReadTimeout("Timeout")
caller = Caller(header={}) caller = Caller(header={})
response = caller.put("https://api.example.com/data/1", data={"test": "data"}) response = caller.put("https://api.example.com/data/1", data={"test": "data"})
assert response is None assert isinstance(response, ErrorResponse)
captured = capsys.readouterr() assert response.code == 300
assert "Timeout (20s) during 'put'" in captured.out assert "Timeout (20s) during 'put'" in response.message
assert response.action == "put"
assert response.url == "https://api.example.com/data/1"
class TestCallerPatch: class TestCallerPatch:
@@ -345,7 +370,8 @@ class TestCallerPatch:
headers={"Content-Type": "application/json"}, headers={"Content-Type": "application/json"},
timeout=20, timeout=20,
verify=True, verify=True,
proxies=None proxies=None,
cert=None
) )
@patch('corelibs.requests_handling.caller.requests.patch') @patch('corelibs.requests_handling.caller.requests.patch')
@@ -364,16 +390,18 @@ class TestCallerPatch:
assert mock_patch.call_args[1]["params"] == params assert mock_patch.call_args[1]["params"] == params
@patch('corelibs.requests_handling.caller.requests.patch') @patch('corelibs.requests_handling.caller.requests.patch')
def test_patch_connection_error_returns_none(self, mock_patch: Mock, capsys: Any): def test_patch_connection_error_returns_none(self, mock_patch: Mock):
"""Test PATCH request connection error returns None""" """Test PATCH request connection error returns ErrorResponse"""
mock_patch.side_effect = requests.exceptions.ConnectionError("Connection failed") mock_patch.side_effect = requests.exceptions.ConnectionError("Connection failed")
caller = Caller(header={}) caller = Caller(header={})
response = caller.patch("https://api.example.com/data/1", data={"test": "data"}) response = caller.patch("https://api.example.com/data/1", data={"test": "data"})
assert response is None assert isinstance(response, ErrorResponse)
captured = capsys.readouterr() assert response.code == 400
assert "Connection error during 'patch'" in captured.out assert "Connection error during 'patch'" in response.message
assert response.action == "patch"
assert response.url == "https://api.example.com/data/1"
class TestCallerDelete: class TestCallerDelete:
@@ -396,7 +424,8 @@ class TestCallerDelete:
headers={"Authorization": "Bearer token"}, headers={"Authorization": "Bearer token"},
timeout=20, timeout=20,
verify=True, verify=True,
proxies=None proxies=None,
cert=None
) )
@patch('corelibs.requests_handling.caller.requests.delete') @patch('corelibs.requests_handling.caller.requests.delete')
@@ -414,16 +443,18 @@ class TestCallerDelete:
assert mock_delete.call_args[1]["params"] == params assert mock_delete.call_args[1]["params"] == params
@patch('corelibs.requests_handling.caller.requests.delete') @patch('corelibs.requests_handling.caller.requests.delete')
def test_delete_invalid_schema_returns_none(self, mock_delete: Mock, capsys: Any): def test_delete_invalid_schema_returns_none(self, mock_delete: Mock):
"""Test DELETE request with invalid URL schema returns None""" """Test DELETE request with invalid URL schema returns ErrorResponse"""
mock_delete.side_effect = requests.exceptions.InvalidSchema("Invalid URL") mock_delete.side_effect = requests.exceptions.InvalidSchema("Invalid URL")
caller = Caller(header={}) caller = Caller(header={})
response = caller.delete("invalid://example.com/data/1") response = caller.delete("invalid://example.com/data/1")
assert response is None assert isinstance(response, ErrorResponse)
captured = capsys.readouterr() assert response.code == 200
assert "Invalid URL during 'delete'" in captured.out assert "Invalid URL during 'delete'" in response.message
assert response.action == "delete"
assert response.url == "invalid://example.com/data/1"
class TestCallerParametrized: class TestCallerParametrized:
@@ -492,7 +523,7 @@ class TestCallerParametrized:
]) ])
@patch('corelibs.requests_handling.caller.requests.get') @patch('corelibs.requests_handling.caller.requests.get')
def test_exception_handling( def test_exception_handling(
self, mock_get: Mock, exception_class: type, expected_message: str, capsys: Any self, mock_get: Mock, exception_class: type, expected_message: str
): ):
"""Test exception handling for all exception types""" """Test exception handling for all exception types"""
mock_get.side_effect = exception_class("Test error") mock_get.side_effect = exception_class("Test error")
@@ -500,9 +531,8 @@ class TestCallerParametrized:
caller = Caller(header={}) caller = Caller(header={})
response = caller.get("https://api.example.com/data") response = caller.get("https://api.example.com/data")
assert response is None assert isinstance(response, ErrorResponse)
captured = capsys.readouterr() assert expected_message in response.message
assert expected_message in captured.out
class TestCallerIntegration: class TestCallerIntegration:
@@ -599,7 +629,8 @@ class TestCallerEdgeCases:
headers={}, headers={},
timeout=20, timeout=20,
verify=True, verify=True,
proxies=None proxies=None,
cert=None
) )
@patch('corelibs.requests_handling.caller.requests.post') @patch('corelibs.requests_handling.caller.requests.post')
@@ -659,7 +690,8 @@ class TestCallerEdgeCases:
headers={}, headers={},
timeout=20, timeout=20,
verify=True, verify=True,
proxies=None proxies=None,
cert=None
) )
@patch('corelibs.requests_handling.caller.requests.get') @patch('corelibs.requests_handling.caller.requests.get')
@@ -679,7 +711,8 @@ class TestCallerEdgeCases:
headers={}, headers={},
timeout=20, timeout=20,
verify=True, verify=True,
proxies=None proxies=None,
cert=None
) )
def test_timeout_zero(self): def test_timeout_zero(self):
@@ -730,9 +763,10 @@ class TestCallerProxyHandling:
mock_response = Mock(spec=requests.Response) mock_response = Mock(spec=requests.Response)
mock_get.return_value = mock_response mock_get.return_value = mock_response
proxy = { proxy: ProxyConfig = {
"http": "http://proxy.example.com:8080", "type": "socks5",
"https": "https://proxy.example.com:8080" "host": "proxy.example.com:8080",
"port": "8080"
} }
caller = Caller(header={}, proxy=proxy) caller = Caller(header={}, proxy=proxy)
caller.get("https://api.example.com/data") caller.get("https://api.example.com/data")
@@ -746,9 +780,10 @@ class TestCallerProxyHandling:
mock_response = Mock(spec=requests.Response) mock_response = Mock(spec=requests.Response)
mock_post.return_value = mock_response mock_post.return_value = mock_response
proxy = { proxy: ProxyConfig = {
"http": "http://user:pass@proxy.example.com:8080", "type": "socks5",
"https": "https://user:pass@proxy.example.com:8080" "host": "proxy.example.com:8080",
"port": "8080"
} }
caller = Caller(header={}, proxy=proxy) caller = Caller(header={}, proxy=proxy)
caller.post("https://api.example.com/data", data={"test": "data"}) caller.post("https://api.example.com/data", data={"test": "data"})
@@ -789,7 +824,7 @@ class TestCallerResponseHandling:
caller = Caller(header={}) caller = Caller(header={})
response = caller.get("https://api.example.com/data") response = caller.get("https://api.example.com/data")
assert response is not None assert not isinstance(response, ErrorResponse)
assert response.status_code == 200 assert response.status_code == 200
assert response.text == "Success" assert response.text == "Success"
assert response.json() == {"status": "ok"} assert response.json() == {"status": "ok"}
@@ -805,7 +840,7 @@ class TestCallerResponseHandling:
caller = Caller(header={}) caller = Caller(header={})
response = caller.get("https://api.example.com/data") response = caller.get("https://api.example.com/data")
assert response is not None assert not isinstance(response, ErrorResponse)
assert response.status_code == status_code assert response.status_code == status_code