#!/usr/bin/env python3 """bounded command-line help and option rejection contracts.""" import argparse import os import subprocess from pathlib import Path parser = argparse.ArgumentParser() parser.add_argument('--group', choices=['binaries', 'scripts', 'js', 'all'], default='all') parser.add_argument('--bin-dir', default='build/bin') parser.add_argument('--js-dir', default='build/js') args = parser.parse_args() commands = [] if args.group in ('binaries', 'all'): commands += [[str(Path(args.bin_dir) / name)] for name in ['zy', 'zym', 'zclsp', 'zc0', 'mkgenome', 'genmap']] if args.group in ('scripts', 'all'): commands += [['bash', name] for name in ['tinyvm.sh', 'src/tools/zcc', 'src/tools/automap.sh', 'src/tools/findcc.sh', 'src/tools/bootstrap-check.sh', 'src/tools/mklsp.sh', 'src/tools/mklspwasm.sh', 'src/tools/mkvsix.sh', 'src/web/build.sh', 'src/baremetal/run.sh']] if args.group in ('js', 'all'): commands += [['node', name] for name in [str(Path(args.js_dir) / 'tinyvm.js'), 'src/js/mklayout.js', 'src/js/extract_lsp.js']] def invoke(command, option): # keep stdin open: help and rejected options must finish without reading it. env = dict(os.environ, TINYVM_MEMORY_WORDS='invalid', TINYVM_MAX_MEMORY_WORDS='invalid') child = subprocess.Popen([*command, option], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env) try: child.wait(timeout=3) return child.returncode, child.stdout.read(), child.stderr.read() finally: if child.poll() is None: child.kill() child.wait() child.stdin.close() child.stdout.close() child.stderr.close() failures = 0 for command in commands: try: for option in ['--help', '-h']: status, out, err = invoke(command, option) assert status == 0 and b'usage:' in out.lower() and not err, (option, status, out[:200], err[:200]) status, out, err = invoke(command, '--unknown-option') assert status > 0 and err and not out, (status, out[:200], err[:200]) print('ok help and option rejection: ' + ' '.join(command)) except (AssertionError, subprocess.TimeoutExpired) as error: failures += 1 print('FAIL ' + ' '.join(command) + ': ' + str(error)) if args.group in ('binaries', 'all'): source = b'int identity(int n) { return n; }\n' for option in ['--format', '--annotate', '--types']: result = subprocess.run([str(Path(args.bin_dir) / 'zclsp'), option], input=source, capture_output=True, timeout=10) assert result.returncode == 0 and not result.stderr, (option, result.stdout, result.stderr) if option != '--types': assert b'identity' in result.stdout, (option, result.stdout) print('ok lsp source options remain available alongside help') raise SystemExit(bool(failures))