#!/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')
    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}']
        run(make + ['install'] + variables, env=env)
        assert not (root / 'bin/xtc').exists()
        assert (root / 'share/licenses/xtc/LICENSE').read_bytes() == (source / 'LICENSE').read_bytes()
        assert (root / 'share/doc/xtc/PROJECT_FORMAT.md').is_file()
        assert os.access(root / 'bin/xtc-check', os.X_OK)
        run([str(root / 'bin/xtc-check')])
        diagnose = subprocess.check_output([str(root / 'bin/xtc-check'), '--diagnose'], text=True)
        assert 'Project formats: 1..7' in diagnose and 'JACK compiled:' in diagnose
        # Upgrade/repair repeats the same owned-file install and keeps unrelated data.
        (root / 'include/xtc/xtc.h').write_text('old installation marker\n')
        run(make + ['install'] + variables, env=env)
        assert (root / 'include/xtc/xtc.h').read_bytes() == (source / 'include/xtc/xtc.h').read_bytes()
        assert sentinel.read_text() == 'keep\n'
        version = subprocess.check_output([str(root / 'bin/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(root / 'bin/xtc-check'), '--validate', str(valid)])
        valid.write_text('damaged\n')
        assert subprocess.run([str(root / 'bin/xtc-check'), '--validate', str(valid)],
                              stdout=subprocess.PIPE, stderr=subprocess.PIPE).returncode != 0
        pkg_env = dict(env, PKG_CONFIG_PATH=str(root / 'lib/pkgconfig') + ':' + 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,&note) != 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(root / 'bin/xtc'), '--version'], env=gui_env, text=True) == version
            run([str(root / 'bin/xtc'), '--help'], env=gui_env)
            if shutil.which('desktop-file-validate'):
                run(['desktop-file-validate', str(root / 'share/applications/xtc.desktop')])
        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()