Allow tests to initialize non-stubbed dependencies

patrickroteman · patrickroteman · commit 0ed16f2b9914 · 2025-04-17T12:08:38.000-07:00
Add flag `allow-tests-to-init-real-dependencies` that will force all dependency resolver methods to be declared as `internal` rather than `private` or `fileprivate` so that any `@Testable import` of the generated code is able to initialize both the dependency container and access all of the DependencyResolvers. Note that this does **NOT** change any of the test mock generation, this is altering the access level of the **real** dependencies to be able to facilitate customization of test dependencies. It is then possible to mix and match real and mocked dependencies based on your test setup. Previously this was not possible because the MainDependencyContainer initializer was private, along with all of the dependency resolvers. Without setting this flag, there is no impact to code generation so this change is fully backward compatible. For example, now inside of unit tests for some `CoolSampleApp` , you would be able to do this: ``` @testable import CoolSampleApp class ExampleTests: XCTestCase { func testExample() { let realDependencyContainer = MainDependencyContainer() let realDependency = realDependencyContainer.specificDependencyResolver().specificDependency // Test code that actually uses the real dependency } } ``` It is still possible to use the `tests` flag to generate stubbed dependencies and use those alongside each other. For example, you can now mix and match real and mocked dependencies for a class under test to be able to do integration or feature level tests. Continuing the `textExample()` from above, you may see something like this: ``` func testExample() { let realDependencyContainer = MainDependencyContainer() let realDependencyFoo = realDependencyContainer.dependencyFooResolver().dependencyFoo let mockedDependencyContainer = StubbedDependencies() let mockedDependencyBar = StubbedDependencies.dependencyBarDouble let objectUnderTest = SomeClass(foo: realDependencyFoo, bar: mockedDependencyBar) // Actual test logic and validation } ```
diff --git a/.gitignore b/.gitignore
@@ -21,6 +21,7 @@ xcuserdata/
 *.moved-aside
 *.xccheckout
 *.xcscmblueprint
+*DS_Store
 
 ## Obj-C/Swift specific
 *.hmap
diff --git a/.version b/.version
@@ -1 +1 @@
-1.1.6
+1.1.7
diff --git a/Package.resolved b/Package.resolved
@@ -1,15 +1,6 @@
 {
   "object": {
     "pins": [
-      {
-        "package": "Commandant",
-        "repositoryURL": "https://github.com/Carthage/Commandant.git",
-        "state": {
-          "branch": null,
-          "revision": "ab68611013dec67413628ac87c1f29e8427bc8e4",
-          "version": "0.17.0"
-        }
-      },
       {
         "package": "Commander",
         "repositoryURL": "https://github.com/kylef/Commander.git",
@@ -28,15 +19,6 @@
           "version": null
         }
       },
-      {
-        "package": "Nimble",
-        "repositoryURL": "https://github.com/Quick/Nimble.git",
-        "state": {
-          "branch": null,
-          "revision": "7a46a5fc86cb917f69e3daf79fcb045283d8f008",
-          "version": "8.1.2"
-        }
-      },
       {
         "package": "PathKit",
         "repositoryURL": "https://github.com/kylef/PathKit.git",
@@ -46,15 +28,6 @@
           "version": "0.9.2"
         }
       },
-      {
-        "package": "Quick",
-        "repositoryURL": "https://github.com/Quick/Quick.git",
-        "state": {
-          "branch": null,
-          "revision": "09b3becb37cb2163919a3842a4c5fa6ec7130792",
-          "version": "2.2.1"
-        }
-      },
       {
         "package": "Rainbow",
         "repositoryURL": "https://github.com/onevcat/Rainbow",
@@ -78,8 +51,8 @@
         "repositoryURL": "https://github.com/jpsim/SourceKitten.git",
         "state": {
           "branch": null,
-          "revision": "77a4dbbb477a8110eb8765e3c44c70fb4929098f",
-          "version": "0.29.0"
+          "revision": "eb6656ed26bdef967ad8d07c27e2eab34dc582f2",
+          "version": "0.37.0"
         }
       },
       {
@@ -91,22 +64,31 @@
           "version": "0.9.2"
         }
       },
