test/integration/projects/create-file: Add
All checks were successful
CI / Packaging - Kali Linux (pull_request) Successful in 4m18s
CI / Packaging - OpenSUSE Tumbleweed (pull_request) Successful in 4m24s
CI / Packaging test (pull_request) Successful in 0s
CI / Packaging - Kali Linux (push) Successful in 4m52s
CI / Packaging - OpenSUSE Tumbleweed (push) Successful in 4m30s
CI / Packaging test (push) Successful in 0s

CmdCreateFile renders a file from project metadata, yet nothing runs it end
to end. The "tmpl" format substitutes --field values into template markers,
and the "pyright" format computes extra paths from the jw run dependencies
of a module. Both formats are untested, and so is the handling of missing
templates, unknown --field keys, and malformed command-line arguments.

Add an integration test under test/integration/jw-pkg/projects that drives
the command through the real CLI and diffs the rendered output against
a reference. It covers single- and multi-value field substitution, the
default and custom field separators including the %n newline escape, value
quoting, and --field-keys filling in keys the caller omitted. The pyright
case uses a relative topdir so the computed project paths stay relocatable.
The error cases check that the command rejects a missing template name, an
unknown template file, a --field key outside --field-keys, an unsupported
pyright separator, and invalid --format and --field arguments with the
expected message and exit status.

Assisted-by: unsloth/Qwen3.8-27B-GGUF:Q4_K_M with pi.dev v0.85.1
Signed-off-by: Jan Lindemann <jan@janware.com>
This commit is contained in:
Jan Lindemann 2026-09-13 17:05:07 +02:00
commit 6fe8f5dc65
Signed by: Jan Lindemann
GPG key ID: 3750640C9E25DD61
5 changed files with 189 additions and 0 deletions

View file

@ -0,0 +1,23 @@
TOPDIR = ../../../../..
OUTPUT = test-out.txt
REFERENCE = test-expected.txt
# Relative topdir keeps the rendered project paths relocatable; dropping the
# log position keeps the error output free of volatile line numbers.
TEST_CMD_ARGS = --topdir-format relative --log-flags prio,stderr
include $(TOPDIR)/make/proj.mk
include $(TOPDIR)/make/test-jw-pkg.mk
all:
$(OUTPUT): Makefile test.sh templates/basic.tmpl templates/list.tmpl
bash ./test.sh $(TEST_CMD_LINE) > $(OUTPUT).tmp 2>&1
diff $(REFERENCE) $(OUTPUT).tmp
mv $(OUTPUT).tmp $(OUTPUT)
test: $(OUTPUT)
clean: test.integration.in-tree.clean
test.integration.in-tree.clean:
rm -f $(OUTPUT) $(OUTPUT).tmp

View file

@ -0,0 +1,2 @@
name={name}
path={path}

View file

@ -0,0 +1 @@
start={items}end

View file

@ -0,0 +1,55 @@
============= Running: jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format tmpl --template-name basic.tmpl --search-path templates --field name=foo jw-pkg
name=foo
path={path}
============= Running: jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format tmpl --template-name list.tmpl --search-path templates --field items=a --field items=b jw-pkg
start=a,
start=bend
============= Running: jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format tmpl --template-name list.tmpl --search-path templates --field items=a --field items=b --field-separator | jw-pkg
start=a|bend
============= Running: jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format tmpl --template-name list.tmpl --search-path templates --field items=a --field items=b --field-separator %n jw-pkg
start=a
start=bend
============= Running: jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format tmpl --template-name list.tmpl --search-path templates --field items=a --field items=b --quote --field-separator | jw-pkg
start="a"|"b"end
============= Running: jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format tmpl --template-name basic.tmpl --search-path templates --field-keys name,path --field name=foo jw-pkg
name=foo
path=
============= Running: jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format pyright --field base=./conf/project/pyrightconfig-base.json --field include=src/python jw-pkg
{
"extends": "./conf/project/pyrightconfig-base.json",
"include": [
"src/python"
],
"exclude": [
"**/__pycache__",
"**/.pytest_cache",
"**/.mypy_cache",
"**/.ruff_cache",
"**/.venv",
"**/build",
"**/dist"
],
"extraPaths": [
"src/python"
],
"typeCheckingMode": "basic",
"pythonPlatform": "Linux"
}
============= Running (expect failure): jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format tmpl jw-pkg
<E> Failed: Can't render template without name
============= Exit status: 1
============= Running (expect failure): jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format tmpl --template-name nosuch.tmpl --search-path templates jw-pkg
<E> Failed: Failed to find template "nosuch.tmpl"
============= Exit status: 1
============= Running (expect failure): jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format tmpl --template-name basic.tmpl --search-path templates --field-keys name --field path=x jw-pkg
<E> Failed: The following keys in --field are not in --field-keys: path
============= Exit status: 1
============= Running (expect failure): jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format pyright --field base=x --field include=y --field-separator | jw-pkg
<E> Failed: Unsupported separator for pyright config: "|"
============= Exit status: 1
============= Running (expect failure): jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format bogus jw-pkg
jw-pkg.py projects create-file: error: argument --format: invalid choice: 'bogus' (choose from 'pyright', 'tmpl')
============= Exit status: 2
============= Running (expect failure): jw-pkg.py -t ../../../../.. --log-level info --topdir-format relative --log-flags prio,stderr projects create-file --format tmpl --template-name basic.tmpl --search-path templates --field noval jw-pkg
jw-pkg.py projects create-file: error: argument -f/--field: Expected KEY=VALUE
============= Exit status: 2

