BlueGit

projects-timfalken-com microchess

Files

microchess / web / tests / integration.py

integration.py

integration.py 10.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')
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 a.post('set_avatar',avatar='blue-knight')
89 check(a.state()['user']['avatar']=='blue-knight','Avatar persists across requests')
90 check(b.state()['user']['avatar'] is None,'Avatar change affects only the signed-in user')
91 a.post('set_avatar',avatar='../../data/config.php',expected=409)
92 a.post('set_avatar',avatar='not-a-piece',expected=409)
93 a.post('set_avatar',avatar=['blue-knight'],expected=409)
94 b.post('set_avatar',avatar='purple-elephant')
95 check(b.state()['user']['avatar']=='purple-elephant','Fairy avatar can be selected')
96 b.post('set_avatar',avatar=None)
97 check(b.state()['user']['avatar'] is None,'Reset avatar to initials')
98 a.post('switch_user', user='admin', expected=409)
99 old = a.csrf; a.csrf = 'wrong'; a.post('create_link', kind='match', expected=403); a.csrf = old
100 token = a.post('create_link', kind='friend')['url'].split('=')[1]
101 check(b.get('/api.php?invite='+token)['invite']['kind'] == 'friend', 'Friend request preview')
102 a.post('accept_link', token=token, expected=409)
103 b.post('accept_link', token=token)
104 check(len(a.state()['friends']) == len(b.state()['friends']) == 1, 'Mutual friendship')
105 check(b.state()['friends'][0]['avatar']=='blue-knight','Friends see selected avatar')
106 b.post('accept_link', token=token, expected=409)
107 a.post('challenge', friend='local:test_user_2')
108 g = b.state()['games'][0]; id = g['id']
109 check(g['incoming'] and g['status']=='pending', 'Incoming challenge')
110 a.post('challenge', friend='local:test_user_2', expected=409)
111 a.game_action('accept', id, expected=409)
112 b.game_action('reject', id)
113 check(not a.state()['games'] and not b.state()['games'], 'Reject removes both tiles')
114 a.post('challenge', friend='local:test_user_2'); id = b.state()['games'][0]['id']; b.game_action('accept', id)
115 ga, gb = a.game(id), b.game(id)
116 check(gb['opponentAvatar']=='blue-knight','Game tile includes opponent avatar')
117 check(ga['color'] != gb['color'] and ga['yourTurn'] != gb['yourTurn'], 'Opposite colors and one turn')
118 white, black = (a,b) if ga['color']=='w' else (b,a)
119 black.game_action('move', id, from_=4, to=8, expected=409)
120 current = white.game(id)
121 white.post('move', game=id, version=current['version'], **{'from':15,'to':7}, expected=409)
122 move = current['legal'][0]
123 white.post('move', game=id, version=current['version'], **move)
124 white.post('move', game=id, version=current['version'], **move, expected=409)
125 check(black.game(id)['yourTurn'], 'Turn passes')
126 black.game_action('resign', id)
127 check(a.game(id)['status']=='ended' and b.game(id)['winner']==white.state()['user']['name'], 'Resignation result')
128 check(sum(a.state()['friends'][0][k] for k in ['wins','losses','ties'])==1, 'Stats recorded once')
129 old_color = a.game(id)['color']
130 a.game_action('rematch', id)
131 check(b.game(id)['opponentRematch'], 'Rematch notification')
132 b.game_action('rematch', id)
133 check(a.game(id)['color'] != old_color and a.game(id)['state']['ply']==0, 'Rematch swaps sides, same tile')
134 turn = a if a.game(id)['yourTurn'] else b
135 turn.game_action('offer_draw', id)
136 move = turn.game(id)['legal'][0]; turn.game_action('move',id,**move)
137 other = b if turn is a else a
138 other.game_action('accept_draw', id)
139 check(a.state()['friends'][0]['ties']==1, 'Draw stats')
140 a.game_action('rematch', id); b.game_action('exit', id)
141 check(not a.game(id)['canRematch'], 'Exit disables opponent rematch')
142 check(not b.state()['games'], 'Exit hides own tile only')
143 a.game_action('rematch', id, expected=409)
144 a.game_action('exit', id)
145 match = a.post('create_link',kind='match')['url'].split('=')[1]
146 check(b.get('/api.php?invite='+match)['invite']['kind']=='match', 'Match link modal')
147 check(b.get('/api.php?invite='+match)['invite']['kind']=='match', 'Preview/reject leaves link valid')
148 def race_accept(_):
149 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})
150 try:
151 with b.opener.open(req) as response:
152 response.read()
153 return response.status
154 except urllib.error.HTTPError as error:
155 return error.code
156 with concurrent.futures.ThreadPoolExecutor(max_workers=2) as pool:
157 statuses=list(pool.map(race_accept,range(2)))
158 check(sorted(statuses)==[200,409],'Concurrent link acceptance starts only one game')
159 con=sqlite3.connect(root/'data/microchess.sqlite')
160 expired = a.post('create_link',kind='match')['url'].split('=')[1]
161 con.execute('UPDATE links SET expires=0 WHERE token=?',(expired,));con.commit()
162 b.post('accept_link',token=expired,expected=409)
163 # Server-side claim with an intended move: no requirement to play it first.
164 id=a.state()['games'][0]['id'];g=a.game(id)
165 raw=json.loads(con.execute('SELECT state FROM games WHERE id=?',(id,)).fetchone()[0]);raw['halfmove']=99
166 con.execute('UPDATE games SET state=? WHERE id=?',(json.dumps(raw),id));con.commit()
167 turn=a if g['yourTurn'] else b
168 move=next(m for m in turn.game(id)['legal'] if m['from']==18)
169 turn.game_action('claim_draw',id,**move)
170 check(a.game(id)['reason']=='50-move rule','Intended move draw claim')
171 a.post('remove_friend',friend='local:test_user_2')
172 check(not a.state()['friends'] and not b.state()['friends'],'Mutual removal')
173 a.post('challenge',friend='local:test_user_2',expected=409)
174 exported=a.get('/api.php?action=export')
175 check(len(exported['results'])==3 and len(exported['games'])==2,'Export includes archived games/results')
176 check('token' not in exported['profile'],'No auth token in export')
177 check(exported['profile']['avatar']=='blue-knight','Data export includes avatar preference')
178 for path in ['/data/microchess.sqlite','/lib/bootstrap.php','/tests/chess.php','/data%2fmicrochess.sqlite','/.htaccess']:
179 try:
180 urllib.request.urlopen(base+path)
181 check(False,'Protected '+path)
182 except urllib.error.HTTPError as e:
183 check(e.code==403,'Protected '+path)
184 req=urllib.request.Request(base+'/api.php',headers={'Host':'production.example'})
185 try:
186 urllib.request.urlopen(req)
187 check(False,'No production autologin')
188 except urllib.error.HTTPError as e:
189 check(e.code==401,'No production autologin')
190 con.close()
191 print(f'API: {checks} assertions passed.')
192 finally:
193 os.killpg(process.pid,signal.SIGTERM);process.wait();log.close()