Separate built-in rule tests from framework tests (#5924)

* Short names for test modules * Lint plugins and `Package.swift` in integration tests * Simplify and merge file groups in Bazel * Move common functions to `TestHelpers`
realm · Dec 30, 2024 · 15b2855 · 15b2855
1 parent bef8acf
commit 15b2855
Show file tree

Hide file tree

Showing 227 changed files with 200 additions and 99 deletions.
diff --git a/.sourcery/GeneratedTests.stencil b/.sourcery/GeneratedTests.stencil
@@ -1,6 +1,6 @@
 @testable import SwiftLintBuiltInRules
 @testable import SwiftLintCore
-import SwiftLintTestHelpers
+import TestHelpers
 
 // swiftlint:disable:next blanket_disable_command
 // swiftlint:disable file_length single_test_class type_name

diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -5,7 +5,8 @@ included:
   - Tests
   - Package.swift
 excluded:
-  - Tests/SwiftLintFrameworkTests/Resources
+  - Tests/BuiltInRulesTests/Resources
+  - Tests/FrameworkTests/Resources
 
 # Enabled/disabled rules
 analyzer_rules:

diff --git a/BUILD b/BUILD
@@ -194,9 +194,10 @@ cc_library(
 
 filegroup(
     name = "LintInputs",
-    srcs = glob(["Source/**/*.swift"]) + [
+    srcs = glob(["Plugins/**/*.swift", "Source/**/*.swift"]) + [
         ".swiftlint.yml",
-        "//Tests:SwiftLintFrameworkTestsData",
+        "Package.swift",
+        "//Tests:TestSources",
     ],
     visibility = ["//Tests:__subpackages__"],
 )

diff --git a/Package.swift b/Package.swift
@@ -113,18 +113,18 @@ let package = Package(
         ),
         .target(name: "DyldWarningWorkaround"),
         .target(
-            name: "SwiftLintTestHelpers",
+            name: "TestHelpers",
             dependencies: [
                 "SwiftLintFramework"
             ],
-            path: "Tests/SwiftLintTestHelpers",
+            path: "Tests/TestHelpers",
             swiftSettings: swiftFeatures
         ),
         .testTarget(
-            name: "SwiftLintFrameworkTests",
+            name: "FrameworkTests",
             dependencies: [
                 "SwiftLintFramework",
-                "SwiftLintTestHelpers",
+                "TestHelpers",
                 "SwiftLintCoreMacros",
             ],
             exclude: [
@@ -136,26 +136,38 @@ let package = Package(
             name: "GeneratedTests",
             dependencies: [
                 "SwiftLintFramework",
-                "SwiftLintTestHelpers",
+                "TestHelpers",
             ],
             swiftSettings: swiftFeatures
         ),
         .testTarget(
             name: "IntegrationTests",
             dependencies: [
                 "SwiftLintFramework",
-                "SwiftLintTestHelpers",
+                "TestHelpers",
             ],
             exclude: [
                 "default_rule_configurations.yml"
             ],
             swiftSettings: swiftFeatures
         ),
+        .testTarget(
+            name: "BuiltInRulesTests",
+            dependencies: [
+                "SwiftLintBuiltInRules",
+                "SwiftLintFramework",
+                "TestHelpers",
+            ],
+            exclude: [
+                "Resources",
+            ],
+            swiftSettings: swiftFeatures
+        ),
         .testTarget(
             name: "ExtraRulesTests",
             dependencies: [
                 "SwiftLintFramework",
-                "SwiftLintTestHelpers",
+                "TestHelpers",
             ],
             swiftSettings: swiftFeatures
         ),

diff --git a/Tests/BUILD b/Tests/BUILD
@@ -55,65 +55,78 @@ swift_test(
     deps = [":MacroTests.library"],
 )
 
-# SwiftLintTestHelpers
+# TestHelpers
 
 swift_library(
-    name = "SwiftLintTestHelpers",
+    name = "TestHelpers",
     testonly = True,
-    srcs = glob(["SwiftLintTestHelpers/**/*.swift"]),
-    module_name = "SwiftLintTestHelpers",
+    srcs = glob(["TestHelpers/**/*.swift"]),
+    module_name = "TestHelpers",
     package_name = "SwiftLint",
     deps = [
         "//:SwiftLintFramework",
     ],
     copts = copts,
 )
 
-# SwiftLintFrameworkTests
+# BuiltInRulesTests
 
-filegroup(
-    name = "SwiftLintFrameworkTestsSources",
+swift_library(
+    name = "BuiltInRulesTests.library",
+    testonly = True,
     srcs = glob(
-        ["SwiftLintFrameworkTests/**/*.swift"],
+        ["BuiltInRulesTests/**/*.swift"],
         exclude = [
-            "SwiftLintFrameworkTests/Resources/**",
+            "BuiltInRulesTests/Resources/**",
             # Bazel doesn't support paths with spaces in them
-            "SwiftLintFrameworkTests/FileNameNoSpaceRuleTests.swift",
+            "BuiltInRulesTests/FileNameNoSpaceRuleTests.swift",
         ],
     ),
+    module_name = "BuiltInRulesTests",
+    package_name = "SwiftLint",
+    deps = [
+        ":TestHelpers",
+    ],
+    copts = copts,
 )
 
-filegroup(
-    name = "SwiftLintFrameworkTestsData",
-    srcs = glob(
-        ["**/**"],
+swift_test(
+    name = "BuiltInRulesTests",
+    data = glob(
+        ["BuiltInRulesTests/Resources/**"],
         # Bazel doesn't support paths with spaces in them
-        exclude = ["SwiftLintFrameworkTests/Resources/FileNameNoSpaceRuleFixtures/**"],
+        exclude = ["BuiltInRulesTests/Resources/FileNameNoSpaceRuleFixtures/**"],
     ),
     visibility = ["//visibility:public"],
+    deps = [":BuiltInRulesTests.library"],
 )
 
+# FrameworkTests
+
 swift_library(
-    name = "SwiftLintFrameworkTests.library",
+    name = "FrameworkTests.library",
     testonly = True,
-    srcs = [":SwiftLintFrameworkTestsSources"],
-    module_name = "SwiftLintFrameworkTests",
+    srcs = glob(
+        ["FrameworkTests/**/*.swift"],
+        exclude = [
+            "FrameworkTests/Resources/**",
+        ],
+    ),
+    module_name = "FrameworkTests",
     package_name = "SwiftLint",
     deps = [
-        ":SwiftLintTestHelpers",
+        ":TestHelpers",
     ],
     copts = copts,
 )
 
 swift_test(
-    name = "SwiftLintFrameworkTests",
+    name = "FrameworkTests",
     data = glob(
-        ["SwiftLintFrameworkTests/Resources/**"],
-        # Bazel doesn't support paths with spaces in them
-        exclude = ["SwiftLintFrameworkTests/Resources/FileNameNoSpaceRuleFixtures/**"],
+        ["FrameworkTests/Resources/**"],
     ),
     visibility = ["//visibility:public"],
-    deps = [":SwiftLintFrameworkTests.library"],
+    deps = [":FrameworkTests.library"],
 )
 
 # GeneratedTests
@@ -125,7 +138,7 @@ swift_library(
     module_name = "GeneratedTests",
     package_name = "SwiftLint",
     deps = [
-        ":SwiftLintTestHelpers",
+        ":TestHelpers",
     ],
     copts = copts,
 )
@@ -138,14 +151,23 @@ swift_test(
 
 # IntegrationTests
 
+filegroup(
+    name = "TestSources",
+    srcs = glob(
+        ["**/*.swift"],
+        exclude = ["**/Resources/**"],
+    ),
+    visibility = ["//visibility:public"],
+)
+
 swift_library(
     name = "IntegrationTests.library",
     testonly = True,
     srcs = ["IntegrationTests/IntegrationTests.swift"],
     module_name = "IntegrationTests",
     package_name = "SwiftLint",
     deps = [
-        ":SwiftLintTestHelpers",
+        ":TestHelpers",
     ],
     copts = copts,
 )
@@ -184,7 +206,7 @@ swift_library(
     module_name = "ExtraRulesTests",
     package_name = "SwiftLint",
     deps = [
-        ":SwiftLintTestHelpers",
+        ":TestHelpers",
     ],
 )
 

diff --git a/...tFrameworkTests/AttributesRuleTests.swift → ...iltInRulesTests/AttributesRuleTests.swift b/...tFrameworkTests/AttributesRuleTests.swift → ...iltInRulesTests/AttributesRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 
 final class AttributesRuleTests: SwiftLintTestCase {
     func testAttributesWithAlwaysOnSameLine() {

diff --git a/...ests/BlanketDisableCommandRuleTests.swift → ...ests/BlanketDisableCommandRuleTests.swift b/...ests/BlanketDisableCommandRuleTests.swift → ...ests/BlanketDisableCommandRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 import XCTest
 
 final class BlanketDisableCommandRuleTests: SwiftLintTestCase {

diff --git a/...ildOptionSeverityConfigurationTests.swift → ...ildOptionSeverityConfigurationTests.swift b/...ildOptionSeverityConfigurationTests.swift → ...ildOptionSeverityConfigurationTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 import XCTest
 
 final class ChildOptionSeverityConfigurationTests: SwiftLintTestCase {

diff --git a/...kTests/CollectionAlignmentRuleTests.swift → ...sTests/CollectionAlignmentRuleTests.swift b/...kTests/CollectionAlignmentRuleTests.swift → ...sTests/CollectionAlignmentRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 
 final class CollectionAlignmentRuleTests: SwiftLintTestCase {
     func testCollectionAlignmentWithAlignLeft() {

diff --git a/...ftLintFrameworkTests/ColonRuleTests.swift → Tests/BuiltInRulesTests/ColonRuleTests.swift b/...ftLintFrameworkTests/ColonRuleTests.swift → Tests/BuiltInRulesTests/ColonRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 
 final class ColonRuleTests: SwiftLintTestCase {
     func testColonWithFlexibleRightSpace() {

diff --git a/...Tests/CompilerProtocolInitRuleTests.swift → ...Tests/CompilerProtocolInitRuleTests.swift b/...Tests/CompilerProtocolInitRuleTests.swift → ...Tests/CompilerProtocolInitRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 import XCTest
 
 final class CompilerProtocolInitRuleTests: SwiftLintTestCase {

diff --git a/...sts/ComputedAccessorsOrderRuleTests.swift → ...sts/ComputedAccessorsOrderRuleTests.swift b/...sts/ComputedAccessorsOrderRuleTests.swift → ...sts/ComputedAccessorsOrderRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 import XCTest
 
 final class ComputedAccessorsOrderRuleTests: SwiftLintTestCase {

diff --git a/...onditionalReturnsOnNewlineRuleTests.swift → ...onditionalReturnsOnNewlineRuleTests.swift b/...onditionalReturnsOnNewlineRuleTests.swift → ...onditionalReturnsOnNewlineRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 
 final class ConditionalReturnsOnNewlineRuleTests: SwiftLintTestCase {
     func testConditionalReturnsOnNewlineWithIfOnly() {

diff --git a/...ts/ContainsOverFirstNotNilRuleTests.swift → ...ts/ContainsOverFirstNotNilRuleTests.swift b/...ts/ContainsOverFirstNotNilRuleTests.swift → ...ts/ContainsOverFirstNotNilRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 import XCTest
 
 final class ContainsOverFirstNotNilRuleTests: SwiftLintTestCase {
@@ -25,6 +26,6 @@ final class ContainsOverFirstNotNilRuleTests: SwiftLintTestCase {
             return []
         }
 
-        return SwiftLintFrameworkTests.violations(example, config: config)
+        return TestHelpers.violations(example, config: config)
     }
 }
diff --git a/...lomaticComplexityConfigurationTests.swift → ...lomaticComplexityConfigurationTests.swift b/...lomaticComplexityConfigurationTests.swift → ...lomaticComplexityConfigurationTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 import XCTest
 
 final class CyclomaticComplexityConfigurationTests: SwiftLintTestCase {

diff --git a/...Tests/CyclomaticComplexityRuleTests.swift → ...Tests/CyclomaticComplexityRuleTests.swift b/...Tests/CyclomaticComplexityRuleTests.swift → ...Tests/CyclomaticComplexityRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 
 final class CyclomaticComplexityRuleTests: SwiftLintTestCase {
     private lazy var complexSwitchExample: Example = {

diff --git a/.../DeploymentTargetConfigurationTests.swift → .../DeploymentTargetConfigurationTests.swift b/.../DeploymentTargetConfigurationTests.swift → .../DeploymentTargetConfigurationTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 import XCTest
 
 final class DeploymentTargetConfigurationTests: SwiftLintTestCase {

diff --git a/...workTests/DeploymentTargetRuleTests.swift → ...ulesTests/DeploymentTargetRuleTests.swift b/...workTests/DeploymentTargetRuleTests.swift → ...ulesTests/DeploymentTargetRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 import XCTest
 
 final class DeploymentTargetRuleTests: SwiftLintTestCase {
@@ -39,6 +40,6 @@ final class DeploymentTargetRuleTests: SwiftLintTestCase {
             return []
         }
 
-        return SwiftLintFrameworkTests.violations(example, config: config)
+        return TestHelpers.violations(example, config: config)
     }
 }
diff --git a/...ests/DiscouragedDirectInitRuleTests.swift → ...ests/DiscouragedDirectInitRuleTests.swift b/...ests/DiscouragedDirectInitRuleTests.swift → ...ests/DiscouragedDirectInitRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 
 final class DiscouragedDirectInitRuleTests: SwiftLintTestCase {
     private let baseDescription = DiscouragedDirectInitRule.description

diff --git a/...s/DiscouragedObjectLiteralRuleTests.swift → ...s/DiscouragedObjectLiteralRuleTests.swift b/...s/DiscouragedObjectLiteralRuleTests.swift → ...s/DiscouragedObjectLiteralRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 
 final class DiscouragedObjectLiteralRuleTests: SwiftLintTestCase {
     func testWithImageLiteral() {

diff --git a/...workTests/DuplicateImportsRuleTests.swift → ...ulesTests/DuplicateImportsRuleTests.swift b/...workTests/DuplicateImportsRuleTests.swift → ...ulesTests/DuplicateImportsRuleTests.swift
diff --git a/...tFrameworkTests/EmptyCountRuleTests.swift → ...iltInRulesTests/EmptyCountRuleTests.swift b/...tFrameworkTests/EmptyCountRuleTests.swift → ...iltInRulesTests/EmptyCountRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 
 final class EmptyCountRuleTests: SwiftLintTestCase {
     func testEmptyCountWithOnlyAfterDot() {

diff --git a/...rameworkTests/ExpiringTodoRuleTests.swift → ...tInRulesTests/ExpiringTodoRuleTests.swift b/...rameworkTests/ExpiringTodoRuleTests.swift → ...tInRulesTests/ExpiringTodoRuleTests.swift
@@ -1,5 +1,6 @@
 @testable import SwiftLintBuiltInRules
 import SwiftLintFramework
+import TestHelpers
 import XCTest
 
 final class ExpiringTodoRuleTests: SwiftLintTestCase {
@@ -142,7 +143,7 @@ final class ExpiringTodoRuleTests: SwiftLintTestCase {
     }
 
     private func violations(_ example: Example) -> [StyleViolation] {
-        SwiftLintFrameworkTests.violations(example, config: config)
+        TestHelpers.violations(example, config: config)
     }
 
     private func dateString(for status: ExpiringTodoRule.ExpiryViolationLevel) -> String {

diff --git a/...rameworkTests/ExplicitInitRuleTests.swift → ...tInRulesTests/ExplicitInitRuleTests.swift b/...rameworkTests/ExplicitInitRuleTests.swift → ...tInRulesTests/ExplicitInitRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 
 final class ExplicitInitRuleTests: SwiftLintTestCase {
     func testIncludeBareInit() {

diff --git a/...icitTypeInterfaceConfigurationTests.swift → ...icitTypeInterfaceConfigurationTests.swift b/...icitTypeInterfaceConfigurationTests.swift → ...icitTypeInterfaceConfigurationTests.swift
@@ -1,5 +1,6 @@
 @testable import SwiftLintBuiltInRules
 @testable import SwiftLintCore
+import TestHelpers
 import XCTest
 
 final class ExplicitTypeInterfaceConfigurationTests: SwiftLintTestCase {

diff --git a/...ests/ExplicitTypeInterfaceRuleTests.swift → ...ests/ExplicitTypeInterfaceRuleTests.swift b/...ests/ExplicitTypeInterfaceRuleTests.swift → ...ests/ExplicitTypeInterfaceRuleTests.swift
@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 
 final class ExplicitTypeInterfaceRuleTests: SwiftLintTestCase {
     func testLocalVars() {

diff --git a/...tFrameworkTests/FileHeaderRuleTests.swift → ...iltInRulesTests/FileHeaderRuleTests.swift b/...tFrameworkTests/FileHeaderRuleTests.swift → ...iltInRulesTests/FileHeaderRuleTests.swift
@@ -1,7 +1,8 @@
 @testable import SwiftLintBuiltInRules
+import TestHelpers
 import XCTest
 
-private let fixturesDirectory = "\(TestResources.path)/FileHeaderRuleFixtures"
+private let fixturesDirectory = "\(TestResources.path())/FileHeaderRuleFixtures"
 
 final class FileHeaderRuleTests: SwiftLintTestCase {
     private func validate(fileName: String, using configuration: Any) throws -> [StyleViolation] {