Add an experimental CustomTestReflectable protocol.#1594
Merged
Conversation
This PR adds `CustomTestReflectable` as experimental SPI. This protocol can be
used to customize the breakdown of a value shown when an expectation fails. For
example, given this structure and test:
```swift
struct MyStruct {
var x: Int
func checkX(_ expected: Int) -> Bool { x == expected }
}
@test func foo() {
let value = MyStruct(x: 1234)
#expect(value.checkX(6789))
}
```
A failure would currently be reported as:
```
<X> Test "..." recorded an issue at [...]: Expectation failed: value.checkX(6789)
`-> value.checkX(6789) → false
`-> value → MyStruct(x: 1234)
`-> x → 1234
````
If we add a custom mirror to it, like so:
```swift
extension MyStruct: CustomTestReflectable {
var customTestMirror: Mirror {
Mirror(
self,
children: [
(label: "x", value: x as Any),
(label: "x is even?", value: x.isMultiple(of: 2)),
(label: "x is positive?", value: x > 0),
]
)
}
}
```
Then the output becomes:
```
<X> Test "..." recorded an issue at [...]: Expectation failed: value.checkX(6789)
`-> value.checkX(6789) → false
`-> value → MyStruct(x: 1234)
`-> x → 1234
`-> x is even? → true
`-> x is positive? → true
```
stmontgomery
approved these changes
Feb 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds
CustomTestReflectableas experimental SPI. This protocol can be used to customize the breakdown of a value shown when an expectation fails. For example, given this structure and test:A failure would currently be reported as:
If we add a custom mirror to it, like so:
Then the output becomes:
Checklist: