Merge branch 'feature/deploy-tolerate-foreign'
The FTP guard no longer treats leftover remote files as a blocker. favicon.ico is never uploaded or deleted.
@@ -1,5 +1,11 @@
1
1
#!/usr/bin/env python3
2
"""FTP-upload of build/. Never --delete. Refuses a non-empty foreign folder."""
2
"""FTP-upload of build/. Never --delete.
3
4
The path guard (deploy_guard) is the only hard abort: wrong target,
5
FTP root, missing meteors leaf. Extra files already on the remote are
6
logged and left alone. favicon.ico is never uploaded, so a host- or
7
Tim-provided icon is not overwritten.
8
"""
3
9
import os
4
10
import subprocess
5
11
import sys
@@ -11,14 +17,16 @@ from deploy_guard import DeployGuardError, project_dir # noqa: E402
11
17
12
18
ROOT = Path(__file__).resolve().parents[1]
13
19
14
# Files we ourselves publish; a first deploy may only land in an empty/new
15
# folder, or a folder that already only contains a previous Meteors deploy.
20
# Files this project publishes. Used only to label remote leftovers in the
21
# log; foreign names no longer abort the deploy (we never --delete).
16
22
OURS = {
17
23
'index.html', 'game.js', 'framework.js', 'style.css', 'images',
18
'favicon.ico',
19
24
'.', '..',
20
25
}
21
26
27
# Never upload this name: the remote icon may belong to Tim or the host.
28
LEAVE_ON_REMOTE = ('favicon.ico',)
29
22
30
23
31
def quoted(value):
24
32
if any(c in value for c in '\r\n\x00'):
@@ -104,24 +112,32 @@ def posix_basename(name):
104
112
105
113
106
114
def assert_safe_target(exists, names):
115
"""Path safety lives in deploy_guard.project_dir. Remote leftovers are fine."""
107
116
if not exists:
108
117
print('Remote meteors folder does not exist yet; it will be created.')
109
118
return
110
unexpected = []
119
foreign = []
111
120
for name in names:
112
121
leaf = posix_basename(name)
113
if leaf in OURS or leaf == '':
122
if leaf in OURS or leaf == '' or leaf in LEAVE_ON_REMOTE:
114
123
continue
115
unexpected.append(leaf)
116
if unexpected:
117
raise ValueError(
118
'DEPLOY GEBLOKKEERD: de map meteors op de FTP-server is niet leeg '
119
'en bevat bestanden die niet bij dit project horen: '
120
+ ', '.join(sorted(set(unexpected))[:12])
121
+ '. Niets overschreven.'
124
foreign.append(leaf)
125
if foreign:
126
print(
127
'Opmerking: de remote map bevat ook bestanden die niet bij deze '
128
'deploy horen: '
129
+ ', '.join(sorted(set(foreign))[:12])
130
+ '. Die blijven staan (geen --delete) en worden niet aangeraakt.'
131
)
132
reserved = [posix_basename(n) for n in names if posix_basename(n) in LEAVE_ON_REMOTE]
133
if reserved:
134
print(
135
'Opmerking: '
136
+ ', '.join(sorted(set(reserved)))
137
+ ' blijft ongemoeid; we uploaden dat bestand niet.'
122
138
)
123
139
if names:
124
print('Remote meteors folder already holds a previous Meteors deploy; updating.')
140
print('Remote meteors folder already holds files; updating our own.')
125
141
else:
126
142
print('Remote meteors folder is empty; deploying.')
127
143
@@ -131,10 +147,11 @@ def deploy_commands(environ, target, webroot):
131
147
return lftp_preamble(environ, host) + [
132
148
f'mkdir -p {quoted(target)} || echo "Using existing project directory"',
133
149
f'cd {quoted(target)}',
134
# GEEN --delete. Excludes only keep CI/docs out if they were ever placed in build/.
150
# GEEN --delete. Never upload favicon.ico (leave Tim's / the host's).
135
151
'mirror --reverse --no-perms --no-symlinks --max-errors=1 '
136
152
'--exclude-glob ".git/" --exclude-glob ".git/**" '
137
153
'--exclude-glob "blue-ci-cd.yml" --exclude-glob "README.md" '
154
'--exclude-glob "favicon.ico" --exclude-glob "**/favicon.ico" '
138
155
f'{quoted(str(webroot))} .',
139
156
'bye',
140
157
]
@@ -1,5 +1,11 @@1
#!/usr/bin/env python31
#!/usr/bin/env python32
"""FTP-upload of build/. Never --delete. Refuses a non-empty foreign folder."""2
"""FTP-upload of build/. Never --delete.3
4
The path guard (deploy_guard) is the only hard abort: wrong target,5
FTP root, missing meteors leaf. Extra files already on the remote are6
logged and left alone. favicon.ico is never uploaded, so a host- or7
Tim-provided icon is not overwritten.8
"""3
import os9
import os4
import subprocess10
import subprocess5
import sys11
import sys@@ -11,14 +17,16 @@ from deploy_guard import DeployGuardError, project_dir # noqa: E40211
17
12
ROOT = Path(__file__).resolve().parents[1]18
ROOT = Path(__file__).resolve().parents[1]13
19
14
# Files we ourselves publish; a first deploy may only land in an empty/new20
# Files this project publishes. Used only to label remote leftovers in the15
# folder, or a folder that already only contains a previous Meteors deploy.21
# log; foreign names no longer abort the deploy (we never --delete).16
OURS = {22
OURS = {17
'index.html', 'game.js', 'framework.js', 'style.css', 'images',23
'index.html', 'game.js', 'framework.js', 'style.css', 'images',18
'favicon.ico',19
'.', '..',24
'.', '..',20
}25
}21
26
27
# Never upload this name: the remote icon may belong to Tim or the host.28
LEAVE_ON_REMOTE = ('favicon.ico',)29
22
30
23
def quoted(value):31
def quoted(value):24
if any(c in value for c in '\r\n\x00'):32
if any(c in value for c in '\r\n\x00'):@@ -104,24 +112,32 @@ def posix_basename(name):104
112
105
113
106
def assert_safe_target(exists, names):114
def assert_safe_target(exists, names):115
"""Path safety lives in deploy_guard.project_dir. Remote leftovers are fine."""107
if not exists:116
if not exists:108
print('Remote meteors folder does not exist yet; it will be created.')117
print('Remote meteors folder does not exist yet; it will be created.')109
return118
return110
unexpected = []119
foreign = []111
for name in names:120
for name in names:112
leaf = posix_basename(name)121
leaf = posix_basename(name)113
if leaf in OURS or leaf == '':122
if leaf in OURS or leaf == '' or leaf in LEAVE_ON_REMOTE:114
continue123
continue115
unexpected.append(leaf)124
foreign.append(leaf)116
if unexpected:125
if foreign:117
raise ValueError(126
print(118
'DEPLOY GEBLOKKEERD: de map meteors op de FTP-server is niet leeg '127
'Opmerking: de remote map bevat ook bestanden die niet bij deze '119
'en bevat bestanden die niet bij dit project horen: '128
'deploy horen: '120
+ ', '.join(sorted(set(unexpected))[:12])129
+ ', '.join(sorted(set(foreign))[:12])121
+ '. Niets overschreven.'130
+ '. Die blijven staan (geen --delete) en worden niet aangeraakt.'131
)132
reserved = [posix_basename(n) for n in names if posix_basename(n) in LEAVE_ON_REMOTE]133
if reserved:134
print(135
'Opmerking: '136
+ ', '.join(sorted(set(reserved)))137
+ ' blijft ongemoeid; we uploaden dat bestand niet.'122
)138
)123
if names:139
if names:124
print('Remote meteors folder already holds a previous Meteors deploy; updating.')140
print('Remote meteors folder already holds files; updating our own.')125
else:141
else:126
print('Remote meteors folder is empty; deploying.')142
print('Remote meteors folder is empty; deploying.')127
143
@@ -131,10 +147,11 @@ def deploy_commands(environ, target, webroot):131
return lftp_preamble(environ, host) + [147
return lftp_preamble(environ, host) + [132
f'mkdir -p {quoted(target)} || echo "Using existing project directory"',148
f'mkdir -p {quoted(target)} || echo "Using existing project directory"',133
f'cd {quoted(target)}',149
f'cd {quoted(target)}',134
# GEEN --delete. Excludes only keep CI/docs out if they were ever placed in build/.150
# GEEN --delete. Never upload favicon.ico (leave Tim's / the host's).135
'mirror --reverse --no-perms --no-symlinks --max-errors=1 '151
'mirror --reverse --no-perms --no-symlinks --max-errors=1 '136
'--exclude-glob ".git/" --exclude-glob ".git/**" '152
'--exclude-glob ".git/" --exclude-glob ".git/**" '137
'--exclude-glob "blue-ci-cd.yml" --exclude-glob "README.md" '153
'--exclude-glob "blue-ci-cd.yml" --exclude-glob "README.md" '154
'--exclude-glob "favicon.ico" --exclude-glob "**/favicon.ico" '138
f'{quoted(str(webroot))} .',155
f'{quoted(str(webroot))} .',139
'bye',156
'bye',140
]157
]@@ -122,3 +122,14 @@ dezelfde tween.
122
122
Zie latere secties zodra fase 2 landt. De miss-kans van 30% wordt een
123
123
parameter (`missChance`, standaard 0,30); de planeetformule
124
124
`Planet.missChance` (60%–5% via Power) is voor fase 3.
125
126
## Deploy: vreemde bestanden en favicon.ico
127
128
De FTP-guard blokkeert alleen een duidelijk verkeerd doel (FTP-root, pad
129
zonder `meteors` als laatste segment, map buiten `$timftproot`). Extra
130
bestanden die al in de remote map staan, worden alleen gelogd: we gebruiken
131
nooit `--delete`, dus ze blijven staan en zijn onschadelijk.
132
133
`favicon.ico` op de server wordt niet overschreven en niet verwijderd
134
(mogelijk van Tim of de host). De deploy sluit dat bestand uit van de
135
upload, ook als er lokaal een `build/favicon.ico` staat voor eigen gebruik.
@@ -122,3 +122,14 @@ dezelfde tween.122
Zie latere secties zodra fase 2 landt. De miss-kans van 30% wordt een122
Zie latere secties zodra fase 2 landt. De miss-kans van 30% wordt een123
parameter (`missChance`, standaard 0,30); de planeetformule123
parameter (`missChance`, standaard 0,30); de planeetformule124
`Planet.missChance` (60%–5% via Power) is voor fase 3.124
`Planet.missChance` (60%–5% via Power) is voor fase 3.125
126
## Deploy: vreemde bestanden en favicon.ico127
128
De FTP-guard blokkeert alleen een duidelijk verkeerd doel (FTP-root, pad129
zonder `meteors` als laatste segment, map buiten `$timftproot`). Extra130
bestanden die al in de remote map staan, worden alleen gelogd: we gebruiken131
nooit `--delete`, dus ze blijven staan en zijn onschadelijk.132
133
`favicon.ico` op de server wordt niet overschreven en niet verwijderd134
(mogelijk van Tim of de host). De deploy sluit dat bestand uit van de135
upload, ook als er lokaal een `build/favicon.ico` staat voor eigen gebruik.@@ -72,20 +72,17 @@ describe('deploy_guard', () =>
72
72
73
73
describe('assert_safe_target', () =>
74
74
{
75
it('allows a new or empty folder, and a previous Meteors deploy, but not foreign files', () =>
75
it('allows a new, empty, previous, or leftover-files folder and only logs foreign names', () =>
76
76
{
77
77
const py = [
78
78
'import sys',
79
79
'sys.path.insert(0, "ci")',
80
'from deploy import assert_safe_target',
80
'from deploy import assert_safe_target, deploy_commands',
81
81
'assert_safe_target(False, [])',
82
82
'assert_safe_target(True, [])',
83
'assert_safe_target(True, ["index.html", "game.js", "framework.js", "style.css", "images", "favicon.ico"])',
84
'try:',
85
' assert_safe_target(True, ["index.php", "wp-config.php"])',
86
' raise SystemExit("should have refused")',
87
'except ValueError as e:',
88
' assert "GEBLOKKEERD" in str(e)',
83
'assert_safe_target(True, ["index.html", "game.js", "framework.js", "style.css", "images"])',
84
// Leftovers, including a host favicon, must not abort.
85
'assert_safe_target(True, ["favicon.ico", "index.php", "notes.txt"])',
89
86
'print("safe-target ok")'
90
87
].join('\n');
91
88
const r = spawnSync('python3', ['-c', py], {
@@ -94,5 +91,29 @@ describe('assert_safe_target', () =>
94
91
});
95
92
assert.equal(r.status, 0, r.stdout + r.stderr);
96
93
assert.match(r.stdout, /safe-target ok/);
94
assert.match(r.stdout, /favicon\.ico blijft ongemoeid/);
95
assert.match(r.stdout, /index\.php/);
96
assert.doesNotMatch(r.stdout + r.stderr, /GEBLOKKEERD/);
97
});
98
99
it('the FTP mirror never deletes and never uploads favicon.ico', () =>
100
{
101
const py = [
102
'import sys',
103
'sys.path.insert(0, "ci")',
104
'from pathlib import Path',
105
'from deploy import deploy_commands',
106
'env = {"timftphost": "ftp://example.test", "timftpuser": "u", "timftppassword": "p"}',
107
'cmds = "\\n".join(deploy_commands(env, "/var/www/meteors", Path("build")))',
108
'assert "--delete" not in cmds, cmds',
109
'assert "--exclude-glob \\"favicon.ico\\"" in cmds, cmds',
110
'print("mirror ok")'
111
].join('\n');
112
const r = spawnSync('python3', ['-c', py], {
113
cwd: path.join(__dirname, '..'),
114
encoding: 'utf8'
115
});
116
assert.equal(r.status, 0, r.stdout + r.stderr);
117
assert.match(r.stdout, /mirror ok/);
97
118
});
98
119
});
@@ -72,20 +72,17 @@ describe('deploy_guard', () =>72
72
73
describe('assert_safe_target', () =>73
describe('assert_safe_target', () =>74
{74
{75
it('allows a new or empty folder, and a previous Meteors deploy, but not foreign files', () =>75
it('allows a new, empty, previous, or leftover-files folder and only logs foreign names', () =>76
{76
{77
const py = [77
const py = [78
'import sys',78
'import sys',79
'sys.path.insert(0, "ci")',79
'sys.path.insert(0, "ci")',80
'from deploy import assert_safe_target',80
'from deploy import assert_safe_target, deploy_commands',81
'assert_safe_target(False, [])',81
'assert_safe_target(False, [])',82
'assert_safe_target(True, [])',82
'assert_safe_target(True, [])',83
'assert_safe_target(True, ["index.html", "game.js", "framework.js", "style.css", "images", "favicon.ico"])',83
'assert_safe_target(True, ["index.html", "game.js", "framework.js", "style.css", "images"])',84
'try:',84
// Leftovers, including a host favicon, must not abort.85
' assert_safe_target(True, ["index.php", "wp-config.php"])',85
'assert_safe_target(True, ["favicon.ico", "index.php", "notes.txt"])',86
' raise SystemExit("should have refused")',87
'except ValueError as e:',88
' assert "GEBLOKKEERD" in str(e)',89
'print("safe-target ok")'86
'print("safe-target ok")'90
].join('\n');87
].join('\n');91
const r = spawnSync('python3', ['-c', py], {88
const r = spawnSync('python3', ['-c', py], {@@ -94,5 +91,29 @@ describe('assert_safe_target', () =>94
});91
});95
assert.equal(r.status, 0, r.stdout + r.stderr);92
assert.equal(r.status, 0, r.stdout + r.stderr);96
assert.match(r.stdout, /safe-target ok/);93
assert.match(r.stdout, /safe-target ok/);94
assert.match(r.stdout, /favicon\.ico blijft ongemoeid/);95
assert.match(r.stdout, /index\.php/);96
assert.doesNotMatch(r.stdout + r.stderr, /GEBLOKKEERD/);97
});98
99
it('the FTP mirror never deletes and never uploads favicon.ico', () =>100
{101
const py = [102
'import sys',103
'sys.path.insert(0, "ci")',104
'from pathlib import Path',105
'from deploy import deploy_commands',106
'env = {"timftphost": "ftp://example.test", "timftpuser": "u", "timftppassword": "p"}',107
'cmds = "\\n".join(deploy_commands(env, "/var/www/meteors", Path("build")))',108
'assert "--delete" not in cmds, cmds',109
'assert "--exclude-glob \\"favicon.ico\\"" in cmds, cmds',110
'print("mirror ok")'111
].join('\n');112
const r = spawnSync('python3', ['-c', py], {113
cwd: path.join(__dirname, '..'),114
encoding: 'utf8'115
});116
assert.equal(r.status, 0, r.stdout + r.stderr);117
assert.match(r.stdout, /mirror ok/);97
});118
});98
});119
});