+      {
+        "package": "swift-argument-parser",
+        "repositoryURL": "https://github.com/apple/swift-argument-parser.git",
+        "state": {
+          "branch": null,
+          "revision": "41982a3656a71c768319979febd796c6fd111d5c",
+          "version": "1.5.0"
+        }
+      },
       {
         "package": "SWXMLHash",
         "repositoryURL": "https://github.com/drmohundro/SWXMLHash.git",
         "state": {
           "branch": null,
-          "revision": "9183170d20857753d4f331b0ca63f73c60764bf3",
-          "version": "5.0.2"
+          "revision": "a853604c9e9a83ad9954c7e3d2a565273982471f",
+          "version": "7.0.2"
         }
       },
       {
         "package": "Yams",
         "repositoryURL": "https://github.com/jpsim/Yams.git",
         "state": {
           "branch": null,
-          "revision": "c947a306d2e80ecb2c0859047b35c73b8e1ca27f",
-          "version": "2.0.0"
+          "revision": "b4b8042411dc7bbb696300a34a4bf3ba1b7ad19b",
+          "version": "5.3.1"
         }
       }
     ]
diff --git a/Package.swift b/Package.swift
@@ -1,28 +1,32 @@
-// swift-tools-version:5.0
+// swift-tools-version:5.5
 import PackageDescription
 
 let package = Package(
     name: "Weaver",
     platforms: [
-       .macOS(.v10_13)
+        .macOS(.v12)
     ],
     products: [
-      .executable(name: "Weaver", targets: ["WeaverMain"])
+        .executable(name: "Weaver", targets: ["WeaverMain"])
     ],
     dependencies: [
-        .package(url: "https://github.com/jpsim/SourceKitten.git", from: "0.27.0"),
+        .package(url: "https://github.com/jpsim/SourceKitten.git", from: "0.37.0"),
         .package(url: "https://github.com/kylef/Commander.git", from: "0.9.0"),
         .package(url: "https://github.com/onevcat/Rainbow", from: "3.0.0"),
-        .package(url: "https://github.com/jpsim/Yams.git", from: "2.0.0"),
+        .package(url: "https://github.com/jpsim/Yams.git", from: "5.0.0"),
         .package(url: "https://github.com/kylef/PathKit.git", from: "0.9.0"),
         .package(url: "https://github.com/scribd/Meta.git", .branch("master")),
         .package(url: "https://github.com/JohnSundell/ShellOut.git", from: "2.2.0")
     ],
     targets: [
-        .target(name: "WeaverCodeGen", dependencies: ["SourceKittenFramework", "Meta", "PathKit"]),
+        .target(name: "WeaverCodeGen", dependencies: [
+            .product(name: "SourceKittenFramework", package: "SourceKitten"),
+            "Meta",
+            "PathKit"
+        ]),
         .testTarget(name: "WeaverCodeGenTests", dependencies: ["WeaverCodeGen"]),
         .target(name: "WeaverCommand", dependencies: ["PathKit", "Commander", "Rainbow", "Yams", "WeaverCodeGen", "ShellOut"]),
         .testTarget(name: "WeaverCommandTests", dependencies: ["WeaverCommand"]),
-        .target(name: "WeaverMain", dependencies: ["WeaverCommand"])
+        .executableTarget(name: "WeaverMain", dependencies: ["WeaverCommand"])
     ]
 )
diff --git a/README.md b/README.md
@@ -549,6 +549,7 @@ Options:
     --ignored-path - Paths to ignore.
     --cache-path - Where the cache gets stored.
     --recursive-off