View file

@ -0,0 +1,108 @@
#!/bin/bash
# shellcheck disable=SC2048,SC2086
# Unquoted $* is intentional — the jw-pkg command line
export LC_ALL="C"
set -euo pipefail
jw_pkg_py="$*"
# Print a header and run a command whose output is part of the expected
# result. Under `set -e` a non-zero exit aborts the test.
run()
{
local log_cmd
# shellcheck disable=SC2001
log_cmd=$(echo "$*" | sed 's|.*python3[0-9.]*\s\+\(\.\.\/\)*scripts/||')
printf '============= Running: %s\n' "$log_cmd"
"$@"
}
# Run a command that must exit non-zero and report the given message. Prints
# the command, the resulting error message, and the observed exit status.
# Fails the test if the command unexpectedly succeeds or the message is
# missing. Only the last output line is shown: for the app-level errors it is
# the error itself, and for argparse rejections it is the error line, which
# keeps the expected file free of the volatile usage text.
expect_fail()
{
local expected out rc log_cmd
expected=$1
shift
# shellcheck disable=SC2001
log_cmd=$(echo "$*" | sed 's|.*python3[0-9.]*\s\+\(\.\.\/\)*scripts/||')
printf '============= Running (expect failure): %s\n' "$log_cmd"
set +e
out=$("$@" 2>&1)
rc=$?
set -e
printf '%s\n' "$(tail -n 1 <<<"$out")"
printf '============= Exit status: %s\n' "$rc"
if [ "$rc" -eq 0 ]; then
echo "ERROR: expected failure, but the command succeeded" >&2
return 1
fi
if ! grep -qF -- "$expected" <<<"$out"; then
echo "ERROR: expected message not found: $expected" >&2
return 1
fi
}
cmd_test()
{
# -- tmpl: substitute a field; a marker without a value stays literal
run $jw_pkg_py projects create-file --format tmpl \
--template-name basic.tmpl --search-path templates \
--field name=foo jw-pkg
# -- tmpl: multi-value field, default separator (comma, newline)
run $jw_pkg_py projects create-file --format tmpl \
--template-name list.tmpl --search-path templates \
--field items=a --field items=b jw-pkg
# -- tmpl: multi-value field, custom separator
run $jw_pkg_py projects create-file --format tmpl \
--template-name list.tmpl --search-path templates \
--field items=a --field items=b --field-separator '|' jw-pkg
# -- tmpl: multi-value field, "%n" separator
run $jw_pkg_py projects create-file --format tmpl \
--template-name list.tmpl --search-path templates \
--field items=a --field items=b --field-separator '%n' jw-pkg
# -- tmpl: multi-value field, quoted values
run $jw_pkg_py projects create-file --format tmpl \
--template-name list.tmpl --search-path templates \
--field items=a --field items=b --quote --field-separator '|' jw-pkg
# -- tmpl: --field-keys adds keys that were not passed as empty fields
run $jw_pkg_py projects create-file --format tmpl \
--template-name basic.tmpl --search-path templates \
--field-keys name,path --field name=foo jw-pkg
# -- pyright: built-in template, extra paths from project metadata
run $jw_pkg_py projects create-file --format pyright \
--field base=./conf/project/pyrightconfig-base.json \
--field include=src/python jw-pkg
# -- errors
expect_fail "Can't render template without name" \
$jw_pkg_py projects create-file --format tmpl jw-pkg
expect_fail 'Failed to find template "nosuch.tmpl"' \
$jw_pkg_py projects create-file --format tmpl \
--template-name nosuch.tmpl --search-path templates jw-pkg
expect_fail "not in --field-keys: path" \
$jw_pkg_py projects create-file --format tmpl \
--template-name basic.tmpl --search-path templates \
--field-keys name --field path=x jw-pkg
expect_fail 'Unsupported separator for pyright config: "|"' \
$jw_pkg_py projects create-file --format pyright \
--field base=x --field include=y --field-separator '|' jw-pkg
expect_fail "invalid choice: 'bogus'" \
$jw_pkg_py projects create-file --format bogus jw-pkg
expect_fail "Expected KEY=VALUE" \
$jw_pkg_py projects create-file --format tmpl \
--template-name basic.tmpl --search-path templates --field noval jw-pkg
}
cmd_test