Skip to content

Add optional test case description #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ma11hewThomas wants to merge 8 commits into from
Open

Add optional test case description #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
288bfb6
Add optional test case description
Ma11hewThomas Oct 24, 2026
1e92d8a
Merge branch 'prep/0.3.0-07-output-lines' into prep/0.3.0-08-test-des…
Ma11hewThomas Oct 25, 2026
43bb167
Merge branch 'prep/0.3.0-07-output-lines' into prep/0.3.0-08-test-des…
Ma11hewThomas Oct 25, 2026
8ba3bbf
Merge branch 'prep/0.3.0-07-output-lines' into prep/0.3.0-08-test-des…
Ma11hewThomas Oct 25, 2026
7bd4167
Merge branch 'prep/0.3.0-07-output-lines' into prep/0.3.0-08-test-des…
Ma11hewThomas Oct 25, 2026
29ae45a
Merge branch 'prep/0.3.0-07-output-lines' into prep/0.3.0-08-test-des…
Ma11hewThomas Oct 25, 2026
5f45b91
Merge branch 'prep/0.3.0-07-output-lines' into prep/0.3.0-08-test-des…
Ma11hewThomas Oct 25, 2026
7272352
Simplify test description documentation
Ma11hewThomas Oct 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- Optional Test `description` in specification 0.3.0 for human-readable case context, separate from its name, suite and attempt diagnostics.

### Changed

