[Groundwork for #1201] Rewrite test descriptions containing meaningful symbols #1242
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
The motivation for this change is that it’s groundwork for removing the Quick testing framework using an automated migrator tool (#1201). The migrator that I’m writing will convert all symbols in test descriptions to underscores in the emitted method names. This is okay most of the time, but we have a few places where the symbols have meaning, and removing them will change the description of the test. The migrator emits a warning when it thinks this is the case, but it’s up to us to look at this output and decide which ones need changing.
lawrence-forooghian
changed the title
lawrence-forooghian
requested review from
QuintinWillison,
ben-xD,
lukasz-szyszkowski and
maratal
lukasz-szyszkowski
approved these changes
Dec 1, 2021
maratal
approved these changes
Dec 1, 2021
lawrence-forooghian
deleted the
1201-rename-tests-where-symbols-have-meaning
branch
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.
What does this do?
Rewrites test descriptions so that they don't contain any symbols which, if removed, would change the meaning of the test description.
Does it change the behaviour of the test suite?
No, it's just a refactor.
Why are we doing this?
It’s groundwork for removing the Quick testing framework using an automated migrator tool (#1201). The migrator that I’m writing will convert all symbols in test descriptions to underscores in the emitted method names. This is okay most of the time, but we have a few places where the symbols have meaning, and removing them will change the description of the test. The migrator emits a warning when it thinks this is the case, but it’s up to us to look at this output and decide which ones need changing.