Files
EVEngine/scripts/check_resource_format_exports.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

67 lines
2.9 KiB
Python

#!/usr/bin/env python3
"""Independently decode engine PNG/TGA exports with Pillow and FFmpeg.
A missing file or decoder is a failure. Run after resourceFormats.image.*Export
with EVENGINE_FORMAT_EXPORT_DIR set. Does not regenerate or modify the exports.
"""
import argparse
import json
from pathlib import Path
import struct
import subprocess
from PIL import Image
import utf8_stdio
def verify(directory):
expected = [(17 + x * 37, 23 + y * 71, 11 + x * 13 + y * 29, (x + y * 5) * 17)
for y in range(3) for x in range(5)]
results = []
for name in ['rgba8.png', 'rgba16.png', 'rgba8.tga']:
path = directory / name
with Image.open(path) as image:
if image.size != (5, 3):
raise ValueError(f'{name}: wrong dimensions {image.size}')
if image.mode != 'RGBA':
raise ValueError(f'{name}: independent decoder lost alpha ({image.mode})')
actual = [image.getpixel((x, y)) for y in range(3) for x in range(5)]
error = max(abs(a - b) for actual_pixel, expected_pixel in zip(actual, expected)
for a, b in zip(actual_pixel, expected_pixel))
if error > 1:
raise ValueError(f'{name}: pixel error {error}')
if name == 'rgba16.png':
if path.read_bytes()[24] != 16:
raise ValueError('rgba16.png: encoder did not preserve 16-bit depth')
run = subprocess.run(['ffmpeg', '-hide_banner', '-loglevel', 'error', '-i', str(path),
'-f', 'rawvideo', '-pix_fmt', 'rgba64le', '-'], check=True, capture_output=True)
if len(run.stdout) != 5 * 3 * 8:
raise ValueError('rgba16.png: wrong decoded byte count')
actual16 = struct.unpack('<60H', run.stdout)
expected16 = [v * 257 + i % 5 + 1 for i, pixel in enumerate(expected) for v in pixel]
error16 = max(abs(a - b) for a, b in zip(actual16, expected16))
if error16 > 1:
raise ValueError(f'rgba16.png: 16-bit pixel error {error16}')
results.append({'file': name, 'status': 'passed', 'maxRgba8Error': error})
return results
def main():
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument('directory', type=Path)
parser.add_argument('--report', type=Path, required=True)
args = parser.parse_args()
try:
result = {'status': 'passed', 'exports': verify(args.directory)}
except (OSError, ValueError, subprocess.SubprocessError) as error:
result = {'status': 'failed', 'error': str(error)}
args.report.parent.mkdir(parents=True, exist_ok=True)
args.report.write_text(json.dumps(result, indent=2) + '\n', encoding="utf-8")
print(json.dumps(result))
return 0 if result['status'] == 'passed' else 1
if __name__ == '__main__':
utf8_stdio.enable_utf8_stdio()
raise SystemExit(main())