- Clarified output-line arrays and valid omission or empty arrays when no stdout or stderr was captured, on final results and previous attempts.
Expand Down
4 changes: 4 additions & 0 deletions schema/ctrf.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,10 @@
"type": "string",
"minLength": 1
},
"description": {
"description": "Human-readable description of the test case",
"type": "string"
},
"status": {
"description": "Final outcome of the test case",
"enum": [ "passed", "failed", "skipped", "pending", "other" ]
Expand Down
15 changes: 15 additions & 0 deletions spec/ctrf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -965,6 +965,17 @@ The name or title of the test case.
`name` MUST be present.
It MUST be a non-empty string.

### 9.4.1. `description`

**Description:**
A human-readable description of the test case, such as its purpose or the behavior it checks.

`name` remains the case's primary display name, and `suite` describes its grouping hierarchy. `description` provides additional context; attempt-specific failure diagnostics belong in `message` and `trace`.

**Requirements:**
`description` is OPTIONAL.
If present, it MUST be a string.

### 9.5. `status`

**Description:**
Expand Down Expand Up @@ -2283,6 +2294,10 @@ to this specification.
"type": "string",
"minLength": 1
},
"description": {
"description": "Human-readable description of the test case",
"type": "string"
},
"status": {
"description": "Final outcome of the test case",
"enum": [ "passed", "failed", "skipped", "pending", "other" ]
Expand Down
44 changes: 44 additions & 0 deletions tests/normative/additional-properties.test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,50 @@
}]
}
}
},
{
"description": "Description is a Test field, not an attempt history field",
"valid": false,
"data": {
"reportFormat": "CTRF",
"specVersion": "0.3.0",
"results": {
"tool": {
"name": "example-runner"
},
"summary": {
"tests": 1,
"passed": 1,
"failed": 0,
"pending": 0,
"skipped": 0,
"other": 0,
"start": 1609459200000,
"stop": 1609459201000
},
"tests": [
{
"name": "test_icmp_ping",
"status": "passed",
"duration": 100,
"suite": [
"tests",
"test_ping",
"TestPingTestCase"
],
"filePath": "tests/test_ping.py",
"retries": 1,
"retryAttempts": [
{
"attempt": 1,
"status": "failed",
"description": "Not an attempt field"
}
]
}
]
}
}
}
]
}
185 changes: 185 additions & 0 deletions tests/normative/type-validation.test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1234,6 +1234,191 @@
]
}
}
},
{
"description": "Test description rejects null",
"valid": false,
"data": {
"reportFormat": "CTRF",
"specVersion": "0.3.0",
"results": {
"tool": {
"name": "example-runner"
},
"summary": {
"tests": 1,
"passed": 1,
"failed": 0,
"pending": 0,
"skipped": 0,
"other": 0,
"start": 1609459200000,
"stop": 1609459201000
},
"tests": [
{
"name": "test_icmp_ping",
"status": "passed",
"duration": 100,
"description": null,
"suite": [
"tests",
"test_ping",
"TestPingTestCase"
],
"filePath": "tests/test_ping.py"
}
]
}
}
},
{
"description": "Test description rejects number",
"valid": false,
"data": {
"reportFormat": "CTRF",
"specVersion": "0.3.0",
"results": {
"tool": {
"name": "example-runner"
},
"summary": {
"tests": 1,
"passed": 1,
"failed": 0,
"pending": 0,
"skipped": 0,
"other": 0,
"start": 1609459200000,
"stop": 1609459201000
},
"tests": [
{
"name": "test_icmp_ping",
"status": "passed",
"duration": 100,
"description": 42,
"suite": [
"tests",
"test_ping",
"TestPingTestCase"
],
"filePath": "tests/test_ping.py"
}
]
}
}
},
{
"description": "Test description rejects boolean",
"valid": false,
"data": {
"reportFormat": "CTRF",
"specVersion": "0.3.0",
"results": {
"tool": {
"name": "example-runner"
},
"summary": {
"tests": 1,
"passed": 1,
"failed": 0,
"pending": 0,
"skipped": 0,
"other": 0,
"start": 1609459200000,
"stop": 1609459201000
},
"tests": [
{
"name": "test_icmp_ping",
"status": "passed",
"duration": 100,
"description": false,
"suite": [
"tests",
"test_ping",
"TestPingTestCase"
],
"filePath": "tests/test_ping.py"
}
]
}
}
},
{
"description": "Test description rejects array",
"valid": false,
"data": {
"reportFormat": "CTRF",
"specVersion": "0.3.0",
"results": {
"tool": {
"name": "example-runner"
},
"summary": {
"tests": 1,
"passed": 1,
"failed": 0,
"pending": 0,
"skipped": 0,
"other": 0,
"start": 1609459200000,
"stop": 1609459201000
},
"tests": [
{
"name": "test_icmp_ping",
"status": "passed",
"duration": 100,
"description": [],
"suite": [
"tests",
"test_ping",
"TestPingTestCase"
],
"filePath": "tests/test_ping.py"
}
]
}
}
},
{
"description": "Test description rejects object",
"valid": false,
"data": {
"reportFormat": "CTRF",
"specVersion": "0.3.0",
"results": {
"tool": {
"name": "example-runner"
},
"summary": {
"tests": 1,
"passed": 1,
"failed": 0,
"pending": 0,
"skipped": 0,
"other": 0,
"start": 1609459200000,
"stop": 1609459201000
},
"tests": [
{
"name": "test_icmp_ping",
"status": "passed",
"duration": 100,
"description": {},
"suite": [
"tests",
"test_ping",
"TestPingTestCase"
],
"filePath": "tests/test_ping.py"
}
]
}
}
}
]
}
74 changes: 74 additions & 0 deletions tests/normative/valid-documents.test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,80 @@
]
}
}
},
{
"description": "Test description accepts empty string",
"valid": true,
"data": {
"reportFormat": "CTRF",
"specVersion": "0.3.0",
"results": {
"tool": {
"name": "example-runner"
},
"summary": {
"tests": 1,
"passed": 1,
"failed": 0,
"pending": 0,
"skipped": 0,
"other": 0,
"start": 1609459200000,
"stop": 1609459201000
},
"tests": [
{
"name": "test_icmp_ping",
"status": "passed",
"duration": 100,
"description": "",
"suite": [
"tests",
"test_ping",
"TestPingTestCase"
],
"filePath": "tests/test_ping.py"
}
]
}
}
},
{
"description": "Test description accepts multiline string",
"valid": true,
"data": {
"reportFormat": "CTRF",
"specVersion": "0.3.0",
"results": {
"tool": {
"name": "example-runner"
},
"summary": {
"tests": 1,
"passed": 1,
"failed": 0,
"pending": 0,
"skipped": 0,
"other": 0,
"start": 1609459200000,
"stop": 1609459201000
},
"tests": [
{
"name": "test_icmp_ping",
"status": "passed",
"duration": 100,
"description": "Checks reachability.\nUses ICMP echo.",
"suite": [
"tests",
"test_ping",
"TestPingTestCase"
],
"filePath": "tests/test_ping.py"
}
]
}
}
}
]
}
Loading