Skip to content

[T-035d] SimulatorBackend contract test suite (parametrised over registered backends) #57

Closed

Description

@CodewithJha

Task T-035d · Milestone M2 — Scenario + kinematic2d · Size S · Priority P0 · Epic #2

Implements NFR-EXT-001 · FR-RUN-004

Branch test/t-035d-simulatorbackend-contract-test-suite-parametrised — one task = one branch = one PR (doc 32 §6)

Summary

Write tests/contract/backends/ implementing doc 18 §4.3: materialise determinism, trace schema/columns/units, sample rate ≥ 10 Hz, cancel within 10 s, infra errors reported not raised, supported_params honesty.

Context / motivation

Doc 10 §10: any new simulator is accepted if it passes this suite — it is the executable definition of the port.

Scope

In scope

  • Marker backend_contract; --backend <name> option.
  • A FakeBackend in tests/fakes/backends.py to self-test the suite.

Implementation guidance

  • Gazebo-specific heavy tests run under -m sim using the same suite.
  • Standards: respect the layering contracts (doc 16 §2) and conventions in doc 34; no hard-coded tunables — thresholds/defaults come from typed settings (doc 27); no magic numbers (ruff PLR2004); public APIs typed (mypy strict) and documented.

Acceptance criteria

  • FakeBackend, Kinematic2DBackend (once merged) and ReplayBackend pass.
  • Suite documented in doc 10 §10.
  • Tests listed below added and green in CI; coverage of new code meets the gate in doc 18 §3.
  • Docs, config reference and CHANGELOG Unreleased updated where behaviour, keys or interfaces changed.
  • Definition of Done (doc 32 §3) satisfied.

Tests required

  • The suite.

Dependencies

Blocked by: #48 (T-035a), #47 (T-018)

Blocks: no other task (leaf)

Parallelization notes

Files / paths owned by this task — avoid editing other paths; shared files (pyproject.toml entry points, cli/main.py, api/routers/__init__.py, router.tsx, docker/compose.yaml, ci.yml) are append-only:

  • backend/tests/contract/backends/**
  • backend/tests/fakes/backends.py

Test-only.

Definition of Done

Per doc 32 §3 and AGENTS.md §5: lint, format, mypy strict and import-linter green; tests added and passing; docs updated; PR template completed with Closes #<this issue>; Conventional Commit messages referencing T-035d (doc 16 §6); commits authored only by the repository owner identity (AGENTS.md §4); CI green; reviewer checklist (doc 32 §5.1) satisfied.

References

Design docs: doc 18 §4.3 · doc 10 §10

Requirements: NFR-EXT-001 · FR-RUN-004 (traceability: doc 28)

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:simulatorSimulator backends (kinematic2d, Gazebo adapter)milestone:M2M2 — Scenario + kinematic2dpriority:P0Critical path / blocks otherssize:S<= 1 daytaskChild task of a milestone epictype:testTest suites and test infrastructure

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions