Files
EVEngine/scripts/check_test_manifest.py
西风逍遥游 31880f0021 feat(examples): gate examples in CI and make repository scripts UTF-8 on every host
`examples/<name>/` was a tested surface in name only. The source-quality job had
no examples check at all, and scripts/smoke_examples.sh accepted any process that
had not printed one of its error markers: a project that died during startup,
exited after a single frame, or crashed without a marker was reported as PASS.
Nothing stopped a malformed or unregistered example from reaching dev, which is
how 14 examples arrived without READMEs and 20 were never registered in the
overview table.

Source side
- scripts/check_examples.py classifies every directory under examples/ as either
  runnable (main.nut plus a config.nut that assigns the engine `config` table) or
  as a reviewed non-runnable sample listed in NON_RUNNABLE_EXAMPLES with a
  reason. Both kinds must own a README.md and appear in examples/README.md.
  Stale exemptions and overview links to missing directories fail as well.
- `make check/examples` and a new source-quality CI step run the gate.
- scripts/tests/test_check_examples.py covers it and pins each failure mode
  against fixtures.

Runtime side
- scripts/smoke_examples.sh now enforces liveness, not just marker absence: every
  runnable example must still be running after MIN_RUN_SECONDS (default 2s; CI
  passes 2s), and a process that dies inside that window fails whatever its exit
  code. A clean self-exit after the window passes with an explicit note instead
  of being silently accepted as a pass.
- The Linux CI step sets MIN_RUN_SECONDS=2 and keeps RUN_SECONDS=6, so the job's
  wall clock is unchanged (13.7 min of its 20 min budget on dev).

Windows / GBK
- scripts/utf8_stdio.py re-encodes stdout/stderr as UTF-8 and every scripts/*.py
  program calls it as the first statement of its __main__ block. On a Chinese
  Windows a redirected stream falls back to the ANSI code page (cp936), and
  printing a character that code page cannot encode (arrows, superscripts, bullet
  separators, emoji - all common in this repository) raised UnicodeEncodeError
  and turned a checker into a traceback.
- The mirror image is input: read_text() without encoding= decoded UTF-8
  repository text as cp936 and raised UnicodeDecodeError.
- scripts/tests/test_utf8_stdio.py enforces both conventions for every script and
  test module; text file I/O and child-process decoding now pass encoding="utf-8"
  explicitly.
- Unit-test invocations run with `python3 -X utf8` so the runner's own output
  never follows the host code page.

Violations the new gates found on top of dev, fixed here: 14 examples shipped
without a README (fluid3d, mesh-impact-lab, mesh-modifier-lab, spline-tube-lab on
the earlier dev tip, plus pcg-depth-of-field, pcg-detail-overwrite,
pcg-layer-culling, pcg-location-system, pcg-runtime-orchestration,
pcg-scene-player-culling, pcg-snow-wind, pcg-thunder-strike, pcg-ui-scaler and
pcg-underwater added by #397), 20 were missing from the overview table (those 14
plus archspace-editor, geometry-stroke-lab, interior-mapping, layered-animation,
triplanar-decal, terrain-stamping), and scripts/export_meshret_onnx.py had no
UTF-8 stdio guard.

Verified locally: `python -m ruff check scripts` (All checks passed);
scripts/check_test_manifest.py; scripts/check_quality_metadata.py;
scripts/check_architecture_contracts.py --base HEAD; scripts/check_nodiscard.py;
`make -n check/examples`; scripts/check_examples.py (125 examples: 118 runnable,
7 reviewed non-runnable); and `python -X utf8 -m unittest discover -s scripts/tests
-p "test_*.py"` (155 tests, OK). The runtime half of the contract needs a Linux
headless build, so it is verified by the CI examples smoke step rather than
locally.
2026-09-15 20:20:23 +08:00

88 lines
3.0 KiB
Python

#!/usr/bin/env python3
"""Verify the test suite retains automatic source discovery.
Top-level test/*.cpp files are globbed at configure time and recorded in
test_src.txt. Make reconfigures when an individual test/*.cpp is newer than
that list. This check prevents a regression to a central append-only list,
Ninja CONFIGURE_DEPENDS glob restacking, or a glob that never re-runs after
a new file is added.
"""
from __future__ import annotations
import re
import sys
from pathlib import Path
import utf8_stdio
REPO = Path(__file__).resolve().parent.parent
TEST_DIR = REPO / "test"
CMAKE_LIST = TEST_DIR / "CMakeLists.txt"
MAKEFILE = REPO / "Makefile"
CONFIGURE_DEPENDS_GLOB_RE = re.compile(
r"file\(GLOB\s+all_test_cpp\s+CONFIGURE_DEPENDS\b",
re.MULTILINE,
)
GLOB_RE = re.compile(
r'file\(GLOB\s+all_test_cpp\s+"\$\{CMAKE_CURRENT_SOURCE_DIR\}/\*\.cpp"\s*\)',
re.MULTILINE,
)
TEST_SRC_TXT_RE = re.compile(r"test_src\.txt")
MAKE_TEST_CPP_RE = re.compile(r"test/\*\.cpp")
DEMO_EXCLUSION_RE = re.compile(
r'list\(REMOVE_ITEM\s+all_test_cpp\s+'
r'"\$\{CMAKE_CURRENT_SOURCE_DIR\}/demo\.cpp"\s*\)'
)
DEMO_APPEND_RE = re.compile(r"list\(APPEND\s+all_test_cpp\s+demo\.cpp\s*\)")
def discovery_contract_errors(cmake_text: str, makefile_text: str = "") -> list[str]:
"""Return errors when CMake/Make no longer auto-discover all test sources."""
errors: list[str] = []
if CONFIGURE_DEPENDS_GLOB_RE.search(cmake_text):
errors.append(
"all_test_cpp must not use CONFIGURE_DEPENDS; write test_src.txt and "
"reconfigure from make when test/*.cpp changes"
)
if not GLOB_RE.search(cmake_text):
errors.append("all_test_cpp must glob test/*.cpp at configure time")
if not TEST_SRC_TXT_RE.search(cmake_text):
errors.append("configure must write test_src.txt for added/removed test sources")
if not MAKE_TEST_CPP_RE.search(makefile_text) or not TEST_SRC_TXT_RE.search(makefile_text):
errors.append(
"Makefile ensure-built must reconfigure when test/*.cpp is newer than test_src.txt"
)
if not DEMO_EXCLUSION_RE.search(cmake_text):
errors.append("demo.cpp must be removed from the unconditional source set")
if not DEMO_APPEND_RE.search(cmake_text):
errors.append("demo.cpp must remain conditionally appended")
return errors
def main() -> int:
if not CMAKE_LIST.exists():
print(f"error: {CMAKE_LIST} not found", file=sys.stderr)
return 1
if not MAKEFILE.exists():
print(f"error: {MAKEFILE} not found", file=sys.stderr)
return 1
errors = discovery_contract_errors(
CMAKE_LIST.read_text(encoding="utf-8"),
MAKEFILE.read_text(encoding="utf-8"),
)
if errors:
for error in errors:
print(f"error: {error}", file=sys.stderr)
return 1
count = sum(1 for _ in TEST_DIR.glob("*.cpp"))
print(f"test auto-discovery OK: test_src.txt covers {count} sources")
return 0
if __name__ == "__main__":
utf8_stdio.enable_utf8_stdio()
sys.exit(main())