西风逍遥游
31880f0021
`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.
60 lines
1.9 KiB
Python
60 lines
1.9 KiB
Python
from pathlib import Path
|
|
import importlib.util
|
|
import sys
|
|
import unittest
|
|
|
|
|
|
ROOT = Path(__file__).resolve().parents[2]
|
|
# Loading a script by path bypasses the normal sys.path entry for its directory,
|
|
# so its own sibling imports (utf8_stdio) only resolve if the test puts that
|
|
# directory on sys.path itself.
|
|
sys.path.insert(0, str(ROOT / "scripts"))
|
|
SPEC = importlib.util.spec_from_file_location("migrate_evescript", ROOT / "scripts" / "migrate_evescript.py")
|
|
MODULE = importlib.util.module_from_spec(SPEC)
|
|
assert SPEC.loader is not None
|
|
sys.modules[SPEC.name] = MODULE
|
|
SPEC.loader.exec_module(MODULE)
|
|
|
|
|
|
def migrate(source: str) -> str:
|
|
return MODULE.migrate_source(source)[0]
|
|
|
|
|
|
class MigrateEveScriptTests(unittest.TestCase):
|
|
def test_migrates_root_guard_with_nested_initializer(self):
|
|
source = 'if (!("state" in getroottable())) state <- { items = [1, 2], label = ";" };\n'
|
|
self.assertEqual(migrate(source), 'persist state = { items = [1, 2], label = ";" }\n')
|
|
|
|
def test_migrates_multiline_guard(self):
|
|
source = 'if (!("world" in getroottable()))\n world <- make_world(\n 0.0, 980.0);\n'
|
|
self.assertEqual(migrate(source), 'persist world = make_world(\n 0.0, 980.0)\n')
|
|
|
|
def test_migrates_legacy_persist_call(self):
|
|
source = '''game <- persist("game", function() {
|
|
return {
|
|
score = 0,
|
|
title = "ready; go"
|
|
};
|
|
});
|
|
'''
|
|
self.assertEqual(migrate(source), '''persist game = {
|
|
score = 0,
|
|
title = "ready; go"
|
|
}
|
|
''')
|
|
|
|
def test_does_not_migrate_nested_dynamic_guard(self):
|
|
source = '''function update() {
|
|
if (!("yaw" in getroottable())) yaw <- 0.0;
|
|
}
|
|
'''
|
|
self.assertEqual(migrate(source), source)
|
|
|
|
def test_does_not_touch_capability_check(self):
|
|
source = 'if ("gfx" in getroottable()) gfx.clear();\n'
|
|
self.assertEqual(migrate(source), source)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|