BlueGit

projects-timfalken-com microchess

Files

microchess / web / tests / integration.py

integration.py

integration.py 22.9 KiB Download Raw
1#!/usr/bin/env python3
2"""Isolated end-to-end API tests. No changes to the application's real database."""
3import concurrent.futures
4import os
5import signal
6import http.cookiejar
7import json
8from pathlib import Path
9import shutil
10import socket
11import sqlite3
12import subprocess
13import tempfile
14import time
15import urllib.request
16import urllib.error
17
18WEB = Path(__file__).resolve().parents[1]
19ARTIFACTS = WEB / 'tests/artifacts'
20ARTIFACTS.mkdir(exist_ok=True)
21checks = 0
22
23def check(value, label):
24 global checks
25 checks += 1
26 assert value, label
27
28with tempfile.TemporaryDirectory(prefix='api-', dir=ARTIFACTS) as tmp:
29 root = Path(tmp)
30 for name in ['api.php', 'index.php', 'auth.php', 'callback.php', 'router.php']:
31 shutil.copy(WEB / name, root / name)
32 shutil.copytree(WEB / 'lib', root / 'lib', ignore=shutil.ignore_patterns('tablebase'))
33 shutil.copytree(WEB / 'assets/avatars', root / 'assets/avatars')
34 (root / 'data').mkdir()
35 with socket.socket() as sock:
36 sock.bind(('127.0.0.1', 0))
37 port = sock.getsockname()[1]
38 base = f'http://127.0.0.1:{port}'
39 log = (root / 'server.log').open('w')
40 process = subprocess.Popen(['php', '-S', f'127.0.0.1:{port}', '-t', str(root), str(root / 'router.php')], stdout=log, stderr=log, env={**os.environ, 'PHP_CLI_SERVER_WORKERS':'4'}, start_new_session=True)
41 class Client:
42 def __init__(self):
43 self.opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(http.cookiejar.CookieJar()))
44 self.csrf = None
45 def get(self, path='/api.php'):
46 with self.opener.open(base + path) as r:
47 return json.load(r)
48 def state(self):
49 state = self.get()
50 self.csrf = state['csrf']
51 return state
52 def post(self, action, expected=200, **fields):
53 req = urllib.request.Request(base + '/api.php', data=json.dumps({'action':action, **fields}).encode(), headers={'Content-Type':'application/json', 'X-CSRF-Token':self.csrf or ''})
54 try:
55 response = self.opener.open(req)
56 except urllib.error.HTTPError as error:
57 response = error
58 with response:
59 check(response.status == expected, f'{action}: expected {expected}, got {response.status}')
60 return json.load(response)
61 def game(self, id):
62 return next(g for g in self.state()['games'] if g['id'] == id)
63 def game_action(self, action, id, **fields):
64 g = self.game(id)
65 return self.post(action, game=id, version=g['version'], **fields)
66 try:
67 for _ in range(100):
68 try:
69 urllib.request.urlopen(base + '/index.php').close()
70 break
71 except urllib.error.URLError:
72 time.sleep(.05)
73 config_path=root/'data/config.php'
74 check(config_path.is_file(),'First page request creates config.php')
75 generated=config_path.read_text()
76 check(all(f"'{key}' => ''" in generated for key in ['base_url','client_id','client_secret']),'Generated config fields are empty')
77 configured=generated.replace("'client_id' => ''", "'client_id' => 'fixture-client'")+'\n// Keep this server-specific comment.\n'
78 config_path.write_text(configured)
79 a, b = Client(), Client()
80 check(a.state()['user']['name'] == 'test_user_1', 'Local autologin')
81 check(config_path.read_text()==configured,'Existing configuration preserved byte-for-byte')
82 loaded=subprocess.check_output(['php','-r',
83 'require $argv[1]; echo json_encode(config());',str(root/'lib/bootstrap.php')],
84 env={**os.environ,'MICROCHESS_BASE_URL':'https://example.test','MICROCHESS_CLIENT_ID':'environment-client','MICROCHESS_CLIENT_SECRET':'fixture-secret'},text=True)
85 check(json.loads(loaded)=={'base_url':'https://example.test','client_id':'fixture-client','client_secret':'fixture-secret'},'Empty fields use environment; configured fields take precedence')
86 b.state(); b.post('switch_user', user='test_user_2'); b.state()
87 check(b.state()['user']['name'] == 'test_user_2', 'Independent sessions')
88 check(a.state()['user']['rating']==b.state()['user']['rating']==1200, 'Accounts start at 1200 Elo')
89 initial_avatar=b.state()['user']['avatar']
90 check(initial_avatar in {v['id'] for v in json.loads((root/'assets/avatars/catalog.json').read_text())},'Random default avatar')
91 a.post('set_avatar',avatar='blue-knight')
92 check(a.state()['user']['avatar']=='blue-knight','Avatar persists across requests')
93 check(b.state()['user']['avatar']==initial_avatar,'Avatar change affects only the signed-in user')
94 a.post('set_avatar',avatar='../../data/config.php',expected=409)
95 a.post('set_avatar',avatar='not-a-piece',expected=409)
96 a.post('set_avatar',avatar=['blue-knight'],expected=409)
97 b.post('set_avatar',avatar='purple-elephant')
98 check(b.state()['user']['avatar']=='purple-elephant','Fairy avatar can be selected')
99 b.post('set_avatar',avatar=None)
100 check(b.state()['user']['avatar'] is not None,'Random avatar reset')
101 a.post('switch_user', user='admin', expected=409)
102 old = a.csrf; a.csrf = 'wrong'; a.post('create_link', kind='match', expected=403); a.csrf = old
103 token = a.post('create_link', kind='friend')['url'].split('=')[1]
104 check(b.get('/api.php?invite='+token)['invite']['kind'] == 'friend', 'Friend request preview')
105 a.post('accept_link', token=token, expected=409)
106 b.post('accept_link', token=token)
107 check(len(a.state()['friends']) == len(b.state()['friends']) == 1, 'Mutual friendship')
108 check(b.state()['friends'][0]['avatar']=='blue-knight','Friends see selected avatar')
109 b.post('accept_link', token=token, expected=409)
110 a.post('challenge', friend='local:test_user_2')
111 g = b.state()['games'][0]; id = g['id']
112 check(g['incoming'] and g['status']=='pending', 'Incoming challenge')
113 a.post('challenge', friend='local:test_user_2', expected=409)
114 a.game_action('accept', id, expected=409)
115 b.game_action('reject', id)
116 check(not a.state()['games'] and not b.state()['games'], 'Reject removes both tiles')
117 a.post('challenge', friend='local:test_user_2'); id = b.state()['games'][0]['id']; b.game_action('accept', id)
118 ga, gb = a.game(id), b.game(id)
119 check(gb['opponentAvatar']=='blue-knight','Game tile includes opponent avatar')
120 check(ga['color'] != gb['color'] and ga['yourTurn'] != gb['yourTurn'], 'Opposite colors and one turn')
121 white, black = (a,b) if ga['color']=='w' else (b,a)
122 black.game_action('move', id, from_=4, to=8, expected=409)
123 current = white.game(id)
124 white.post('move', game=id, version=current['version'], **{'from':15,'to':7}, expected=409)
125 move = current['legal'][0]
126 check('analysis' not in current, 'Polling carries no obsolete evaluation data')
127 response = white.post('move', game=id, version=current['version'], **move)
128 check(response['feedback']['model'] == 'tactical-estimate' and response['feedback']['ply'] == 1, 'Confirmed move returns live tactical estimate')
129 check(response['feedback']['quality'] in [None, 'good', 'poor'], 'Only supported feedback values')
130 white.post('move', game=id, version=current['version'], **move, expected=409)
131 check(black.game(id)['yourTurn'], 'Turn passes')
132 check(black.game(id)['turnOrder']>current['turnOrder'],'New turn receives a later persistent queue position')
133 black.game_action('resign', id)
134 check(a.game(id)['status']=='ended' and b.game(id)['winner']==white.state()['user']['name'], 'Resignation result')
135 check(white.state()['user']['rating']==1216 and black.state()['user']['rating']==1184, 'Equal rating win transfers 16 points')
136 black.game_action('resign', id, expected=409)
137 check(black.state()['user']['ratedGames']==1, 'Duplicate result cannot change rating twice')
138 check(sum(a.state()['friends'][0][k] for k in ['wins','losses','ties'])==1, 'Stats recorded once')
139 archive=white.get('/api.php?action=history')
140 check(len(archive)==1 and archive[0]['outcome']=='win','Winner has saved game')
141 saved_id=archive[0]['id']
142 saved=white.get(f'/api.php?action=replay&id={saved_id}')
143 check(len(saved['positions'])==2 and saved['positions'][-1]['board']==white.game(id)['state']['board'],'Replay reconstructs opening and final board')
144 check(black.get('/api.php?action=history')[0]['outcome']=='loss','Both participants can access their result')
145 check(saved['color']=='w','Replay retains player orientation')
146 old_color = a.game(id)['color']
147 a.game_action('rematch', id)
148 check(b.game(id)['opponentRematch'], 'Rematch notification')
149 b.game_action('rematch', id)
150 check(a.game(id)['color'] != old_color and a.game(id)['state']['ply']==0, 'Rematch swaps sides, same tile')
151 turn = a if a.game(id)['yourTurn'] else b
152 turn.game_action('offer_draw', id)
153 move = turn.game(id)['legal'][0]; turn.game_action('move',id,**move)
154 other = b if turn is a else a
155 other.game_action('accept_draw', id)
156 check(a.state()['friends'][0]['ties']==1, 'Draw stats')
157 check(white.state()['user']['rating']==1215 and black.state()['user']['rating']==1185, 'Rematch draw transfers one point to lower rated player')
158 check(a.state()['user']['ratedGames']==b.state()['user']['ratedGames']==2, 'Rematch rated separately')
159 archive=a.get('/api.php?action=history')
160 check(len(archive)==2 and archive[0]['id']>archive[1]['id'] and archive[0]['outcome']=='draw','Rematches saved separately, newest first')
161 check(white.get(f'/api.php?action=replay&id={saved_id}')['positions']==saved['positions'] and white.get(f'/api.php?action=replay&id={saved_id}')['color']==saved['color'],'Rematch preserves original replay')
162 a.game_action('rematch', id); b.game_action('exit', id)
163 check(not a.game(id)['canRematch'], 'Exit disables opponent rematch')
164 check(not b.state()['games'], 'Exit hides own tile only')
165 check(len(b.get('/api.php?action=history'))==2,'Exiting keeps saved games')
166 a.game_action('rematch', id, expected=409)
167 a.game_action('exit', id)
168 match = a.post('create_link',kind='match')['url'].split('=')[1]
169 check(b.get('/api.php?invite='+match)['invite']['kind']=='match', 'Match link modal')
170 check(b.get('/api.php?invite='+match)['invite']['kind']=='match', 'Preview/reject leaves link valid')
171 def race_accept(_):
172 req=urllib.request.Request(base+'/api.php',data=json.dumps({'action':'accept_link','token':match}).encode(),headers={'Content-Type':'application/json','X-CSRF-Token':b.csrf})
173 try:
174 with b.opener.open(req) as response:
175 response.read()
176 return response.status
177 except urllib.error.HTTPError as error:
178 return error.code
179 with concurrent.futures.ThreadPoolExecutor(max_workers=2) as pool:
180 statuses=list(pool.map(race_accept,range(2)))
181 check(sorted(statuses)==[200,409],'Concurrent link acceptance starts only one game')
182 con=sqlite3.connect(root/'data/microchess.sqlite')
183 expired = a.post('create_link',kind='match')['url'].split('=')[1]
184 con.execute('UPDATE links SET expires=0 WHERE token=?',(expired,));con.commit()
185 b.post('accept_link',token=expired,expected=409)
186 # Server-side claim with an intended move: no requirement to play it first.
187 id=a.state()['games'][0]['id'];g=a.game(id)
188 raw=json.loads(con.execute('SELECT state FROM games WHERE id=?',(id,)).fetchone()[0]);raw['halfmove']=99
189 con.execute('UPDATE games SET state=? WHERE id=?',(json.dumps(raw),id));con.commit()
190 turn=a if g['yourTurn'] else b
191 move=next(m for m in turn.game(id)['legal'] if m['from']==18)
192 turn.game_action('claim_draw',id,**move)
193 check(a.game(id)['reason']=='50-move rule','Intended move draw claim')
194 a.post('remove_friend',friend='local:test_user_2')
195 check(not a.state()['friends'] and not b.state()['friends'],'Mutual removal')
196 a.post('challenge',friend='local:test_user_2',expected=409)
197 exported=a.get('/api.php?action=export')
198 check(len(exported['results'])==3 and len(exported['games'])==2,'Export includes archived games/results')
199 check('token' not in exported['profile'],'No auth token in export')
200 check(exported['profile']['avatar']=='blue-knight','Data export includes avatar preference')
201 for path in ['/data/microchess.sqlite','/lib/bootstrap.php','/tests/chess.php','/data%2fmicrochess.sqlite','/.htaccess']:
202 try:
203 urllib.request.urlopen(base+path)
204 check(False,'Protected '+path)
205 except urllib.error.HTTPError as e:
206 check(e.code==403,'Protected '+path)
207 req=urllib.request.Request(base+'/api.php',headers={'Host':'production.example'})
208 try:
209 urllib.request.urlopen(req)
210 check(False,'No production autologin')
211 except urllib.error.HTTPError as e:
212 check(e.code==401,'No production autologin')
213 # Inactivity is enforced on the server, with stale confirmation protection.
214 token=a.post('create_link',kind='match')['url'].split('=')[1]
215 inactive_id=b.post('accept_link',token=token)['game']
216 a.game_action('stop_inactive',inactive_id,expected=409)
217 con.execute('UPDATE games SET activity_at=? WHERE id=?',(int(time.time())-8*86400,inactive_id));con.commit()
218 old=a.game(inactive_id)
219 check(old['inactiveDays']==8,'Eight inactive days shown')
220 turn=a if old['yourTurn'] else b
221 turn.game_action('move',inactive_id,**turn.game(inactive_id)['legal'][0])
222 a.post('stop_inactive',game=inactive_id,version=old['version'],expected=409)
223 check(a.game(inactive_id)['inactiveDays']==0,'Move resets inactivity')
224 con.execute('UPDATE games SET activity_at=? WHERE id=?',(int(time.time())-7*86400,inactive_id));con.commit()
225 a.game_action('stop_inactive',inactive_id)
226 check(all(g['id']!=inactive_id for c in [a,b] for g in c.state()['games']),'Stop removes both tiles')
227 check(len(a.get('/api.php?action=export')['results'])==3,'Stopped game adds no result')
228 # Opponent statistics work without friendship; requests need recipient consent.
229 opponent=a.state()['games'][0]
230 check(opponent['opponentId']=='local:test_user_2' and sum(opponent['rivalry'].values())==3,'Non-friend opponent has historical rivalry statistics')
231 a.post('send_friend_request',friend='local:test_user_1',expected=409)
232 a.post('send_friend_request',friend='missing',expected=409)
233 a.post('send_friend_request',friend=['invalid'],expected=409)
234 old=a.csrf; a.csrf='wrong';a.post('send_friend_request',friend='local:test_user_2',expected=403);a.csrf=old
235 with concurrent.futures.ThreadPoolExecutor(max_workers=2) as pool:
236 list(pool.map(lambda _:a.post('send_friend_request',friend='local:test_user_2'),range(2)))
237 check(len(a.state()['friendRequests'])==len(b.state()['friendRequests'])==1,'Concurrent sends produce one request')
238 check(not a.state()['friendRequests'][0]['incoming'] and b.state()['friendRequests'][0]['incoming'],'Request direction is correct')
239 check(not a.state()['friends'] and not b.state()['friends'],'Sending request does not create friendship')
240 check(len(a.get('/api.php?action=export')['friend_requests'])==1,'Export includes pending requests')
241 a.post('accept_friend_request',friend='local:test_user_2',expected=409)
242 a.post('reject_friend_request',friend='local:test_user_2',expected=409)
243 b.post('send_friend_request',friend='local:test_user_1',expected=409)
244 b.post('reject_friend_request',friend='local:test_user_1')
245 check(not a.state()['friendRequests'] and not b.state()['friends'],'Rejection clears request without friendship')
246 a.post('send_friend_request',friend='local:test_user_2')
247 b.post('accept_friend_request',friend='local:test_user_1')
248 check(len(a.state()['friends'])==len(b.state()['friends'])==1,'Acceptance creates bilateral friendship')
249 check(not a.state()['friendRequests'] and not b.state()['friendRequests'],'Acceptance consumes request for both users')
250 check({k:a.state()['friends'][0][k] for k in ['wins','losses','ties']}==opponent['rivalry'],'Friend and opponent statistics match')
251 b.post('accept_friend_request',friend='local:test_user_1',expected=409)
252 a.post('send_friend_request',friend='local:test_user_2',expected=409)
253 a.post('remove_friend',friend='local:test_user_2')
254 a.post('send_friend_request',friend='local:test_user_2')
255 token=b.post('create_link',kind='friend')['url'].split('=')[1]
256 a.post('accept_link',token=token)
257 check(not a.state()['friendRequests'],'Friend link acceptance clears pending request')
258 a.post('remove_friend',friend='local:test_user_2')
259 # Queue requests survive sessions and never match the same user to themselves.
260 before_count=con.execute('SELECT count(*) FROM games').fetchone()[0]
261 a.post('join_matchmaking'); a.post('join_matchmaking')
262 check(con.execute('SELECT count(*) FROM matchmaking').fetchone()[0]==1,'One queue entry per user')
263 check(a.state()['matchmaking']['status']=='searching','Search persists on polling')
264 check(con.execute('SELECT count(*) FROM games').fetchone()[0]==before_count,'No self match')
265 a.post('cancel_matchmaking'); a.post('cancel_matchmaking')
266 check(a.state()['matchmaking'] is None,'Cancel is persistent and idempotent')
267 # Simultaneous joins produce one bilateral game, even without friendship.
268 with concurrent.futures.ThreadPoolExecutor(max_workers=2) as pool:
269 list(pool.map(lambda c:c.post('join_matchmaking'),[a,b]))
270 check(con.execute('SELECT count(*) FROM games').fetchone()[0]==before_count+1,'Concurrent joins create exactly one game')
271 check(a.state()['matchmaking'] is None and b.state()['matchmaking'] is None,'Both entries consumed')
272 matched=a.state()['games'][0]
273 check(matched['id']==b.state()['games'][0]['id'] and matched['status']=='active','Match starts for both players')
274 check(matched['color']!=b.game(matched['id'])['color'],'Matched players have opposite colors')
275 # Set ratings and elapsed time directly rather than sleeping for minutes.
276 con.execute('UPDATE ratings SET rating=1200 WHERE user_id=?',('local:test_user_1',))
277 con.execute('UPDATE ratings SET rating=1400 WHERE user_id=?',('local:test_user_2',)); con.commit()
278 a.post('join_matchmaking'); b.post('join_matchmaking')
279 check(a.state()['matchmaking'] and b.state()['matchmaking'],'200 point gap initially waits')
280 con.execute('UPDATE matchmaking SET joined=? WHERE user_id=?',(int(time.time())-120,'local:test_user_1'))
281 con.execute('UPDATE matchmaking_clock SET checked=0');con.commit()
282 check(a.state()['matchmaking'] is not None,'Both players must allow rating gap')
283 con.execute('UPDATE matchmaking SET joined=?',(int(time.time())-120,))
284 con.execute('UPDATE matchmaking_clock SET checked=0');con.commit()
285 check(a.state()['matchmaking'] is None and b.state()['matchmaking'] is None,'Activity matches after two minutes of widening')
286 a.post('join_matchmaking')
287 con.execute('UPDATE matchmaking SET joined=?',(int(time.time())-86400,));con.commit()
288 b.post('join_matchmaking')
289 check(a.state()['matchmaking']['status']=='expired','Expired registration is excluded')
290 a.post('join_matchmaking')
291 check(a.state()['matchmaking']['status']=='searching','Expired search can restart')
292 con.execute('UPDATE ratings SET rating=1800 WHERE user_id=?',('local:test_user_2',))
293 con.execute('UPDATE matchmaking SET joined=?',(int(time.time())-3600,))
294 con.execute('UPDATE matchmaking_clock SET checked=0');con.commit()
295 check(a.state()['matchmaking'] is not None,'Rating tolerance capped at 500')
296 a.post('cancel_matchmaking');b.post('cancel_matchmaking')
297 # An unrelated user's page activity processes the entire pool, oldest first,
298 # choosing the closest eligible opponent and leaving unmatched entries intact.
299 now=int(time.time())
300 for uid,rating,joined in [('queue:oldest',1200,now-300),('queue:far',1290,now-200),('queue:near',1220,now-100)]:
301 con.execute('INSERT INTO users VALUES(?,?)',(uid,uid))
302 con.execute('INSERT INTO ratings VALUES(?,?,0)',(uid,rating))
303 con.execute('INSERT INTO matchmaking VALUES(?,?)',(uid,joined))
304 con.execute('UPDATE matchmaking_clock SET checked=0');con.commit()
305 a.state()
306 pair=con.execute('SELECT a,b FROM games ORDER BY id DESC LIMIT 1').fetchone()
307 check(set(pair)=={'queue:oldest','queue:near'},'Whole pool prefers closest opponent for oldest entry')
308 check(con.execute('SELECT user_id FROM matchmaking').fetchall()==[('queue:far',)],'Unmatched entry remains queued')
309 check(con.execute('SELECT count(*) FROM rating_changes').fetchone()[0]==3,'Every completed result has one rating ledger entry')
310 con.close()
311 with sqlite3.connect(root/'data/microchess.sqlite') as archive_db:
312 private_id=archive_db.execute("INSERT INTO results(game_id,a,b,winner,reason,state,ended) SELECT game_id,'queue:oldest','queue:near',NULL,'Draw','{}',ended FROM results WHERE id=?",(saved_id,)).lastrowid
313 archive_db.execute("INSERT INTO replays SELECT ?,'queue:oldest',moves FROM replays WHERE result_id=?",(private_id,saved_id))
314 check(all(r['id']!=private_id for r in a.get('/api.php?action=history')),'History excludes other players games')
315 try:
316 a.get(f'/api.php?action=replay&id={private_id}')
317 check(False,'Other players replay unavailable')
318 except urllib.error.HTTPError as e:
319 check(e.code==404,'Other players replay unavailable')
320 with sqlite3.connect(root/'data/microchess.sqlite') as archive_db:
321 check(archive_db.execute('SELECT length(moves) FROM replays WHERE result_id=?',(saved_id,)).fetchone()[0]==23,'One move uses two bytes plus initial position')
322 archive_db.execute('UPDATE results SET ended=? WHERE id=?',(int(time.time())-10*365*86400,saved_id))
323 check(any(r['id']==saved_id for r in a.get('/api.php?action=history')),'Old replay remains in history without a retention limit')
324 check(a.get(f'/api.php?action=replay&id={saved_id}')['positions']==saved['positions'],'Old replay remains fully playable')
325 check(any(r['id']==saved_id for r in a.get('/api.php?action=export')['replays']),'Old replay remains available in exports')
326 print(f'API: {checks} assertions passed.')
327 finally:
328 os.killpg(process.pid,signal.SIGTERM);process.wait();log.close()