146 lines
8.6 KiB
Python
146 lines
8.6 KiB
Python
#!/usr/bin/env python3
|
|
"""Exercise core/GUI install and exact uninstall solely below a temporary DESTDIR."""
|
|
import argparse
|
|
import os
|
|
from pathlib import Path
|
|
import shlex
|
|
import shutil
|
|
import subprocess
|
|
import tempfile
|
|
|
|
|
|
def run(args, **kwargs):
|
|
return subprocess.run(args, check=True, **kwargs)
|
|
|
|
|
|
def main():
|
|
parser = argparse.ArgumentParser(description=__doc__)
|
|
parser.add_argument('--build-dir', type=Path, required=True)
|
|
parser.add_argument('--gui', action='store_true')
|
|
parser.add_argument('--custom-layout', action='store_true')
|
|
args = parser.parse_args()
|
|
source = Path.cwd()
|
|
with tempfile.TemporaryDirectory(prefix='xtc-install-') as directory:
|
|
stage = Path(directory)
|
|
prefix = '/opt/xtc test'
|
|
root = stage / prefix.lstrip('/')
|
|
sentinel = root / 'lib/keep-unrelated.txt'
|
|
sentinel.parent.mkdir(parents=True)
|
|
sentinel.write_text('keep\n')
|
|
make = shlex.split(os.environ.get('MAKE', 'make'))
|
|
# MAKEFLAGS jobserver descriptors do not cross Python subprocesses.
|
|
env = dict(os.environ, MAKEFLAGS='', MFLAGS='')
|
|
variables = [f'BUILD_DIR={args.build_dir}', f'PREFIX={prefix}', f'DESTDIR={stage}']
|
|
if args.custom_layout:
|
|
variables += [f'exec_prefix={prefix}/runtime', f'libdir={prefix}/lib64',
|
|
f'includedir={prefix}/headers', f'datarootdir={prefix}/resources',
|
|
f'docdir={prefix}/manual', f'pkgconfigdir={prefix}/metadata']
|
|
binaries = root / ('runtime/bin' if args.custom_layout else 'bin')
|
|
headers = root / ('headers' if args.custom_layout else 'include')
|
|
resources = root / ('resources' if args.custom_layout else 'share')
|
|
docs = root / ('manual' if args.custom_layout else 'share/doc/xtc')
|
|
metadata = root / ('metadata' if args.custom_layout else 'lib/pkgconfig')
|
|
run(make + ['install'] + variables, env=env)
|
|
assert not (binaries / 'xtc').exists()
|
|
assert (resources / 'licenses/xtc/LICENSE').read_bytes() == (source / 'LICENSE').read_bytes()
|
|
assert (docs / 'PROJECT_FORMAT.md').is_file()
|
|
assert (resources / 'licenses/xtc/CLAP-LICENSE').is_file()
|
|
assert (resources / 'licenses/xtc/VST3-C-API-LICENSE').is_file()
|
|
assert os.access(binaries / 'xtc-check', os.X_OK)
|
|
run([str(binaries / 'xtc-check')])
|
|
for filename in ('performance-baseline.json', 'project-performance-baseline.json', 'graph-performance-phase29.json'):
|
|
assert (docs / filename).read_bytes() == (source / 'docs' / filename).read_bytes()
|
|
example = resources / 'xtc/examples/midi-demo.xtc'
|
|
run([str(binaries / 'xtc-check'), '--inspect', str(example)])
|
|
assert (resources / 'xtc/examples/README.md').is_file()
|
|
diagnose = subprocess.check_output([str(binaries / 'xtc-check'), '--diagnose'], text=True)
|
|
assert 'Project formats: 1..12' in diagnose and 'JACK compiled:' in diagnose
|
|
# Replacing a file symlink must not overwrite an unrelated target.
|
|
protected = stage / 'unrelated-target'
|
|
protected.write_text('keep unrelated target\n')
|
|
(binaries / 'xtc-check').unlink()
|
|
(binaries / 'xtc-check').symlink_to(protected)
|
|
# Upgrade/repair repeats the same owned-file install and keeps unrelated data.
|
|
(headers / 'xtc/xtc.h').write_text('old installation marker\n')
|
|
run(make + ['install'] + variables, env=env)
|
|
assert (headers / 'xtc/xtc.h').read_bytes() == (source / 'include/xtc/xtc.h').read_bytes()
|
|
assert sentinel.read_text() == 'keep\n'
|
|
assert protected.read_text() == 'keep unrelated target\n'
|
|
version = subprocess.check_output([str(binaries / 'xtc-check'), '--version'], text=True)
|
|
assert version.startswith('xtc ')
|
|
valid = stage / 'valid.xtc'
|
|
valid.write_text('XTC_PROJECT 4\nAPP 0 1 0\nTEMPO 120000\nIDS 0 0\nGRAPH 1 0 0 0\nTRACKS 0\nCLIPS 0\nNOTES 0 0\nAUTOMATION 0\nEND\n')
|
|
run([str(binaries / 'xtc-check'), '--validate', str(valid)])
|
|
valid.write_text('damaged\n')
|
|
assert subprocess.run([str(binaries / 'xtc-check'), '--validate', str(valid)],
|
|
stdout=subprocess.PIPE, stderr=subprocess.PIPE).returncode != 0
|
|
pkg_env = dict(env, PKG_CONFIG_PATH=str(metadata) + ':' + env.get('PKG_CONFIG_PATH', ''),
|
|
PKG_CONFIG_SYSROOT_DIR=str(stage))
|
|
pkg = shlex.split(os.environ.get('PKG_CONFIG', 'pkg-config'))
|
|
# A no-JACK test can be invoked with PKG_CONFIG=false; package consumer
|
|
# discovery itself still uses the installed pkg-config tool.
|
|
if pkg == ['false']:
|
|
pkg = ['pkg-config']
|
|
flags = shlex.split(subprocess.check_output(pkg + ['--cflags', '--libs', '--static', 'xtc'], env=pkg_env, text=True))
|
|
includes = ''.join(f'#include "xtc/{p.name}"\n' for p in sorted((source / 'include/xtc').glob('*.h')))
|
|
consumer = stage / 'consumer.c'
|
|
consumer.write_text(includes + r'''
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
int main(int argc, char **argv) {
|
|
xtc_project *p = 0, *q = 0; xtc_midi_plan *a = 0, *b = 0;
|
|
uint64_t track, clip, note; float before[127], after[127]; int i, nonzero = 0;
|
|
if (argc != 2 || xtc_project_create(&p) != XTC_OK || xtc_project_create(&q) != XTC_OK) return 1;
|
|
if (xtc_project_add_track(p,"Installed",&track) != XTC_OK ||
|
|
xtc_project_add_midi_clip(p,track,0,960,&clip) != XTC_OK ||
|
|
xtc_project_add_note(p,clip,0,960,69,127,0,¬e) != XTC_OK ||
|
|
xtc_project_save(p,argv[1]) != XTC_OK || xtc_project_load(q,argv[1]) != XTC_OK ||
|
|
xtc_midi_plan_create(p,48000,&a) != XTC_OK || xtc_midi_plan_create(q,48000,&b) != XTC_OK ||
|
|
xtc_midi_plan_render(a,0,0,0,before,127) != XTC_OK || xtc_midi_plan_render(b,0,0,0,after,127) != XTC_OK) return 2;
|
|
for (i = 0; i < 127; ++i) { if (before[i] != after[i]) return 3; if (before[i] != 0) nonzero = 1; }
|
|
xtc_midi_plan_destroy(a); xtc_midi_plan_destroy(b); xtc_project_destroy(p); xtc_project_destroy(q);
|
|
remove(argv[1]); return !nonzero;
|
|
}
|
|
''')
|
|
for compiler, standard in [('CC', 'c99'), ('CXX', 'c++17')]:
|
|
output = stage / ('consumer-' + compiler)
|
|
command = shlex.split(env.get(compiler, 'cc' if compiler == 'CC' else 'c++'))
|
|
run(command + [f'-std={standard}', '-Wall', '-Wextra', '-Werror', str(consumer)] + flags + ['-o', str(output)])
|
|
run([str(output), str(stage / ("installed-" + compiler + ".xtc"))])
|
|
if args.gui:
|
|
run(make + ['install-gui'] + variables, env=env)
|
|
gui_env = dict(env, DISPLAY='', WAYLAND_DISPLAY='')
|
|
assert subprocess.check_output([str(binaries / 'xtc'), '--version'], env=gui_env, text=True) == version
|
|
run([str(binaries / 'xtc'), '--help'], env=gui_env)
|
|
if shutil.which('desktop-file-validate'):
|
|
run(['desktop-file-validate', str(resources / 'applications/xtc.desktop')])
|
|
# Both operations must reject staging paths redirected outside DESTDIR.
|
|
with tempfile.TemporaryDirectory(prefix='xtc-install-outside-') as outside:
|
|
escape = root / 'escape'
|
|
escape.symlink_to(outside, target_is_directory=True)
|
|
redirected = variables + [f'docdir={prefix}/escape/docs']
|
|
for operation in ('install', 'uninstall'):
|
|
refusal = subprocess.run(make + [operation] + redirected, env=env,
|
|
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
|
assert refusal.returncode != 0 and not list(Path(outside).iterdir())
|
|
assert (headers / 'xtc/xtc.h').is_file()
|
|
escape.unlink()
|
|
# A directory at an owned file path must fail the whole removal preflight.
|
|
saved_binary = stage / 'saved-check'
|
|
(binaries / 'xtc-check').rename(saved_binary)
|
|
(binaries / 'xtc-check').mkdir()
|
|
refusal = subprocess.run(make + ['uninstall'] + variables, env=env,
|
|
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
|
assert refusal.returncode != 0 and (headers / 'xtc/xtc.h').is_file()
|
|
(binaries / 'xtc-check').rmdir()
|
|
saved_binary.rename(binaries / 'xtc-check')
|
|
run(make + ['uninstall'] + variables, env=env)
|
|
run(make + ['uninstall'] + variables, env=env)
|
|
remaining = sorted(p.relative_to(root).as_posix() for p in root.rglob('*') if p.is_file() or p.is_symlink())
|
|
assert remaining == ['lib/keep-unrelated.txt'], remaining
|
|
assert sentinel.read_text() == 'keep\n'
|
|
print('Staged install/uninstall, C/C++ pkg-config consumers and headless CLI passed.')
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|