Falling-Metal-Interactive/Blacksite
2
0
Fork 0
Code Issues 15 Pull Requests Actions Packages Projects Releases Wiki Activity

BS-JD-502 - Tool regression tests and undo invariants #33

New Issue
Closed
opened 2026-06-06 01:49:05 -04:00 by Rbanh · 3 comments
Rbanh commented 2026-06-06 01:49:05 -04:00
Owner
Copy Link

Summary

Add reusable tests for every modal tool and every editor operator.

Why

The roadmap depends on consistent preview/commit/cancel/undo behavior across all tools.

Implementation notes

  • Create shared test harness for operators/modal tools.
  • Cover commit, cancel, dirty flag, helper cleanup, and undo grouping.
  • Add fixtures for asset drops, brush strokes, terrain strokes, and physics settle sessions.
  • Make failures identify the invariant that broke.

Acceptance criteria

  • Every production modal tool has commit/cancel/undo coverage.
  • Helper entities are verified absent after cancel/commit as appropriate.
  • Undo grouping is tested for continuous actions.
  • Test harness is easy to reuse for new tools.

Tests/docs

This ticket is test infrastructure. Document how to add tool regression tests.

## Summary Add reusable tests for every modal tool and every editor operator. ## Why The roadmap depends on consistent preview/commit/cancel/undo behavior across all tools. ## Implementation notes - Create shared test harness for operators/modal tools. - Cover commit, cancel, dirty flag, helper cleanup, and undo grouping. - Add fixtures for asset drops, brush strokes, terrain strokes, and physics settle sessions. - Make failures identify the invariant that broke. ## Acceptance criteria - [ ] Every production modal tool has commit/cancel/undo coverage. - [ ] Helper entities are verified absent after cancel/commit as appropriate. - [ ] Undo grouping is tested for continuous actions. - [ ] Test harness is easy to reuse for new tools. ## Tests/docs This ticket is test infrastructure. Document how to add tool regression tests.
Rbanh added this to the M5 - Regression, docs, and first-hour UX milestone 2026-06-06 01:49:05 -04:00
Rbanh added the
roadmap:jackdaw
type:architecture
priority:P0
area:quality
 labels 2026-06-06 01:49:05 -04:00
Rbanh commented 2026-07-10 05:51:13 -04:00
Author
Owner
Copy Link

Production-operator regression pass (2026-07-10):

Implemented reusable operators::test_harness::OperatorInvariantHarness with shared assertions for:

  • committed/canceled/blocked phase,
  • authored entity deltas,
  • dirty-state preservation/propagation,
  • exact undo-group deltas,
  • preview/helper cleanup,
  • full undo/redo state projections.

Current production coverage now includes:

  • generic operator success, commit failure rollback, and blocked no-op;
  • asset placement commit + spawn round trip;
  • missing sub-asset/material failure paths;
  • multi-actor texture assignment grouped into one undo command;
  • Draw Brush cancel reset and decomposed multi-brush grouped commit;
  • Brush CSG pending cancel and merge/delete grouped round trip;
  • brush clip grouped geometry round trip;
  • brush-element Escape rollback plus gizmo-helper despawn;
  • continuous multi-target transform finalization as one undo command.

The harness exposed and this pass fixed two real defects:

  1. texture/material assignment across multiple actors created multiple undo steps, and missing MaterialDesc could bypass history; this is now SetMaterialGroup.
  2. Escape during an active brush-element gizmo preview discarded the saved pre-edit brush without restoring it; cancellation now restores exact geometry before helper cleanup.

Documentation: docs/editor/operator-regression-testing.md, indexed from both documentation maps and architecture.

Validation: strict workspace Clippy clean, strict editor dev-feature Clippy clean, 135 tests passed / 1 intentional migration test ignored, cargo validate-levels, formatting, and diff checks clean.

Ticket remains open intentionally: terrain-stroke and physics-settle fixtures belong here when those roadmap tools are implemented; current production modal/editor operators are covered.

Production-operator regression pass (2026-07-10): Implemented reusable `operators::test_harness::OperatorInvariantHarness` with shared assertions for: - committed/canceled/blocked phase, - authored entity deltas, - dirty-state preservation/propagation, - exact undo-group deltas, - preview/helper cleanup, - full undo/redo state projections. Current production coverage now includes: - generic operator success, commit failure rollback, and blocked no-op; - asset placement commit + spawn round trip; - missing sub-asset/material failure paths; - multi-actor texture assignment grouped into one undo command; - Draw Brush cancel reset and decomposed multi-brush grouped commit; - Brush CSG pending cancel and merge/delete grouped round trip; - brush clip grouped geometry round trip; - brush-element Escape rollback plus gizmo-helper despawn; - continuous multi-target transform finalization as one undo command. The harness exposed and this pass fixed two real defects: 1. texture/material assignment across multiple actors created multiple undo steps, and missing `MaterialDesc` could bypass history; this is now `SetMaterialGroup`. 2. Escape during an active brush-element gizmo preview discarded the saved pre-edit brush without restoring it; cancellation now restores exact geometry before helper cleanup. Documentation: `docs/editor/operator-regression-testing.md`, indexed from both documentation maps and architecture. Validation: strict workspace Clippy clean, strict editor dev-feature Clippy clean, 135 tests passed / 1 intentional migration test ignored, `cargo validate-levels`, formatting, and diff checks clean. Ticket remains open intentionally: terrain-stroke and physics-settle fixtures belong here when those roadmap tools are implemented; current production modal/editor operators are covered.
Rbanh commented 2026-07-12 23:55:40 -04:00
Author
Owner
Copy Link

