#!/usr/bin/env python3 """Exercise the real Unraid boot writer in private ordinary-user directories. Boot text is never executed. Filesystem faults/concurrency and registration results are models, not a native NAS, flash, watchdog or installed-agent proof. """ from pathlib import Path import os import shlex import shutil import subprocess import tempfile import unittest SOURCE = Path(__file__).resolve().parents[2] / 'scripts/install.sh' BASH = shutil.which('bash') NAMES = ('portable_path_uid', 'nas_agent_removal_file_safe', 'filter_nas_agent_boot_file', 'render_unraid_go_launch', 'write_unraid_go_entry') def definitions(source): result = [] for name in NAMES: marker = name + '() {' if source.count(marker) != 1: raise ValueError('missing or ambiguous production function: ' + name) result.append(marker + source.split(marker, 1)[1].split('\n}\n', 1)[0] + '\n}\n') return '\n'.join(result) class UnraidGoUpdate(unittest.TestCase): source = SOURCE.read_text() def setUp(self): directory = tempfile.TemporaryDirectory(prefix='pulse-unraid-boot-') self.addCleanup(directory.cleanup) self.root = Path(directory.name) for name in ('flash', 'state', 'tools'): (self.root / name).mkdir(mode=0o700) self.boot = self.root / 'flash/go' self.wrapper = self.root / 'state/start-pulse-agent.sh' self.runtime = self.root / 'bin/pulse-agent' self.secret = self.root / 'state/token' self.secret.write_text('synthetic-secret-not-for-logs') self.environment = dict(os.environ, PATH=str(self.root / 'tools') + ':' + os.environ['PATH']) def invoke(self, override=''): code = ('set -euo pipefail\nAGENT_NAME=pulse-agent\n' + definitions(self.source) + '\n' + override + '\nwrite_unraid_go_entry "$1" "$2" "$3"\n') result = subprocess.run([BASH, '-c', code, '_', str(self.boot), str(self.wrapper), str(self.runtime)], env=self.environment, capture_output=True, text=True, timeout=10) self.assertNotIn('synthetic-secret-not-for-logs', result.stdout + result.stderr) self.assertEqual(self.secret.read_text(), 'synthetic-secret-not-for-logs') self.assertFalse((self.root / 'executed').exists(), 'boot text must not execute') return result def write(self, content): self.boot.write_bytes(content if isinstance(content, bytes) else content.encode()) self.boot.chmod(0o640) def stub(self, name, code): path = self.root / 'tools' / name path.write_text('#!/bin/sh\n' + code + '\n') path.chmod(0o700) def assert_refused_unchanged(self, original): self.write(original) before = self.boot.read_bytes() result = self.invoke() self.assertNotEqual(result.returncode, 0) self.assertEqual(self.boot.read_bytes(), before) def test_first_install_and_repeat_create_one_detached_entry(self): self.assertEqual(self.invoke().returncode, 0) first = self.boot.read_bytes() self.assertTrue(first.startswith(b'#!/bin/bash\n')) self.assertEqual(first.count(b'# Pulse Agent\n'), 1) self.assertTrue(first.endswith(b' >> /var/log/pulse-agent.log 2>&1 &\n')) self.assertEqual(self.invoke().returncode, 0) self.assertEqual(self.boot.read_bytes(), first) self.assertEqual(list(self.boot.parent.glob('*.pulse-setup.*')), []) def test_unrelated_jobs_comments_and_multiline_constructs_survive(self): original = ('#!/bin/bash\n# Archive start-pulse-agent.sh first\n' 'cp /private/start-pulse-agent.sh.bak /backup/wrapper\n' 'bash /other/start-pulse-agent-prod.sh &\n' 'if true; then\n echo unrelated\nfi\n' 'cat <> "$2"; fi') self.assertNotEqual(self.invoke().returncode, 0) self.assertEqual(self.boot.read_bytes(), before + b'# concurrent change\n') def test_first_write_refuses_concurrent_file_directory_or_link(self): other = self.root / 'foreign'; other.write_text('foreign target\n') for kind in ('file', 'directory', 'link'): with self.subTest(kind=kind): self.boot = self.boot.with_name('new-' + kind) create = ('ln -s ' + shlex.quote(str(other)) + ' ' + shlex.quote(str(self.boot)) if kind == 'link' else 'mkdir ' + shlex.quote(str(self.boot)) if kind == 'directory' else 'printf "foreign file\\n" > ' + shlex.quote(str(self.boot))) self.stub('cat', shlex.quote(shutil.which('cat')) + ' "$@" || exit $?\ncase "$1" in */updated) ' + create + ';; esac') self.assertNotEqual(self.invoke().returncode, 0) self.assertEqual(other.read_text(), 'foreign target\n') if kind == 'link': self.assertTrue(self.boot.is_symlink()) elif kind == 'directory': self.assertTrue(self.boot.is_dir()) else: self.assertEqual(self.boot.read_text(), 'foreign file\n') self.assertTrue(list(self.boot.parent.glob(self.boot.name + '.pulse-setup.*/updated'))) def test_partial_first_write_is_not_success_and_blocks_blind_retry(self): self.stub('cat', 'case "$1" in */ready) printf partial; exit 28;; esac\n' + shlex.quote(shutil.which('cat')) + ' "$@"') self.assertNotEqual(self.invoke().returncode, 0) self.assertEqual(self.boot.read_bytes(), b'partial') staged = list(self.boot.parent.glob('*.pulse-setup.*/updated')) self.assertEqual(len(staged), 1); self.assertIn(b'# Pulse Agent\n', staged[0].read_bytes()) (self.root / 'tools/cat').unlink() self.assertNotEqual(self.invoke().returncode, 0) self.assertEqual(self.boot.read_bytes(), b'partial') def test_final_readback_and_cleanup_failures_are_not_success(self): for command in ('mv', 'rmdir'): with self.subTest(command=command): self.boot = self.boot.with_name('terminal-' + command) self.write('#!/bin/bash\necho kept\n') code = ('exit 1' if command == 'rmdir' else shlex.quote(shutil.which('mv')) + ' "$@" || exit $?\nprintf "# concurrent change\\n" >> ' + shlex.quote(str(self.boot))) self.stub(command, code) self.assertNotEqual(self.invoke().returncode, 0) self.assertTrue(self.boot.read_text().startswith('#!/bin/bash\necho kept\n')) self.assertTrue(list(self.boot.parent.glob(self.boot.name + '.pulse-setup.*'))) (self.root / 'tools' / command).unlink() self.assertNotEqual(self.invoke().returncode, 0) def test_too_many_entries_need_reconciliation_not_unbounded_parser_work(self): self.assert_refused_unchanged('#!/bin/bash\n' + ('# Pulse Agent\nbash ' + str(self.wrapper) + '\n') * 17) def test_wrapper_paths_with_spaces_remain_idempotent(self): self.wrapper = self.root / 'state with spaces/start-pulse-agent.sh' self.assertEqual(self.invoke().returncode, 0) first = self.boot.read_bytes() self.assertIn(b'state\\ with\\ spaces/', first) self.assertEqual(self.invoke().returncode, 0) self.assertEqual(self.boot.read_bytes(), first) def test_registration_failure_exits_before_start_or_persistence_success(self): start = self.source.index(' if write_unraid_go_entry "$GO_SCRIPT"') entry = self.source[start:self.source.index(' # Start the agent now using the wrapper', start)] events = self.root / 'events' for fault, expected in ((False, ['replace', 'configured', 'would-start']), (True, ['replace', 'failed'])): with self.subTest(fault=fault): events.write_text('') setup = ('set -euo pipefail\nGO_SCRIPT=fixture WRAPPER_SCRIPT=fixture RUNTIME_BINARY=fixture EXIT_GENERAL=1\n' 'event() { printf "%s\\n" "$1" >> ' + shlex.quote(str(events)) + '; }\n' 'write_unraid_go_entry() { event replace; return ' + ('1' if fault else '0') + '; }\n' 'log_info() { event configured; }\nfail() { event failed; exit 1; }\n') result = subprocess.run([BASH, '-c', setup + entry + '\nevent would-start\n'], capture_output=True, text=True, timeout=5) self.assertEqual(result.returncode != 0, fault, result.stderr) self.assertEqual(events.read_text().splitlines(), expected) if __name__ == '__main__': unittest.main()