Move fixtures into resources folder

Author: SimplyDanny

.github/copilot-instructions.md

@@ -4,7 +4,7 @@ Linting rules are defined in `Source/SwiftLintBuiltInRules/Rules`. If someone me
 
 User-facing changes must be documented in the `CHANGELOG.md` file, which is organized by version. New entries always go into the "Main" section. They give credit to the person who has made the change and they reference the issue which has been fixed by the change.
 
-All changes on configuration options must be reflected in `Tests/IntegrationTests/default_rule_configurations.yml`. This can be achieved by running `swift run swiftlint-dev rules register`. Running this command is also necessary when new rules got added or removed to (un-)register them from/in the list of built-in rules and tests verifying all examples in rule descriptions.
+All changes on configuration options must be reflected in `Tests/IntegrationTests/Resources/default_rule_configurations.yml`. This can be achieved by running `swift run swiftlint-dev rules register`. Running this command is also necessary when new rules got added or removed to (un-)register them from/in the list of built-in rules and tests verifying all examples in rule descriptions.
 
 For some rules, there are dedicated tests in `Tests/BuiltInRulesTests`. However, they are typically not required as all the examples in the rule descriptions are automatically tested. The examples in the rule descriptions are also used to generate documentation for the rules. If an example presents a very pathological case, that's helpful for testing but not for user documentation, you can add the `excludeFromDocumentation: true` parameter to the example initializer. Important is that all examples in the rule description are verified by running `<RuleName>RuleGeneratedTests` for rule modified rules.
 

.swiftlint.yml

@@ -8,7 +8,7 @@ excluded:
   - assets
   - Tests/BuiltInRulesTests/Resources
   - Tests/FileSystemAccessTests/Resources
-  - Tests/IntegrationTests/PathHierarchyFixtures
+  - Tests/IntegrationTests/Resources
 
 # Enabled/disabled rules
 analyzer_rules:

Package.swift

@@ -207,8 +207,7 @@ let package = Package(
                 "TestHelpers",
             ],
             exclude: [
-                "default_rule_configurations.yml",
-                "PathHierarchyFixtures",
+                "Resources",
             ],
             swiftSettings: swiftFeatures + targetedConcurrency // Set to strict once SwiftLintFramework is updated
         ),

Source/swiftlint-dev/Rules+Register.swift

