Files
canina/scripts/tests/test_revalidation_runtime.py
T

115 lines
5.7 KiB
Python

import importlib.util
import os
from pathlib import Path
import stat
import subprocess
import tempfile
import unittest
ROOT = Path(__file__).resolve().parents[2]
HELPER = ROOT / 'scripts/provision-revalidation-env.py'
class RevalidationRuntimeTests(unittest.TestCase):
def load(self):
self.assertTrue(HELPER.is_file(), 'secure revalidation provisioning helper missing')
spec = importlib.util.spec_from_file_location('revalidation_env', HELPER)
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
return module
def test_preserves_existing_secret_and_writes_private_release_file(self):
module = self.load()
with tempfile.TemporaryDirectory() as directory:
root = Path(directory)
source, output = root/'runtime.env', root/'release.env'
original = '# existing runtime configuration\nREVALIDATION_SECRET=' + 'a'*48 + '\n'
source.write_text(original)
module.provision(source, output)
self.assertEqual(source.read_text(), original)
self.assertEqual(output.read_text(), 'REVALIDATION_SECRET='+'a'*48+'\n')
self.assertEqual(stat.S_IMODE(output.stat().st_mode), 0o600)
def test_missing_runtime_secret_is_generated_once_and_reused(self):
module = self.load()
with tempfile.TemporaryDirectory() as directory:
root = Path(directory)
source = root/'runtime.env'
module.provision(source, root/'first.env')
module.provision(source, root/'second.env')
self.assertEqual((root/'first.env').read_bytes(), (root/'second.env').read_bytes())
self.assertEqual(stat.S_IMODE(source.stat().st_mode), 0o600)
self.assertGreaterEqual(len(source.read_text().split('=', 1)[1].strip()), 43)
def test_unsafe_or_invalid_input_is_rejected_without_touching_output(self):
module = self.load()
with tempfile.TemporaryDirectory() as directory:
root = Path(directory)
target = root/'target'
target.write_text('REVALIDATION_SECRET='+'b'*48+'\n')
source = root/'source'
source.symlink_to(target)
with self.assertRaises(ValueError):
module.provision(source, root/'output')
source.unlink()
os.link(target, source)
with self.assertRaises(ValueError):
module.provision(source, root/'output')
source.unlink()
for content in ('', 'REVALIDATION_SECRET=short\n', 'REVALIDATION_SECRET='+'a'*48+'\nREVALIDATION_SECRET='+'b'*48+'\n', 'REVALIDATION_SECRET='+'a'*48+'\nUNEXPECTED=value\n'):
source.write_text(content)
with self.assertRaises(ValueError):
module.provision(source, root/'output')
self.assertFalse((root/'output').exists())
def test_cli_is_silent_and_uses_same_contract_for_each_environment(self):
import sys
with tempfile.TemporaryDirectory() as directory:
root = Path(directory)
for environment in ('stage', 'prod'):
result = subprocess.run([sys.executable, str(HELPER), '--environment', environment,
'--source', str(root/(environment+'.env')), '--output', str(root/(environment+'-release.env'))],
env={**os.environ, 'GITHUB_ACTIONS': 'true'}, text=True, capture_output=True)
self.assertEqual(result.returncode, 0, result.stderr)
self.assertEqual(result.stdout + result.stderr, '')
self.assertEqual((root/(environment+'.env')).read_bytes(), (root/(environment+'-release.env')).read_bytes())
self.assertNotEqual((root/'stage.env').read_bytes(), (root/'prod.env').read_bytes())
def test_symlink_parent_cannot_create_a_persistent_secret(self):
module = self.load()
with tempfile.TemporaryDirectory() as directory:
root = Path(directory)
real = root/'real'
real.mkdir()
link = root/'link'
link.symlink_to(real, target_is_directory=True)
with self.assertRaises(ValueError):
module.provision(link/'source', root/'output')
self.assertFalse((real/'source').exists())
class StageEnvironmentTests(unittest.TestCase):
def test_stage_uses_direct_next_revalidation_and_shared_required_secret(self):
config = (ROOT/'scripts/compose.stage.yml').read_text()
self.assertIn('- FRONTEND_INTERNAL_URL=http://frontend_stage:3000', config)
frontend = config.split(' frontend_stage:', 1)[1]
self.assertIn('- INTERNAL_API_URL=http://backend_stage:3000/api', frontend)
self.assertEqual(config.count('path: .revalidation.env\n required: true'), 2)
rollout = (ROOT/'scripts/rollout-stage.sh').read_text()
self.assertIn('stage_revalidation_provision() {', rollout)
self.assertIn('--source "$STAGE_DIR/.revalidation.env"', rollout)
self.assertIn('--output "$TARGET_DIR/.revalidation.env"', rollout)
class RoutingTests(unittest.TestCase):
def test_all_backend_routes_use_runtime_docker_dns_without_uri_rewrite(self):
config = (ROOT/'nginx.conf').read_text()
servers = config.split('server {')[1:]
self.assertEqual(len(servers), 2)
for server in servers:
self.assertIn('resolver 127.0.0.11 valid=5s ipv6=off;', server)
self.assertIn('resolver_timeout 2s;', server)
self.assertIn('set $backend_upstream __BACKEND_HOST__:3000;', server)
self.assertEqual(server.count('proxy_pass http://$backend_upstream;'), 2)
self.assertNotIn('proxy_pass http://__BACKEND_HOST__', config)
if __name__ == '__main__':
unittest.main()