BlueGit

projects-timfalken-com microchess

Files

microchess / ci / deploy.py

deploy.py

deploy.py 3.6 KiB Download Raw
1#!/usr/bin/env python3
2"""Deploy only web/, preserving server-owned data. Passwords never enter argv."""
3import os
4from pathlib import Path
5import subprocess
6import sys
7from urllib.parse import urlsplit
8
9ROOT = Path(__file__).resolve().parents[1]
10
11def quoted(value):
12 if any(c in value for c in '\r\n\x00'):
13 raise ValueError('Deployment variables must not contain line breaks or NUL bytes.')
14 return '"' + value.replace('\\', '\\\\').replace('"', '\\"') + '"'
15
16def deployment_commands(environ, webroot):
17 for key in ['timftphost', 'timftpuser', 'timftppassword', 'projectftp']:
18 if not environ.get(key):
19 raise ValueError(f'CI variable {key} is not set.')
20 host = environ['timftphost']
21 if '://' not in host:
22 host = 'ftp://' + host
23 parsed = urlsplit(host)
24 if parsed.scheme not in ['ftp', 'ftps', 'sftp'] or not parsed.hostname:
25 raise ValueError('timftphost must be an FTP, FTPS or SFTP host URL.')
26 if parsed.username or parsed.password or parsed.query or parsed.fragment:
27 raise ValueError('Keep login credentials in timftpuser/timftppassword; use a plain host URL.')
28 commands = [
29 'set cmd:fail-exit yes',
30 'set net:timeout 20',
31 'set net:max-retries 2',
32 'set net:reconnect-interval-base 3',
33 # This hosting account uses a mismatched FTP certificate; retain the owner's deployment policy.
34 'set ssl:verify-certificate no',
35 'set ftp:list-options -a',
36 # New SFTP hosts are remembered within this runner; changed host keys fail.
37 'set sftp:connect-program "ssh -a -x -o StrictHostKeyChecking=accept-new"',
38 f'open --user {quoted(environ["timftpuser"])} --env-password {quoted(host)}',
39 f'cd {quoted(environ["projectftp"])}',
40 'mkdir -p data || echo "Using existing data directory"',
41 f'put {quoted(str(webroot / "data/.htaccess"))} -o data/.htaccess',
42 # No --delete-excluded: these paths belong to the running server.
43 'mirror --reverse --delete --no-perms --no-symlinks --max-errors=1 '
44 '--exclude-glob "data/" --exclude-glob "data/**" '
45 '--exclude-glob "tests/" --exclude-glob "tests/**" '
46 '--exclude-glob "README.md" --exclude-glob "router.php" '
47 f'{quoted(str(webroot))} .',
48 'bye',
49 ]
50 return '\n'.join(commands) + '\n'
51
52def write_asset_version(webroot, environ=None):
53 """Stamp the deploy commit into web/asset-version.txt for cache-busting."""
54 environ = os.environ if environ is None else environ
55 sha = (environ.get('CI_COMMIT_SHA') or '').strip()
56 if not sha:
57 try:
58 sha = subprocess.check_output(
59 ['git', '-C', str(ROOT), 'rev-parse', 'HEAD'], text=True, stderr=subprocess.DEVNULL
60 ).strip()
61 except (subprocess.CalledProcessError, FileNotFoundError):
62 sha = ''
63 if not sha or len(sha) < 7:
64 raise ValueError('Unable to determine commit SHA for asset-version.txt (set CI_COMMIT_SHA).')
65 (webroot / 'asset-version.txt').write_text(sha + '\n', encoding='utf-8')
66 print(f'Wrote asset-version.txt = {sha}')
67
68def main():
69 try:
70 webroot = ROOT / 'web'
71 write_asset_version(webroot, os.environ)
72 commands = deployment_commands(os.environ, webroot)
73 subprocess.run(['lftp', '--norc'], input=commands, text=True,
74 env={**os.environ, 'LFTP_PASSWORD':os.environ['timftppassword']}, check=True)
75 except (ValueError, subprocess.CalledProcessError) as error:
76 print(str(error), file=sys.stderr)
77 return 1
78 return 0
79
80if __name__ == '__main__':
81 sys.exit(main())