Skip to content

Test the constructor's trimming and report's tag cleaning #17

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
dmccoystephenson merged 1 commit into from
Oct 18, 2026
Merged

Test the constructor's trimming and report's tag cleaning #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions tests/test_trace_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,17 @@ def test_report_posts_the_event_to_the_metrics_endpoint_with_the_key(self):
json.loads(request["body"]))
client.close()

def test_constructor_trims_the_base_url_application_and_key(self):
client = TraceClient(" " + self.base_url + "/ ", " MyGame ", "1.2.3", key=" k-123 ")
client.report("startup")
self.assertTrue(self.capture.arrived.wait(5), "a padded base URL should still reach the server")
request = self.capture.requests[0]
self.assertEqual("/api/metrics", request["path"])
self.assertEqual("Bearer k-123", request["authorization"], "the key is sent without its padding")
self.assertEqual("MyGame", json.loads(request["body"])["application"])
self.assertTrue(request["user_agent"].endswith("(MyGame)"), request["user_agent"])
client.close()

def test_report_carries_value_and_tags_when_given(self):
client = TraceClient(self.base_url, "MyGame", "1.2.3", key="k")
client.report("world-load", 2.5, {"seed": "42", "size": 'the "big" one'})
Expand Down Expand Up @@ -354,6 +365,14 @@ def test_report_never_modifies_the_callers_tags(self):
self.assertEqual({"name": "home", "version": "1.2.3"},
json.loads(self.capture.requests[0]["body"])["tags"])

def test_report_drops_none_tags_and_stringifies_the_rest_before_adding_the_version(self):
client = TraceClient(self.base_url, "MyGame", "1.2.3", key="k")
client.report("command", tags={"version": None, None: "orphan", "count": 7})
self.assertTrue(self.capture.arrived.wait(5))
self.assertEqual({"count": "7", "version": "1.2.3"}, json.loads(self.capture.requests[0]["body"])["tags"],
"a None version tag does not suppress the program's own version")
client.close()

def test_with_version_never_modifies_the_callers_mapping(self):
from trace_client.trace_client import _with_version
tags = {"name": "home"}
Expand Down
Loading