writing swift-java.classpath per module now

Author: ktoso

JavaKit/src/main/java/org/swift/javakit/dependencies/DependencyResolver.java

@@ -29,6 +29,8 @@
  * Fetches dependencies using the Gradle resolver and returns the resulting classpath which includes
  * the fetched dependency and all of its dependencies.
  */
+@UsedFromSwift
+@SuppressWarnings("unused")
 public class DependencyResolver {
 
     private static final String COMMAND_OUTPUT_LINE_PREFIX_CLASSPATH = "CLASSPATH:";
@@ -48,7 +50,6 @@ public class DependencyResolver {
     public static String resolveDependenciesToClasspath(String projectBaseDirectoryString, String[] dependencies) throws IOException {
         try {
             simpleLog("Fetch dependencies: " + Arrays.toString(dependencies));
-            simpleLog("Classpath: " + System.getProperty("java.class.path"));
             var projectBasePath = new File(projectBaseDirectoryString).toPath();
 
             File projectDir = Files.createTempDirectory("java-swift-dependencies").toFile();

Plugins/Java2SwiftPlugin/Java2SwiftPlugin.swift

@@ -97,17 +97,23 @@ struct Java2SwiftBuildToolPlugin: SwiftJavaPluginProtocol, 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 []
-    }
-    
+//    guard let classes = config.classes else {
+//      log("Config at \(configFile) did not have 'classes' configured, skipping java2swift step.")
+//      return []
+//    }
+    let classes = config.classes ?? [:]
+
     /// Determine the set of Swift files that will be emitted by the Java2Swift
     /// tool.
     let outputSwiftFiles = classes.map { (javaClassName, swiftName) in
       let swiftNestedName = swiftName.replacingOccurrences(of: ".", with: "+")
       return outputDirectory.appending(path: "\(swiftNestedName).swift")
     }
+    
+    arguments += [
+      "--cache-directory",
+      context.pluginWorkDirectoryURL.path(percentEncoded: false)
+    ]
 
     // Find the Java .class files generated from prior plugins.
     let compiledClassFiles = sourceModule.pluginGeneratedResources.filter { url in
@@ -141,19 +147,17 @@ struct Java2SwiftBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
       }
     }
 
-    guard let classes = config.classes else {
-      log("Skipping java2swift step: Missing 'classes' key in swift-java.config at '\(configFile.path)'")
-      return []
-    }
-
     let executable = try context.tool(named: "Java2Swift").url
 
     return [
       .buildCommand(
-        displayName: "Wrapping \(classes.count) Java classes target \(sourceModule.name) in Swift",
+        displayName: "Wrapping \(classes.count) Java classes target in Swift target '\(sourceModule.name)'",
         executable: executable,
         arguments: arguments,
-        inputFiles: [ configFile ] + compiledClassFiles,
+        inputFiles: compiledClassFiles + [
+          configFile,
+          context.cachedClasspathFile(moduleName: sourceModule.name)
+        ],
         outputFiles: outputSwiftFiles
       )
     ]

Plugins/PluginsShared/PluginUtils.swift

@@ -71,4 +71,9 @@ extension PluginContext {
     self.pluginWorkDirectoryURL
       .appending(path: "Sources")
   }
+  
+  func cachedClasspathFile(moduleName: String) -> URL {
+    self.pluginWorkDirectoryURL
+      .appending(path: "\(moduleName)", directoryHint: .notDirectory)
+  }
 }

Samples/JavaDependencySampleApp/Sources/JavaCommonsCSV/swift-java.config

@@ -1,7 +1,8 @@
 {
   "classes" : {
-
+    "org.apache.commons.io.FilenameUtils" : "FilenameUtils"
   },
+  "classpath" : "\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/org.apache.commons\/commons-csv\/1.12.0\/c77e053d7189bc0857f8d323ab61cb949965fbd1\/commons-csv-1.12.0.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/commons-io\/commons-io\/2.17.0\/ddcc8433eb019fb48fe25207c0278143f3e1d7e2\/commons-io-2.17.0.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/commons-codec\/commons-codec\/1.17.1\/973638b7149d333563584137ebf13a691bb60579\/commons-codec-1.17.1.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/org.apache.commons\/commons-csv\/1.12.0\/c77e053d7189bc0857f8d323ab61cb949965fbd1\/commons-csv-1.12.0.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/commons-io\/commons-io\/2.17.0\/ddcc8433eb019fb48fe25207c0278143f3e1d7e2\/commons-io-2.17.0.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/commons-codec\/commons-codec\/1.17.1\/973638b7149d333563584137ebf13a691bb60579\/commons-codec-1.17.1.jar:..\/..\/JavaKit\/build\/classes\/java\/main:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/org.apache.commons\/commons-csv\/1.12.0\/c77e053d7189bc0857f8d323ab61cb949965fbd1\/commons-csv-1.12.0.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/commons-io\/commons-io\/2.17.0\/ddcc8433eb019fb48fe25207c0278143f3e1d7e2\/commons-io-2.17.0.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/commons-codec\/commons-codec\/1.17.1\/973638b7149d333563584137ebf13a691bb60579\/commons-codec-1.17.1.jar:..\/..\/JavaKit\/build\/classes\/java\/main:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/org.apache.commons\/commons-csv\/1.12.0\/c77e053d7189bc0857f8d323ab61cb949965fbd1\/commons-csv-1.12.0.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/commons-io\/commons-io\/2.17.0\/ddcc8433eb019fb48fe25207c0278143f3e1d7e2\/commons-io-2.17.0.jar:\/Users\/ktoso\/.gradle\/caches\/modules-2\/files-2.1\/commons-codec\/commons-codec\/1.17.1\/973638b7149d333563584137ebf13a691bb60579\/commons-codec-1.17.1.jar:..\/..\/JavaKit\/build\/classes\/java\/main",
   "dependencies" : [
     "org.apache.commons:commons-csv:1.12.0"
   ]

Samples/JavaDependencySampleApp/ci-validate.sh

@@ -12,17 +12,20 @@ MODULE_CONFIG_DIR=$(pwd)/Sources/$MODULE_NAME/
 echo "Resolve dependencies..."
 "$JAVASWIFT" --fetch "$MODULE_CONFIG_DIR/swift-java.config" \
     --module-name "$MODULE_NAME" \
+    --cache-dir "Plugins/outputs/javadependencysampleapp/${MODULE_NAME}/destination"
     --output-directory "$MODULE_CONFIG_DIR"
 
 #### 2) extract the config for the fetched dependency
-#MODULE_CONFIG_PATH="$MODULE_CONFIG_DIR/swift-java.config"
-#DEP_JAR_CP=$(jq .classpath "$MODULE_CONFIG_PATH")
-#DEP_JAR_CP=$(echo "$DEP_JAR_CP" | tr -d '"') # trim the "..."
-## shellcheck disable=SC2086
-#"$JAVASWIFT" --jar $DEP_JAR_CP \
-#    --module-name "$MODULE_NAME" \
-#    --java-package-filter org.apache.commons \
-#    --existing-config amend
+MODULE_CONFIG_PATH="$MODULE_CONFIG_DIR/swift-java.config"
+DEP_JAR_CP=$(jq .classpath "$MODULE_CONFIG_PATH")
+DEP_JAR_CP=$(echo "$DEP_JAR_CP" | tr -d '"') # trim the "..."
+
+# Import just a single class for our test purposes
+# shellcheck disable=SC2086
+"$JAVASWIFT" --jar $DEP_JAR_CP \
+    --module-name "$MODULE_NAME" \
+    --java-package-filter org.apache.commons.io.FilenameUtils \
+    --existing-config amend
 
 # for now in CI we just use what we have already generated and comitted in the config
 

Sources/Java2Swift/JavaToSwift+FetchDependencies.swift

@@ -75,24 +75,22 @@ extension JavaToSwift {
 }
 
 extension JavaToSwift {
-  mutating func writeFetchDependencies(resolvedClasspath: ResolvedDependencyClasspath) throws {
-    var configuration = Configuration()
-    configuration.dependencies = resolvedClasspath.rootDependencies
-    configuration.classpath = resolvedClasspath.classpath
-
+  mutating func writeFetchedDependenciesClasspath(
+    moduleName: String,
+    cacheDir: String,
+    resolvedClasspath: ResolvedDependencyClasspath) throws {
     // Convert the artifact name to a module name
     // e.g. reactive-streams -> ReactiveStreams
-    // TODO: Should we prefix them with `Java...`?
-    let targetModule = artifactIDAsModuleID(resolvedClasspath.rootDependencies.first!.artifactID)
 
-    // Encode the configuration.
-    let contents = try configuration.renderJSON()
+    // The file contents are just plain
+    let contents = resolvedClasspath.classpath
 
     // Write the file
     try writeContents(
       contents,
-      to: "swift-java.config",
-      description: "swift-java configuration file"
+      outputDirectoryOverride: URL(fileURLWithPath: cacheDir),
+      to: "\(moduleName).swift-java.classpath",
+      description: "swift-java.classpath file for module \(moduleName)"
     )
   }
 

Sources/Java2Swift/JavaToSwift.swift

@@ -62,6 +62,20 @@ struct JavaToSwift: ParsableCommand {
   @Option(name: .shortAndLong, help: "The directory in which to output the generated Swift files or the Java2Swift configuration file.")
   var outputDirectory: String? = nil
 
+  
+  @Option(name: .shortAndLong, help: "Directory where to write cached values (e.g. swift-java.classpath files)")
+  var cacheDirectory: String? = nil
+  
+  var effectiveCacheDirectory: String? {
+    if let cacheDirectory {
+      return cacheDirectory
+    } else if let outputDirectory {
+      return outputDirectory
+    } else {
+      return nil
+    }
+  }
+  
   @Option(name: .shortAndLong, help: "How to handle an existing swift-java.config; by default 'overwrite' by can be changed to amending a configuration")
   var existingConfig: ExistingConfigFileMode = .overwrite
   public enum ExistingConfigFileMode: String, ExpressibleByArgument, Codable {
@@ -288,10 +302,16 @@ struct JavaToSwift: ParsableCommand {
           environment: jvm.environment()
         )
 
-      case .fetchDependencies/*(let config)*/:
+      case .fetchDependencies:
         guard let dependencies = config.dependencies else {
           fatalError("Configuration for fetching dependencies must have 'dependencies' defined!")
         }
+        guard let moduleName = self.moduleName else {
+          fatalError("Fetching dependencies must specify module name (--module-name)!")
+        }
+        guard let effectiveCacheDirectory else {
+          fatalError("Fetching dependencies must effective cache directory! Specify --output-directory or --cache-directory")
+        }
 
         let dependencyClasspath = try fetchDependencies(
           moduleName: moduleName,
@@ -300,7 +320,10 @@ struct JavaToSwift: ParsableCommand {
           environment: jvm.environment()
         )
 
-        try writeFetchDependencies(resolvedClasspath: dependencyClasspath)
+        try writeFetchedDependenciesClasspath(
+          moduleName: moduleName,
+          cacheDir: effectiveCacheDirectory,
+          resolvedClasspath: dependencyClasspath)
       }
     } catch {
       // We fail like this since throwing out of the run often ends up hiding the failure reason when it is executed as SwiftPM plugin (!)
@@ -309,7 +332,8 @@ struct JavaToSwift: ParsableCommand {
       fatalError(message)
     }
 
-    print("[info][swift-java] " + "Done: ".green + CommandLine.arguments.joined(separator: " "))
+    // Just for debugging so it is clear which command has finished
+    print("[debug][swift-java] " + "Done: ".green + CommandLine.arguments.joined(separator: " ").green)
   }
 
   private func names(from javaClassNameOpt: String) -> (javaClassName: String, swiftName: String) {
@@ -346,8 +370,9 @@ struct JavaToSwift: ParsableCommand {
   mutating func writeContents(
     _ contents: String,
     outputDirectoryOverride: Foundation.URL?,
-    to filename: String, description: String) throws {
-    guard let outputDir = actualOutputDirectory else {
+    to filename: String,
+    description: String) throws {
+    guard let outputDir = (outputDirectoryOverride ?? actualOutputDirectory) else {
       print("// \(filename) - \(description)")
       print(contents)
       return
@@ -365,9 +390,9 @@ struct JavaToSwift: ParsableCommand {
 
     // Write the file:
     let file = outputDir.appendingPathComponent(filename)
-    print("[swift-java] Writing \(description) to '\(file.path)'...", terminator: "")
+    print("[debug][swift-java] Writing \(description) to '\(file.path)'... ", terminator: "")
     try contents.write(to: file, atomically: true, encoding: .utf8)
-    print(" done.".green)
+    print("done.".green)
   }
 }