@@ -269,6 +269,7 @@ private extension SwiftLintDev.Rules.Register {
             .write(
                 to: testsParentDirectory
                     .appendingPathComponent("IntegrationTests", isDirectory: true)
+                    .appendingPathComponent("Resources", isDirectory: true)
                     .appendingPathComponent("default_rule_configurations.yml", isDirectory: false),
                 atomically: true,
                 encoding: .utf8

Tests/BUILD

@@ -166,7 +166,7 @@ swift_library(
 swift_test(
     name = "IntegrationTests",
     data = [
-        "IntegrationTests/default_rule_configurations.yml",
+        "IntegrationTests/Resources/default_rule_configurations.yml",
         "//:LintInputs",
     ],
     visibility = ["//visibility:public"],

Tests/IntegrationTests/ConfigHierarchyPathResolutionTests.swift renamed to Tests/IntegrationTests/ConfigPathResolutionTests.swift

@@ -3,11 +3,11 @@ import SwiftLintFramework
 import TestHelpers
 import XCTest
 
-final class ConfigHierarchyPathResolutionTests: SwiftLintTestCase {
+final class ConfigPathResolutionTests: SwiftLintTestCase {
     private func fixturePath(_ scenario: String) -> String {
         #filePath.bridge()
             .deletingLastPathComponent
-            .stringByAppendingPathComponent("PathHierarchyFixtures")
+            .stringByAppendingPathComponent("Resources")
             .stringByAppendingPathComponent(scenario)
     }
 
@@ -33,15 +33,15 @@ final class ConfigHierarchyPathResolutionTests: SwiftLintTestCase {
 
     func testParentChildSameDirectory() {
         XCTAssertEqual(
-            lintableFilePaths(in: "scenario1_parent_child_same_dir", configFile: "parent.yml"),
+            lintableFilePaths(in: "_1_parent_child_same_dir", configFile: "parent.yml"),
             ["Sources/CoreFile.swift"]
         )
     }
 
     func testParentChildDifferentDirectories() {
         XCTAssertEqual(
             lintableFilePaths(
-                in: "scenario2_parent_child_different_dirs",
+                in: "_2_parent_child_different_dirs",
                 configFile: "project/.swiftlint.yml",
                 inPath: "project"
             ),
@@ -52,7 +52,7 @@ final class ConfigHierarchyPathResolutionTests: SwiftLintTestCase {
     func testChildOverridesParentExclusion() {
         XCTAssertEqual(
             lintableFilePaths(
-                in: "scenario3_child_overrides_parent_exclusion",
+                in: "_3_child_overrides_parent_exclusion",
                 configFile: "project/.swiftlint.yml",
                 inPath: "project"
             ),
@@ -62,22 +62,22 @@ final class ConfigHierarchyPathResolutionTests: SwiftLintTestCase {
 
     func testParentIncludesChildExcludes() {
         XCTAssertEqual(
-            lintableFilePaths(in: "scenario1_parent_child_same_dir", configFile: "parent.yml"),
+            lintableFilePaths(in: "_1_parent_child_same_dir", configFile: "parent.yml"),
             ["Sources/CoreFile.swift"]
         )
     }
 
     func testNestedConfigurationBasic() {
         XCTAssertEqual(
-            lintableFilePaths(in: "scenario4_nested_basic", configFile: ".swiftlint.yml"),
+            lintableFilePaths(in: "_4_nested_basic", configFile: ".swiftlint.yml"),
             ["ModuleA/File.swift", "ModuleA/Generated/File.swift", "ModuleB/File.swift"]
         )
     }
 
     func testWildcardPatternCount() {
         XCTAssertEqual(
             lintableFilePaths(
-                in: "scenario6_wildcard_patterns",
+                in: "_5_wildcard_patterns",
                 configFile: "project/.swiftlint.yml",
                 inPath: "project"
             ),
@@ -88,7 +88,7 @@ final class ConfigHierarchyPathResolutionTests: SwiftLintTestCase {
     func testLintChildFolder() {
         XCTAssertEqual(
             lintableFilePaths(
-                in: "scenario2_parent_child_different_dirs",
+                in: "_2_parent_child_different_dirs",
                 configFile: "project/.swiftlint.yml",
                 inPath: "project"
             ),
@@ -99,7 +99,7 @@ final class ConfigHierarchyPathResolutionTests: SwiftLintTestCase {
     func testEmptyIncludedDefaultsToAll() {
         XCTAssertEqual(
             lintableFilePaths(
-                in: "scenario7_wildcard_regression_5953",
+                in: "_6_wildcards_from_nested_folder",
                 configFile: ".swiftlint-exclude-thirdparty.yml"
             ),
             [
@@ -113,25 +113,25 @@ final class ConfigHierarchyPathResolutionTests: SwiftLintTestCase {
 
     func testMultipleLevelsOfExclusion() {
         XCTAssertEqual(
-            lintableFilePaths(in: "scenario1_parent_child_same_dir", configFile: "parent.yml"),
+            lintableFilePaths(in: "_1_parent_child_same_dir", configFile: "parent.yml"),
             ["Sources/CoreFile.swift"]
         )
     }
 
     func testConfigFromParentFolder() {
         XCTAssertEqual(
-            lintableFilePaths(in: "scenario7_wildcard_regression_5953", configFile: ".swiftlint.yml"),
+            lintableFilePaths(in: "_6_wildcards_from_nested_folder", configFile: ".swiftlint.yml"),
             ["MyProject/Sources/App.swift"]
         )
 
         XCTAssertEqual(
-            lintableFilePaths(in: "scenario7_wildcard_regression_5953/MyProject", configFile: "../.swiftlint.yml"),
+            lintableFilePaths(in: "_6_wildcards_from_nested_folder/MyProject", configFile: "../.swiftlint.yml"),
             ["Sources/App.swift"]
         )
     }
 
     func testNestedConfigurationAppliesOnlyToSubdirectory() {
-        let scenarioPath = fixturePath("scenario4_nested_basic")
+        let scenarioPath = fixturePath("_4_nested_basic")
         let config = Configuration(configurationFiles: [])
 
         let moduleAFile = SwiftLintFile(
@@ -155,7 +155,7 @@ final class ConfigHierarchyPathResolutionTests: SwiftLintTestCase {
     }
 
     func testNestedConfigurationDisabledByConfigFlag() {
-        let scenarioPath = fixturePath("scenario4_nested_basic")
+        let scenarioPath = fixturePath("_4_nested_basic")
         let configFile = scenarioPath.stringByAppendingPathComponent("root.yml")
 
         let moduleAFile = SwiftLintFile(