wip

Author: ktoso

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.
@@ -49,7 +50,7 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
 
     for target in context.package.targets {
       guard getSwiftJavaConfigPath(target: target) != nil else {
-        log("Skipping target '\(target.name)', has no 'swift-java.config' file")
+        log("[swift-java-command] Skipping jextract step: Missing swift-java.config for target '\(target.name)'")
         continue
       }
 
@@ -94,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)
@@ -146,11 +150,6 @@ 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

Plugins/Java2SwiftPlugin/Java2SwiftPlugin.swift

@@ -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,

Plugins/PluginsShared/PluginUtils.swift

@@ -47,6 +47,18 @@ func getSwiftJavaConfigPath(target: Target) -> String? {
   }
 }
 
+func getEnvironmentBool(_ name: String) -> Bool {
+  if let value = ProcessInfo.processInfo.environment[name] {
+    switch value.lowercased() {
+    case "true", "yes", "1": true
+    case "false", "no", "0": false
+    default: false
+    }
+  } else {
+    false
+  }
+}
+
 extension PluginContext {
   var outputDirectoryJava: URL {
     self.pluginWorkDirectoryURL

Plugins/PluginsShared/SwiftJavaPluginErrors.swift renamed to Plugins/PluginsShared/SwiftJavaPlugin+Errors.swift

@@ -13,5 +13,5 @@
 //===----------------------------------------------------------------------===//
 
 enum SwiftJavaPluginError: Error {
-  case missingConfiguration(sourceDir: String, key: String?)
+  case missingConfiguration(sourceDir: String, key: String?, file: String = #file, line: UInt = #line)
 }

Plugins/PluginsShared/SwiftJavaPluginProtocol.swift

@@ -0,0 +1,28 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2024 Apple Inc. and the Swift.org project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of Swift.org project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+protocol SwiftJavaPluginProtocol {
+  var verbose: Bool { get }
+  var pluginName: String { get }
+  
+  func log(_ message: @autoclosure () -> String, terminator: String)
+}
+
+extension SwiftJavaPluginProtocol {
+  func log(_ message: @autoclosure () -> String, terminator: String = "\n") {
+    if self.verbose {
+      print("[swift-java-command] \(message())", terminator: terminator)
+    }
+  }
+}

Plugins/SwiftJavaPlugin/JExtractSwiftPlugin.swift

@@ -16,29 +16,36 @@ import Foundation
 import PackagePlugin
 
 @main
-struct JExtractSwiftBuildToolPlugin: BuildToolPlugin {
+struct JExtractSwiftBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
+
+  var pluginName: String = "swift-java"
+  var verbose: Bool = getEnvironmentBool("SWIFT_JAVA_VERBOSE")
+
   func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {
+    let toolURL = try context.tool(named: "JExtractSwiftTool").url
+    
     guard let sourceModule = target.sourceModule else { return [] }
 
     // Note: Target doesn't have a directoryURL counterpart to directory,
     // so we cannot eliminate this deprecation warning.
-    let sourceDir = target.directory.string
-    
-    let t = target.dependencies.first!
-    switch (t) {
-    case .target(let t):
-      t.sourceModule
-    case .product(let p):
-      p.sourceModules
-    @unknown default:
-      fatalError("Unknown target dependency type: \(t)")
+    for dependency in target.dependencies {
+      switch (dependency) {
+      case .target(let t):
+        t.sourceModule
+      case .product(let p):
+        p.sourceModules
+      @unknown default:
+        fatalError("Unknown target dependency type: \(dependency)")
+      }
     }
 
-    let toolURL = try context.tool(named: "JExtractSwiftTool").url
-    
+    let sourceDir = target.directory.string
     let configuration = try readConfiguration(sourceDir: "\(sourceDir)")
+    
     guard let javaPackage = configuration.javaPackage else {
-      throw SwiftJavaPluginError.missingConfiguration(sourceDir: "\(sourceDir)", key: "javaPackage")
+      // throw SwiftJavaPluginError.missingConfiguration(sourceDir: "\(sourceDir)", key: "javaPackage")
+      log("Skipping jextract step, no 'javaPackage' configuration in \(getSwiftJavaConfigPath(target: target) ?? "")")
+      return []
     }
 
     // We use the the usual maven-style structure of "src/[generated|main|test]/java/..."