Skip to content

Establish a tests-first Workshop corpus and seasonal feature census #10

Description

@Teakowa

Goal

Establish a durable tests-first Workshop corpus and seasonal feature census
that exercises real projects, minimized regressions, the canonical Workshop
surface, and recorded client captures for workshop-rs and downstream
language implementations.

Context

workshop-rs owns canonical Workshop feature identities and the test/result
contracts used by this corpus. Source-language repositories remain responsible
for their own syntax, semantics, and source-level fixtures.

The durable contract is ordinary tests, test data, source attribution, and
machine-readable results. It must not introduce a parallel evidence taxonomy
or treat implementation output as an independent expected result.

Scope

  • Keep focused unit/property tests, minimized regressions, complete real-project fixtures, and seasonal client workflows as separate test/data workflows without generic evidence classes.
  • Retain repository, revision, path, digest, license, locale, catalog, game, season, and capture-time metadata where it supports attribution, reproducibility, or runtime interpretation.
  • Require an actual expected-versus-observed comparison before reporting matched; when only a pinned source identity is available, report inconclusive rather than fabricating a comparison.
  • Preserve minimized reproductions for real-project semantic/compatibility defects where practical, together with the original full-project source input.
  • Define stable Workshop feature identities for machine-readable results across the declared semantic/catalog surface.
  • Maintain a canonical Workshop feature-census fixture/mode that exercises the declared surface and reports failures by feature identity rather than only as a monolithic script diff.
  • Use semantic/normalized equivalence when text identity is not part of the contract.
  • Provide machine-readable results for matched comparisons, unsupported surface, known gaps, unexpected regressions, and inconclusive tests; known gaps and inconclusive tests must not count as successful parity.
  • Define a repeatable seasonal validation workflow in which census artifacts can be round-tripped through the live Overwatch client with game/season/client-locale/catalog and raw-capture metadata.
  • Use English client output as the primary semantic baseline where appropriate, with explicit locale sweeps for localization/catalog changes.
  • Keep corpus/result contracts reusable by opy-rs and deltin-rs without transferring canonical Workshop ownership out of this repository.

Non-goals

  • Claiming exhaustive live-runtime/gameplay correctness solely from import/export tests.
  • Requiring byte-identical or formatting-identical output.
  • Building a network service or automatically downloading unreviewed catalog data at runtime.
  • Moving OPY or DEL/OSTW source-language fixtures or semantics into workshop-rs.
  • Treating one giant census script as a replacement for focused unit/property tests or real-world projects.
  • Freezing a separate cross-repository test framework before concrete corpus integration requires one.
  • Maintaining child-issue completion state or execution sequencing in this parent issue body.

Acceptance criteria

  • The repository documents and enforces a tests-first contract: direct tests and test data are primary, with concrete source attribution retained where needed.
  • Matched results require an actual expected-versus-observed comparison; source identity alone produces an explicit inconclusive result.
  • Real-project failures retain project-level source attribution and, where valuable, minimized source-attributed regression fixtures.
  • A canonical feature-census fixture covers the declared Workshop semantic/catalog surface with stable machine-readable feature identities.
  • Census failures identify affected features rather than reducing the result to a single whole-file pass/fail.
  • parse -> canonical semantics -> emit and supported locale conversion are gated against the corpus using semantic/normalized contracts.
  • Known gaps and inconclusive tests are represented explicitly and are not reported as successful parity/conformance.
  • A documented seasonal client-validation procedure records client/game/catalog/locale and raw-capture metadata and supports structured comparison with prior captures.
  • The resulting corpus/result contracts can be consumed by opy-rs and deltin-rs without transferring canonical Workshop ownership out of this repository.

Relationships

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions