#!/usr/bin/env python3 """Run the actual lftp command sequence against an isolated local FTP server.""" import os import logging from pathlib import Path import subprocess import tempfile import threading import unittest from pyftpdlib.log import config_logging config_logging(level=logging.ERROR) from pyftpdlib.authorizers import DummyAuthorizer from pyftpdlib.handlers import FTPHandler from pyftpdlib.servers import FTPServer from deploy import ROOT, deployment_commands, write_asset_version from deploy_guard import DeployGuardError, project_dir, main as guard_main class DeployTests(unittest.TestCase): def test_mirror_preserves_data(self): artifacts=ROOT/'web/tests/artifacts' artifacts.mkdir(exist_ok=True) with tempfile.TemporaryDirectory(dir=artifacts,prefix='deploy-') as directory: base=Path(directory); local=base/'local web'; remote=base/'remote' local.mkdir();remote.mkdir();target=remote/'verhaaltjesboek';target.mkdir() for folder in [local/'data', local/'tests',local/'assets',target/'data',target/'data/backups']: folder.mkdir() (local/'data/.htaccess').write_text('Require all denied\n') (local/'data/config.php').write_text('DO NOT UPLOAD LOCAL SECRET') (local/'data/verhalenboek.sqlite').write_text('DO NOT UPLOAD LOCAL DB') (local/'tests/check.php').write_text('test code') (local/'router.php').write_text('dev router') (local/'README.md').write_text('readme') (local/'index.php').write_text('new application') (local/'.htaccess').write_text('Options -Indexes\n') (local/'assets/app.js').write_text('new frontend') (target/'obsolete.php').write_text('stale application code') retained={'config.php':'PRODUCTION SECRET','verhalenboek.sqlite':'PRODUCTION DB', 'verhalenboek.sqlite-wal':'LIVE WAL','backups/older.sqlite':'BACKUP'} for file,data in retained.items():(target/'data'/file).write_text(data) authorizer=DummyAuthorizer();authorizer.add_user('fixture-user','fixture-password',str(remote),perm='elradfmwMT') class Handler(FTPHandler): pass Handler.authorizer=authorizer server=FTPServer(('127.0.0.1',0),Handler) thread=threading.Thread(target=server.serve_forever,kwargs={'timeout':.1},daemon=True);thread.start() env={'timftphost':f'ftp://127.0.0.1:{server.socket.getsockname()[1]}','timftpuser':'fixture-user', 'timftppassword':'fixture-password','projectftp':'verhaaltjesboek'} try: commands=deployment_commands(env,local) self.assertNotIn(env['timftppassword'],commands) for _ in range(2): result=subprocess.run(['lftp','--norc'],input=commands,text=True, env={**os.environ,'LFTP_PASSWORD':env['timftppassword'], 'LFTP_HOME':str(base/'lftp')}, capture_output=True,timeout=30) self.assertEqual(result.returncode,0,result.stdout+result.stderr) for file,data in retained.items():self.assertEqual((target/'data'/file).read_text(),data) self.assertEqual((target/'data/.htaccess').read_text(),'Require all denied\n') self.assertEqual((target/'index.php').read_text(),'new application') self.assertEqual((target/'.htaccess').read_text(),'Options -Indexes\n') self.assertEqual((target/'assets/app.js').read_text(),'new frontend') for excluded in ['tests','router.php','README.md','obsolete.php']: self.assertFalse((target/excluded).exists(),excluded) finally: server.close_all();thread.join(timeout=2) def test_write_asset_version_from_ci(self): with tempfile.TemporaryDirectory() as directory: webroot = Path(directory) write_asset_version(webroot, {'CI_COMMIT_SHA': 'deadbeefcafebabe0123456789abcdef01234567'}) self.assertEqual((webroot/'asset-version.txt').read_text(), 'deadbeefcafebabe0123456789abcdef01234567\n') def test_invalid_config_fails_before_connecting(self): with self.assertRaises(ValueError):deployment_commands({},ROOT/'web') env={'timftphost':'ftp://example.test','timftpuser':'user','timftppassword':'secret','projectftp':'x\nrm -r data'} with self.assertRaises(ValueError):deployment_commands(env,ROOT/'web') class DeployGuardTests(unittest.TestCase): BASE={'timftphost':'ftp://example.test','timftpuser':'user','timftppassword':'secret','timftproot':'/domains/projects.timfalken.com/public_html'} def blocked(self, **extra): env=dict(self.BASE); env.update(extra) env={k:v for k,v in env.items() if v is not None} with self.assertRaises(DeployGuardError):project_dir(env) with self.assertRaises(ValueError):deployment_commands(env,ROOT/'web') def test_not_set(self):self.blocked(projectftp=None) def test_empty(self):self.blocked(projectftp='') def test_whitespace(self):self.blocked(projectftp=' ') def test_slash(self):self.blocked(projectftp='/') def test_dot(self):self.blocked(projectftp='.') def test_dot_slash(self):self.blocked(projectftp='./') def test_root_literal(self):self.blocked(projectftp='/domains/projects.timfalken.com/public_html/') def test_root_reference(self):self.blocked(projectftp='$timftproot') def test_root_reference_slash(self):self.blocked(projectftp='${timftproot}/') def test_root_reference_without_root(self):self.blocked(projectftp='$timftproot/verhaaltjesboek',timftproot=None) def test_parent(self):self.blocked(projectftp='$timftproot/verhaaltjesboek/..') def test_outside_root(self):self.blocked(projectftp='/domains/other.site/public_html/x') def test_unknown_reference(self):self.blocked(projectftp='$HOME/x') def test_valid(self): env=dict(self.BASE,projectftp='$timftproot/verhaaltjesboek') self.assertEqual(project_dir(env),'/domains/projects.timfalken.com/public_html/verhaaltjesboek') self.assertIn('cd "/domains/projects.timfalken.com/public_html/verhaaltjesboek"',deployment_commands(env,ROOT/'web')) self.assertEqual(project_dir(dict(self.BASE,projectftp='verhaaltjesboek')),'verhaaltjesboek') self.assertEqual(project_dir(dict(self.BASE,timftproot='/r/',projectftp='$timftproot/vb/')),'/r/vb') def test_cli_exit_code_and_no_values(self): import io,contextlib err=io.StringIO() with contextlib.redirect_stderr(err):self.assertEqual(guard_main(dict(self.BASE,projectftp='/')),1) self.assertIn('DEPLOY GEBLOKKEERD',err.getvalue()) self.assertNotIn(self.BASE['timftproot'],err.getvalue()) if __name__=='__main__': unittest.main()