-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds quick_discouraged_pending_test opt-in rule #1910
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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 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
78 changes: 78 additions & 0 deletions
78
Source/SwiftLintFramework/Rules/QuickDiscouragedPendingTestRule.swift
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| // | ||
| // QuickDiscouragedPendingTestRule.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Ornithologist Coder on 10/15/17. | ||
| // Copyright © 2017 Realm. All rights reserved. | ||
| // | ||
|
|
||
| import Foundation | ||
| import SourceKittenFramework | ||
|
|
||
| public struct QuickDiscouragedPendingTestRule: OptInRule, ConfigurationProviderRule { | ||
| public var configuration = SeverityConfiguration(.warning) | ||
|
|
||
| public init() {} | ||
|
|
||
| public static let description = RuleDescription( | ||
| identifier: "quick_discouraged_pending_test", | ||
| name: "Quick Discouraged Pending Test", | ||
| description: "Discouraged pending test. This test won't run while it's marked as pending.", | ||
| kind: .lint, | ||
| nonTriggeringExamples: QuickDiscouragedPendingTestRuleExamples.nonTriggeringExamples, | ||
| triggeringExamples: QuickDiscouragedPendingTestRuleExamples.triggeringExamples | ||
| ) | ||
|
|
||
| public func validate(file: File) -> [StyleViolation] { | ||
| let testClasses = file.structure.dictionary.substructure.filter { | ||
| return $0.inheritedTypes.contains("QuickSpec") && | ||
| $0.kind.flatMap(SwiftDeclarationKind.init) == .class | ||
| } | ||
|
|
||
| let specDeclarations = testClasses.flatMap { classDict in | ||
| return classDict.substructure.filter { | ||
| return $0.name == "spec()" && $0.enclosedVarParameters.isEmpty && | ||
| $0.kind.flatMap(SwiftDeclarationKind.init) == .functionMethodInstance && | ||
| $0.enclosedSwiftAttributes.contains("source.decl.attribute.override") | ||
| } | ||
| } | ||
|
|
||
| return specDeclarations.flatMap { | ||
| validate(file: file, dictionary: $0) | ||
| } | ||
| } | ||
|
|
||
| private func validate(file: File, dictionary: [String: SourceKitRepresentable]) -> [StyleViolation] { | ||
| return dictionary.substructure.flatMap { subDict -> [StyleViolation] in | ||
| var violations = validate(file: file, dictionary: subDict) | ||
|
|
||
| if let kindString = subDict.kind, | ||
| let kind = SwiftExpressionKind(rawValue: kindString) { | ||
| violations += validate(file: file, kind: kind, dictionary: subDict) | ||
| } | ||
|
|
||
| return violations | ||
| } | ||
| } | ||
|
|
||
| private func validate(file: File, | ||
| kind: SwiftExpressionKind, | ||
| dictionary: [String: SourceKitRepresentable]) -> [StyleViolation] { | ||
| guard | ||
| kind == .call, | ||
| let name = dictionary.name, | ||
| let offset = dictionary.offset, | ||
| QuickPendingCallKind(rawValue: name) != nil else { return [] } | ||
|
|
||
| return [StyleViolation(ruleDescription: type(of: self).description, | ||
| severity: configuration.severity, | ||
| location: Location(file: file, byteOffset: offset))] | ||
| } | ||
| } | ||
|
|
||
| private enum QuickPendingCallKind: String { | ||
| case pending | ||
| case xdescribe | ||
| case xcontext | ||
| case xit | ||
| } | ||
71 changes: 71 additions & 0 deletions
71
Source/SwiftLintFramework/Rules/QuickDiscouragedPendingTestRuleExamples.swift
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| // | ||
| // QuickDiscouragedPendingTestRuleExamples.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Ornithologist Coder on 10/16/17. | ||
| // Copyright © 2017 Realm. All rights reserved. | ||
| // | ||
|
|
||
| import Foundation | ||
|
|
||
| internal struct QuickDiscouragedPendingTestRuleExamples { | ||
| static let nonTriggeringExamples = [ | ||
| "class TotoTests: QuickSpec {\n" + | ||
| " override func spec() {\n" + | ||
| " describe(\"foo\") {\n" + | ||
| " describe(\"bar\") { } \n" + | ||
| " context(\"bar\") {\n" + | ||
| " it(\"bar\") { }\n" + | ||
| " }\n" + | ||
| " it(\"bar\") { }\n" + | ||
| " }\n" + | ||
| " }\n" + | ||
| "}\n" | ||
| ] | ||
|
|
||
| static let triggeringExamples = [ | ||
| "class TotoTests: QuickSpec {\n" + | ||
| " override func spec() {\n" + | ||
| " ↓xdescribe(\"foo\") { }\n" + | ||
| " }\n" + | ||
| "}\n", | ||
| "class TotoTests: QuickSpec {\n" + | ||
| " override func spec() {\n" + | ||
| " ↓xcontext(\"foo\") { }\n" + | ||
| " }\n" + | ||
| "}\n", | ||
| "class TotoTests: QuickSpec {\n" + | ||
| " override func spec() {\n" + | ||
| " ↓xit(\"foo\") { }\n" + | ||
| " }\n" + | ||
| "}\n", | ||
| "class TotoTests: QuickSpec {\n" + | ||
| " override func spec() {\n" + | ||
| " describe(\"foo\") {\n" + | ||
| " ↓xit(\"bar\") { }\n" + | ||
| " }\n" + | ||
| " }\n" + | ||
| "}\n", | ||
| "class TotoTests: QuickSpec {\n" + | ||
| " override func spec() {\n" + | ||
| " context(\"foo\") {\n" + | ||
| " ↓xit(\"bar\") { }\n" + | ||
| " }\n" + | ||
| " }\n" + | ||
| "}\n", | ||
| "class TotoTests: QuickSpec {\n" + | ||
| " override func spec() {\n" + | ||
| " describe(\"foo\") {\n" + | ||
| " context(\"bar\") {\n" + | ||
| " ↓xit(\"toto\") { }\n" + | ||
| " }\n" + | ||
| " }\n" + | ||
| " }\n" + | ||
| "}\n", | ||
| "class TotoTests: QuickSpec {\n" + | ||
| " override func spec() {\n" + | ||
| " ↓pending(\"foo\")\n" + | ||
| " }\n" + | ||
| "}\n" | ||
| ] | ||
| } |
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 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
probably
xitBehavesLikeshould be here tooThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting. Quick's SDL.swift doesn't have
xitBehavesLike. It's defined as a #define in QCKSDL.h. I'll add it.