Deduplicate shared configuration between swiftpm plugins

wip

Author: ktoso

.licenseignore

@@ -41,3 +41,4 @@ gradlew.bat
 **/gradlew.bat
 **/ci-validate.sh
 **/DO_NOT_EDIT.txt
+Plugins/**/_PluginsShared

Package.swift

@@ -128,9 +128,9 @@ let package = Package(
 
     // ==== Plugin for wrapping Java classes in Swift
     .plugin(
-      name: "JExtractSwiftPlugin",
+      name: "SwiftJavaPlugin",
       targets: [
-        "JExtractSwiftPlugin"
+        "SwiftJavaPlugin"
       ]
     ),
     .plugin(
@@ -347,7 +347,7 @@ let package = Package(
     ),
 
     .plugin(
-      name: "JExtractSwiftPlugin",
+      name: "SwiftJavaPlugin",
       capability: .buildTool(),
       dependencies: [
         "JExtractSwiftTool"

Plugins/JExtractSwiftCommandPlugin/JExtractSwiftCommandPlugin.swift

@@ -16,9 +16,10 @@ import Foundation
 import PackagePlugin
 
 @main
-final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
+final class JExtractSwiftCommandPlugin: SwiftJavaPluginProtocol, BuildToolPlugin, CommandPlugin {
 
-  var verbose: Bool = false
+  var pluginName: String = "swift-java-command"
+  var verbose: Bool = getEnvironmentBool("SWIFT_JAVA_VERBOSE")
 
   /// Build the target before attempting to extract from it.
   /// This avoids trying to extract from broken sources.
@@ -48,8 +49,8 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
       }
 
     for target in context.package.targets {
-      guard let configPath = getSwiftJavaConfig(target: target) else {
-        log("Skipping target '\(target.name)', has no 'swift-java.config' file")
+      guard getSwiftJavaConfigPath(target: target) != nil else {
+        log("[swift-java-command] Skipping jextract step: Missing swift-java.config for target '\(target.name)'")
         continue
       }
 
@@ -73,21 +74,15 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
     let sourceDir = target.directory.string
 
     let configuration = try readConfiguration(sourceDir: "\(sourceDir)")
-
-    // We use the the usual maven-style structure of "src/[generated|main|test]/java/..."
-    // that is common in JVM ecosystem
-    let outputDirectoryJava = context.pluginWorkDirectoryURL
-      .appending(path: "src")
-      .appending(path: "generated")
-      .appending(path: "java")
-    let outputDirectorySwift = context.pluginWorkDirectoryURL
-      .appending(path: "Sources")
+    guard let javaPackage = configuration.javaPackage else {
+      throw SwiftJavaPluginError.missingConfiguration(sourceDir: "\(sourceDir)", key: "javaPackage")
+    }
 
     var arguments: [String] = [
       "--swift-module", sourceModule.name,
-      "--package-name", configuration.javaPackage,
-      "--output-directory-java", outputDirectoryJava.path(percentEncoded: false),
-      "--output-directory-swift", outputDirectorySwift.path(percentEncoded: false),
+      "--package-name", javaPackage,
+      "--output-directory-java", context.outputDirectoryJava.path(percentEncoded: false),
+      "--output-directory-swift", context.outputDirectorySwift.path(percentEncoded: false),
       // TODO: "--build-cache-directory", ...
       //       Since plugins cannot depend on libraries we cannot detect what the output files will be,
       //       as it depends on the contents of the input files. Therefore we have to implement this as a prebuild plugin.
@@ -100,14 +95,17 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
 
   /// Perform the command on a specific target.
   func performCommand(context: PluginContext, target: Target, extraArguments _: [String]) throws {
-    // Make sure the target can builds properly
-    try self.packageManager.build(.target(target.name), parameters: .init())
-
     guard let sourceModule = target.sourceModule else { return }
 
     if self.buildInputs {
+      // Make sure the target can builds properly
       log("Pre-building target '\(target.name)' before extracting sources...")
-      try self.packageManager.build(.target(target.name), parameters: .init())
+      let targetBuildResult = try self.packageManager.build(.target(target.name), parameters: .init())
+
+      guard targetBuildResult.succeeded else {
+        print("[swift-java-command] Build of '\(target.name)' failed: \(targetBuildResult.logText)")
+        return
+      }
     }
 
     let arguments = try prepareJExtractArguments(context: context, target: target)
@@ -124,7 +122,13 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
       log("Post-extract building products with target '\(target.name)'...")
       for product in context.package.products where product.targets.contains(where: { $0.id == target.id }) {
         log("Post-extract building product '\(product.name)'...")
-        try self.packageManager.build(.product(product.name), parameters: .init())
+        let buildResult = try self.packageManager.build(.product(product.name), parameters: .init())
+        
+        if buildResult.succeeded {
+          log("Post-extract build: " + "done".green + ".")
+        } else {
+          log("Post-extract build: " + "done".red + "!")
+        }
       }
     }
   }
@@ -146,16 +150,15 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
     }
   }
 
-  func log(_ message: @autoclosure () -> String, terminator: String = "\n") {
-    if self.verbose {
-      print("[swift-java-command] \(message())", terminator: terminator)
-    }
-  }
 }
 
 // Mini coloring helper, since we cannot have dependencies we keep it minimal here
 extension String {
+  var red: String {
+    "\u{001B}[0;31m" + "\(self)" + "\u{001B}[0;0m"
+  }
   var green: String {
     "\u{001B}[0;32m" + "\(self)" + "\u{001B}[0;0m"
   }
-}
+}
+

Plugins/JExtractSwiftCommandPlugin/PluginsShared/Configuration.swift

@@ -0,0 +1 @@
+../PluginsShared

Plugins/JExtractSwiftCommandPlugin/_PluginsShared

@@ -18,7 +18,11 @@ import PackagePlugin
 fileprivate let Java2SwiftConfigFileName = "Java2Swift.config"
 
 @main
-struct Java2SwiftBuildToolPlugin: BuildToolPlugin {
+struct Java2SwiftBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
+
+  var pluginName: String = "swift-java-javac"
+  var verbose: Bool = getEnvironmentBool("SWIFT_JAVA_VERBOSE")
+  
   func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {
     guard let sourceModule = target.sourceModule else { return [] }
 
@@ -87,9 +91,14 @@ struct Java2SwiftBuildToolPlugin: BuildToolPlugin {
     }
     arguments.append(configFile.path(percentEncoded: false))
 
+    guard let classes = config.classes else {
+      log("Config at \(configFile) did not have 'classes' configured, skipping java2swift step.")
+      return []
+    }
+    
     /// Determine the set of Swift files that will be emitted by the Java2Swift
     /// tool.
-    let outputSwiftFiles = config.classes.map { (javaClassName, swiftName) in
+    let outputSwiftFiles = classes.map { (javaClassName, swiftName) in
       let swiftNestedName = swiftName.replacingOccurrences(of: ".", with: "+")
       return outputDirectory.appending(path: "\(swiftNestedName).swift")
     }
@@ -125,10 +134,15 @@ struct Java2SwiftBuildToolPlugin: BuildToolPlugin {
         arguments += [ "--swift-native-implementation", className]
       }
     }
+    
+    guard let classes = config.classes else {
+      log("Skipping java2swift step: Missing 'classes' key in swift-java.config at '\(configFile.path)'")
+      return []
+    }
 
     return [
       .buildCommand(
-        displayName: "Wrapping \(config.classes.count) Java classes target \(sourceModule.name) in Swift",
+        displayName: "Wrapping \(classes.count) Java classes target \(sourceModule.name) in Swift",
         executable: try context.tool(named: "Java2Swift").url,
         arguments: arguments,
         inputFiles: [ configFile ] + compiledClassFiles,
@@ -137,25 +151,3 @@ struct Java2SwiftBuildToolPlugin: BuildToolPlugin {
     ]
   }
 }
-
-// Note: the JAVA_HOME environment variable must be set to point to where
-// Java is installed, e.g.,
-//   Library/Java/JavaVirtualMachines/openjdk-21.jdk/Contents/Home.
-func findJavaHome() -> String {
-  if let home = ProcessInfo.processInfo.environment["JAVA_HOME"] {
-    return home
-  }
-
-  // This is a workaround for envs (some IDEs) which have trouble with
-  // picking up env variables during the build process
-  let path = "\(FileManager.default.homeDirectoryForCurrentUser.path()).java_home"
-  if let home = try? String(contentsOfFile: path, encoding: .utf8) {
-    if let lastChar = home.last, lastChar.isNewline {
-      return String(home.dropLast())
-    }
-
-    return home
-  }
-
-  fatalError("Please set the JAVA_HOME environment variable to point to where Java is installed.")
-}

Plugins/JExtractSwiftPlugin/PluginsShared/Configuration.swift

@@ -0,0 +1 @@
+../PluginsShared