BlueGit

projects-timfalken-com verhalenboek

Files

verhalenboek / web / tests / integration.py

integration.py

feat: laat een beheerder andere gebruikers promoveren
timfa project_87242033_bot_b167a9be22027ad5a4b431d0ad8426c6 · pushed by timfa · 6 weeks ago
1d95d234 History
integration.py 21.5 KiB Download Raw
1#!/usr/bin/env python3
2"""Geïsoleerde API-tests. De echte database van de applicatie blijft onaangeroerd."""
3import json
4import os
5import signal
6import http.cookiejar
7import shutil
8import socket
9import sqlite3
10import subprocess
11import tempfile
12import time
13import urllib.error
14import urllib.request
15from pathlib import Path
16
17WEB = Path(__file__).resolve().parents[1]
18ARTIFACTS = WEB / 'tests/artifacts'
19ARTIFACTS.mkdir(exist_ok=True)
20checks = 0
21
22def check(value, label):
23 global checks
24 checks += 1
25 assert value, label
26
27def stories(prefix='Verhaal'):
28 return [
29 {'title': f'{prefix} een', 'paragraphs': ['Eerste alinea.', 'Tweede alinea met één accent.']},
30 {'title': f'{prefix} twee', 'paragraphs': ['Midden.']},
31 {'title': f'{prefix} drie', 'paragraphs': ['Slot.']},
32 ]
33
34with tempfile.TemporaryDirectory(prefix='api-', dir=ARTIFACTS) as tmp:
35 root = Path(tmp)
36 for name in ['api.php', 'index.php', 'auth.php', 'callback.php', 'router.php', 'docs.php']:
37 shutil.copy(WEB / name, root / name)
38 shutil.copytree(WEB / 'lib', root / 'lib')
39 (root / 'assets').mkdir()
40 shutil.copy(WEB / 'assets/favicon.svg', root / 'assets/favicon.svg')
41 (root / 'data').mkdir()
42 with socket.socket() as sock:
43 sock.bind(('127.0.0.1', 0))
44 port = sock.getsockname()[1]
45 base = f'http://127.0.0.1:{port}'
46 log_path = root / 'server.log'
47 log = log_path.open('w')
48 process = subprocess.Popen(
49 ['php', '-d', 'opcache.enable=0', '-S', f'127.0.0.1:{port}', '-t', str(root), str(root / 'router.php')],
50 stdout=log, stderr=log, start_new_session=True,
51 )
52
53 class Client:
54 def __init__(self, token=None):
55 self.token = token
56 self.opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(http.cookiejar.CookieJar()))
57 self.csrf = None
58
59 def request(self, method, path, body=None, expected=200, csrf=True, extra_headers=None):
60 headers = {'Accept': 'application/json'}
61 data = None
62 if body is not None:
63 data = json.dumps(body).encode()
64 headers['Content-Type'] = 'application/json'
65 if self.token:
66 headers['Authorization'] = 'Bearer ' + self.token
67 elif method not in ('GET', 'HEAD') and csrf:
68 headers['X-CSRF-Token'] = self.csrf or ''
69 if extra_headers:
70 headers.update(extra_headers)
71 req = urllib.request.Request(base + '/api.php' + path, data=data, headers=headers, method=method)
72 try:
73 response = self.opener.open(req)
74 except urllib.error.HTTPError as error:
75 response = error
76 with response:
77 raw = response.read().decode()
78 payload = json.loads(raw)
79 self.last_headers = {key.lower(): value for key, value in response.headers.items()}
80 check(response.status == expected, f'{method} {path}: verwacht {expected}, kreeg {response.status} {payload}')
81 return payload
82
83 def me(self):
84 data = self.request('GET', '/me')
85 self.csrf = data['csrf']
86 return data
87
88 try:
89 for _ in range(100):
90 try:
91 urllib.request.urlopen(base + '/index.php').close()
92 break
93 except urllib.error.URLError:
94 time.sleep(0.05)
95 else:
96 raise RuntimeError(log_path.read_text()[-2000:])
97
98 config_path = root / 'data/config.php'
99 check(config_path.is_file(), 'Eerste pagina maakt config.php')
100 generated = config_path.read_text()
101 check(all(f"'{key}' => ''" in generated for key in ['base_url', 'client_id', 'client_secret']), 'Gegenereerde configvelden zijn leeg')
102 configured = generated.replace("'client_id' => ''", "'client_id' => 'fixture-client'") + '\n// Bewaar deze servercommentaar.\n'
103 config_path.write_text(configured)
104
105 anonymous = Client()
106 missing = anonymous.request('GET', '/me', expected=401, extra_headers={'Host': 'verhalenboek.test'})
107 check('geen Authorization-header' in missing['how_to_authenticate'] and missing['hint'] == missing['how_to_authenticate'] and 'docs.php' in missing['how_to_authenticate'], '401 zonder header legt authenticatie uit')
108 check(anonymous.last_headers.get('www-authenticate') == 'Bearer', '401 stuurt WWW-Authenticate: Bearer')
109 malformed = anonymous.request('GET', '/days/latest', expected=401, extra_headers={'Authorization': 'Basic abc', 'Host': 'verhalenboek.test'})
110 check('verkeerde formaat' in malformed['how_to_authenticate'] and 'docs.php' in malformed['hint'], 'Verkeerde Authorization-vorm krijgt een eigen uitleg')
111 short = anonymous.request('GET', '/days/latest', expected=401, extra_headers={'Authorization': 'Bearer vb_kort', 'Host': 'verhalenboek.test'})
112 check(short['error'].startswith('De API-sleutel heeft het verkeerde formaat') and 'verkeerde formaat' in short['how_to_authenticate'], 'Een te korte sleutel is het verkeerde formaat')
113 unknown = anonymous.request('GET', '/days/latest', expected=401, extra_headers={'Authorization': 'Bearer vb_' + 'ab' * 32})
114 check(unknown['error'] == 'Deze API-sleutel is onbekend.' and 'onbekend of ingetrokken' in unknown['how_to_authenticate'], 'Onbekende sleutel krijgt de afwijs-uitleg')
115
116 admin = Client()
117 me = admin.me()
118 check(me['user']['name'] == 'test_user_1' and me['user']['admin'] is True and me['local'] is True, 'Eerste lokale gebruiker is beheerder')
119 check('email' not in me['user'], 'Profiel bevat geen e-mail')
120 check(config_path.read_text() == configured, 'Bestaande configuratie blijft byte voor byte staan')
121 loaded = subprocess.check_output(
122 ['php', '-r', 'require $argv[1]; echo json_encode(config());', str(root / 'lib/bootstrap.php')],
123 env={**os.environ, 'VERHALENBOEK_BASE_URL': 'https://example.test', 'VERHALENBOEK_CLIENT_ID': 'environment-client', 'VERHALENBOEK_CLIENT_SECRET': 'fixture-secret'},
124 text=True,
125 )
126 loaded_config = json.loads(loaded)
127 check(loaded_config['base_url'] == 'https://example.test' and loaded_config['client_id'] == 'fixture-client' and loaded_config['client_secret'] == 'fixture-secret', 'Lege velden gebruiken de omgeving; gevulde velden winnen')
128 check(__import__('re').fullmatch(r'[a-f0-9]{64}', loaded_config['key_secret']) is not None, 'key_secret blijft de gegenereerde serverwaarde')
129
130 reader = Client()
131 reader.me()
132 switched = reader.request('POST', '/session/switch', {'user': 'test_user_2'})
133 reader.csrf = switched['csrf']
134 check(reader.me()['user']['name'] == 'test_user_2' and reader.me()['user']['admin'] is False, 'Tweede gebruiker is alleen lezer')
135 check(admin.me()['user']['name'] == 'test_user_1', 'Sessies blijven onafhankelijk')
136
137 from urllib.parse import quote
138 roster = admin.request('GET', '/users')['users']
139 check(any(user['id'] == 'local:test_user_1' and user['name'] == 'test_user_1' and user['admin'] is True for user in roster), 'De beheerder ziet zichzelf')
140 check(any(user['id'] == 'local:test_user_2' and user['admin'] is False and 'email' not in user and 'theme' not in user for user in roster), 'De beheerder ziet de lezer, zonder privéinstellingen')
141 reader_users = reader.request('GET', '/users', expected=403)
142 check('Gebruikers beheren' in reader_users['how_to_authenticate'] and 'docs.php' in reader_users['hint'], 'Een lezer ziet de gebruikerslijst niet')
143 reader.request('PUT', '/users/' + quote('local:test_user_1', safe=''), {'admin': False}, expected=403)
144 promoted = admin.request('PUT', '/users/' + quote('local:test_user_2', safe=''), {'admin': True})['user']
145 check(promoted['admin'] is True and promoted['id'] == 'local:test_user_2', 'Een lezer wordt beheerder')
146 check(reader.me()['user']['admin'] is True, 'De gepromoveerde sessie is meteen beheerder')
147 self_denied = admin.request('PUT', '/users/' + quote('local:test_user_1', safe=''), {'admin': False}, expected=403)
148 check('eigen' in self_denied['error'] and admin.me()['user']['admin'] is True, 'Een beheerder kan zichzelf niet degraderen')
149 admin.request('PUT', '/users/' + quote('local:test_user_1', safe=''), {'admin': 'ja'}, expected=422)
150 admin.request('PUT', '/users/' + quote('auth:99', safe=''), {'admin': True}, expected=404)
151 demoted = admin.request('PUT', '/users/' + quote('local:test_user_2', safe=''), {'admin': False})['user']
152 check(demoted['admin'] is False and reader.me()['user']['admin'] is False, 'Een andere beheerder wordt weer lezer')
153
154 forbidden = reader.request('POST', '/days', {'date': '2026-05-01', 'title': 'Verboden', 'stories': stories()}, expected=403)
155 check('API-sleutel of als beheerder' in forbidden['how_to_authenticate'] and 'docs.php' in forbidden['hint'] and 'www-authenticate' not in reader.last_headers, '403 voor een lezer legt de sleutel uit, zonder WWW-Authenticate')
156 keys_forbidden = reader.request('GET', '/keys', expected=403)
157 check('ingelogde beheerder' in keys_forbidden['how_to_authenticate'] and 'docs.php' in keys_forbidden['hint'], 'Sleutels bekijken mag alleen de beheerder')
158 reader.request('POST', '/keys', {'name': 'nee'}, expected=403)
159 old = admin.csrf
160 admin.csrf = 'fout'
161 csrf_denied = admin.request('POST', '/keys', {'name': 'nee'}, expected=403)
162 check('how_to_authenticate' not in csrf_denied and csrf_denied['error'] == 'Ongeldige sessie. Laad de pagina opnieuw.', 'Een CSRF-fout blijft een kale 403')
163 admin.csrf = old
164
165 created = admin.request('POST', '/keys', {'name': 'Schrijver'}, expected=201)['key']
166 token = created['token']
167 check(token.startswith('vb_') and created['prefix'] == token[:11], 'Nieuwe sleutel toont het geheim')
168 listed = admin.request('GET', '/keys')['keys']
169 check(token not in json.dumps(listed) and listed[0]['prefix'] == created['prefix'] and 'token' not in listed[0], 'De lijst verbergt het geheim')
170 revealed = admin.request('GET', '/keys/' + str(created['id']))['key']
171 check(revealed['token'] == token and 'token_cipher' not in revealed, 'De beheerder kan de volledige sleutel opnieuw opvragen')
172 reader.request('GET', '/keys/' + str(created['id']), expected=403)
173 with sqlite3.connect(root / 'data/verhalenboek.sqlite') as db:
174 stored_hash, stored_cipher = db.execute('SELECT token_hash, token_cipher FROM api_keys WHERE id=?', (created['id'],)).fetchone()
175 check(stored_hash != token and len(stored_hash) == 64 and token not in stored_cipher and stored_cipher != '', 'De database bewaart een hash en cijfertekst, geen platte sleutel')
176
177 bearer = Client(token)
178 check(bearer.request('GET', '/days/latest', expected=404)['error'], 'Nog geen laatste datum')
179 check(bearer.request('GET', '/days/gaps') == {'first': None, 'latest': None, 'missing': [], 'incomplete': []}, 'Lege gaten')
180 bearer.request('POST', '/days', {'date': '2026-05-01', 'title': 'Mei', 'stories': stories()[:2]}, expected=422)
181 bearer.request('POST', '/days', {'date': '2026-05-01', 'title': 'Mei', 'stories': stories() + [{'title': 'Extra', 'paragraphs': ['Te veel']}]}, expected=422)
182 bearer.request('POST', '/days', {'date': '2026-02-31', 'title': 'Nee', 'stories': stories()}, expected=422)
183 bearer.request('POST', '/days', {'date': '2026-05-01', 'title': 'Mei', 'stories': [
184 {'title': 'Een', 'paragraphs': ['']},
185 {'title': 'Twee', 'paragraphs': ['Oké']},
186 {'title': 'Drie', 'paragraphs': ['Oké']},
187 ]}, expected=422)
188 first = bearer.request('POST', '/days', {'date': '2026-05-01', 'title': 'De eerste bladzijde', 'stories': stories('Eerste')}, expected=201)
189 check(first['complete'] is True and first['storyCount'] == 3 and [s['position'] for s in first['stories']] == [1, 2, 3], 'Eén aanroep maakt een volledige dag')
190 check(first['stories'][0]['paragraphs'][1] == 'Tweede alinea met één accent.', 'Unicode blijft intact')
191 bearer.request('POST', '/days', {'date': '2026-05-01', 'title': 'Dubbel', 'stories': stories()}, expected=409)
192 bearer.request('POST', '/days', {'date': '2026-05-02', 'title': 'De regen op het dak', 'stories': stories('Regen')}, expected=201)
193 bearer.request('POST', '/days', {'date': '2026-05-04', 'title': 'Het licht in de keuken', 'stories': stories('Licht')}, expected=201)
194 check(bearer.request('GET', '/days/latest')['date'] == '2026-05-04', 'Laatste geschreven datum')
195 gaps = bearer.request('GET', '/days/gaps')
196 check(gaps['first'] == '2026-05-01' and gaps['latest'] == '2026-05-04' and gaps['missing'] == ['2026-05-03'] and gaps['incomplete'] == [], 'Ontbrekende dag tussen de eerste en de laatste')
197
198 middle = bearer.request('GET', '/days/2026-05-02')
199 check(middle['previous'] == '2026-05-01' and middle['next'] == '2026-05-04' and 'read' not in middle, 'Vorige en volgende dag, zonder leesstatus voor een sleutel')
200 kept = bearer.request('PUT', '/days/2026-05-02/stories/2', {'title': 'Nieuwe middag'})
201 check(kept['stories'][1]['title'] == 'Nieuwe middag' and kept['stories'][1]['paragraphs'] == ['Midden.'], 'Verhaal bewerken bewaart de alinea\'s')
202 broken = bearer.request('DELETE', '/days/2026-05-04/stories/2')
203 check(broken['complete'] is False and [s['position'] for s in broken['stories']] == [1, 3], 'Verwijderd verhaal laat een gat in de plekken')
204 latest = bearer.request('GET', '/days/latest')
205 check(latest['date'] == '2026-05-04' and latest['complete'] is False and latest['storyCount'] == 2, 'De laatste datum blijft, ook als de dag onvolledig is')
206 gaps = bearer.request('GET', '/days/gaps')
207 check(gaps['missing'] == ['2026-05-03'], 'Een onvolledige dag staat niet bij de ontbrekende datums')
208 incomplete = gaps['incomplete']
209 check(len(incomplete) == 1 and incomplete[0]['date'] == '2026-05-04' and incomplete[0]['missingPositions'] == [2] and incomplete[0]['storyCount'] == 2, 'Onvolledige dag meldt de ontbrekende plek')
210 repaired = bearer.request('POST', '/days/2026-05-04/stories', {'title': 'Terug', 'paragraphs': ['Weer drie.']}, expected=201)
211 check(repaired['complete'] is True and repaired['stories'][1]['position'] == 2, 'Het ontbrekende verhaal vult plek 2')
212 bearer.request('POST', '/days/2026-05-04/stories', {'title': 'Vier', 'paragraphs': ['Nee']}, expected=422)
213 bearer.request('DELETE', '/days/2026-05-02')
214 check(bearer.request('GET', '/days/latest')['date'] == '2026-05-04', 'Verwijderen van een middendag laat de laatste datum staan')
215 check('2026-05-02' in bearer.request('GET', '/days/gaps')['missing'], 'Een verwijderde dag wordt een gat')
216 bearer.request('POST', '/days/2026-05-02/read', expected=403)
217 bearer_keys = bearer.request('GET', '/keys', expected=403)
218 check('ingelogde beheerder' in bearer_keys['how_to_authenticate'] and token not in json.dumps(bearer_keys), 'Een sleutel mag andere sleutels niet uitlezen')
219 bearer_users = bearer.request('PUT', '/users/' + quote('local:test_user_2', safe=''), {'admin': True}, expected=403)
220 check('Gebruikers beheren' in bearer_users['how_to_authenticate'] and reader.me()['user']['admin'] is False, 'Een API-sleutel kan niemand beheerder maken')
221 bearer.request('DELETE', '/days/2099-01-01', expected=404)
222
223 check(reader.request('GET', '/days/2026-05-01')['read'] is False, 'Openen via GET markeert de dag nog niet')
224 check(reader.request('POST', '/days/2026-05-01/read')['read'] is True, 'De lezer markeert de dag als gelezen')
225 check(reader.request('POST', '/days/2026-05-01/read')['read'] is True, 'Opnieuw gelezen blijft gelezen')
226 reader_days = reader.request('GET', '/days')['days']
227 admin_days = admin.request('GET', '/days')['days']
228 check(next(day for day in reader_days if day['date'] == '2026-05-01')['read'] is True, 'Overzicht van de lezer toont gelezen')
229 check(next(day for day in admin_days if day['date'] == '2026-05-01')['read'] is False, 'De andere gebruiker heeft die dag niet gelezen')
230 check(reader.request('DELETE', '/days/2026-05-01/read')['read'] is False, 'Handmatig ongelezen')
231 reader.request('DELETE', '/days/2026-05-04', expected=403)
232 reader.request('PUT', '/me/settings', {'theme': 'dark', 'font': 'rounded'})
233 check(reader.me()['user']['theme'] == 'dark' and reader.me()['user']['font'] == 'rounded', 'Instellingen blijven bewaard')
234 check(admin.me()['user']['theme'] == 'system' and admin.me()['user']['font'] == 'serif', 'Instellingen zijn per gebruiker')
235 reader.request('PUT', '/me/settings', {'theme': 'blauw', 'font': 'serif'}, expected=422)
236 export = reader.request('GET', '/me/export')
237 check(export['profile']['name'] == 'test_user_2' and 'email' not in export['profile'] and export['api_keys'] == [], 'Export bevat alleen de eigen gegevens')
238 check(all(item['date'] != '2026-05-01' or item['read_at'] for item in export['reads']) or export['reads'] == [], 'Een ongelezen dag staat niet als gelezen in de export')
239 check(export['reads'] == [], 'Na ongelezen zit de dag niet meer in de export')
240
241 admin.request('PUT', '/days/2026-05-01', {'title': 'Herziene titel'})
242 check(admin.request('GET', '/days/2026-05-01')['title'] == 'Herziene titel', 'Beheerder bewerkt een dag in de sessie')
243 admin.request('PUT', '/days/2026-05-01', {'stories': stories()[:1]}, expected=422)
244 revoked = admin.request('DELETE', '/keys/' + str(created['id']))['key']
245 check(revoked['revoked'] is not None and 'token' not in revoked, 'Sleutel intrekken toont het geheim niet')
246 still = admin.request('GET', '/keys/' + str(created['id']))['key']
247 check(still['token'] == token and still['revoked'] is not None, 'Een ingetrokken sleutel blijft zichtbaar voor de beheerder')
248 rejected = bearer.request('GET', '/days/latest', expected=401)
249 check(rejected['error'] == 'Deze API-sleutel is ingetrokken.' and 'onbekend of ingetrokken' in rejected['how_to_authenticate'] and bearer.last_headers.get('www-authenticate') == 'Bearer', 'Ingetrokken sleutel krijgt 401 met uitleg')
250 admin.request('GET', '/days/nope', expected=404)
251 admin.request('PUT', '/days/latest', {'title': 'Nee'}, expected=405)
252
253 for path in ['/data/config.php', '/data/verhalenboek.sqlite', '/lib/bootstrap.php', '/lib/Storybook.php']:
254 try:
255 urllib.request.urlopen(base + path)
256 check(False, path + ' moet afgeschermd zijn')
257 except urllib.error.HTTPError as error:
258 check(error.code == 403, path + ' geeft ' + str(error.code))
259
260 docs = urllib.request.urlopen(base + '/docs.php')
261 body = docs.read().decode()
262 check(docs.status == 200 and 'precies drie verhalen' in body and 'days/latest' in body and 'how_to_authenticate' in body and 'WWW-Authenticate' in body, 'API-documentatie legt authenticatie uit')
263
264 auth_bootstrap = root / 'lib/bootstrap.php'
265 auth_bootstrap.write_text(auth_bootstrap.read_text().replace(
266 " $ch=curl_init('https://auth.timfalken.com'.$path);",
267 " return match($path) {'/api/me'=>['user'=>['id'=>7,'username'=>'oauth_user','email'=>'hidden@example.com']],'/api/logout'=>['ok'=>true],'/api/session/extend'=>['expires_in'=>86400],default=>['access_token'=>'fixture-token','expires_in'=>86400]};\n $ch=curl_init('https://auth.timfalken.com'.$path);",
268 ))
269 config_path.write_text(config_path.read_text().replace("'client_secret' => ''", "'client_secret' => 'fixture-secret'"))
270
271 class NoRedirect(urllib.request.HTTPRedirectHandler):
272 def redirect_request(self, req, fp, code, msg, headers, newurl):
273 return None
274
275 oauth = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(http.cookiejar.CookieJar()), NoRedirect())
276
277 def redirect(path):
278 try:
279 oauth.open(base + path)
280 raise AssertionError('redirect verwacht')
281 except urllib.error.HTTPError as error:
282 check(error.code == 302, 'OAuth redirect: ' + error.read().decode())
283 return error.headers['Location']
284
285 from urllib.parse import parse_qs, urlsplit
286 login = redirect('/auth.php')
287 oauth_state = parse_qs(urlsplit(login).query)['state'][0]
288 check('client_id=fixture-client' in login and 'redirect_uri=' in login and login.startswith('https://auth.timfalken.com/oauth/authorize?'), 'Login gaat naar de account-dienst')
289 callback = redirect('/callback.php?state=' + oauth_state + '&code=fixture')
290 check(urlsplit(callback).path == '/', 'OAuth komt terug op het boek')
291 with sqlite3.connect(root / 'data/verhalenboek.sqlite') as db:
292 row = db.execute("SELECT id, name, role FROM users WHERE id='auth:7'").fetchone()
293 columns = [name for _, name, *_ in db.execute('PRAGMA table_info(users)')]
294 check(row == ('auth:7', 'oauth_user', 'user'), 'OAuth-gebruiker gebruikt het numerieke id en wordt geen beheerder')
295 check('email' not in columns and 'hidden@example.com' not in json.dumps(row), 'E-mail wordt niet opgeslagen')
296
297 print(f'API: {checks} assertions passed.')
298 except Exception:
299 log.flush()
300 print(log_path.read_text()[-4000:])
301 raise
302 finally:
303 os.killpg(process.pid, signal.SIGTERM)
304 process.wait(timeout=5)
305 log.close()