BlueGit

projects-timfalken-com verhalenboek

Files

verhalenboek / web / tests / integration.py

integration.py

feat: voeg Verhalenboek toe met dagen, leesvoortgang en schrijf-API
timfa project_87242033_bot_b167a9be22027ad5a4b431d0ad8426c6 · pushed by timfa · 6 weeks ago
799da657 History
integration.py 16.2 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 check(response.status == expected, f'{method} {path}: verwacht {expected}, kreeg {response.status} {payload}')
80 return payload
81
82 def me(self):
83 data = self.request('GET', '/me')
84 self.csrf = data['csrf']
85 return data
86
87 try:
88 for _ in range(100):
89 try:
90 urllib.request.urlopen(base + '/index.php').close()
91 break
92 except urllib.error.URLError:
93 time.sleep(0.05)
94 else:
95 raise RuntimeError(log_path.read_text()[-2000:])
96
97 config_path = root / 'data/config.php'
98 check(config_path.is_file(), 'Eerste pagina maakt config.php')
99 generated = config_path.read_text()
100 check(all(f"'{key}' => ''" in generated for key in ['base_url', 'client_id', 'client_secret']), 'Gegenereerde configvelden zijn leeg')
101 configured = generated.replace("'client_id' => ''", "'client_id' => 'fixture-client'") + '\n// Bewaar deze servercommentaar.\n'
102 config_path.write_text(configured)
103
104 anonymous = Client()
105 anonymous.request('GET', '/me', expected=401, extra_headers={'Host': 'verhalenboek.test'})
106 anonymous.request('GET', '/days/latest', expected=401, extra_headers={'Authorization': 'Bearer vb_' + 'ab' * 32})
107
108 admin = Client()
109 me = admin.me()
110 check(me['user']['name'] == 'test_user_1' and me['user']['admin'] is True and me['local'] is True, 'Eerste lokale gebruiker is beheerder')
111 check('email' not in me['user'], 'Profiel bevat geen e-mail')
112 check(config_path.read_text() == configured, 'Bestaande configuratie blijft byte voor byte staan')
113 loaded = subprocess.check_output(
114 ['php', '-r', 'require $argv[1]; echo json_encode(config());', str(root / 'lib/bootstrap.php')],
115 env={**os.environ, 'VERHALENBOEK_BASE_URL': 'https://example.test', 'VERHALENBOEK_CLIENT_ID': 'environment-client', 'VERHALENBOEK_CLIENT_SECRET': 'fixture-secret'},
116 text=True,
117 )
118 check(json.loads(loaded) == {'base_url': 'https://example.test', 'client_id': 'fixture-client', 'client_secret': 'fixture-secret'}, 'Lege velden gebruiken de omgeving; gevulde velden winnen')
119
120 reader = Client()
121 reader.me()
122 switched = reader.request('POST', '/session/switch', {'user': 'test_user_2'})
123 reader.csrf = switched['csrf']
124 check(reader.me()['user']['name'] == 'test_user_2' and reader.me()['user']['admin'] is False, 'Tweede gebruiker is alleen lezer')
125 check(admin.me()['user']['name'] == 'test_user_1', 'Sessies blijven onafhankelijk')
126
127 reader.request('POST', '/days', {'date': '2026-05-01', 'title': 'Verboden', 'stories': stories()}, expected=403)
128 reader.request('POST', '/keys', {'name': 'nee'}, expected=403)
129 reader.request('GET', '/keys', expected=403)
130 old = admin.csrf
131 admin.csrf = 'fout'
132 admin.request('POST', '/keys', {'name': 'nee'}, expected=403)
133 admin.csrf = old
134
135 created = admin.request('POST', '/keys', {'name': 'Schrijver'}, expected=201)['key']
136 token = created['token']
137 check(token.startswith('vb_') and created['prefix'] == token[:11], 'Nieuwe sleutel toont het geheim één keer')
138 listed = admin.request('GET', '/keys')['keys']
139 check(token not in json.dumps(listed) and listed[0]['prefix'] == created['prefix'] and 'token' not in listed[0], 'De lijst verbergt het geheim')
140 with sqlite3.connect(root / 'data/verhalenboek.sqlite') as db:
141 stored = db.execute('SELECT token_hash FROM api_keys WHERE id=?', (created['id'],)).fetchone()[0]
142 check(stored != token and len(stored) == 64, 'De database bewaart alleen een hash')
143
144 bearer = Client(token)
145 check(bearer.request('GET', '/days/latest', expected=404)['error'], 'Nog geen laatste datum')
146 check(bearer.request('GET', '/days/gaps') == {'first': None, 'latest': None, 'missing': [], 'incomplete': []}, 'Lege gaten')
147 bearer.request('POST', '/days', {'date': '2026-05-01', 'title': 'Mei', 'stories': stories()[:2]}, expected=422)
148 bearer.request('POST', '/days', {'date': '2026-05-01', 'title': 'Mei', 'stories': stories() + [{'title': 'Extra', 'paragraphs': ['Te veel']}]}, expected=422)
149 bearer.request('POST', '/days', {'date': '2026-02-31', 'title': 'Nee', 'stories': stories()}, expected=422)
150 bearer.request('POST', '/days', {'date': '2026-05-01', 'title': 'Mei', 'stories': [
151 {'title': 'Een', 'paragraphs': ['']},
152 {'title': 'Twee', 'paragraphs': ['Oké']},
153 {'title': 'Drie', 'paragraphs': ['Oké']},
154 ]}, expected=422)
155 first = bearer.request('POST', '/days', {'date': '2026-05-01', 'title': 'De eerste bladzijde', 'stories': stories('Eerste')}, expected=201)
156 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')
157 check(first['stories'][0]['paragraphs'][1] == 'Tweede alinea met één accent.', 'Unicode blijft intact')
158 bearer.request('POST', '/days', {'date': '2026-05-01', 'title': 'Dubbel', 'stories': stories()}, expected=409)
159 bearer.request('POST', '/days', {'date': '2026-05-02', 'title': 'De regen op het dak', 'stories': stories('Regen')}, expected=201)
160 bearer.request('POST', '/days', {'date': '2026-05-04', 'title': 'Het licht in de keuken', 'stories': stories('Licht')}, expected=201)
161 check(bearer.request('GET', '/days/latest')['date'] == '2026-05-04', 'Laatste geschreven datum')
162 gaps = bearer.request('GET', '/days/gaps')
163 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')
164
165 middle = bearer.request('GET', '/days/2026-05-02')
166 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')
167 kept = bearer.request('PUT', '/days/2026-05-02/stories/2', {'title': 'Nieuwe middag'})
168 check(kept['stories'][1]['title'] == 'Nieuwe middag' and kept['stories'][1]['paragraphs'] == ['Midden.'], 'Verhaal bewerken bewaart de alinea\'s')
169 broken = bearer.request('DELETE', '/days/2026-05-04/stories/2')
170 check(broken['complete'] is False and [s['position'] for s in broken['stories']] == [1, 3], 'Verwijderd verhaal laat een gat in de plekken')
171 latest = bearer.request('GET', '/days/latest')
172 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')
173 gaps = bearer.request('GET', '/days/gaps')
174 check(gaps['missing'] == ['2026-05-03'], 'Een onvolledige dag staat niet bij de ontbrekende datums')
175 incomplete = gaps['incomplete']
176 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')
177 repaired = bearer.request('POST', '/days/2026-05-04/stories', {'title': 'Terug', 'paragraphs': ['Weer drie.']}, expected=201)
178 check(repaired['complete'] is True and repaired['stories'][1]['position'] == 2, 'Het ontbrekende verhaal vult plek 2')
179 bearer.request('POST', '/days/2026-05-04/stories', {'title': 'Vier', 'paragraphs': ['Nee']}, expected=422)
180 bearer.request('DELETE', '/days/2026-05-02')
181 check(bearer.request('GET', '/days/latest')['date'] == '2026-05-04', 'Verwijderen van een middendag laat de laatste datum staan')
182 check('2026-05-02' in bearer.request('GET', '/days/gaps')['missing'], 'Een verwijderde dag wordt een gat')
183 bearer.request('POST', '/days/2026-05-02/read', expected=403)
184 bearer.request('GET', '/keys', expected=403)
185 bearer.request('DELETE', '/days/2099-01-01', expected=404)
186
187 check(reader.request('GET', '/days/2026-05-01')['read'] is False, 'Openen via GET markeert de dag nog niet')
188 check(reader.request('POST', '/days/2026-05-01/read')['read'] is True, 'De lezer markeert de dag als gelezen')
189 check(reader.request('POST', '/days/2026-05-01/read')['read'] is True, 'Opnieuw gelezen blijft gelezen')
190 reader_days = reader.request('GET', '/days')['days']
191 admin_days = admin.request('GET', '/days')['days']
192 check(next(day for day in reader_days if day['date'] == '2026-05-01')['read'] is True, 'Overzicht van de lezer toont gelezen')
193 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')
194 check(reader.request('DELETE', '/days/2026-05-01/read')['read'] is False, 'Handmatig ongelezen')
195 reader.request('DELETE', '/days/2026-05-04', expected=403)
196 reader.request('PUT', '/me/settings', {'theme': 'dark', 'font': 'rounded'})
197 check(reader.me()['user']['theme'] == 'dark' and reader.me()['user']['font'] == 'rounded', 'Instellingen blijven bewaard')
198 check(admin.me()['user']['theme'] == 'system' and admin.me()['user']['font'] == 'serif', 'Instellingen zijn per gebruiker')
199 reader.request('PUT', '/me/settings', {'theme': 'blauw', 'font': 'serif'}, expected=422)
200 export = reader.request('GET', '/me/export')
201 check(export['profile']['name'] == 'test_user_2' and 'email' not in export['profile'] and export['api_keys'] == [], 'Export bevat alleen de eigen gegevens')
202 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')
203 check(export['reads'] == [], 'Na ongelezen zit de dag niet meer in de export')
204
205 admin.request('PUT', '/days/2026-05-01', {'title': 'Herziene titel'})
206 check(admin.request('GET', '/days/2026-05-01')['title'] == 'Herziene titel', 'Beheerder bewerkt een dag in de sessie')
207 admin.request('PUT', '/days/2026-05-01', {'stories': stories()[:1]}, expected=422)
208 revoked = admin.request('DELETE', '/keys/' + str(created['id']))['key']
209 check(revoked['revoked'] is not None, 'Sleutel intrekken')
210 bearer.request('GET', '/days/latest', expected=401)
211 admin.request('GET', '/days/nope', expected=404)
212 admin.request('PUT', '/days/latest', {'title': 'Nee'}, expected=405)
213
214 for path in ['/data/config.php', '/data/verhalenboek.sqlite', '/lib/bootstrap.php', '/lib/Storybook.php']:
215 try:
216 urllib.request.urlopen(base + path)
217 check(False, path + ' moet afgeschermd zijn')
218 except urllib.error.HTTPError as error:
219 check(error.code == 403, path + ' geeft ' + str(error.code))
220
221 docs = urllib.request.urlopen(base + '/docs.php')
222 body = docs.read().decode()
223 check(docs.status == 200 and 'precies drie verhalen' in body and 'days/latest' in body, 'API-documentatie is bereikbaar')
224
225 auth_bootstrap = root / 'lib/bootstrap.php'
226 auth_bootstrap.write_text(auth_bootstrap.read_text().replace(
227 " $ch=curl_init('https://auth.timfalken.com'.$path);",
228 " 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);",
229 ))
230 config_path.write_text(config_path.read_text().replace("'client_secret' => ''", "'client_secret' => 'fixture-secret'"))
231
232 class NoRedirect(urllib.request.HTTPRedirectHandler):
233 def redirect_request(self, req, fp, code, msg, headers, newurl):
234 return None
235
236 oauth = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(http.cookiejar.CookieJar()), NoRedirect())
237
238 def redirect(path):
239 try:
240 oauth.open(base + path)
241 raise AssertionError('redirect verwacht')
242 except urllib.error.HTTPError as error:
243 check(error.code == 302, 'OAuth redirect: ' + error.read().decode())
244 return error.headers['Location']
245
246 from urllib.parse import parse_qs, urlsplit
247 login = redirect('/auth.php')
248 oauth_state = parse_qs(urlsplit(login).query)['state'][0]
249 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')
250 callback = redirect('/callback.php?state=' + oauth_state + '&code=fixture')
251 check(urlsplit(callback).path == '/', 'OAuth komt terug op het boek')
252 with sqlite3.connect(root / 'data/verhalenboek.sqlite') as db:
253 row = db.execute("SELECT id, name, role FROM users WHERE id='auth:7'").fetchone()
254 columns = [name for _, name, *_ in db.execute('PRAGMA table_info(users)')]
255 check(row == ('auth:7', 'oauth_user', 'user'), 'OAuth-gebruiker gebruikt het numerieke id en wordt geen beheerder')
256 check('email' not in columns and 'hidden@example.com' not in json.dumps(row), 'E-mail wordt niet opgeslagen')
257
258 print(f'API: {checks} assertions passed.')
259 except Exception:
260 log.flush()
261 print(log_path.read_text()[-4000:])
262 raise
263 finally:
264 os.killpg(process.pid, signal.SIGTERM)
265 process.wait(timeout=5)
266 log.close()