Discourage using unrealistic catalog inputs in tests #1106
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
This example catalog contains significant handcrafted data that doesn't reflect realistic inputs.
franklinsch
approved these changes
Dec 4, 2024
| @@ -39,7 +39,7 @@ class ExternalTopicsGraphHashTests: XCTestCase { | |||
|
|
|||
| func testNoMetricAddedIfNoExternalTopicsAreResolved() throws { | |||
| // Load bundle without using external resolvers | |||
| let (_, context) = try testBundleAndContext(named: "TestBundle") | |||
| let (_, context) = try testBundleAndContext(named: "DoNotUseInNewTests") | |||
There was a problem hiding this comment.
nit: Any thoughts on something more explicit like LegacyBundle_DoNotUseInNewTests to make it clearer that this is a test bundle?
There was a problem hiding this comment.
Updated in 86ce80f
|
@swift-ci please test |
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.
Bug/issue #, if applicable:
Summary
Since before the initial open source release of DocC, rdar://61945486 has tracked updating the tests to not use the "TestBundle" which contains a lot of inaccurate and unrealistic handcrafted data. Unfortunately, use of these test inputs have increased since then.
This PR renames those "TestBundle" to "DoNotUseInNewTests" to discourage using it in new tests and updates many of the tests that only needed some content to created dedicated minimal test inputs to reduce the the use of these unrealistic test inputs. Lastly, it simplifies the loading of inputs in many tests.
Note
This is a test-only PR.
Dependencies
None.
Testing
Nothing in particular. This isn't a user-facing change.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
AddedUpdated tests./bin/testscript and it succeededUpdated documentation if necessaryNot applicable