Make test.sh better

[jcbhmr]

problem: the test.sh is confusing
i.e. not everyone (me included) know what the heck happens in that magic bash script 🤣

this isn't a major problem, but it is a thing to do that i think is a good idea. 😉

solution 1: make it a python script instead with more friendly programming language syntax
solution 2: add a bunch of comments

i vote solution 1. i originally tried to do this in the #20 pr, but was too complicated at the time. time for another crack at it?

[jcbhmr]

some iterations with ChatGPT (i know i know, but its a starting point) gets this: https://sharegpt.com/c/L9KXMBc

#!/usr/bin/env python3

import os
import sys
import shutil
import subprocess
import json

def copy_template(template_id):
    src_dir = f'/tmp/{template_id}'
    shutil.copytree(f'src/{template_id}', src_dir)
    return src_dir

def configure_template(src_dir):
    os.chdir(src_dir)
    with open('devcontainer-template.json', 'r') as f:
        template = json.load(f)
    option_property = template.get('options')
    if option_property and option_property != 'null':
        options = list(option_property.keys())
        if options:
            print(f"(!) Configuring template options for '{template_id}'")
            for option in options:
                option_key = f"${{templateOption:{option}}}"
                option_value = option_property[option].get('default')
                if not option_value or option_value == 'null':
                    print(f"Template '{template_id}' is missing a default value for option '{option}'")
                    sys.exit(1)
                option_value_escaped = option_value.replace('\\', '\\\\').replace('"', '\\"').replace('$', '\\$').replace('`', '\\`')
                subprocess.run(['find', './', '-type', 'f', '-print0', '|', 'xargs', '-0', 'sed', '-i', f's/{option_key}/{option_value_escaped}/g'], check=True, capture_output=True, text=True)

def copy_test_files(template_id, src_dir):
    test_dir = f'test/{template_id}'
    if os.path.isdir(test_dir):
        print('(*) Copying test folder')
        dest_dir = f'{src_dir}/test-project'
        os.makedirs(dest_dir, exist_ok=True)
        shutil.copytree(test_dir, dest_dir, dirs_exist_ok=True)
        shutil.copy('test/test-utils/test-utils.sh', dest_dir)

def build_container(template_id, src_dir):
    id_label = f'test-container={template_id}'
    subprocess.run(['npm', 'install', '-g', '@devcontainers/cli'], check=True)
    subprocess.run(['devcontainer', 'up', '--id-label', id_label, '--workspace-folder', src_dir], check=True)

def run_smoke_test(template_id, src_dir):
    id_label = f'test-container={template_id}'
    cmd = 'set -e && if [ -f "test-project/test.sh" ]; then cd test-project && if [ "$(id -u)" = "0" ]; then chmod +x test.sh; else sudo chmod +x test.sh; fi && ./test.sh; else ls -a; fi'
    subprocess.run(['devcontainer', 'exec', '--workspace-folder', src_dir, '--id-label', id_label, '/bin/sh', '-c', cmd], check=True)

def cleanup(template_id, src_dir):
    id_label = f'test-container={template_id}'
    subprocess.run(['docker', 'rm', '-f', '$(docker', 'container', 'ls', '-f', f'label={id_label}', '-q)'], check=True)
    shutil.rmtree(src_dir)

if __name__ == '__main__':
    template_id = sys.argv[1]
    if not template_id:
        print("(!) Missing Template Id argument. Please provide a template id.")
        sys.exit(1)
    src_dir = copy_template(template_id)
    configure_template(src_dir)
    copy_test_files(template_id, src_dir)
    build_container(template_id, src_dir)
    run_smoke_test(template_id, src_dir)
    cleanup(template

[eitsupi]

I think that the content of this script is confusing, not because of the language, but because there is no way to check the intermediate file (the generated devcontainer.json).

My preference is to use Makefiles to split tasks so they can be executed in order.