YoastCS: add some test specific rules and exceptions #367
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
While WordPressCS makes a best effort to try to prevent false positives on test code for the `WordPress.WP.GlobalVariablesOverride`, it is simpler to just plain exclude the test code from being scanned with this sniff.
For mock-based unit tests, it is fine to use the PHP native `json_encode()` function to mock the WP/Yoast native alternative for this function, so let's prevent the test code needing lots of ignore annotations when the issue is not solvable.
Double classes may overload methods from a parent class just to change the visibility of the method from `protected` to `public` to allow for testing the method directly. This is fine.
Related to 303 Impact on Yoast packages: | Plugin/Tool | Errors/Warnings | |-------------------|-----------------| | PHPUnit Polyfills | -- | WP Test Utils | -- | YoastCS | -- | WHIP | 9 | Yoast Test Helper | -- | Duplicate Post | -- | Yst ACF | -- | Yst WooCommerce | 5 | Yst News | 9 | Yst Local | 1 | Yst Video | 108 | Yst Premium | 76 | Yst Free | 118
... while allowing `abstract` TestCases. Note: the typical/default "Doubles" directories within the "tests" directory are exempt from this rule as "Double" classes are often still combined with mocking and making the class `final` would break those tests. Related to 303 Impact on Yoast packages: | Plugin/Tool | Errors/Warnings | |-------------------|-----------------| | PHPUnit Polyfills | 25 (fixtures for the tests, these will be exempt) | WP Test Utils | 9 (mostly fixtures for the tests) | YoastCS | -- | WHIP | 9 | Yoast Test Helper | -- | Duplicate Post | 25 | Yst ACF | 10 | Yst WooCommerce | 25 | Yst News | 13 | Yst Local | 11 | Yst Video | 101 | Yst Premium | 126 | Yst Free | 647
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.
YoastCS rules: selectively exempt test files [1]
While WordPressCS makes a best effort to try to prevent false positives on test code for the
WordPress.WP.GlobalVariablesOverride, it is simpler to just plain exclude the test code from being scanned with this sniff.YoastCS rules: selectively exempt test files [2]
For mock-based unit tests, it is fine to use the PHP native
json_encode()function to mock the WP/Yoast native alternative for this function, so let's prevent the test code needing lots of ignore annotations when the issue is not solvable.YoastCS rules: selectively exempt test files [3]
Double classes may overload methods from a parent class just to change the visibility of the method from
protectedtopublicto allow for testing the method directly. This is fine.YoastCS rules: enforce namespaces for all test files
Related to #303
Impact on Yoast packages:
YoastCS rules: enforce final classes for all test files
... while allowing
abstractTestCases.Note: the typical/default "Doubles" directories within the "tests" directory are exempt from this rule as "Double" classes are often still combined with mocking and making the class
finalwould break those tests.Related to #303
Impact on Yoast packages: