Test Spec: XCP Measurement / Calibration Workflows¶

Document Control¶

Field	Value
Status	Implemented
Design doc	`docs/design/xcp-workflows.md`
Test file	`tests/test_xcp.py`, `tests/test_xcp_active.py`

Requirement Traceability¶

REQ ID	Description summary	TEST IDs
`REQ-XCP-01`	Command/error naming + CONNECT parsing	`TEST-XCP-01`, `TEST-XCP-02`
`REQ-XCP-02`	Active scan over CONNECT	`TEST-XCP-03`, `TEST-XCP-07`, `TEST-XCP-10`
`REQ-XCP-03`	Trace pairs command/response	`TEST-XCP-04`, `TEST-XCP-08`
`REQ-XCP-04`	Read surfaces DAQ DTOs	`TEST-XCP-05`, `TEST-XCP-08`
`REQ-XCP-05`	Active-transmit safety on scan	`TEST-XCP-11`
`REQ-XCP-05a`	`xcp scan --dry-run` plans without transmit	`TEST-XCP-13`
`REQ-XCP-06`	Request/response id defaults + overrides	`TEST-XCP-07`, `TEST-XCP-12`, `TEST-XCP-13`
`REQ-XCP-07`	Invalid id structured error	`TEST-XCP-09`
`REQ-XCP-08`	Scaffold backend sample data	`TEST-XCP-07`, `TEST-XCP-08`
`REQ-XCP-09`	MCP tool exposure + active gate	`TEST-XCP-12`, `TEST-XCP-14`
`REQ-XCP-10`	`xcp info` capability queries	`TEST-XCP-15`, `TEST-XCP-ACT-*`
`REQ-XCP-11`	`xcp dump` chunked upload + output	`TEST-XCP-17`, `TEST-XCP-ACT-*`
`REQ-XCP-12`	Active info/dump safety + dry-run plans	`TEST-XCP-16`, `TEST-XCP-18`, `TEST-XCP-20`
`REQ-XCP-13`	Info/dump error distinction	`TEST-XCP-19`, `TEST-XCP-21`, `TEST-XCP-ACT-*`
`REQ-XCP-14`	Info/dump MCP exclusion	`test_every_cli_command_is_exposed_or_documented`

Test Cases¶

TEST-XCP-ACT-*: pure-module workflow tests in tests/test_xcp_active.py (CTO framing, response status, info capability collection / unsupported / no-connect / connect-error, dump chunk planning, SET_MTA+UPLOAD and SHORT_UPLOAD paths, stop-on-error). CLI tests TEST-XCP-15..21 live in tests/test_xcp.py::XcpActiveInfoDumpCliTests and drive the full command through a patched live transaction().

TEST-XCP-01 — Command and error code naming¶

Given  the XCP command catalog and error table
When   a code is looked up
Then   the system shall return the catalog name, or a hex fallback for unknown codes

Fixture: none.

TEST-XCP-02 — CONNECT response parsing¶

Given  a CONNECT positive response payload
When   it is parsed
Then   the system shall report resources, max_cto, max_dto, and protocol/transport versions

Fixture: none.

TEST-XCP-03 — Scan pairs CONNECT with a positive response¶

Given  a CONNECT request on the request id and a positive CTO response on the response id
When   the scan parser runs
Then   the system shall emit one CONNECT transaction with parsed connect_info

Fixture: none.

TEST-XCP-04 — Trace pairs commands with responses (incl. error)¶

Given  GET_STATUS and GET_SEED command CTOs each followed by a response CTO
When   the trace parser runs
Then   the system shall emit named transactions, surfacing the GET_SEED error code by name

Fixture: none.

TEST-XCP-05 — Read extracts DAQ DTOs and skips CTO frames¶

Given  two DTO frames (pid 0x00 / 0x01) and one CTO response frame on the response id
When   the read parser runs
Then   the system shall emit two measurement events and skip the CTO frame

Fixture: none.

TEST-XCP-06 — Scan ignores unrelated arbitration ids¶

Given  a CONNECT exchange interleaved with an unrelated CAN id
When   the scan parser runs
Then   the system shall emit only the XCP responder transaction

Fixture: none.

TEST-XCP-07 — `xcp scan` active envelope (scaffold backend)¶

Given  the scaffold transport backend
When   `canarchy xcp scan vcan0 --json` is invoked
Then   the envelope shall report mode active, one responder, and a CONNECT transaction

Fixture: scaffold backend sample provider.

TEST-XCP-08 — `xcp trace` / `xcp read` passive envelopes (scaffold backend)¶

Given  the scaffold transport backend
When   `canarchy xcp trace vcan0 --json` and `canarchy xcp read vcan0 --json` are invoked
Then   trace shall report three transactions and read shall report two measurements

Fixture: scaffold backend sample provider.

TEST-XCP-09 — Invalid CAN id returns a structured error¶

Given  a non-numeric --request-id
When   `canarchy xcp scan vcan0 --request-id not-an-id --json` is invoked
Then   the system shall exit 1 with an error code of `XCP_INVALID_ID`