Implemented and published on main in commit 1ab3886.

Acceptance completed:

  • Typed command dispatch preserves modal Preview ownership while immediate commands terminate normally.
  • Stable operator IDs/phases now cover commit, block, cancel, failure, no-op, and interruption paths.
  • Group Selection and lighting changes are atomic history transactions; group redo preserves unrelated parents and sibling order across repeated cycles.
  • Asset assignment, exact material drops, brush/CSG, terrain sculpt/paint, physics placement, and transform finalizers now exercise production entry points with rollback/helper/undo invariants.
  • Read-only CSG, missing transform targets, clean-view terrain interruption, and zero-delta terrain/physics/transform exits are explicitly covered.

Verification on the publication worktree:

  • cargo test --workspace --all-targets --no-fail-fast passed; editor library: 245 passed, 0 failed.
  • cargo clippy --workspace --all-targets -- -D warnings passed.
  • cargo fmt --all -- --check and git diff --check passed.
  • cargo validate-levels --project .: 62 dependencies, 5 expected non-blocking findings, 0 blocking errors.

Evidence: operator invariant evaluation and testing contract.

Packaged tests remain deferred by project-owner request. A supplementary native editor smoke was attempted, but the Codex desktop approval broker rejected the GUI launch because its reviewer was at capacity; no project runtime failure was observed. Release-candidate G3 remains Partial until the exact candidate is rerun from a clean checkout.

Implemented and published on `main` in commit `1ab3886`. Acceptance completed: - Typed command dispatch preserves modal Preview ownership while immediate commands terminate normally. - Stable operator IDs/phases now cover commit, block, cancel, failure, no-op, and interruption paths. - Group Selection and lighting changes are atomic history transactions; group redo preserves unrelated parents and sibling order across repeated cycles. - Asset assignment, exact material drops, brush/CSG, terrain sculpt/paint, physics placement, and transform finalizers now exercise production entry points with rollback/helper/undo invariants. - Read-only CSG, missing transform targets, clean-view terrain interruption, and zero-delta terrain/physics/transform exits are explicitly covered. Verification on the publication worktree: - `cargo test --workspace --all-targets --no-fail-fast` passed; editor library: 245 passed, 0 failed. - `cargo clippy --workspace --all-targets -- -D warnings` passed. - `cargo fmt --all -- --check` and `git diff --check` passed. - `cargo validate-levels --project .`: 62 dependencies, 5 expected non-blocking findings, 0 blocking errors. Evidence: [operator invariant evaluation](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/src/commit/1ab3886/docs/editor/evaluations/operator-invariants/README.md) and [testing contract](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/src/commit/1ab3886/docs/editor/operator-regression-testing.md). Packaged tests remain deferred by project-owner request. A supplementary native editor smoke was attempted, but the Codex desktop approval broker rejected the GUI launch because its reviewer was at capacity; no project runtime failure was observed. Release-candidate G3 remains Partial until the exact candidate is rerun from a clean checkout.
Rbanh added reference main 2026-07-12 23:55:42 -04:00
Rbanh closed this issue 2026-07-12 23:55:44 -04:00
Rbanh commented 2026-07-13 00:44:14 -04:00
Author
Owner
Copy Link

Native-editor follow-up completed on main at c55f347.

Live replay on the rebuilt Linux editor:

  • Loaded assets/levels/collider_diagnostics_showcase.scn.ron; viewport rendered nonblank with the dark editor chrome, hierarchy, inspector, and asset browser correctly framed.
  • Ctrl+P -> Draw Brush entered Preview; Esc terminated as Canceled with no history entry.
  • Selected two hierarchy actors; Group Selection committed exactly one history item; undo restored the original rows and redo restored the transient Group and children.
  • The replay exposed an empty command-palette title bar after dispatch and a Bevy B0004 inherited-visibility warning on the new Group's icon child. Both were fixed, covered by focused regression assertions, rebuilt, and replayed.
  • Corrected replay fully dismissed the palette and emitted no hierarchy/operator/render panic or warning. The QA-created recovery generation was discarded through File > Discard Recovery Snapshot.

