mirror of https://github.com/Vateron-Media/XC_VM.git synced 2026-09-29 12:02:04 +02:00

Files

T

Divarion_D 7f3812e165 chore(build): move phpstan / php-cs-fixer config out of the repo root

Relocate the dev-tooling config into build/ so the project root only holds
source and first-class project files:
- phpstan.dist.neon        -> build/phpstan.dist.neon
- phpstan-baseline.neon    -> build/phpstan-baseline.neon
- .php-cs-fixer.dist.php    -> build/.php-cs-fixer.dist.php
- .php-cs-fixer.cache       -> build/ (regenerated there; gitignored)

Because neon/CS-Fixer resolve relative paths against the config file's own
directory, the internal references are re-anchored one level up (src/ ->
../src/, tools/ -> ../tools/, Finder in(__DIR__.'/../src'); the baseline's
path: entries likewise). The Makefile now points PHPStan at the config with
-c build/phpstan.dist.neon (it previously relied on root auto-discovery),
generates the baseline into build/, and passes --config=build/... to CS-Fixer;
the CS-Fixer cache is pinned to build/ via setCacheFile and re-gitignored.

No behaviour change. Verified: make phpstan (No errors), make cs (0 fixable),
make gates. CI runs through these make targets, so it is covered.

2026-08-09 19:37:11 +03:00

3.5 KiB

Raw Blame History

`tools/` — development, CI & panel-test utilities

Support tooling for the XC_VM panel. Nothing here ships to production — these are CI gates, static-analysis helpers, and manual test/QA utilities written to exercise the panel. Some are wired into the Makefile / CI; others are run by hand during testing. Each is listed below with its purpose and how to run it.

CI gates (run by `make gates`, enforced in CI)

Tool	Purpose
`ci/check_procedural_use.php`	Every non-namespaced procedural/view file must `use`-import the migrated `XcVm\` classes it references (PHP `use` is positional — a short name without an import faults at runtime).
`ci/check-vendor-prod-only.sh`	The committed `src/vendor/` must be production-only — no dev package is tracked or listed in `installed.json` (checked against the git index).
`ci/verify-lb-archive.sh`	The load-balancer archive must exclude privileged code (admin/reseller/player UI, user/device domain, install/root cron jobs).

Static analysis (PHPStan) support

Tool	Purpose
`phpstan/phpstan-bootstrap.php`	PHPStan bootstrap — defines the global constants (e.g. `MAIN_HOME`) the code sets at runtime, so constant-dependent analysis stays accurate. A `bootstrapFile` in `build/phpstan.dist.neon`.
`phpstan/constants.stub.php`	Auto-generated stub of the ~131 runtime `define()` constants PHPStan cannot see via static scanning. A `bootstrapFile`. Do not hand-edit — regenerate it.
`phpstan/gen-constants-stub.php`	Regenerates `constants.stub.php` by scanning `src/` for `define()`s. Run via `make phpstan-stub` when runtime constants change.

Run the analysis with make phpstan (needs dev tools: make dev-tools).

Tests runner

Tool	Purpose
`.bin/phpunit.phar`	Committed PHPUnit 10.5 runner. `php tools/.bin/phpunit.phar -c tests/phpunit.xml.dist` (config in `tests/phpunit.xml.dist`).

Panel test / QA utilities (manual)

Written to test the running panel end-to-end; run by hand as needed.

Tool	Purpose
`test_player_api.sh`	HTTP smoke-test of every `PlayerApiController` endpoint — checks status, `Content-Type` and JSON shape. `./tools/test_player_api.sh <base_url> <username> <password>`. (Note: the password is passed as an argv arg, so it is visible in `ps`/shell history — use on a local/trusted shell.)
`stream_queue_check.py`	Inspects a running stream's packet queue (MPEG-TS `/ts` and HLS) to diagnose buffering/queue behaviour. See `docs/*/development/streaming-subsystem.md`.
`test-stream-generator/`	Turns a single `sample.mp4` into a looping, HTTP-served "live" stream you can paste into the panel as a source — end-to-end streaming-pipeline testing, incl. LLOD (`src/Cli/Commands/LlodCommand.php`). See its `README.md`.
`dts-audio-test/`	Investigates the legacy DTS/AC3 audio path (XUI's `-fix_dts` flag vs stock ffmpeg's `-copyts`) when moving off the bundled ffmpeg `4.0` binary. See its `README.md`.
`test-install/`	Docker-based end-to-end install test of the built release archive — unpacks `XC_VM.zip`, runs the installer with scripted answers, and checks the key installed files. See its `README.md`. Referenced from `docs/*/builds/updates_checklist.md`.

Repo maintenance

Tool	Purpose
`update_top_contributors.py`	Regenerates the contributors table in `CONTRIBUTORS.md` from the GitHub Contributors + Pulls APIs. Optional `GITHUB_TOKEN` env var to avoid rate limits.

3.5 KiB Raw Blame History

tools/ — development, CI & panel-test utilities

CI gates (run by make gates, enforced in CI)