Add TestCaseAccessibilityRule #3376
Conversation
This rule verifies that all members of XCTestCase subclasses are private (or fileprivate) except for those defined by XCTestCase. This is useful for a few things: 1. You can make sure code that isn't needed outside the test case isn't overly accessible 2. You can catch typos like `func tsetSomething` that won't actually be run This rule has configuration for `method_prefixes` so that custom methods can still be allowed. This is useful if you disable tests by renaming them (so they continue to be compiled) like `func disabled_testFoo` This change also extracts some useful shared logic around identifying what members are provided by XCTest since they are now used in multiple places.
Codecov Report
@@ Coverage Diff @@
## master #3376 +/- ##
==========================================
+ Coverage 90.48% 90.51% +0.02%
==========================================
Files 417 420 +3
Lines 20508 20552 +44
==========================================
+ Hits 18557 18602 +45
+ Misses 1951 1950 -1
Continue to review full report at Codecov.
|
Source/SwiftLintFramework/Rules/Lint/TestCaseAccessibilityRule.swift
Outdated
Show resolved
Hide resolved
Source/SwiftLintFramework/Rules/Lint/TestCaseAccessibilityRule.swift
Outdated
Show resolved
Hide resolved
….swift Co-authored-by: JP Simard <jp@jpsim.com>
….swift Co-authored-by: JP Simard <jp@jpsim.com>
|
Updated to more accurately identify XCTestCase members |
|
|
||
| public var consoleDescription: String { | ||
| return severityConfiguration.consoleDescription + | ||
| ", method_prefixes: [\(methodPrefixes)]" | ||
| ", allowed_prefixes: [\(allowedPrefixes)]" |
There was a problem hiding this comment.
Examples can now specify configurations, so it'd be nice to test something like disabled_test as an allowed prefix.
SwiftLint/Source/SwiftLintFramework/Models/Example.swift
Lines 6 to 16 in da408b5
There was a problem hiding this comment.
Is there an example of that working? I tried that and I don't believe it's passed all the way through the tests
There was a problem hiding this comment.
AFAICT it only is for analyze tests
There was a problem hiding this comment.
Oh I think you're right. Let's hold off for now, but it should be easy to make normal lint tests apply this configuration value.
| return false | ||
| static func isXCTestMember(kind: SwiftDeclarationKind, name: String, | ||
| attributes: [SwiftDeclarationAttributeKind]) -> Bool { | ||
| return attributes.contains(.override) |
|
Nice rule! So maybe a possible improvement to consider: would it be possible to ie. only execute this rule's check within the main class declaration, and skip any extension declared on the test class instead? This would give some room in how to organise the class definition while still having this rule enabled. |
This rule verifies that all members of XCTestCase subclasses are private
(or fileprivate) except for those defined by XCTestCase. This is useful
for a few things:
overly accessible
func tsetSomethingthat won't actually berun
This rule has configuration for
method_prefixesso that custom methodscan still be allowed. This is useful if you disable tests by renaming
them (so they continue to be compiled) like
func disabled_testFooThis change also extracts some useful shared logic around identifying
what members are provided by XCTest since they are now used in multiple
places.