mirror of
https://github.com/realm/SwiftLint.git
synced 2026-06-06 20:18:40 +00:00
JP Simard
86d60400c1
Over the years, SwiftLintFramework had become a fairly massive monolith, containing over 400 source files with both core infrastructure and rules. Architecturally, the rules should rely on the core infrastructure but not the other way around. There are two exceptions to this: `custom_rules` and `superfluous_disable_command` which need special integration with the linter infrastructure. Now the time has come to formalize this architecture and one way to do that is to move the core SwiftLint functionality out of SwiftLintFramework and into a new SwiftLintCore module that the rules can depend on. Beyond enforcing architectural patterns, this also has the advantage of speeding up incremental compilation by skipping rebuilding the core functionality when iterating on rules. Because the core functionality is always useful when building rules, I'm opting to import SwiftLintCore in SwiftLintFramework as `@_exported` so that it's implicitly available to all files in SwiftLintFramework without needing to import it directly. In a follow-up I'll also split the built-in rules and the extra rules into their own modules. More modularization is possible from there, but not planned. The bulk of this PR just moves files from `Source/SwiftLintFramework/*` to `Source/SwiftLintCore/*`. There are some other changes that can't be split up into their own PRs: * Change jazzy to document the SwiftLintCore module instead of SwiftLintFramework. * Change imports in unit tests to reflect where code was moved to. * Update `sourcery` make rule to reflect where code was moved to. * Create a new `coreRules` array and register those rules with the registry. This allows the `custom_rules` and `superfluous_disable_command` rule implementations to remain internal to the SwiftLintCore module, preventing more implementation details from leaking across architectural layers. * Move `RuleRegistry.registerAllRulesOnce()` out of the type declaration and up one level so it can access rules defined downstream from SwiftLintCore.
306 lines
14 KiB
Swift
306 lines
14 KiB
Swift
import Foundation
|
|
@testable import SwiftLintCore
|
|
import XCTest
|
|
|
|
private struct CacheTestHelper {
|
|
fileprivate let configuration: Configuration
|
|
|
|
private let ruleList: RuleList
|
|
private let ruleDescription: RuleDescription
|
|
private let cache: LinterCache
|
|
|
|
private var fileManager: TestFileManager {
|
|
// swiftlint:disable:next force_cast
|
|
return cache.fileManager as! TestFileManager
|
|
}
|
|
|
|
fileprivate init(dict: [String: Any], cache: LinterCache) {
|
|
ruleList = RuleList(rules: RuleWithLevelsMock.self)
|
|
ruleDescription = ruleList.list.values.first!.description
|
|
configuration = try! Configuration(dict: dict, ruleList: ruleList) // swiftlint:disable:this force_try
|
|
self.cache = cache
|
|
}
|
|
|
|
fileprivate func makeViolations(file: String) -> [StyleViolation] {
|
|
touch(file: file)
|
|
return [
|
|
StyleViolation(ruleDescription: ruleDescription,
|
|
severity: .warning,
|
|
location: Location(file: file, line: 10, character: 2),
|
|
reason: "Something is not right"),
|
|
StyleViolation(ruleDescription: ruleDescription,
|
|
severity: .error,
|
|
location: Location(file: file, line: 5, character: nil),
|
|
reason: "Something is wrong")
|
|
]
|
|
}
|
|
|
|
fileprivate func makeConfig(dict: [String: Any]) -> Configuration {
|
|
return try! Configuration(dict: dict, ruleList: ruleList) // swiftlint:disable:this force_try
|
|
}
|
|
|
|
fileprivate func touch(file: String) {
|
|
fileManager.stubbedModificationDateByPath[file] = Date()
|
|
}
|
|
|
|
fileprivate func remove(file: String) {
|
|
fileManager.stubbedModificationDateByPath[file] = nil
|
|
}
|
|
|
|
fileprivate func fileCount() -> Int {
|
|
return fileManager.stubbedModificationDateByPath.count
|
|
}
|
|
}
|
|
|
|
private class TestFileManager: LintableFileManager {
|
|
fileprivate func filesToLint(inPath: String, rootDirectory: String? = nil) -> [String] {
|
|
return []
|
|
}
|
|
|
|
fileprivate var stubbedModificationDateByPath = [String: Date]()
|
|
|
|
fileprivate func modificationDate(forFileAtPath path: String) -> Date? {
|
|
return stubbedModificationDateByPath[path]
|
|
}
|
|
|
|
fileprivate func isFile(atPath path: String) -> Bool {
|
|
false
|
|
}
|
|
}
|
|
|
|
class LinterCacheTests: SwiftLintTestCase {
|
|
// MARK: Test Helpers
|
|
|
|
private var cache = LinterCache(fileManager: TestFileManager())
|
|
|
|
private func makeCacheTestHelper(dict: [String: Any]) -> CacheTestHelper {
|
|
return CacheTestHelper(dict: dict, cache: cache)
|
|
}
|
|
|
|
private func cacheAndValidate(violations: [StyleViolation], forFile: String, configuration: Configuration,
|
|
file: StaticString = #file, line: UInt = #line) {
|
|
cache.cache(violations: violations, forFile: forFile, configuration: configuration)
|
|
cache = cache.flushed()
|
|
XCTAssertEqual(cache.violations(forFile: forFile, configuration: configuration)!,
|
|
violations, file: (file), line: line)
|
|
}
|
|
|
|
private func cacheAndValidateNoViolationsTwoFiles(configuration: Configuration,
|
|
file: StaticString = #file, line: UInt = #line) {
|
|
let (file1, file2) = ("file1.swift", "file2.swift")
|
|
// swiftlint:disable:next force_cast
|
|
let fileManager = cache.fileManager as! TestFileManager
|
|
fileManager.stubbedModificationDateByPath = [file1: Date(), file2: Date()]
|
|
|
|
cacheAndValidate(violations: [], forFile: file1, configuration: configuration, file: file, line: line)
|
|
cacheAndValidate(violations: [], forFile: file2, configuration: configuration, file: file, line: line)
|
|
}
|
|
|
|
private func validateNewConfigDoesntHitCache(dict: [String: Any], initialConfig: Configuration,
|
|
file: StaticString = #file, line: UInt = #line) throws {
|
|
let newConfig = try Configuration(dict: dict)
|
|
let (file1, file2) = ("file1.swift", "file2.swift")
|
|
|
|
XCTAssertNil(cache.violations(forFile: file1, configuration: newConfig), file: (file), line: line)
|
|
XCTAssertNil(cache.violations(forFile: file2, configuration: newConfig), file: (file), line: line)
|
|
|
|
XCTAssertEqual(cache.violations(forFile: file1, configuration: initialConfig)!, [], file: (file), line: line)
|
|
XCTAssertEqual(cache.violations(forFile: file2, configuration: initialConfig)!, [], file: (file), line: line)
|
|
}
|
|
|
|
// MARK: Cache Reuse
|
|
|
|
// Two subsequent lints with no changes reuses cache
|
|
func testUnchangedFilesReusesCache() {
|
|
let helper = makeCacheTestHelper(dict: ["only_rules": ["mock"]])
|
|
let file = "foo.swift"
|
|
let violations = helper.makeViolations(file: file)
|
|
|
|
cacheAndValidate(violations: violations, forFile: file, configuration: helper.configuration)
|
|
helper.touch(file: file)
|
|
|
|
XCTAssertNil(cache.violations(forFile: file, configuration: helper.configuration))
|
|
}
|
|
|
|
func testConfigFileReorderedReusesCache() {
|
|
let helper = makeCacheTestHelper(dict: ["only_rules": ["mock"], "disabled_rules": [Any]()])
|
|
let file = "foo.swift"
|
|
let violations = helper.makeViolations(file: file)
|
|
|
|
cacheAndValidate(violations: violations, forFile: file, configuration: helper.configuration)
|
|
let configuration2 = helper.makeConfig(dict: ["disabled_rules": [Any](), "only_rules": ["mock"]])
|
|
XCTAssertEqual(cache.violations(forFile: file, configuration: configuration2)!, violations)
|
|
}
|
|
|
|
func testConfigFileWhitespaceAndCommentsChangedOrAddedOrRemovedReusesCache() throws {
|
|
let helper = makeCacheTestHelper(dict: try YamlParser.parse("only_rules:\n - mock"))
|
|
let file = "foo.swift"
|
|
let violations = helper.makeViolations(file: file)
|
|
|
|
cacheAndValidate(violations: violations, forFile: file, configuration: helper.configuration)
|
|
let configuration2 = helper.makeConfig(dict: ["disabled_rules": [Any](), "only_rules": ["mock"]])
|
|
XCTAssertEqual(cache.violations(forFile: file, configuration: configuration2)!, violations)
|
|
let configYamlWithComment = try YamlParser.parse("# comment1\nonly_rules:\n - mock # comment2")
|
|
let configuration3 = helper.makeConfig(dict: configYamlWithComment)
|
|
XCTAssertEqual(cache.violations(forFile: file, configuration: configuration3)!, violations)
|
|
XCTAssertEqual(cache.violations(forFile: file, configuration: helper.configuration)!, violations)
|
|
}
|
|
|
|
func testConfigFileUnrelatedKeysChangedOrAddedOrRemovedReusesCache() {
|
|
let helper = makeCacheTestHelper(dict: ["only_rules": ["mock"], "reporter": "json"])
|
|
let file = "foo.swift"
|
|
let violations = helper.makeViolations(file: file)
|
|
|
|
cacheAndValidate(violations: violations, forFile: file, configuration: helper.configuration)
|
|
let configuration2 = helper.makeConfig(dict: ["only_rules": ["mock"], "reporter": "xcode"])
|
|
XCTAssertEqual(cache.violations(forFile: file, configuration: configuration2)!, violations)
|
|
let configuration3 = helper.makeConfig(dict: ["only_rules": ["mock"]])
|
|
XCTAssertEqual(cache.violations(forFile: file, configuration: configuration3)!, violations)
|
|
}
|
|
|
|
// MARK: Sing-File Cache Invalidation
|
|
|
|
// Two subsequent lints with a file touch in between causes just that one
|
|
// file to be re-linted, with the cache used for all other files
|
|
func testChangedFileCausesJustThatFileToBeLintWithCacheUsedForAllOthers() {
|
|
let helper = makeCacheTestHelper(dict: ["only_rules": ["mock"], "reporter": "json"])
|
|
let (file1, file2) = ("file1.swift", "file2.swift")
|
|
let violations1 = helper.makeViolations(file: file1)
|
|
let violations2 = helper.makeViolations(file: file2)
|
|
|
|
cacheAndValidate(violations: violations1, forFile: file1, configuration: helper.configuration)
|
|
cacheAndValidate(violations: violations2, forFile: file2, configuration: helper.configuration)
|
|
helper.touch(file: file2)
|
|
XCTAssertEqual(cache.violations(forFile: file1, configuration: helper.configuration)!, violations1)
|
|
XCTAssertNil(cache.violations(forFile: file2, configuration: helper.configuration))
|
|
}
|
|
|
|
func testFileRemovedPreservesThatFileInTheCacheAndDoesntCauseAnyOtherFilesToBeLinted() {
|
|
let helper = makeCacheTestHelper(dict: ["only_rules": ["mock"], "reporter": "json"])
|
|
let (file1, file2) = ("file1.swift", "file2.swift")
|
|
let violations1 = helper.makeViolations(file: file1)
|
|
let violations2 = helper.makeViolations(file: file2)
|
|
|
|
cacheAndValidate(violations: violations1, forFile: file1, configuration: helper.configuration)
|
|
cacheAndValidate(violations: violations2, forFile: file2, configuration: helper.configuration)
|
|
XCTAssertEqual(helper.fileCount(), 2)
|
|
helper.remove(file: file2)
|
|
XCTAssertEqual(cache.violations(forFile: file1, configuration: helper.configuration)!, violations1)
|
|
XCTAssertEqual(helper.fileCount(), 1)
|
|
}
|
|
|
|
// MARK: All-File Cache Invalidation
|
|
|
|
func testCustomRulesChangedOrAddedOrRemovedCausesAllFilesToBeReLinted() throws {
|
|
let initialConfig = try Configuration(
|
|
dict: [
|
|
"only_rules": ["custom_rules", "rule1"],
|
|
"custom_rules": ["rule1": ["regex": "([n,N]inja)"]]
|
|
],
|
|
ruleList: RuleList(rules: CustomRules.self)
|
|
)
|
|
cacheAndValidateNoViolationsTwoFiles(configuration: initialConfig)
|
|
|
|
// Change
|
|
try validateNewConfigDoesntHitCache(
|
|
dict: [
|
|
"only_rules": ["custom_rules", "rule1"],
|
|
"custom_rules": ["rule1": ["regex": "([n,N]injas)"]]
|
|
],
|
|
initialConfig: initialConfig
|
|
)
|
|
|
|
// Addition
|
|
try validateNewConfigDoesntHitCache(
|
|
dict: [
|
|
"only_rules": ["custom_rules", "rule1"],
|
|
"custom_rules": ["rule1": ["regex": "([n,N]injas)"], "rule2": ["regex": "([k,K]ittens)"]]
|
|
],
|
|
initialConfig: initialConfig
|
|
)
|
|
|
|
// Removal
|
|
try validateNewConfigDoesntHitCache(dict: ["only_rules": ["custom_rules"]], initialConfig: initialConfig)
|
|
}
|
|
|
|
func testDisabledRulesChangedOrAddedOrRemovedCausesAllFilesToBeReLinted() throws {
|
|
let initialConfig = try Configuration(dict: ["disabled_rules": ["nesting"]])
|
|
cacheAndValidateNoViolationsTwoFiles(configuration: initialConfig)
|
|
|
|
// Change
|
|
try validateNewConfigDoesntHitCache(dict: ["disabled_rules": ["todo"]], initialConfig: initialConfig)
|
|
// Addition
|
|
try validateNewConfigDoesntHitCache(dict: ["disabled_rules": ["nesting", "todo"]], initialConfig: initialConfig)
|
|
// Removal
|
|
try validateNewConfigDoesntHitCache(dict: ["disabled_rules": [Any]()], initialConfig: initialConfig)
|
|
}
|
|
|
|
func testOptInRulesChangedOrAddedOrRemovedCausesAllFilesToBeReLinted() throws {
|
|
let initialConfig = try Configuration(dict: ["opt_in_rules": ["attributes"]])
|
|
cacheAndValidateNoViolationsTwoFiles(configuration: initialConfig)
|
|
|
|
// Change
|
|
try validateNewConfigDoesntHitCache(dict: ["opt_in_rules": ["empty_count"]], initialConfig: initialConfig)
|
|
// Rules addition
|
|
try validateNewConfigDoesntHitCache(dict: ["opt_in_rules": ["attributes", "empty_count"]],
|
|
initialConfig: initialConfig)
|
|
// Removal
|
|
try validateNewConfigDoesntHitCache(dict: ["opt_in_rules": [Any]()], initialConfig: initialConfig)
|
|
}
|
|
|
|
func testEnabledRulesChangedOrAddedOrRemovedCausesAllFilesToBeReLinted() throws {
|
|
let initialConfig = try Configuration(dict: ["enabled_rules": ["attributes"]])
|
|
cacheAndValidateNoViolationsTwoFiles(configuration: initialConfig)
|
|
|
|
// Change
|
|
try validateNewConfigDoesntHitCache(dict: ["enabled_rules": ["empty_count"]], initialConfig: initialConfig)
|
|
// Addition
|
|
try validateNewConfigDoesntHitCache(dict: ["enabled_rules": ["attributes", "empty_count"]],
|
|
initialConfig: initialConfig)
|
|
// Removal
|
|
try validateNewConfigDoesntHitCache(dict: ["enabled_rules": [Any]()], initialConfig: initialConfig)
|
|
}
|
|
|
|
func testOnlyRulesChangedOrAddedOrRemovedCausesAllFilesToBeReLinted() throws {
|
|
let initialConfig = try Configuration(dict: ["only_rules": ["nesting"]])
|
|
cacheAndValidateNoViolationsTwoFiles(configuration: initialConfig)
|
|
|
|
// Change
|
|
try validateNewConfigDoesntHitCache(dict: ["only_rules": ["todo"]], initialConfig: initialConfig)
|
|
// Addition
|
|
try validateNewConfigDoesntHitCache(dict: ["only_rules": ["nesting", "todo"]], initialConfig: initialConfig)
|
|
// Removal
|
|
try validateNewConfigDoesntHitCache(dict: ["only_rules": [Any]()], initialConfig: initialConfig)
|
|
}
|
|
|
|
func testRuleConfigurationChangedOrAddedOrRemovedCausesAllFilesToBeReLinted() throws {
|
|
let initialConfig = try Configuration(dict: ["line_length": 120])
|
|
cacheAndValidateNoViolationsTwoFiles(configuration: initialConfig)
|
|
|
|
// Change
|
|
try validateNewConfigDoesntHitCache(dict: ["line_length": 100], initialConfig: initialConfig)
|
|
// Addition
|
|
try validateNewConfigDoesntHitCache(dict: ["line_length": 100, "number_separator": ["minimum_length": 5]],
|
|
initialConfig: initialConfig)
|
|
// Removal
|
|
try validateNewConfigDoesntHitCache(dict: [:], initialConfig: initialConfig)
|
|
}
|
|
|
|
func testSwiftVersionChangedRemovedCausesAllFilesToBeReLinted() {
|
|
let fileManager = TestFileManager()
|
|
cache = LinterCache(fileManager: fileManager)
|
|
let helper = makeCacheTestHelper(dict: [:])
|
|
let file = "foo.swift"
|
|
let violations = helper.makeViolations(file: file)
|
|
|
|
cacheAndValidate(violations: violations, forFile: file, configuration: helper.configuration)
|
|
let thisSwiftVersionCache = cache
|
|
|
|
let differentSwiftVersion: SwiftVersion = .five
|
|
cache = LinterCache(fileManager: fileManager, swiftVersion: differentSwiftVersion)
|
|
|
|
XCTAssertNotNil(thisSwiftVersionCache.violations(forFile: file, configuration: helper.configuration))
|
|
XCTAssertNil(cache.violations(forFile: file, configuration: helper.configuration))
|
|
}
|
|
}
|