Repository navigation
Expand file tree
/
Copy pathtest_feedback_api.py
More file actions
221 lines (189 loc) · 8.47 KB
/
Copy pathtest_feedback_api.py
File metadata and controls
221 lines (189 loc) · 8.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
from __future__ import annotations
import tempfile
import unittest
from pathlib import Path
from types import SimpleNamespace
from uuid import uuid4
from fastapi import HTTPException
from fastapi.responses import FileResponse, RedirectResponse
from app.api import feedback as feedback_api
from app.auth_service import AuthPrincipal, OAuthIdentity, _upsert_login
from app.config import Settings
from app.db import get_connection, init_app_db, init_db
from app.main import app
from app.rate_limit import reset_rate_limit_state
def _settings(db_path: Path) -> Settings:
return Settings(
project_dir=db_path.parent,
db_path=db_path,
download_db_path=db_path.parent / "downloads" / "bus.db",
tdx_client_id=None,
tdx_client_secret=None,
tdx_base_url="https://example.test",
tdx_token_url="https://example.test/token",
tdx_cities=(),
tdx_request_timeout=30,
tdx_token_refresh_skew=300,
tdx_retry_attempts=1,
tdx_retry_backoff=1.0,
tdx_min_request_interval=0.0,
realtime_cache_ttl=5,
realtime_track_ttl=30,
cors_origins=(),
auth_public_base_url="https://bus.example.test",
auth_state_ttl_seconds=600,
auth_snowflake_node_id=0,
discord_oauth_client_id="discord-client",
discord_oauth_client_secret="discord-secret",
google_oauth_client_id="google-client",
google_oauth_client_secret="google-secret",
google_native_oauth_client_ids=("android-client", "ios-client"),
)
class _FakeRequest:
def __init__(self, settings: Settings, *, user_agent: str = "YABus/1.3.1-abc123 (android)") -> None:
self.app = SimpleNamespace(state=SimpleNamespace(settings=settings))
self.headers = {"user-agent": user_agent}
self.state = SimpleNamespace()
class FeedbackApiTests(unittest.TestCase):
def setUp(self) -> None:
self.temp_dir = tempfile.TemporaryDirectory()
self.db_path = Path(self.temp_dir.name) / "bus.db"
init_db(self.db_path)
self.app_db_path = self.db_path.parent / "app.db"
init_app_db(self.app_db_path)
self.settings = _settings(self.db_path)
self._original_get_request_principal = feedback_api.get_request_principal
reset_rate_limit_state()
def tearDown(self) -> None:
feedback_api.get_request_principal = self._original_get_request_principal
self.temp_dir.cleanup()
reset_rate_limit_state()
def _request(self, *, user_agent: str = "YABus/1.3.1-abc123 (android)") -> _FakeRequest:
return _FakeRequest(self.settings, user_agent=user_agent)
def _set_principal(self, role: str | None, *, account_id: int = 1) -> None:
if role is None:
feedback_api.get_request_principal = lambda request: None
return
feedback_api.get_request_principal = lambda request: AuthPrincipal(
account_id=account_id,
device_id=2,
token_id=3,
role=role,
)
def test_main_app_registers_feedback_routes(self) -> None:
self.assertEqual(str(app.url_path_for("create_feedback")), "/api/v1/feedback")
self.assertEqual(str(app.url_path_for("list_feedbacks")), "/api/v1/admin/feedbacks")
self.assertEqual(str(app.url_path_for("feedbacks_page")), "/admin/feedbacks")
def test_feedback_create_requires_login(self) -> None:
self._set_principal(None)
with self.assertRaises(HTTPException) as context:
feedback_api.create_feedback(
self._request(),
feedback_api.FeedbackCreateRequest(title="Oops", content="No login"),
)
self.assertEqual(context.exception.status_code, 401)
def test_feedback_create_is_limited_per_user_and_persists_client_info(self) -> None:
login = _upsert_login(
self.settings,
identity=OAuthIdentity(
provider="google",
provider_user_id="feedback-user",
email="feedback@example.test",
display_name="Feedback User",
avatar_url=None,
),
device_key=str(uuid4()),
redirect_uri="https://bus.example.test/account",
)
self._set_principal("user", account_id=login.account_id)
request = self._request(user_agent="YABus/2.0.0-deadbee (ios)")
created = feedback_api.create_feedback(
request,
feedback_api.FeedbackCreateRequest(title="Need this", content="Please add this feature."),
)
self.assertTrue(created["ok"])
with get_connection(self.app_db_path) as connection:
row = connection.execute(
"""
SELECT account_id, title, content, client_family, platform_name, app_version
FROM feedbacks
""",
).fetchone()
self.assertIsNotNone(row)
self.assertEqual(int(row["account_id"]), login.account_id)
self.assertEqual(row["title"], "Need this")
self.assertEqual(row["content"], "Please add this feature.")
self.assertEqual(row["client_family"], "app")
self.assertEqual(row["platform_name"], "ios")
self.assertEqual(row["app_version"], "2.0.0")
with self.assertRaises(HTTPException) as limited:
feedback_api.create_feedback(
request,
feedback_api.FeedbackCreateRequest(title="Again", content="Second post"),
)
self.assertEqual(limited.exception.status_code, 429)
self.assertEqual(
limited.exception.detail,
"Feedback submissions are limited to 1 per minute.",
)
def test_feedback_admin_routes_require_admin(self) -> None:
request = self._request()
self._set_principal(None)
page = feedback_api.feedbacks_page(request)
self.assertIsInstance(page, RedirectResponse)
self._set_principal("user")
with self.assertRaises(HTTPException) as denied:
feedback_api.list_feedbacks(request, limit=200)
self.assertEqual(denied.exception.status_code, 403)
def test_feedback_admin_list_returns_identity_context(self) -> None:
admin_login = _upsert_login(
self.settings,
identity=OAuthIdentity(
provider="google",
provider_user_id="admin-user",
email="admin@example.test",
display_name="Admin User",
avatar_url=None,
),
device_key=str(uuid4()),
redirect_uri="https://bus.example.test/account",
)
member_login = _upsert_login(
self.settings,
identity=OAuthIdentity(
provider="discord",
provider_user_id="member-user",
email="member@example.test",
display_name="Member User",
avatar_url=None,
),
device_key=str(uuid4()),
redirect_uri="https://bus.example.test/account",
)
with get_connection(self.app_db_path) as connection:
connection.execute(
"UPDATE accounts SET role = 'admin' WHERE id = ?",
(admin_login.account_id,),
)
connection.commit()
self._set_principal("user", account_id=member_login.account_id)
feedback_api.create_feedback(
self._request(user_agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 Chrome/124.0.0.0 Safari/537.36"),
feedback_api.FeedbackCreateRequest(title="Web report", content="Submitted from browser."),
)
self._set_principal("admin", account_id=admin_login.account_id)
payload = feedback_api.list_feedbacks(self._request(), limit=200)
self.assertEqual(payload["summary"]["total_count"], 1)
self.assertEqual(len(payload["feedbacks"]), 1)
feedback = payload["feedbacks"][0]
self.assertEqual(feedback["account_id"], str(member_login.account_id))
self.assertEqual(feedback["account_label"], "Member User")
self.assertEqual(feedback["account_email"], "member@example.test")
self.assertEqual(feedback["browser_name"], "Chrome")
self.assertEqual(feedback["client_family"], "web")
def test_feedback_page_serves_html_for_admin(self) -> None:
self._set_principal("admin")
response = feedback_api.feedbacks_page(self._request())
self.assertIsInstance(response, FileResponse)
if __name__ == "__main__":
unittest.main()