Use scenario runner for auto subimage regression

ssh4net · ssh4net · commit f6c2ec270a0e · 2026-04-02T11:17:18.000+09:00
Add XML scenario support and runner invocation for auto subimage regression: write imiv scenario XML, implement _run_scenario to execute the scenario runner, and read per-step state outputs. Refactor previous key-chord based calls to use the scenario file and runtime output paths, and fix zoom expectation to use the enabled step's reported zoom. Add helper _path_for_imiv_output and ensure runtime/config dirs are created.

Update upload corpus tooling and tests: move generated corpus paths under build_u/testsuite/imiv/upload_corpus, make oiiotool generate images with explicit constant colors and alpha values, parse channel/color entries properly, set OIIOTOOL_BIN default in ctest wrapper, and only regenerate images when the images directory is missing or empty. Adjust smoke test defaults to the new testsuite paths.

Signed-off-by: Vlad (Kuzmin) Erium &lt;libalias@gmail.com&gt;
diff --git a/src/imiv/tools/imiv_auto_subimage_regression.py b/src/imiv/tools/imiv_auto_subimage_regression.py
@@ -11,6 +11,7 @@
 import shutil
 import subprocess
 import sys
+import xml.etree.ElementTree as ET
 from pathlib import Path
 
 
@@ -177,6 +178,99 @@ def _run_case(
     return state
 
 
+def _path_for_imiv_output(path: Path, run_cwd: Path) -> str:
+    try:
+        return os.path.relpath(path, run_cwd)
+    except ValueError:
+        return str(path)
+
+
+def _write_scenario(path: Path, runtime_dir_rel: str) -> None:
+    root = ET.Element("imiv-scenario")
+    root.set("out_dir", runtime_dir_rel)
+
+    step = ET.SubElement(root, "step")
+    step.set("name", "enable_auto")
+    step.set("key_chord", "shift+comma")
+    step.set("state", "true")
+    step.set("post_action_delay_frames", "2")
+
+    step = ET.SubElement(root, "step")
+    step.set("name", "zoom_out")
+    step.set("key_chord", "ctrl+minus")
+    step.set("state", "true")
+    step.set("post_action_delay_frames", "3")
+
+    path.parent.mkdir(parents=True, exist_ok=True)
+    ET.ElementTree(root).write(path, encoding="utf-8", xml_declaration=True)
+
+
+def _run_scenario(
+    repo_root: Path,
+    runner: Path,
+    exe: Path,
+    cwd: Path,
+    backend: str,
+    image_path: Path,
+    out_dir: Path,
+    scenario_path: Path,
+    env: dict[str, str],
+    trace: bool,
+) -> dict[str, dict]:
+    runtime_dir = out_dir / "runtime"
+    runtime_dir.mkdir(parents=True, exist_ok=True)
+    config_home = out_dir / "cfg_scenario"
+    shutil.rmtree(config_home, ignore_errors=True)
+    cmd = [
+        sys.executable,
+        str(runner),
+        "--bin",
+        str(exe),
+        "--cwd",
+        str(cwd),
+    ]
+    if backend:
+        cmd.extend(["--backend", backend])
+    cmd.extend(
+        [
+            "--open",
+            str(image_path),
+            "--scenario",
+            str(scenario_path),
+        ]
+    )
+    if trace:
+        cmd.append("--trace")
+
+    case_env = dict(env)
+    case_env["IMIV_CONFIG_HOME"] = str(config_home)
+
+    with (out_dir / "scenario.log").open("w", encoding="utf-8") as log_handle:
+        proc = subprocess.run(
+            cmd,
+            cwd=str(repo_root),
+            env=case_env,
+            check=False,
+            stdout=log_handle,
+            stderr=subprocess.STDOUT,
+            timeout=90,
+        )
+    if proc.returncode != 0:
+        raise RuntimeError(f"scenario: runner exited with code {proc.returncode}")
+
+    result: dict[str, dict] = {}
+    for step_name in ("enable_auto", "zoom_out"):
+        state_path = runtime_dir / f"{step_name}.state.json"
+        if not state_path.exists():
+            raise RuntimeError(f"scenario: missing state output for {step_name}")
+        with state_path.open("r", encoding="utf-8") as handle:
+            state = json.load(handle)
+        state["_state_path"] = str(state_path)
+        state["_log_path"] = str(out_dir / "scenario.log")
+        result[step_name] = state
+    return result
+
+
 def _calc_expected_subimage_from_zoom(
     current_subimage: int, nsubimages: int, zoom: float
 ) -> tuple[int, float]:
@@ -258,42 +352,23 @@ def main() -> int:
             env,
             args.trace,
         )
