Introduce resolve subcommand and further dis-entangle commands

Author: ktoso

Package.swift

@@ -85,7 +85,7 @@ let javaIncludePath = "\(javaHome)/include"
 let package = Package(
   name: "SwiftJava",
   platforms: [
-    .macOS(.v10_15)
+    .macOS(.v13)
   ],
   products: [
     // ==== JavaKit (i.e. calling Java directly Swift utilities)
@@ -467,6 +467,15 @@ let package = Package(
       ]
     ),
 
+    .testTarget(
+      name: "JavaKitConfigurationSharedTests",
+      dependencies: ["JavaKitConfigurationShared"],
+      swiftSettings: [
+        .swiftLanguageMode(.v5),
+        .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
+      ]
+    ),
+
     .testTarget(
       name: "JExtractSwiftTests",
       dependencies: [

Plugins/JExtractSwiftCommandPlugin/JExtractSwiftCommandPlugin.swift

@@ -82,7 +82,7 @@ final class JExtractSwiftCommandPlugin: SwiftJavaPluginProtocol, BuildToolPlugin
     ]
     // arguments.append(sourceDir) // TODO: we could do this shape maybe? to have the dirs last?
     if let package = configuration?.javaPackage, !package.isEmpty {
-      ["--java-package", package]
+      arguments += ["--java-package", package]
     }
 
     return arguments

Plugins/PluginsShared/SwiftJavaPluginProtocol.swift

@@ -21,8 +21,6 @@ protocol SwiftJavaPluginProtocol {
 
 extension SwiftJavaPluginProtocol {
   func log(_ message: @autoclosure () -> String, terminator: String = "\n") {
-//    if self.verbose {
-      print("[\(pluginName)] \(message())", terminator: terminator)
-//    }
+    print("[\(pluginName)] \(message())", terminator: terminator)
   }
 }

Plugins/SwiftJavaPlugin/SwiftJavaPlugin.swift

@@ -88,24 +88,13 @@ struct SwiftJavaBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
     }
 
     var arguments: [String] = []
-    arguments += argumentsModuleName(sourceModule: sourceModule)
+    arguments += argumentsSwiftModuleDeprecated(sourceModule: sourceModule)
     arguments += argumentsOutputDirectory(context: context)
-    
-    arguments += dependentConfigFiles.flatMap { moduleAndConfigFile in
-      let (moduleName, configFile) = moduleAndConfigFile
-      return [
-        "--depends-on",
-        "\(moduleName)=\(configFile.path(percentEncoded: false))"
-      ]
-    }
+    arguments += argumentsDependedOnConfigs(dependentConfigFiles)
     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 []
-//    }
     let classes = config.classes ?? [:]
-    print("Classes to wrap: \(classes.map(\.key))")
+    print("[swift-java-plugin] Classes to wrap (\(classes.count)): \(classes.map(\.key))")
 
     /// Determine the set of Swift files that will be emitted by the Java2Swift tool.
     // TODO: this is not precise and won't work with more advanced Java files, e.g. lambdas etc.
@@ -165,12 +154,14 @@ struct SwiftJavaBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
         .buildCommand(
           displayName: displayName,
           executable: executable,
-          arguments: [
-            // FIXME: change to 'resolve' subcommand
-            "--fetch", configFile.path(percentEncoded: false),
-            "--swift-module", sourceModule.name,
-            "--output-directory", outputDirectory(context: context, generated: false).path(percentEncoded: false)
-          ],
+          arguments: ["resolve"]
+            + argumentsOutputDirectory(context: context, generated: false)
+            + argumentsSwiftModule(sourceModule: sourceModule)
+            // + [
+            //  // explicitly provide config path
+            //   configFile.path(percentEncoded: false)
+            // ]
+            ,
           environment: [:],
           inputFiles: [configFile],
           outputFiles: fetchDependenciesOutputFiles
@@ -192,28 +183,49 @@ struct SwiftJavaBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
           outputFiles: outputSwiftFiles
         )
       ]
-    } else {
-      log("No Swift output files, skip wrapping")
+    }
+
+    if commands.isEmpty {
+      log("No swift-java commands for module '\(sourceModule.name)'")
     }
 
     return commands
   }
 }
 
 extension SwiftJavaBuildToolPlugin {
-  func argumentsModuleName(sourceModule: Target) -> [String] {
+  func argumentsSwiftModule(sourceModule: Target) -> [String] {
     return [
       "--swift-module", sourceModule.name
     ]
   }
-  
+
+  // FIXME: remove this and the deprecated property inside SwiftJava, this is a workaround
+  //        since we cannot have the same option in common options and in the top level
+  //        command from which we get into sub commands. The top command will NOT have this option.
+  func argumentsSwiftModuleDeprecated(sourceModule: Target) -> [String] {
+    return [
+      "--swift-module-deprecated", sourceModule.name
+    ]
+  }
+
   func argumentsOutputDirectory(context: PluginContext, generated: Bool = true) -> [String] {
     return [
       "--output-directory",
       outputDirectory(context: context, generated: generated).path(percentEncoded: false)
     ]
   }
-  
+
+  func argumentsDependedOnConfigs(_ dependentConfigFiles: [(String, URL)]) -> [String] {
+    dependentConfigFiles.flatMap { moduleAndConfigFile in
+      let (moduleName, configFile) = moduleAndConfigFile
+      return [
+        "--depends-on",
+        "\(moduleName)=\(configFile.path(percentEncoded: false))"
+      ]
+    }
+  }
+
   func outputDirectory(context: PluginContext, generated: Bool = true) -> URL {
     let dir = context.pluginWorkDirectoryURL
     if generated {

Samples/JavaDependencySampleApp/%

@@ -3,4 +3,12 @@
 set -e
 set -x
 
+# invoke resolve as part of a build run
 swift run --disable-sandbox
+
+# explicitly invoke resolve without explicit path or dependency
+# the dependencies should be uses from the --swift-module
+.build/plugins/tools/debug/SwiftJavaTool-tool resolve \
+  Sources/JavaCommonsCSV/swift-java.config \
+  --swift-module JavaCommonsCSV \
+  --output-directory .build/plugins/outputs/javadependencysampleapp/JavaCommonsCSV/destination/SwiftJavaPlugin/

Samples/JavaDependencySampleApp/ci-validate.sh

@@ -46,11 +46,7 @@ public struct Configuration: Codable {
   public var classpath: String? = nil
 
   public var classpathEntries: [String] {
-    guard let classpath else {
-      return []
-    }
-
-    return classpath.split(separator: ":").map(String.init)
+    return classpath?.split(separator: ":").map(String.init) ?? []
   }
 
   /// The Java classes that should be translated to Swift. The keys are
@@ -80,6 +76,12 @@ public struct JavaDependencyDescriptor: Hashable, Codable {
   public var artifactID: String
   public var version: String
 
+  public init(groupID: String, artifactID: String, version: String) {
+    self.groupID = groupID
+    self.artifactID = artifactID
+    self.version = version
+  }
+
   public init(from decoder: any Decoder) throws {
     let container = try decoder.singleValueContainer()
     let string = try container.decode(String.self)

Sources/JavaKitConfigurationShared/Configuration.swift

@@ -0,0 +1,48 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+
+// Regex is not sendable yet so we can't cache it in a let
+fileprivate var GradleDependencyDescriptorRegex: Regex<(Substring, Substring, Substring, Substring)> {
+  try! Regex(#"^([^:]+):([^:]+):(\d[^:]+)$"#) // TODO: improve the regex to be more precise
+}
+
+// note: can't use `package` access level since it would break in usage in plugins in `_PluginsShared`.
+public func parseDependencyDescriptor(_ descriptor: String) -> JavaDependencyDescriptor? {
+  guard let match = try? GradleDependencyDescriptorRegex.firstMatch(in: descriptor) else {
+    return nil
+  }
+
+  let groupID = String(match.1)
+  let artifactID = String(match.2)
+  let version = String(match.3)
+
+  return JavaDependencyDescriptor(groupID: groupID, artifactID: artifactID, version: version)
+}
+
+// note: can't use `package` access level since it would break in usage in plugins in `_PluginsShared`.
+public func parseDependencyDescriptors(_ string: String) -> [JavaDependencyDescriptor] {
+  let descriptors = string.components(separatedBy: ",")
+  var parsedDependencies: [JavaDependencyDescriptor] = []
+  parsedDependencies.reserveCapacity(descriptors.count)
+
+  for descriptor in descriptors {
+    if let dependency = parseDependencyDescriptor(descriptor) {
+      parsedDependencies.append(dependency)
+    }
+  }
+
+  return parsedDependencies
+}

Sources/JavaKitConfigurationShared/GradleDependencyParsing.swift

@@ -16,11 +16,11 @@ import Foundation
 import JavaKitConfigurationShared
 
 extension JavaTranslator {
-  /// Read a configuration file from the given URL.
-  package static func readConfiguration(from url: URL) throws -> Configuration {
-    let contents = try Data(contentsOf: url)
-    return try JSONDecoder().decode(Configuration.self, from: contents)
-  }
+//  /// Read a configuration file from the given URL.
+//  package static func readConfiguration(from url: URL) throws -> Configuration {
+//    let contents = try Data(contentsOf: url)
+//    return try JSONDecoder().decode(Configuration.self, from: contents)
+//  }
 
   /// Load the configuration file with the given name to populate the known set of
   /// translated Java classes.

Sources/SwiftJavaLib/JavaTranslator+Configuration.swift

@@ -66,42 +66,11 @@ extension SwiftJava {
 
 extension SwiftJava.ConfigureCommand {
   mutating func runSwiftJavaCommand(config: inout Configuration) async throws {
-    // Form a class path from all of our input sources:
-    //   * Command-line option --classpath
-    let classpathOptionEntries: [String] = self.commonJVMOptions.classpath.flatMap { $0.split(separator: ":").map(String.init) }
-    let classpathFromEnv = ProcessInfo.processInfo.environment["CLASSPATH"]?.split(separator: ":").map(String.init) ?? []
-    let classpathFromConfig: [String] = config.classpath?.split(separator: ":").map(String.init) ?? []
-    print("[debug][swift-java] Base classpath from config: \(classpathFromConfig)")
-
-    var classpathEntries: [String] = classpathFromConfig
-
-    let swiftJavaCachedModuleClasspath = findSwiftJavaClasspaths(in:
-    // self.effectiveCacheDirectory ??
-    FileManager.default.currentDirectoryPath)
-    print("[debug][swift-java] Classpath from *.swift-java.classpath files: \(swiftJavaCachedModuleClasspath)")
-    classpathEntries += swiftJavaCachedModuleClasspath
-
-    if !classpathOptionEntries.isEmpty {
-      print("[debug][swift-java] Classpath from options: \(classpathOptionEntries)")
-      classpathEntries += classpathOptionEntries
-    } else {
-      // * Base classpath from CLASSPATH env variable
-      print("[debug][swift-java] Classpath from environment: \(classpathFromEnv)")
-      classpathEntries += classpathFromEnv
-    }
-
-    let extraClasspath = input ?? "" // FIXME: just use the -cp as usual
-    let extraClasspathEntries = extraClasspath.split(separator: ":").map(String.init)
-    print("[debug][swift-java] Extra classpath: \(extraClasspathEntries)")
-    classpathEntries += extraClasspathEntries
+    let classpathEntries =
+      self.configureCommandJVMClasspath(effectiveSwiftModuleURL: self.effectiveSwiftModuleURL, config: config)
 
-    // Bring up the Java VM when necessary
-
-    if logLevel >= .debug {
-      let classpathString = classpathEntries.joined(separator: ":")
-      print("[debug][swift-java] Initialize JVM with classpath: \(classpathString)")
-    }
-    let jvm = try JavaVirtualMachine.shared(classpath: classpathEntries)
+    let jvm =
+      try self.makeJVM(classpathEntries: classpathEntries)
 
     try emitConfiguration(classpath: self.commonJVMOptions.classpath, environment: jvm.environment())
   }
@@ -178,6 +147,7 @@ extension SwiftJava.ConfigureCommand {
     // Write the file.
     try writeContents(
       contents,
+      outputDirectory: self.actualOutputDirectory,
       to: "swift-java.config",
       description: "swift-java configuration file"
     )