askrobots / foxray Public

Foxray: a light error tracker for the Sentry SDKs. Runs inside Django (the admin is the UI) or on its own; SQLite or Postgres, nothing else. Not affiliated with Sentry.

0 downloads

foxray/tests/test_events.py
Download zip
Clone
Clone with git
git clone https://gitstable.com/git/askrobots/foxray.git
HTTPS
https://gitstable.com/git/askrobots/foxray.git
SSH
ssh://git@gitstable.com:2222/askrobots/foxray.git

Cloning needs no sign-in. Pushing over HTTPS asks for your username and an access token. SSH needs your key under SSH keys.

danq9 0.1.2: the first PyPI release (v0.1.1 is already tagged at 05cc354, before the PyPI metadata) 58507e3 4 weeks ago History
test_events.py · 8.7 KB · 184 lines
1"""Normalising, fingerprints and scrubbing."""
2
3from foxray.core.fingerprint import fingerprint, fingerprint_components, normalize_message
4from foxray.core.normalize import event_culprit, event_title, normalize_event
5from foxray.core.scrub import FILTERED, scrub, scrub_event, scrub_string
6from foxray.core.settings import Settings
7from tests.helpers import make_event
8
9S = Settings()
10
11
12def norm(raw, **kw):
13 return normalize_event(raw, Settings(**kw) if kw else S)[0]
14
15
16# -- normalising ---------------------------------------------------------
17
18def test_keeps_only_user_id_and_request_url_method_by_default():
19 ev, meta = normalize_event({
20 "user": {"id": 5, "email": "a@b.c", "ip_address": "1.2.3.4"},
21 "request": {"url": "https://x.test/p?token=s3cret#frag", "method": "post",
22 "headers": {"User-Agent": "Googlebot/2.1", "Cookie": "a=b"}, "data": {"pw": "x"},
23 "query_string": "token=s3cret"},
24 }, S)
25 assert ev["user"] == {"id": "5"}
26 assert ev["request"] == {"url": "https://x.test/p", "method": "POST"}
27 assert meta["user_agent"] == "Googlebot/2.1"
28
29
30def test_more_user_fields_when_configured():
31 ev = norm({"user": {"id": 1, "email": "a@b.c"}}, user_fields=("id", "email"))
32 assert ev["user"] == {"id": "1", "email": "a@b.c"}
33
34
35def test_levels_platform_release_environment():
36 ev = norm({"level": "warn", "platform": "javascript", "release": "1.2", "environment": "production",
37 "server_name": "web1", "transaction": "/api/x", "dist": "7"})
38 assert (ev["level"], ev["platform"], ev["release"], ev["environment"]) == ("warning", "javascript", "1.2", "production")
39 assert ev["server_name"] == "web1" and ev["transaction"] == "/api/x"
40 assert norm({"level": "nonsense"})["level"] == "error"
41 assert norm({"level": "critical"})["level"] == "fatal"
42
43
44def test_message_forms():
45 assert norm({"message": "plain"})["message"] == "plain"
46 ev = norm({"logentry": {"message": "user %s failed", "params": ["bob"]}})
47 assert ev["message"] == "user bob failed" and ev["message_template"] == "user %s failed"
48 assert norm({"message": {"formatted": "f"}})["message"] == "f"
49
50
51def test_exception_chain_frames_and_in_app_guess():
52 raw = {"exception": {"values": [
53 {"type": "KeyError", "value": "'a'", "stacktrace": {"frames": [{"filename": "a.py", "function": "f"}]}},
54 {"type": "ValueError", "value": "outer", "mechanism": {"type": "django", "handled": False},
55 "stacktrace": {"frames": [
56 {"abs_path": "/venv/lib/python3.10/site-packages/django/x.py", "function": "g", "lineno": 1},
57 {"abs_path": "/srv/app/views.py", "module": "app.views", "function": "h", "lineno": 2,
58 "vars": {"password": "x"}}]}},
59 ]}}
60 ev = norm(raw)
61 values = ev["exception"]["values"]
62 assert [v["type"] for v in values] == ["KeyError", "ValueError"]
63 frames = values[1]["stacktrace"]["frames"]
64 assert [f["in_app"] for f in frames] == [False, True]
65 assert "vars" not in frames[1] # off by default
66 assert values[1]["mechanism"] == {"type": "django", "handled": False}
67 assert event_title(ev) == "ValueError: outer"
68 assert event_culprit(ev) == "app.views in h"
69 assert "vars" in norm(raw, keep_frame_vars=True)["exception"]["values"][1]["stacktrace"]["frames"][1]
70
71
72def test_breadcrumbs_are_capped_and_tags_normalised():
73 crumbs = [{"message": f"c{i}", "category": "x", "timestamp": 1700000000 + i} for i in range(80)]
74 ev = norm({"breadcrumbs": {"values": crumbs}, "tags": [["a", 1], ["b", "two"]]})
75 assert len(ev["breadcrumbs"]) == 50 and ev["breadcrumbs"][-1]["message"] == "c79"
76 assert ev["tags"] == {"a": "1", "b": "two"}
77 assert len(norm({"breadcrumbs": crumbs}, breadcrumbs_cap=5)["breadcrumbs"]) == 5
78
79
80def test_event_id_from_envelope_header_or_new():
81 ev, _ = normalize_event({}, S, {"event_id": "AB" * 16})
82 assert ev["event_id"] == "ab" * 16
83 assert len(normalize_event({"event_id": "not-hex"}, S)[0]["event_id"]) == 32
84
85
86def test_contexts_kept_and_bounded():
87 ev = norm({"contexts": {"os": {"name": "Linux"}, "runtime": {"name": "CPython", "version": "3.10"},
88 "junk": "not a dict"}})
89 assert ev["contexts"] == {"os": {"name": "Linux"}, "runtime": {"name": "CPython", "version": "3.10"}}
90
91
92# -- fingerprints --------------------------------------------------------
93
94def fp(raw):
95 return fingerprint(norm(raw))
96
97
98def test_same_place_same_issue_despite_line_numbers_and_values():
99 a = make_event("ValueError", "bad id 123", lineno=10)
100 b = make_event("ValueError", "bad id 456", lineno=99)
101 assert fp(a) == fp(b)
102
103
104def test_different_function_or_type_differs():
105 assert fp(make_event(function="index")) != fp(make_event(function="detail"))
106 assert fp(make_event("ValueError")) != fp(make_event("TypeError"))
107
108
109def test_library_frames_ignored_when_app_frames_exist():
110 a = make_event()
111 b = make_event()
112 b["exception"]["values"][0]["stacktrace"]["frames"][0]["function"] = "other_lib_fn"
113 assert fp(a) == fp(b)
114
115
116def test_sdk_fingerprint_wins_and_default_placeholder():
117 a = make_event(fingerprint=["db-down"])
118 b = make_event("TypeError", function="x", fingerprint=["db-down"])
119 assert fp(a) == fp(b)
120 c = make_event(fingerprint=["{{ default }}", "tenant-1"])
121 d = make_event(fingerprint=["{{default}}", "tenant-2"])
122 assert fp(c) != fp(d)
123 assert fingerprint_components(norm(c))[0] == "type:ValueError"
124
125
126def test_message_fallback_strips_numbers_and_hex():
127 assert normalize_message("Order 1234 failed at 0xdeadbeef id 3f2a9c1e7b") == \
128 "Order <n> failed at <hex> id <hex>"
129 assert normalize_message("user 550e8400-e29b-41d4-a716-446655440000 gone") == "user <id> gone"
130 assert fp({"message": "Timeout after 30s on job 991"}) == fp({"message": "Timeout after 45s on job 17"})
131 assert fp({"message": "Timeout"}) != fp({"message": "Refused"})
132 # the template groups logging calls regardless of their arguments
133 assert fp({"logentry": {"message": "user %s failed", "params": ["bob"]}}) == \
134 fp({"logentry": {"message": "user %s failed", "params": ["alice"]}})
135
136
137def test_js_bundle_hash_does_not_split_issues():
138 def js(name):
139 return {"platform": "javascript", "exception": {"values": [{"type": "TypeError", "value": "x",
140 "stacktrace": {"frames": [{"filename": name, "function": "go", "in_app": True}]}}]}}
141 assert fp(js("https://x.test/static/main.3f2a1b9c.js")) == fp(js("https://x.test/static/main.77ab12ff.js"))
142
143
144# -- scrubbing -----------------------------------------------------------
145
146def test_sensitive_keys():
147 out = scrub({"password": "hunter2", "Authorization": "Bearer abc", "api_key": "k", "sessionid": "s",
148 "csrftoken": "t", "nested": {"db_password": "p", "safe": "ok"}, "list": [{"secret": 1}],
149 "author": "dan", "empty_password": ""})
150 assert out["password"] == out["Authorization"] == out["api_key"] == FILTERED
151 assert out["sessionid"] == out["csrftoken"] == FILTERED
152 assert out["nested"] == {"db_password": FILTERED, "safe": "ok"}
153 assert out["list"] == [{"secret": FILTERED}]
154 assert out["author"] == "dan" and out["empty_password"] == ""
155
156
157def test_card_numbers_only_when_luhn_valid():
158 assert scrub_string("card 4111 1111 1111 1111 ok") == f"card {FILTERED} ok"
159 assert scrub_string("4111-1111-1111-1111") == FILTERED
160 assert scrub_string("order 1234567890123456") == "order 1234567890123456" # fails Luhn
161 assert scrub_string("ts 1700000000123") == "ts 1700000000123"
162
163
164def test_secret_looking_strings():
165 s = scrub_string
166 assert FILTERED in s("key sk_live_" + "a1" * 12)
167 assert FILTERED in s("AKIAABCDEFGHIJKLMNOP")
168 assert FILTERED in s("ghp_" + "x" * 36)
169 assert s("Authorization: Bearer abcdefghijklmnop") == f"Authorization: Bearer {FILTERED}"
170 assert s("postgres://bob:pa55@db:5432/x") == f"postgres://bob:{FILTERED}@db:5432/x"
171 assert s("GET /cb?token=abc123&x=1") == f"GET /cb?token={FILTERED}&x=1"
172 assert FILTERED in s("-----BEGIN RSA PRIVATE KEY-----\nMIIE\n-----END RSA PRIVATE KEY-----")
173 assert FILTERED in s("jwt eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U")
174 assert s("nothing to see here 42") == "nothing to see here 42"
175
176
177def test_scrub_event_covers_exception_values_breadcrumbs_and_extra():
178 ev = norm({"exception": {"values": [{"type": "E", "value": "login failed password=hunter2"}]},
179 "breadcrumbs": [{"message": "card 4111111111111111", "data": {"token": "t"}}],
180 "extra": {"cookie": "c", "note": "fine"}})
181 out = scrub_event(ev)
182 assert "hunter2" not in str(out) and "4111111111111111" not in str(out)
183 assert out["breadcrumbs"][0]["data"]["token"] == FILTERED
184 assert out["extra"] == {"cookie": FILTERED, "note": "fine"}