+    --allow-tests-to-init-real-dependencies - Makes dependency resolvers available to @Testable imports.
     --tests - Activates the test helpers' generation.
     --testable-imports - Modules to imports in the test helpers.
     --swiftlint-disable-all - Disables all swiftlint rules.
@@ -578,6 +579,7 @@ weaver swift --project-path $PROJECT_DIR/$PROJECT_NAME --main-output-path Genera
 - `--platform` - Platform for which the generated code will be compiled (iOS, watchOS, OSX, macOS or tvOS).
 - `--included-imports` - Modules which can be imported in generated files.
 - `--excluded-imports` - Modules which can't be imported in generated files.
+- `--allow_tests_to_init_real_dependencies` - Will declare every DependencyResolver with internal access level so `@Testable import`s can invoke them to initialize real dependencies in tests.
 
 ### Configuration File:
 
diff --git a/Sources/WeaverCodeGen/SwiftGenerator.swift b/Sources/WeaverCodeGen/SwiftGenerator.swift
@@ -28,6 +28,8 @@ public final class SwiftGenerator {
 
     private let mainActor: Bool
 
+    private let allowTestsToInitRealDependencies: Bool
+
     public typealias ImportFilter = (String) -> Bool
     private let importFilter: ImportFilter
     
@@ -39,6 +41,7 @@ public final class SwiftGenerator {
                 testableImports: [String]?,
                 swiftlintDisableAll: Bool,
                 mainActor: Bool,
+                allowTestsToInitRealDependencies: Bool,
                 importFilter: @escaping ImportFilter) throws {
 
         self.dependencyGraph = dependencyGraph
@@ -49,6 +52,7 @@ public final class SwiftGenerator {
         self.testableImports = testableImports?.filter(importFilter)
         self.swiftlintDisableAll = swiftlintDisableAll
         self.mainActor = mainActor
+        self.allowTestsToInitRealDependencies = allowTestsToInitRealDependencies
         self.importFilter = importFilter
     }
     
@@ -77,6 +81,7 @@ public final class SwiftGenerator {
             version,
             testableImports,
             swiftlintDisableAll,
+            allowTestsToInitRealDependencies,
             importFilter
         )
         _file = file
@@ -216,6 +221,8 @@ private final class MetaWeaverFile {
 
     private let mainActor: Bool
 
+    private let allowTestsToInitRealDependencies: Bool
+
     private let importFilter: SwiftGenerator.ImportFilter
     
     // Pre computed data
@@ -244,6 +251,7 @@ private final class MetaWeaverFile {
          _ version: String,
          _ testableImports: [String]?,
          _ swiftlintDisableAll: Bool,
+         _ allowTestsToInitRealDependencies: Bool,
          _ importFilter: @escaping SwiftGenerator.ImportFilter) throws {
         
         self.dependencyGraph = dependencyGraph
@@ -253,6 +261,7 @@ private final class MetaWeaverFile {
         self.version = version
         self.testableImports = testableImports
         self.swiftlintDisableAll = swiftlintDisableAll
+        self.allowTestsToInitRealDependencies = allowTestsToInitRealDependencies
         self.importFilter = importFilter
         
         let desambiguatedDeclarations = try MetaWeaverFile.desambiguatedDeclarations(from: dependencyGraph)
@@ -367,18 +376,17 @@ private extension MetaWeaverFile {
             .adding(member: Property(variable: Variable(name: "provider").with(immutable: true).with(type: .provider)).with(accessLevel: .private))
             .adding(member: EmptyLine())
 
-
+        let accessLevel: Meta.AccessLevel = self.allowTestsToInitRealDependencies ? .internal : .fileprivate
         if self.mainActor == true {
-
             type = type.adding(member: PlainCode(code: """
-fileprivate init(provider: Provider? = nil) {
+\(accessLevel.swiftString) init(provider: Provider? = nil) {
     self.provider = provider ?? Provider()
 }
 """))
 
         } else {
             type = type.adding(member: Function(kind: .`init`(convenience: false, optional: false))
-                .with(accessLevel: .fileprivate)
+                .with(accessLevel: accessLevel)
                 .adding(parameter: FunctionParameter(name: "provider", type: .provider).with(defaultValue: TypeIdentifier.provider.reference | .call()))
                 .adding(members: [
                     Assignment(variable: Reference.named(.`self`) + .named("provider"), value: Reference.named("provider")),
@@ -883,7 +891,7 @@ static func _pushDynamicResolver<Resolver>(_ resolver: Resolver) {
             EmptyLine(),
             Function(kind: .named(publicInterface ?
                 dependencyContainer.type.publicDependencyResolverVariable.name : dependencyContainer.type.dependencyResolverVariable.name))
-                .with(accessLevel: accessLevel)
+                .with(accessLevel: self.allowTestsToInitRealDependencies ? .internal : accessLevel)
                 .with(resultType: containsAmbiguousDeclarations ?
                     dependencyContainer.type.dependencyResolverProxyTypeID : dependencyContainer.type.dependencyResolverTypeID
                 )
@@ -1456,7 +1464,7 @@ private extension MetaWeaverFile {
 
             // MARK: - Provider
 
-            private final class Provider {
+            \(self.allowTestsToInitRealDependencies ? "internal" : "private") final class Provider {
 
                 typealias ParametersCopier = (Provider) -> Void
                 typealias Builder<T> = (ParametersCopier?) -> T
diff --git a/Sources/WeaverCommand/Command.swift b/Sources/WeaverCommand/Command.swift
@@ -13,7 +13,7 @@ import Darwin
 import PathKit
 import Rainbow
 
-private let version = "1.1.6"
+private let version = "1.1.7"
 
 // MARK: - Linker
 
@@ -115,6 +115,7 @@ private enum Parameters {
     static let recursiveOff = OptionalFlag("recursive-off", disabledName: "recursive-on")
     static let pretty = Flag("pretty", default: false)
     static let mainActor = Flag("mainactor", default: false)
+    static let allowTestsToInitRealDependencies = OptionalFlag("allow-tests-to-init-real-dependencies", default: nil)
     static let tests = OptionalFlag("tests", default: nil)
     static let testableImports = VariadicOption<String>("testable-imports", default: [], description: "Modules to import for testing.")
     static let swiftlintDisableAll = OptionalFlag("swiftlint-disable-all", default: nil)
@@ -139,6 +140,7 @@ public let weaverCommand = Group {
         Parameters.cachePath,
         Parameters.recursiveOff,
         Parameters.mainActor,
+        Parameters.allowTestsToInitRealDependencies,
         Parameters.tests,
         Parameters.testableImports,
         Parameters.swiftlintDisableAll,
@@ -156,6 +158,7 @@ public let weaverCommand = Group {
         cachePath,
         recursiveOff,
         mainActor,
+        allowTestsToInitRealDependencies,
         tests,
         testableImports,
         swiftlintDisableAll,
@@ -174,6 +177,7 @@ public let weaverCommand = Group {
             cachePath: cachePath,
             recursiveOff: recursiveOff,
             tests: tests,
+            allowTestsToInitRealDependencies: allowTestsToInitRealDependencies,
             testableImports: testableImports.isEmpty ? nil : testableImports,
             swiftlintDisableAll: swiftlintDisableAll,
             platform: Platform(platform),
@@ -235,6 +239,7 @@ public let weaverCommand = Group {
                 testableImports: configuration.testableImports,
                 swiftlintDisableAll: configuration.swiftlintDisableAll,
                 mainActor: mainActor,
+                allowTestsToInitRealDependencies: configuration.allowTestsToInitRealDependencies,
                 importFilter: configuration.importFilter
             )
 
diff --git a/Sources/WeaverCommand/Configuration.swift b/Sources/WeaverCommand/Configuration.swift
@@ -24,6 +24,7 @@ struct Configuration {
     let cachePath: Path
     let recursiveOff: Bool
     let tests: Bool
+    let allowTestsToInitRealDependencies: Bool
     let testableImports: [String]?
     let swiftlintDisableAll: Bool
     let platform: Platform?
@@ -39,6 +40,7 @@ struct Configuration {
                  cachePath: Path?,
                  recursiveOff: Bool?,
                  tests: Bool?,
+                 allowTestsToInitRealDependencies: Bool?,
                  testableImports: [String]?,
                  swiftlintDisableAll: Bool?,
                  platform: Platform?,
@@ -57,6 +59,7 @@ struct Configuration {
         self.cachePath = cachePath ?? Defaults.cachePath
         self.recursiveOff = recursiveOff ?? Defaults.recursiveOff
         self.tests = tests ?? Defaults.tests
+        self.allowTestsToInitRealDependencies = allowTestsToInitRealDependencies ?? Defaults.allowTestsToInitRealDependencies
         self.testableImports = testableImports
         self.swiftlintDisableAll = swiftlintDisableAll ?? Defaults.swiftlintDisableAll
         self.platform = platform
@@ -74,6 +77,7 @@ struct Configuration {
          cachePath: Path? = nil,
          recursiveOff: Bool? = nil,
          tests: Bool? = nil,
+         allowTestsToInitRealDependencies: Bool? = nil,
          testableImports: [String]? = nil,
          swiftlintDisableAll: Bool? = nil,
          platform: Platform? = nil,
@@ -103,6 +107,7 @@ struct Configuration {
                 cachePath: _cachePath,
                 recursiveOff: recursiveOff,
                 tests: tests,
+                allowTestsToInitRealDependencies: allowTestsToInitRealDependencies,
                 testableImports: testableImports,
                 swiftlintDisableAll: swiftlintDisableAll,
                 platform: platform,
@@ -127,6 +132,7 @@ struct Configuration {
         self.cachePath = cachePath ?? configuration.cachePath
         self.recursiveOff = recursiveOff ?? configuration.recursiveOff
         self.tests = tests ?? configuration.tests
+        self.allowTestsToInitRealDependencies = allowTestsToInitRealDependencies ?? configuration.allowTestsToInitRealDependencies
         self.testableImports = testableImports ?? configuration.testableImports
         self.swiftlintDisableAll = swiftlintDisableAll ?? configuration.swiftlintDisableAll
         self.platform = platform ?? configuration.platform
@@ -172,6 +178,7 @@ extension Configuration {
         static let inputPathStrings = ["."]
         static let detailedResolvers = false
         static let tests = false
+        static let allowTestsToInitRealDependencies = false
         static let swiftlintDisableAll = true
         
         static var projectPath: Path {
@@ -197,6 +204,7 @@ extension Configuration: Decodable {
         case ignoredPaths = "ignored_paths"
         case recursive
         case tests
+        case allowTestsToInitRealDependencies = "allow_tests_to_init_real_dependencies"
         case testableImports = "testable_imports"
         case cachePath = "cache_path"
         case swiftlintDisableAll = "swiftlint_disable_all"
@@ -224,6 +232,7 @@ extension Configuration: Decodable {
             cachePath: try container.decodeIfPresent(Path.self, forKey: .cachePath),
             recursiveOff: recursive.map { !$0 },
             tests: try container.decodeIfPresent(Bool.self, forKey: .tests),
+            allowTestsToInitRealDependencies: try container.decodeIfPresent(Bool.self, forKey: .allowTestsToInitRealDependencies),
             testableImports: try container.decodeIfPresent([String].self, forKey: .testableImports),
             swiftlintDisableAll: try container.decodeIfPresent(Bool.self, forKey: .swiftlintDisableAll),
             platform: try container.decodeIfPresent(Platform.self, forKey: .platform),
