Unit testing of AttributeRemover
#2247
Merged
Conversation
This file contains 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
ahoppen
reviewed
Oct 2, 2023
Tests/SwiftSyntaxMacroExpansionTest/AttributeRemoverTests.swift
Outdated
Show resolved
Hide resolved
Tests/SwiftSyntaxMacroExpansionTest/AttributeRemoverTests.swift
Outdated
Show resolved
Hide resolved
Tests/SwiftSyntaxMacroExpansionTest/AttributeRemoverTests.swift
Outdated
Show resolved
Hide resolved
ahoppen
reviewed
Oct 5, 2023
Tests/SwiftSyntaxMacroExpansionTest/AttributeRemoverTests.swift
Outdated
Show resolved
Hide resolved
ahoppen
reviewed
Oct 5, 2023
|
@ahoppen I think this PR is just about ready for final review, pending your review of the latest changes. (Particularly the And, when you say to, I'll squash this PR into a single commit and mark the PR as "Ready" instead of "Draft". |
* Add a private assert helper: `assertSyntaxRemovingTestAttributes` * Make `AttributeRemover` SPI (`@_spi(Testing)`) * Rather than depending on `SyntaxNode`'s id-only `Equatable` conformance, refactor `AttributeRemover` to remove attributes matching a predicate: `AttributeRemover.init(removingWhere:)` of type `(AttributeSyntax) -> Bool)`. This change allows `AttributeRemover` to be used without first plucking the `AttributeSyntax` values to be removed from a live tree. Note: Unlike `assertMacroExpansion`, the new `assertSyntaxRemovingTestAttributes` does not trim newlines before comparing values. The trimming by `assertMacroExpansion` was masking a (minor) bug in `AttributeRemover` where an extra leading newline remains when the removed attribute has no proceeding tokens. For now, this commit "fixes" the failing tests by including the unwanted leading newlines in the expected test output, while also adding "FIXME" comments to draw attention to the need for a future fix.
gohanlon
force-pushed
the
unit-test-attribute-remover
branch
from
e5069f1 to
80113cd
Compare
|
@ahoppen Squashed. Let me know if there's anything else! |
|
@swift-ci please test |
|
@swift-ci Please test |
|
@swift-ci Please test macOS |
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.
Following discussions in #2215, this PR isolates
AttributeRemoverTeststoAttributeRemover(SwiftSyntaxMacroExpansionmodule).Test Changes:
fileprivateassert helper:assertSyntaxRemovingTestAttributes.Core Changes:
SyntaxNode's id-onlyEquatableconformance, refactorAttributeRemoverto remove attributes matching a predicate:AttributeRemover.init(removingWhere:)of type(AttributeSyntax) -> Bool). This change allowsAttributeRemoverto be used without first plucking theAttributeSyntaxvalues to be removed from the live tree.AttributeRemoverclass with@_spi(Testing)to make the class visible from the test module without includingAttributeRemoverin the public API.