-        enabled = _run_case(
-            repo_root,
-            runner,
-            exe,
-            cwd,
-            args.backend,
-            image_path,
-            out_dir,
-            "enable_auto",
-            ["--key-chord", "shift+comma"],
-            env,
-            args.trace,
-        )
-        auto_zoom = _run_case(
+        scenario_path = out_dir / "auto_subimage.scenario.xml"
+        runtime_dir = out_dir / "runtime"
+        _write_scenario(scenario_path, _path_for_imiv_output(runtime_dir, cwd))
+        scenario_states = _run_scenario(
             repo_root,
             runner,
             exe,
             cwd,
             args.backend,
             image_path,
             out_dir,
-            "auto_zoom_out",
-            [
-                "--key-chord",
-                "shift+comma",
-                "--mouse-pos-window-rel",
-                "0.5",
-                "0.5",
-                "--mouse-click",
-                "1",
-                "--post-action-delay-frames",
-                "3",
-            ],
+            scenario_path,
             env,
             args.trace,
         )
+        enabled = scenario_states["enable_auto"]
+        auto_zoom = scenario_states["zoom_out"]
     except (RuntimeError, subprocess.SubprocessError) as exc:
         return _fail(str(exc))
 
@@ -319,7 +394,7 @@ def main() -> int:
         return _fail(f"enable_auto changed subimage unexpectedly: {enabled['subimage']}")
 
     expected_subimage, expected_zoom = _calc_expected_subimage_from_zoom(
-        current_subimage=0, nsubimages=4, zoom=baseline_zoom * 0.5
+        current_subimage=0, nsubimages=4, zoom=float(enabled["zoom"]) * 0.5
     )
     actual_subimage = int(auto_zoom["subimage"])
     actual_zoom = float(auto_zoom["zoom"])
diff --git a/src/imiv/tools/imiv_generate_upload_corpus.sh b/src/imiv/tools/imiv_generate_upload_corpus.sh
@@ -6,8 +6,8 @@
 set -euo pipefail
 
 repo_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
-out_dir="${1:-$repo_root/build_u/imiv_upload_corpus/images}"
-manifest_csv="${2:-$repo_root/build_u/imiv_upload_corpus/corpus_manifest.csv}"
+out_dir="${1:-$repo_root/build_u/testsuite/imiv/upload_corpus/images}"
+manifest_csv="${2:-$repo_root/build_u/testsuite/imiv/upload_corpus/corpus_manifest.csv}"
 oiiotool_bin="${OIIOTOOL_BIN:-$repo_root/build_u/bin/oiiotool}"
 
 if [[ ! -x "$oiiotool_bin" ]]; then
@@ -35,8 +35,8 @@ dimensions=(
 )
 
 channels=(
-    "rgb:3"
-    "rgba:4"
+    "rgb:3:0.85,0.35,0.15"
+    "rgba:4:0.10,0.80,0.95,0.75"
 )
 
 depths=(
@@ -54,7 +54,9 @@ for dim in "${dimensions[@]}"; do
     height="${dim#*x}"
     for ch_entry in "${channels[@]}"; do
         ch_name="${ch_entry%%:*}"
-        ch_count="${ch_entry#*:}"
+        rest="${ch_entry#*:}"
+        ch_count="${rest%%:*}"
+        color="${rest#*:}"
         for depth_entry in "${depths[@]}"; do
             depth_tag="${depth_entry%%:*}"
             rest="${depth_entry#*:}"
@@ -64,8 +66,9 @@ for dim in "${dimensions[@]}"; do
             file_name="${ch_name}_${depth_tag}_${width}x${height}.${extension}"
             file_path="${out_dir}/${file_name}"
 
-            "$oiiotool_bin" --create "${width}x${height}" "${ch_count}" \
-                -d "${depth_name}" -o "${file_path}"
+            "$oiiotool_bin" \
+                --pattern "constant:color=${color}" "${width}x${height}" \
+                "${ch_count}" -d "${depth_name}" -o "${file_path}"
 
             printf '%s,%s,%s,%s,%s,%s\n' \
                 "$file_path" "$width" "$height" "$ch_count" "$depth_name" \
diff --git a/src/imiv/tools/imiv_upload_corpus_ctest.sh b/src/imiv/tools/imiv_upload_corpus_ctest.sh
@@ -7,8 +7,7 @@ set -euo pipefail
 
 repo_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
 build_dir="${1:-$repo_root/build_u}"
-
-corpus_root="${build_dir}/imiv_upload_corpus"
+corpus_root="${build_dir}/testsuite/imiv/upload_corpus"
 images_dir="${corpus_root}/images"
 manifest_csv="${corpus_root}/corpus_manifest.csv"
 results_dir="${corpus_root}/results"
@@ -19,9 +18,16 @@ smoke_script="${repo_root}/src/imiv/tools/imiv_upload_corpus_smoke_test.sh"
 if [[ -z "${IMIV_ENV_SCRIPT:-}" ]]; then
     export IMIV_ENV_SCRIPT="${build_dir}/imiv_env.sh"
 fi
+if [[ -z "${OIIOTOOL_BIN:-}" ]]; then
+    export OIIOTOOL_BIN="${build_dir}/bin/oiiotool"
+fi
 
 export PER_CASE_TIMEOUT="${PER_CASE_TIMEOUT:-90s}"
 export RUNNER_TRACE="${RUNNER_TRACE:-0}"
 
-"${generate_script}" "${images_dir}" "${manifest_csv}"
+if ! [[ -d "${images_dir}" ]] \
+    || ! find "${images_dir}" -maxdepth 1 -type f | read -r _; then
+    "${generate_script}" "${images_dir}" "${manifest_csv}"
+fi
+
 "${smoke_script}" "${images_dir}" "${results_dir}"
diff --git a/src/imiv/tools/imiv_upload_corpus_smoke_test.sh b/src/imiv/tools/imiv_upload_corpus_smoke_test.sh
@@ -6,8 +6,8 @@
 set -euo pipefail
 
 repo_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
-corpus_dir="${1:-$repo_root/build_u/imiv_upload_corpus/images}"
-result_dir="${2:-$repo_root/build_u/imiv_upload_corpus/results}"
+corpus_dir="${1:-$repo_root/build_u/testsuite/imiv/upload_corpus/images}"
+result_dir="${2:-$repo_root/build_u/testsuite/imiv/upload_corpus/results}"
 runner_py="${RUNNER_PY:-$repo_root/src/imiv/tools/imiv_gui_test_run.py}"
 python_bin="${PYTHON_BIN:-python3}"
 env_script="${IMIV_ENV_SCRIPT:-$repo_root/build_u/imiv_env.sh}"
