FAQ and troubleshooting

Platform spec article

FAQ and troubleshooting

Back to Test harnesses and fixtures ◎ Open feature in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (3)

1. 0001-feature-hub-authority Feature hub authority Accepted

   This feature hub owns normative MUST/SHOULD contract text for Test harnesses and fixtures.

   Context

   Sibling articles under this feature previously restated requirements in inconsistent forms.

   Decision

   This feature hub owns normative MUST/SHOULD contract text. Sibling articles must not redefine hub requirements and should link here for authority.

   Consequences

   Contract changes start on the hub or in linked ADRs, then propagate to articles and implementation anchors.

   Verification anchors

   • site/website/src/content/docs/platform-spec/compiler/conformance/test-harnesses-and-fixtures/index.mdx
   • article bundle under the same feature directory.

   Open full ADR page

2. 0002-spec-over-implementation-notes Specification over implementation notes Accepted

   Platform-spec text supersedes informal crate comments for Test harnesses and fixtures.

   Context

   Implementation crates accumulated informal notes that diverged from published contracts.

   Decision

   Normative platform-spec prose and ADRs under this feature supersede informal comments in implementation crates until explicitly migrated into spec text.

   Consequences

   Engineers file spec/ADR updates when behavior changes; crate comments are non-authoritative for conformance arguments.

   Verification anchors

   • compiler/crates/beskid_tests/src/analysis
   • compiler/crates/beskid_tests/src/runtime
   • compiler/crates/beskid_e2e_tests/src/tests/runtime_cases.rs

   Open full ADR page

3. 0003-primary-contract-choice Primary contract for Test harnesses and fixtures Accepted

   This feature explains how the project proves that implemented behavior remains stable release over release. It is organi

   Context

   This feature explains how the project proves that implemented behavior remains stable release over release. It is organized into newcomer-friendly articles that move from model, to flow, to contracts, then practical verification and debugging guidance.

   Decision

   The reference compiler must implement Test harnesses and fixtures as documented in this feature hub and its article bundle.

   Consequences

   Changes require hub/ADR updates and verification anchor extensions.

   Verification anchors

   • compiler/crates/beskid_tests/src/analysis
   • compiler/crates/beskid_tests/src/runtime
   • compiler/crates/beskid_e2e_tests/src/tests/runtime_cases.rs

   Open full ADR page

Articles

• Contracts and edge cases Normative guarantees and known edge cases for `Test harnesses and fixtures`. article Standard
• Design model Conceptual model for `Test harnesses and fixtures` and its subsystem boundaries. article Standard
• Examples Practical examples that demonstrate `Test harnesses and fixtures` behavior. article Standard
• FAQ and troubleshooting Common questions and debugging guidance for `Test harnesses and fixtures`. article Standard
• Flow and algorithm End-to-end control flow and major algorithmic steps for `Test harnesses and fixtures`. article Standard
• Verification and traceability How `Test harnesses and fixtures` requirements map to tests and implementation anchors. article Standard

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKfeature · 2 SpecSection(s) · 1 H2 heading(s)

Section id	Required	Found
what-this-feature-specifies	yes	yes
implementation-anchors	yes	yes

Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).

Related spec docs

• Area
  Conformance

  Parent area

• Area
  Semantic pipeline

  Rule and diagnostics behavior is locked by fixtures

• Area
  ABI and host boundary

  ABI guarantees are validated through regression suites

• Feature
  Test harnesses and fixtures

  Parent feature hub

Why did a change pass locally but fail in CI?

Most often, one crate boundary changed but the corresponding fixture or downstream consumer was not updated. Re-run the nearest conformance suite and inspect cross-crate handoff points.

Where should I start debugging?

1. Confirm the target requirement in this feature hub.
2. Step through compiler/crates/beskid_tests/src/analysis and compiler/crates/beskid_tests/src/runtime.
3. Validate consumer behavior at compiler/crates/beskid_e2e_tests/src/tests/runtime_cases.rs.
4. Reproduce with compiler/crates/beskid_tests/src/doc_tests.rs.

How do I add a new rule safely?

Document the new contract in the relevant article, update implementation in the owning crate, and add a fixture proving both happy-path and failure-path behavior.