116 lines
5.4 KiB
Python
116 lines
5.4 KiB
Python
"""Release-plan safety and integrity tests; no network or application services."""
|
|
import copy
|
|
import errno
|
|
import hashlib
|
|
import importlib.util
|
|
import json
|
|
from pathlib import Path
|
|
import stat
|
|
import tempfile
|
|
from types import SimpleNamespace
|
|
import unittest
|
|
from unittest.mock import patch
|
|
import zipfile
|
|
import io
|
|
|
|
|
|
def module(name):
|
|
spec = importlib.util.spec_from_file_location(name, Path(__file__).with_name(name + '.py'))
|
|
value = importlib.util.module_from_spec(spec)
|
|
spec.loader.exec_module(value)
|
|
return value
|
|
|
|
|
|
review = module('release_review')
|
|
rollback = module('release_restore_local')
|
|
|
|
|
|
class ReadOnlySFTP:
|
|
def __init__(self, files): self.files = files
|
|
|
|
def lstat(self, absolute):
|
|
relative = absolute.removeprefix(review.REMOTE_ROOT + '/')
|
|
if relative in self.files:
|
|
return SimpleNamespace(st_mode=stat.S_IFREG, st_size=len(self.files[relative]))
|
|
if any(name.startswith(relative + '/') for name in self.files):
|
|
return SimpleNamespace(st_mode=stat.S_IFDIR, st_size=0)
|
|
raise FileNotFoundError(errno.ENOENT, 'missing')
|
|
|
|
def open(self, absolute, mode):
|
|
assert mode == 'rb', 'A remote write was attempted'
|
|
return io.BytesIO(self.files[absolute.removeprefix(review.REMOTE_ROOT + '/')])
|
|
|
|
def close(self): pass
|
|
|
|
|
|
class ReleaseReviewTests(unittest.TestCase):
|
|
def test_snapshot_plan_is_read_only_and_can_reconstruct_old_local_files(self):
|
|
with tempfile.TemporaryDirectory() as temporary:
|
|
root = Path(temporary); project = root / 'maxkb'; build = project / 'ui/build'
|
|
for path, raw in {
|
|
'apps/system_manage/example.py': b'new source\n',
|
|
'ui/src/new.ts': b'new module\n',
|
|
'ui/build/admin.html': b'<script src="/admin/assets/new.js"></script>',
|
|
'ui/build/assets/new.js': b'new static',
|
|
}.items():
|
|
file = project / path; file.parent.mkdir(parents=True, exist_ok=True); file.write_bytes(raw)
|
|
files = {'apps/system_manage/example.py': b'old source\n'}
|
|
for prefix in review.STATIC_ROOTS:
|
|
files[prefix + '/index.html'] = b'<script src="/admin/assets/old.js"></script>'
|
|
files[prefix + '/assets/old.js'] = b'old static'
|
|
original = copy.deepcopy(files)
|
|
client = SimpleNamespace(open_sftp=lambda: ReadOnlySFTP(files))
|
|
|
|
def probe(_client, paths):
|
|
return {'files': {name: {'exists': True, 'sha256': review.sha(files[name]), 'size': len(files[name])}
|
|
if name in files else {'exists': False} for name in paths}, 'processes': []}
|
|
|
|
output = root / 'review'
|
|
with patch.object(review, 'WORKSPACE', root), patch.object(review, 'PROJECT', project), \
|
|
patch.object(review, 'SOURCES', ['apps/system_manage/example.py', 'ui/src/new.ts']), \
|
|
patch.object(review, 'probe', side_effect=probe):
|
|
review.prepare(output, build, client)
|
|
self.assertEqual(files, original)
|
|
plan = json.loads((output / 'release-plan.json').read_text(encoding='utf-8'))
|
|
self.assertFalse(plan['remote_mutation'])
|
|
self.assertFalse(plan['release_ready'])
|
|
self.assertEqual([row['status'] for row in plan['sources']], ['modified', 'added'])
|
|
verified = rollback.verify(output)
|
|
self.assertEqual(len(verified['files']), 5)
|
|
self.assertIn('ui/src/new.ts', verified['new_paths_to_remove_only_after_future_approval'])
|
|
target = root / 'restored'
|
|
self.assertEqual(rollback.restore(output, target), 5)
|
|
self.assertEqual((target / 'apps/system_manage/example.py').read_bytes(), b'old source\n')
|
|
self.assertFalse((target / 'ui/src/new.ts').exists())
|
|
with self.assertRaises(ValueError): rollback.restore(output, target)
|
|
(output / 'rollback-before.zip').write_bytes(b'corrupted')
|
|
with self.assertRaises(ValueError): rollback.verify(output)
|
|
|
|
def test_permission_denied_is_not_treated_as_a_new_remote_file(self):
|
|
def denied(_path): raise PermissionError(errno.EACCES, 'denied')
|
|
with self.assertRaises(RuntimeError):
|
|
review.read_remote(SimpleNamespace(lstat=denied), 'apps/system_manage/example.py')
|
|
|
|
def test_path_traversal_is_rejected(self):
|
|
for value in ('../secret', '/etc/passwd', 'C:/secret', 'apps/../../secret', 'ui\\src\\file'):
|
|
with self.assertRaises(ValueError): review.safe_relative(value)
|
|
|
|
def test_normalized_line_endings_are_not_reported_as_logic_changes(self):
|
|
row, delta = review.compare('example.py', b'line\r\n', b'line\n')
|
|
self.assertEqual(row['status'], 'modified')
|
|
self.assertTrue(row['line_endings_only'])
|
|
self.assertFalse(delta)
|
|
|
|
def test_remote_probe_contains_no_application_import_or_service_mutation(self):
|
|
import ast
|
|
tree = ast.parse(review.REMOTE_PROBE)
|
|
for node in ast.walk(tree):
|
|
if isinstance(node, ast.Call) and isinstance(node.func, ast.Attribute):
|
|
self.assertNotIn(node.func.attr, {'write', 'write_text', 'write_bytes', 'mkdir', 'unlink', 'rename', 'remove', 'chmod', 'connect', 'kill'})
|
|
if node.func.attr == 'open':
|
|
self.assertEqual(node.args[0].value, 'rb')
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|