[feat]: adopt swift-custom-dump in some testing utilities #317
Conversation
- Before: assertStateModifications was difficult to use because the diffs for failed assertions were difficult to read - After: Incorporate CustomDump into assertStateModifications to make the assertions easy to read
Package.swift
Outdated
| @@ -64,6 +64,7 @@ let package = Package( | |||
| .package(url: "https://github.com/pointfreeco/swift-identified-collections", from: "1.0.0"), | |||
| .package(url: "https://github.com/pointfreeco/swift-macro-testing", from: "0.4.0"), | |||
| .package(url: "https://github.com/pointfreeco/swift-perception", from: "1.1.4"), | |||
| .package(url: "https://github.com/pointfreeco/swift-custom-dump", from: "1.3.3"), | |||
There was a problem hiding this comment.
any particular reason this version was picked? will it be compatible with the resolved values used elsewhere (i'm assuming yes, but might as well check).
There was a problem hiding this comment.
Not really. Register has v1.2.1 which uses the now-deprecated XCTAssertNoDifference. Good callout.
There was a problem hiding this comment.
I added a commit to downgrade. let me know if you prefer that approach. I'm ambivalent about it.
There was a problem hiding this comment.
downgrading to match other clients seems reasonable to me. i haven't looked at what changed or why it's deprecated so don't have a strong opinion either.
| _ modifications: (inout WorkflowType.State) throws -> Void, | ||
| fileID: StaticString = #fileID, | ||
| filePath: StaticString = #filePath, | ||
| line: UInt = #line, | ||
| _ modifications: (inout WorkflowType.State) throws -> Void | ||
| column: UInt = #column |
There was a problem hiding this comment.
can this be done in a way that is purely additive so this isn't technically a source break (and thus should require a major semver bump)?
There was a problem hiding this comment.
ah yeah we should probably create a new function and deprecate this one. Though it would be a lot easier to use v1.2.1 for now and handle upgrading later (or use the deprecated function here).
gilgtm
force-pushed
the
gil/assertStateModifications-custom-dump
branch
from
cd0218a to
3586399
Compare
gilgtm
force-pushed
the
gil/assertStateModifications-custom-dump
branch
from
3586399 to
fd23f6a
Compare
gilgtm
force-pushed
the
gil/assertStateModifications-custom-dump
branch
4 times, most recently
from
d637515 to
07fbbca
Compare
gilgtm
force-pushed
the
gil/assertStateModifications-custom-dump
branch
from
07fbbca to
d60d294
Compare
jamieQ
changed the title
Demo
Complex Demo
Checklist