Verification on the follow-up commit:

  • cargo test --workspace --all-targets --no-fail-fast (editor library: 246 passed, 0 failed)
  • cargo clippy --workspace --all-targets -- -D warnings
  • cargo fmt --all -- --check
  • cargo validate-levels --project . (62 dependencies, 5 expected non-blocking findings, 0 blocking)
  • git diff --check

Packaged-runtime tests remain intentionally deferred by project-owner request.

Native-editor follow-up completed on `main` at `c55f347`. Live replay on the rebuilt Linux editor: - Loaded `assets/levels/collider_diagnostics_showcase.scn.ron`; viewport rendered nonblank with the dark editor chrome, hierarchy, inspector, and asset browser correctly framed. - `Ctrl+P` -> `Draw Brush` entered Preview; `Esc` terminated as Canceled with no history entry. - Selected two hierarchy actors; `Group Selection` committed exactly one history item; undo restored the original rows and redo restored the transient Group and children. - The replay exposed an empty command-palette title bar after dispatch and a Bevy B0004 inherited-visibility warning on the new Group's icon child. Both were fixed, covered by focused regression assertions, rebuilt, and replayed. - Corrected replay fully dismissed the palette and emitted no hierarchy/operator/render panic or warning. The QA-created recovery generation was discarded through File > Discard Recovery Snapshot. Verification on the follow-up commit: - `cargo test --workspace --all-targets --no-fail-fast` (editor library: 246 passed, 0 failed) - `cargo clippy --workspace --all-targets -- -D warnings` - `cargo fmt --all -- --check` - `cargo validate-levels --project .` (62 dependencies, 5 expected non-blocking findings, 0 blocking) - `git diff --check` Packaged-runtime tests remain intentionally deferred by project-owner request.
Sign in to join this conversation.
main
Branches Tags
Labels
Clear labels   
area:animation

Skeletal animation import, preview, graph/state authoring, and runtime integration.

  
area:assets

Asset browser, material browser, thumbnails, import, processing, and asset watcher.

  
area:audio

Audio source/listener authoring, buses, spatial preview, and runtime integration.

  
area:brushes

Brush geometry, CSG, face editing, UVs, and brush diagnostics.

  
area:build-release

Build profiles, packaging, content validation, release gates, and distribution diagnostics.

  
area:extensions

Static extension API, extension scaffolds, dylib exploration.

  
area:governance

Policy, attribution, planning, and production process.

  
area:hierarchy

Outliner hierarchy, parenting, grouping, prefab structure, ordering, and selection workflows.

  
area:inspector

Inspector, component metadata, component editing UX.

  
area:navigation

Navigation mesh authoring, baking, diagnostics, and AI path preview.

  
area:operators

Editor operator/action framework, undo, commit/cancel semantics.

  
area:physics

Physics placement, colliders, rigid bodies, diagnostics, and overlays.

  
area:project-ux

Project launcher, profiles, templates, or first-run project workflow.

  
area:quality

Regression packs, tests, performance budgets, profiler, first-hour UX.

  
area:rendering

Static and skinned renderers, material slots, shaders, ray tracing, and render-path integration.

  
area:runtime

BRP, remote inspector, PIE, game preview, runtime integration.

  
area:scene-io

Scene document, save/load, schema, migration, or reference repair.

  
area:terrain

Terrain authoring, terrain sculpting, heightmaps, and terrain materials.

  
area:viewport

Viewport interaction, selection, shortcuts, camera, overlays, and controls.

  
priority:P0

Must-have prerequisite or milestone-critical item.

  
priority:P1

Important production feature after P0 work is stable.

  
priority:P2

Useful follow-up or polish item.

  
priority:P3

Exploratory or later spike.

  
roadmap:jackdaw

Jackdaw-inspired Blacksite editor roadmap item.

  
roadmap:production

Blacksite production-readiness roadmap item beyond the Jackdaw-inspired foundation.

  
type:architecture

Architecture, internal framework, or hard-to-reverse technical decision.

  
type:docs

Documentation, policy, samples, or issue-board structure.

  
type:epic

Tracking epic that groups related milestone work.

  
type:feature

User-visible feature or capability.

No Label
area:animation
area:assets
area:audio
area:brushes
area:build-release
area:extensions
area:governance
area:hierarchy
area:inspector
area:navigation
area:operators
area:physics
area:project-ux
area:quality
area:rendering
area:runtime
area:scene-io
area:terrain
area:viewport
priority:P0
priority:P1
priority:P2
priority:P3
roadmap:jackdaw
roadmap:production
type:architecture
type:docs
type:epic
type:feature
Milestone
Clear milestone
No items
No Milestone
M5 - Regression, docs, and first-hour UX
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Falling-Metal-Interactive/Blacksite#33
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?