Skip to content

testing.md

Latest commit

 

History

History
164 lines (124 loc) · 7.69 KB

testing.md

File metadata and controls

164 lines (124 loc) · 7.69 KB
Raw

Testing

CI runs three workflows on every pull request, forks included. This page lists their commands in the order to run them locally. A green unit tier does not prove the durable tier, and neither proves what a real client shows.

Prerequisites

  • Rust through rustup. rust-toolchain.toml pins 1.93.0 with rustfmt, clippy and the wasm32-unknown-unknown target, and rustup installs them on the first cargo call in the checkout.
  • On Linux, a C toolchain, pkg-config and the OpenSSL headers (build-essential pkg-config libssl-dev on Ubuntu). macOS needs only the Xcode Command Line Tools.
  • For Gateway binding preparation and the durable tier: the SpacetimeDB CLI 2.7.1 on PATH as spacetime, with the matching standalone. quickstart.md gives the install. Durable test fixtures also accept SPACETIME_BIN to locate the CLI.
  • For the Runtime Script check: Bun 1.4.3.

None of the tiers needs your own client or a world database. Tests that do need one are ignored by default (see Client data).

Unit tier

From .github/workflows/rust.yml. No SpacetimeDB node runs.

cargo fmt --all -- --check
./lyracore bindings
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo test -p lyracore-importer
cargo test -p lyracore-module --lib --features=debug_reducers
cargo test -p lyracore-module --test build_script
cargo test -p lyracore-module --test package_api_lint
cargo test -p lyracore-package-delta
cargo test -p lyracore-gateway
cargo test -p lyracore-shared
cargo test -p lyracore-test-support
cargo check --target wasm32-unknown-unknown -p lyracore-module --features=debug_reducers

The wasm check builds the feature set lyracore publish builds. A default-feature check would skip the published debug reducers.

CI also builds the Module with every Official Package installed, so a core change that breaks one fails before the Package's next publish. To run the same check, link each Package from a checkout of LyraCoreProject/packages into packages/, run cargo test -p lyracore-module --test package_api_lint, and repeat the wasm check. The named test checks all installed Package source files; the Wasm compile checks their types and generated registrations.

Durable tier

From .github/workflows/module-durable.yml. Each test in module/tests/ is #[ignore]d because it starts its own SpacetimeDB standalone on a free loopback port, publishes the Module with --features=debug_reducers,package_test_fixture, calls reducers and reads the result. The lyracore-test-support crate owns that fixture. Standalone logs go to lyracore-standalone-logs under the system temp directory.

Build the Module first, so a build failure shows before any fixture starts. Then run one target:

cargo build --release --target wasm32-unknown-unknown -p lyracore-module --features=debug_reducers,package_test_fixture
cargo test -p lyracore-module --test weather -- --ignored

CI runs every target in three parallel jobs with --test-threads=4 --skip deadmines --skip lethal_floor. The Deadmines targets need the separately installed dungeons Package, and the lethal_floor ranged phase is flaky.

scripts/durable-test-targets.py assigns targets by the durations in .github/durable-test-seconds.json. It includes every current target once and estimates 20 seconds for a new target. JOB_SECONDS reserves time for each job's builds, setup and Gateway checks. To refresh the estimates, use a successful main run: record each Module target's reported test duration, rounded up to whole seconds, in the JSON file. Set each job's JOB_SECONDS entry to its total duration minus those target durations. Keep the run reference in the script current. Run python3 -m unittest discover -s scripts/tests to check the assignment.

The Session expiry test checks the five-minute production interval before it shortens the schedule on its private fixture. It then checks two real scheduled cleanups without a five-minute wait. The Operator-only debug_accelerate_session_reaper control is for disposable test instances; its shorter interval persists if used on an existing Shard.

CI also runs Gateway tests that need a node. The workflow names individual tests with --ignored --exact and runs the party command test group with:

cargo test -p lyracore-gateway --bin lyracore-gateway stdb::subscriptions::party_command_durable_tests -- --ignored --test-threads=1

The Headless Client scenarios, their Benilla pin and the opcode inventory are in benilla-compatibility.md.

Gateway bindings

Before Gateway tests, checks, or Clippy on a fresh checkout, prepare its bindings:

./lyracore bindings
cargo test -p lyracore-gateway

Preparation needs the pinned SpacetimeDB CLI and standalone, builds the local Module with debug_reducers, and includes private tables. It does not contact a Realm. The Rust and durable CI workflows prepare bindings before compiling the Gateway. Schema generation and CLI publishing use Rust flags from the checkout's Cargo configuration and ignore ambient Rust-flag overrides.

Generated files stay in .lyracore/generated/gateway/. The CLI reuses complete output while its inputs and generated files match their recorded hashes. Module sources, installed Package sources, workspace crates, Cargo manifests and lockfile, Cargo configuration, the Runtime Script event catalogue, and toolchain pins are inputs. Source edits, Package additions and removals, and edits through Package symlinks require preparation again.

./lyracore bindings --check checks freshness without running Cargo or SpacetimeDB. It prints JSON with the generated directory and watched paths for the Gateway build script. Direct Cargo builds use the installed CLI binary for this check, so they never install tools or start a nested build. Prepare bindings before opening the Gateway in an editor on a fresh checkout.

A failed generation preserves the previous complete directory, but stale output cannot pass a build. Old directories remain available to compilers already reading them. Delete .lyracore/generated/gateway/ to clear this cache, then prepare again.

Runtime Scripts

From .github/workflows/runtime-scripts.yml:

cd datascripts
bun install --frozen-lockfile
bun test

Client data

These ignored tests read data you own. Set the variable, then run the test with --ignored.

Variable Holds Tests
LYRACORE_CLIENT_DATA your 1.12.1 client's Data/ directory the terrain slice self-checks in importer/src/terrain.rs
LYRACORE_TEST_DBC the DBC files of a build 5875 client the spell catalogue tests in importer/src/spell.rs
LYRACORE_CLASSIC_DB_SQL the pinned classic-db dump, decompressed or gzip the dump tests in importer/src/main.rs

For example:

LYRACORE_CLIENT_DATA=/games/WoW-1.12.1/Data cargo test -p lyracore-importer terrain -- --ignored

The complete creature import test loads the pinned dump and client catalogues into a private local SpacetimeDB node, checks every source position, waits for the shared-world population, and reimports the populated roster:

LYRACORE_CLASSIC_DB_SQL=/path/to/classic.sql LYRACORE_TEST_DBC=/path/to/client/Data \
  cargo test -p lyracore-importer full_world_source_loads_every_definition_and_spawn_locally -- --ignored

Run the terrain check before an --apply after you change a profile anchor.

A Package test runner sets LYRACORE_TEST_CORE to the Core checkout it builds against.

Higher rungs

A live stack, a real client and a load run each catch what the tiers above cannot. architecture.md describes the ladder, and verification/ holds the written checks.