feat: allow to pass path to swift tests file (#24)

Allow to provide a path for pointing to the plugin tests file.
Also fixes the plugin tests import.

Author: jcesarmobile

README.md

@@ -27,6 +27,8 @@ OPTIONS:
   --objc-file <objc-file> Objective-C file containing CAP_PLUGIN macro
   --swift-file <swift-file>
                           Swift file containing class inheriting from CAPPlugin
+  --swift-tests-file <swift-tests-file>
+                          Swift file containing plugin tests
   -h, --help              Show help information.
 ```
 

Sources/CapacitorPluginTools/CapacitorPluginPackage.swift

@@ -110,6 +110,25 @@ public class CapacitorPluginPackage {
         throw .cantFindPluginSwift(fileName)
     }
 
+    public func findSwiftTestsPluginFile() -> URL? {
+        if let oldPlugin {
+            let fileName = "\(oldPlugin.capacitorPlugin.identifier)Tests.swift"
+            let fileURL = iosSrcDirectoryURL.appending(path: "PluginTests").appending(path: fileName)
+            if (try? fileURL.checkResourceIsReachable()) == true {
+                return fileURL
+            } else {
+                print("Warning: file \(fileURL.path()) not found, trying PluginTests.swift")
+            }
+
+            let backupFileURL = iosSrcDirectoryURL.appending(path: "PluginTests").appending(path: "PluginTests.swift")
+
+            if (try? backupFileURL.checkResourceIsReachable()) == true {
+                return backupFileURL
+            }
+        }
+        return nil
+    }
+
     public func findPodspecFile() throws -> URL {
         let fileName = packageJSONParser.podspec
 

Sources/CommandLineTool/CLIArguments.swift

@@ -5,10 +5,12 @@ extension Cap2SPM {
     func getUrlsForArgs(package: CapacitorPluginPackage,
                         objcHeader: String?,
                         objcFile: String?,
-                        swiftFile: String?) throws -> (URL, URL, URL) {
+                        swiftFile: String?,
+                        swiftTestsFile: String?) throws -> (URL, URL, URL, URL?) {
 
         let mFileURL: URL
         let swiftFileURL: URL
+        let swiftTestsFileURL: URL?
         let hFileURL: URL
 
         if let objcHeader {
@@ -30,6 +32,12 @@ extension Cap2SPM {
             swiftFileURL = try package.findSwiftPluginFile()
         }
 
-        return (mFileURL, swiftFileURL, hFileURL)
+        if let swiftTestsFile {
+            swiftTestsFileURL = URL(filePath: swiftTestsFile, directoryHint: .notDirectory)
+        } else {
+            swiftTestsFileURL = package.findSwiftTestsPluginFile()
+        }
+
+        return (mFileURL, swiftFileURL, hFileURL, swiftTestsFileURL)
     }
 }

Sources/CommandLineTool/CLIFileOperations.swift

@@ -89,4 +89,10 @@ extension Cap2SPM {
         }
         try gitignoreText.write(to: fileURL, atomically: true, encoding: .utf8)
     }
+
+    func modifyTestsFile(at fileURL: URL, with target: String) throws {
+        var testsText = try String(contentsOf: fileURL, encoding: .utf8)
+        testsText.replace("@testable import Plugin\n", with: "@testable import \(target)\n")
+        try testsText.write(to: fileURL, atomically: true, encoding: .utf8)
+    }
 }

Sources/CommandLineTool/cap2spm.swift

@@ -18,20 +18,25 @@ struct Cap2SPM: ParsableCommand {
     @Option(help: "Swift file containing class inheriting from CAPPlugin")
     var swiftFile: String?
 
+    @Option(help: "Swift file containing plugin tests")
+    var swiftTestsFile: String?
+
     @Argument(help: "Plugin Directory")
     var pluginDirectory: String
 
     mutating func run() throws {
         let mFileURL: URL
         let swiftFileURL: URL
+        let swiftTestsFileURL: URL?
         let hFileURL: URL
 
         let capacitorPluginPackage = try CapacitorPluginPackage(directoryName: pluginDirectory)
 
-        (mFileURL, swiftFileURL, hFileURL) = try getUrlsForArgs(package: capacitorPluginPackage,
+        (mFileURL, swiftFileURL, hFileURL, swiftTestsFileURL) = try getUrlsForArgs(package: capacitorPluginPackage,
                                                                 objcHeader: objcHeader,
                                                                 objcFile: objcFile,
-                                                                swiftFile: swiftFile)
+                                                                swiftFile: swiftFile,
+                                                                swiftTestsFile: swiftTestsFile)
 
 
         let podspecFileURL = try capacitorPluginPackage.findPodspecFile()
@@ -41,6 +46,10 @@ struct Cap2SPM: ParsableCommand {
 
         try capPlugin.modifySwiftFile(at: swiftFileURL)
 
+        if let swiftTestsFileURL {
+            try? modifyTestsFile(at: swiftTestsFileURL, with: capPlugin.identifier)
+        }
+
         let packageGenerator = PackageFileGenerator(packageName: podspec.podName, targetName: capPlugin.identifier)
 
         try packageGenerator.generateFile(at: podspecFileURL)