Skip to content

Better debug output management for APIRequest (formerly TestRequest) #55

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

Merged
LswaN58 merged 3 commits into from
Jan 5, 2026
Merged

Better debug output management for APIRequest (formerly TestRequest) #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4092a9d
Improve how we output logging info from request class.
LswaN58 Jan 4, 2026
a3738f3
Rename TestRequest class -> APIRequest.
LswaN58 Jan 4, 2026
bdb640f
Now, move the file to models module, and update imports.
LswaN58 Jan 4, 2026
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
13 changes: 8 additions & 5 deletions src/ogd/apis/utils/TestRequest.py → src/ogd/apis/models/APIRequest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
import requests
from typing import Any, Dict, Optional

def TestRequest(url:str, request:str, params:Optional[Dict[str, Any]]=None, body:Optional[Dict[str, Any]]=None, timeout:int=1, logger:Optional[logging.Logger]=None) -> requests.Response:
from ogd.apis.models.enums.ResponseStatus import ResponseStatus

def APIRequest(url:str, request:str, params:Optional[Dict[str, Any]]=None, body:Optional[Dict[str, Any]]=None, timeout:int=1, logger:Optional[logging.Logger]=None) -> requests.Response:
"""Utility function to make it easier to send requests to a remote server during unit testing.

This function does some basic sanity checking of the target URL,
Expand Down Expand Up @@ -48,8 +50,9 @@ def TestRequest(url:str, request:str, params:Optional[Dict[str, Any]]=None, body
raise err
else:
if logger:
logger.debug(f"Request sent to: {url}")
logger.debug(f"Response received from: {ret_val.url}")
logger.debug(f" Status: {ret_val.status_code}")
logger.debug(f" Data: {ret_val.text}")
out = logger.debug if ret_val.status_code == ResponseStatus.OK else logger.warning
out(f"Request sent to: {url}")
out(f"Response received from: {ret_val.url}")
out(f" Status: {ret_val.status_code}")
out(f" Data: {ret_val.text}")
return ret_val
8 changes: 4 additions & 4 deletions tests/cases/apis/HelloAPI/remote/t_Hello.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from ogd.common.configs.TestConfig import TestConfig
from ogd.common.utils.Logger import Logger
# import locals
from src.ogd.apis.utils.TestRequest import TestRequest
from src.ogd.apis.models.APIRequest import APIRequest
from tests.config.t_config import settings

class t_Hello_remote(TestCase):
Expand All @@ -24,7 +24,7 @@ def setUpClass(cls) -> None:
def test_get(self):
_url = f"{self.base_url}/hello"
try:
result = TestRequest(url=_url, request="GET", params={}, logger=Logger.std_logger)
result = APIRequest(url=_url, request="GET", params={}, logger=Logger.std_logger)
except Exception as err:
self.fail(str(err))
else:
Expand All @@ -42,7 +42,7 @@ def test_get(self):
def test_post(self):
_url = f"{self.base_url}/hello"
try:
result = TestRequest(url=_url, request="POST", params={}, logger=Logger.std_logger)
result = APIRequest(url=_url, request="POST", params={}, logger=Logger.std_logger)
except Exception as err:
self.fail(str(err))
else:
Expand All @@ -61,7 +61,7 @@ def test_put(self):
_url = f"{self.base_url}/hello"
Logger.Log(f"PUT test at {_url}", logging.DEBUG)
try:
result = TestRequest(url=_url, request="PUT", params={}, logger=Logger.std_logger)
result = APIRequest(url=_url, request="PUT", params={}, logger=Logger.std_logger)
except Exception as err:
self.fail(str(err))
else:
Expand Down
8 changes: 4 additions & 4 deletions tests/cases/apis/HelloAPI/remote/t_ParamHello.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from ogd.common.configs.TestConfig import TestConfig
from ogd.common.utils.Logger import Logger
# import locals
from src.ogd.apis.utils.TestRequest import TestRequest
from src.ogd.apis.models.APIRequest import APIRequest
from tests.config.t_config import settings

class t_ParamHello_remote(TestCase):
Expand All @@ -25,7 +25,7 @@ def setUpClass(cls) -> None:
def test_get(self):
_url = f"{self.base_url}/p_hello/{self.param}"
try:
result = TestRequest(url=_url, request="GET", params={}, logger=Logger.std_logger)
result = APIRequest(url=_url, request="GET", params={}, logger=Logger.std_logger)
except Exception as err:
self.fail(str(err))
else:
Expand All @@ -43,7 +43,7 @@ def test_get(self):
def test_post(self):
_url = f"{self.base_url}/p_hello/{self.param}"
try:
result = TestRequest(url=_url, request="POST", params={}, logger=Logger.std_logger)
result = APIRequest(url=_url, request="POST", params={}, logger=Logger.std_logger)
except Exception as err:
self.fail(str(err))
else:
Expand All @@ -62,7 +62,7 @@ def test_put(self):
_url = f"{self.base_url}/p_hello/{self.param}"
Logger.Log(f"PUT test at {_url}", logging.DEBUG)
try:
result = TestRequest(url=_url, request="PUT", params={}, logger=Logger.std_logger)
result = APIRequest(url=_url, request="PUT", params={}, logger=Logger.std_logger)
except Exception as err:
self.fail(str(err))
else:
Expand Down
Loading