#!/usr/bin/env python3 # SPDX-License-Identifier: GPL-3.0-or-later """Exercise the compiled reader and its UI in an isolated headless browser.""" import argparse from functools import partial import hashlib from http.server import SimpleHTTPRequestHandler, ThreadingHTTPServer import json from pathlib import Path import re import random import tempfile from threading import Thread from urllib.parse import urlsplit import zipfile from playwright.sync_api import sync_playwright, expect from uc2 import UC2File, UC2Writer ROOT = Path(__file__).resolve().parents[1] class QuietHandler(SimpleHTTPRequestHandler): def log_message(self, *args): pass def do_GET(self): override = getattr(self.server, 'overrides', {}).get(urlsplit(self.path).path) if override is not None: self.send_response(200) self.send_header('Content-Type', 'application/javascript' if self.path.endswith('.js') else 'text/html') self.send_header('Cache-Control', 'no-store') self.end_headers() self.wfile.write(override) else: super().do_GET() def check_zip(path, archive, wanted=None): """Check ZIP CRCs, portable unique names, metadata and decoded bytes independently.""" with zipfile.ZipFile(path) as exported, UC2File(archive) as reference: assert exported.testzip() is None report = json.loads(exported.read('inventory.json')) assert report['schema'] == 'uc2-browser-export-1' files = report['files'] expected = [info for info in reference.infolist(all_versions=True) if not info.is_dir()] if wanted is not None: expected = [info for info in expected if (info.filename, info.version) in wanted] assert len(files) == len(expected), (files, expected) assert len(exported.namelist()) == len(files) + 1 assert len(set(name.lower() for name in exported.namelist())) == len(files) + 1 for row, info in zip(files, expected): assert (row['path'], row['version']) == (info.filename, info.version) assert re.fullmatch(r'files/\d+-v\d+-[A-Za-z0-9._-]+', row['output']) assert not row['output'].endswith('.') data = exported.read(row['output']) assert data == reference.read(info), row['path'] assert row['size'] == len(data) and row['verified'] is True assert row['sha256'] == hashlib.sha256(data).hexdigest() assert exported.getinfo(row['output']).compress_type == zipfile.ZIP_STORED def main(): parser = argparse.ArgumentParser() parser.add_argument('--dist', type=Path, default=ROOT / 'web/dist') parser.add_argument('--browser') parser.add_argument('--engine', choices=('chromium', 'firefox', 'webkit'), default='chromium') parser.add_argument('--screenshot', type=Path) args = parser.parse_args() server = ThreadingHTTPServer(('127.0.0.1', 0), partial(QuietHandler, directory=str(args.dist))) thread = Thread(target=server.serve_forever, daemon=True) thread.start() url = f'http://127.0.0.1:{server.server_port}/' try: with tempfile.TemporaryDirectory(prefix='uc2-browser-test-') as temporary, sync_playwright() as pw: scratch = Path(temporary) browser = getattr(pw, args.engine).launch(headless=True, executable_path=args.browser) # A failed first install must be visible and allow a clean retry. first = browser.new_context() first_page = first.new_page() first_page.goto(url) server.overrides = {'/icon-192.png': b'inconsistent deployment'} first_page.get_by_role('button', name='Save reader offline').click() expect(first_page.locator('#offline-status')).to_contain_text('Offline download failed', timeout=30000) assert first_page.evaluate('caches.keys()') == [] server.overrides = {} first_page.get_by_role('button', name='Save reader offline').click() expect(first_page.locator('#offline-status')).to_contain_text('Reader saved for offline use', timeout=120000) first.close() context = browser.new_context(accept_downloads=True) page = context.new_page() errors, requests, downloads = [], [], [] injected_corruption = False def record_error(error): message = str(error) # WebKit also forwards deliberately rejected SW fetches to # pageerror; Chromium/Firefox expose only the fetch rejection. if injected_corruption and args.engine == 'webkit' and message in ( 'Error: The reader changed during download. Reload and try again.', f'/127.0.0.1:{server.server_port}/icon-192.png.', ): return errors.append(message) page.on('pageerror', record_error) context.on('request', lambda request: requests.append((request.method, request.url))) page.on('download', lambda download: downloads.append(download)) page.goto(url) page.get_by_role('button', name='Try the sample archive').click() expect(page.locator('#workspace')).to_be_visible(timeout=30000) expect(page.locator('#archive-name')).to_have_text('sample.uc2') page.get_by_role('button', name='Verify all versions').click() expect(page.locator('#status')).to_contain_text('passed UC2 checksum', timeout=30000) if args.screenshot: page.screenshot(path=str(args.screenshot), full_page=True) for fixture in sorted((ROOT / 'tests/archives').glob('*.uc2')): page.locator('#archive').set_input_files(fixture) expect(page.locator('#archive-name')).to_have_text(fixture.name, timeout=30000) page.get_by_role('button', name='Verify all versions').click() expect(page.locator('#status')).to_contain_text('passed UC2 checksum', timeout=30000) with UC2File(fixture) as reference: for info in reference.infolist(): page.locator('#entries').get_by_role('button', name=info.filename, exact=True).click() with page.expect_download() as downloaded: page.get_by_role('button', name='Save verified file').click() target = scratch / 'download' downloaded.value.save_as(target) assert target.read_bytes() == reference.read(info), info.filename # Exercise shared raw/compressed chunks through the WASM decoder and ZIP exporter. base = random.Random(11).randbytes(80000) + b'chunk-sharing' * 8000 for level in (4, 8): shared = scratch / f'shared-{level}.uc2' with UC2Writer(shared, level=level, chunked=True) as writer: writer.writestr('old.bin', base) writer.writestr('new.bin', base[:40000] + b'inserted' + base[40000:]) assert writer.stats['shared_bytes'] > 100000 page.locator('#archive').set_input_files(shared) expect(page.locator('#archive-name')).to_have_text(shared.name, timeout=30000) page.get_by_role('button', name='Verify all versions').click() expect(page.locator('#status')).to_contain_text('All 2 stored files passed', timeout=30000) page.get_by_role('button', name='Select matching files').click() with page.expect_download() as downloaded: page.get_by_role('button', name='Save selected ZIP').click() downloaded.value.save_as(scratch / f'shared-{level}.zip') check_zip(scratch / f'shared-{level}.zip', shared) modern = scratch / 'versions.uc2' with UC2Writer(modern, level=8) as writer: writer.writestr('folder/café.txt', b'old version') writer.writestr('folder/café.txt', b'new version') writer.writestr('