Fixture: none.

TEST-XCP-10 — Scan sends CONNECT and parses live responses¶

Given  a python-can backed transport with send/capture patched
When   `xcp_scan_events` is invoked
Then   the system shall send exactly one CONNECT frame and parse the captured response into a CONNECT transaction

Fixture: mocked transport send / capture.

TEST-XCP-11 — Active-transmit safety gates `xcp scan`¶

Given  `CANARCHY_REQUIRE_ACTIVE_ACK=1` and no `--ack-active`
When   `canarchy xcp scan vcan0 --json` is invoked
Then   the system shall exit 1 with an error code of `ACTIVE_ACK_REQUIRED`

Fixture: environment variable patched in-test.

TEST-XCP-12 — MCP exposure and argv mapping¶

Given  the MCP tool registry
Then   `xcp_scan`, `xcp_trace`, `xcp_read`, and `xcp_commands` shall be registered tools
And    `_build_argv` shall map them to the corresponding CLI argv

Fixture: none.

TEST-XCP-13 — `xcp scan --dry-run` plans the CONNECT without transmitting¶

Given  a 29-bit request id and `--dry-run`
When   `canarchy xcp scan vcan0 --request-id 0x18DAF110 --dry-run --json` is invoked
Then   the system shall report mode dry_run with a planned CONNECT frame marked extended, opening no transport

Fixture: none.

TEST-XCP-14 — MCP `xcp_scan` is gated behind active-transmit ack¶

Given  the MCP `xcp_scan` tool
When   it is called without `ack_active=true`
Then   the system shall refuse with `ACTIVE_TRANSMIT_REQUIRES_ACK` before any transport call

Fixture: none.

TEST-XCP-15..21 — Active `xcp info` / `xcp dump` CLI¶

Given  a python-can backed transport with transaction() patched to a fake XCP slave
When   `xcp info` / `xcp dump` are invoked
Then   info shall report mode active with parsed capabilities (TEST-XCP-15),
And    info dry-run shall plan four commands without transmitting (TEST-XCP-16),
And    a silent slave shall return XCP_NO_RESPONSE with exit 2 (TEST-XCP-19),
And    dump shall upload a bounded range, assemble the bytes, and write --output (TEST-XCP-17),
And    dump dry-run shall plan connect + chunk requests without transmitting (TEST-XCP-18),
And    dump without --ack-active under require_active_ack shall return ACTIVE_ACK_REQUIRED (TEST-XCP-20),
And    an oversize --size shall return XCP_INVALID_VALUE with exit 1 (TEST-XCP-21)

Fixture: patched LocalTransport.transaction; a temp --output file.

Fixtures And Environment¶

Tests use crafted CanFrame lists for the parser cases and the scaffold transport backend (CANARCHY_TRANSPORT_BACKEND=scaffold) for the CLI cases, so no live hardware or network is required. The live-path test patches the transport send / capture methods.

Explicit Non-Coverage¶

XCP-on-Ethernet / USB transports.
A2L-based decoding of DAQ ODT entries into named signals.
Active DAQ configuration and calibration-write command sequences.

Test Spec: XCP Measurement / Calibration Workflows¶

Document Control¶

Requirement Traceability¶

Test Cases¶

TEST-XCP-01 — Command and error code naming¶

TEST-XCP-02 — CONNECT response parsing¶

TEST-XCP-03 — Scan pairs CONNECT with a positive response¶

TEST-XCP-04 — Trace pairs commands with responses (incl. error)¶

TEST-XCP-05 — Read extracts DAQ DTOs and skips CTO frames¶

TEST-XCP-06 — Scan ignores unrelated arbitration ids¶

TEST-XCP-07 — xcp scan active envelope (scaffold backend)¶

TEST-XCP-08 — xcp trace / xcp read passive envelopes (scaffold backend)¶

TEST-XCP-09 — Invalid CAN id returns a structured error¶

TEST-XCP-10 — Scan sends CONNECT and parses live responses¶

TEST-XCP-11 — Active-transmit safety gates xcp scan¶

TEST-XCP-12 — MCP exposure and argv mapping¶

TEST-XCP-13 — xcp scan --dry-run plans the CONNECT without transmitting¶

TEST-XCP-14 — MCP xcp_scan is gated behind active-transmit ack¶

TEST-XCP-15..21 — Active xcp info / xcp dump CLI¶

Fixtures And Environment¶

Explicit Non-Coverage¶

TEST-XCP-07 — `xcp scan` active envelope (scaffold backend)¶

TEST-XCP-08 — `xcp trace` / `xcp read` passive envelopes (scaffold backend)¶

TEST-XCP-11 — Active-transmit safety gates `xcp scan`¶

TEST-XCP-13 — `xcp scan --dry-run` plans the CONNECT without transmitting¶

TEST-XCP-14 — MCP `xcp_scan` is gated behind active-transmit ack¶

TEST-XCP-15..21 — Active `xcp info` / `xcp dump` CLI¶