Correct the SwiftAndJavaJarSampleLib example and actually verify created

jar

Author: ktoso

Package.swift

@@ -175,12 +175,6 @@ let package = Package(
         "JExtractSwiftPlugin"
       ]
     ),
-//    .plugin(
-//      name: "JExtractSwiftCommandPlugin",
-//      targets: [
-//        "JExtractSwiftCommandPlugin"
-//      ]
-//    ),
 
     // ==== Examples
 
@@ -429,16 +423,6 @@ let package = Package(
         "SwiftJavaTool"
       ]
     ),
-//    .plugin(
-//      name: "JExtractSwiftCommandPlugin",
-//      capability: .command(
-//        intent: .custom(verb: "jextract", description: "Extract Java accessors from Swift module"),
-//        permissions: [
-//        ]),
-//      dependencies: [
-//        "SwiftJavaTool"
-//      ]
-//    ),
 
     .testTarget(
       name: "JavaKitTests",

Plugins/JExtractSwiftCommandPlugin/JExtractSwiftCommandPlugin.swift

@@ -108,14 +108,6 @@ struct JExtractSwiftBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
         inputFiles: [ configFile ] + swiftFiles,
         outputFiles: outputSwiftFiles
       )
-//      .prebuildCommand(
-//        displayName: "Generate Java wrappers for Swift types",
-//        executable: toolURL,
-//        arguments: arguments,
-//        // inputFiles: [ configFile ] + swiftFiles,
-//        // outputFiles: outputJavaFiles
-//        outputFilesDirectory: outputSwiftDirectory
-//      )
     ]
   }
 }

Plugins/JExtractSwiftCommandPlugin/_PluginsShared

@@ -49,21 +49,34 @@ dependencies {
     testImplementation("org.junit.jupiter:junit-jupiter")
 }
 
-//// This is for development, when we edit the Swift swift-java project, the outputs of the generated sources may change.
-//// Thus, we also need to watch and re-build the top level project.
-//def compileSwiftJExtractPlugin = tasks.register("compileSwiftJava", Exec) {
-//    description = "Rebuild the swift-java root project (" + swiftBuildConfiguration() + ")"
-//
-//    inputs.file(new File(rootDir, "Package.swift"))
-//    inputs.dir(new File(rootDir, "Sources"))
-//    outputs.dir(new File(rootDir, ".build"))
-//
-//    workingDir = rootDir
-//    commandLine "swift"
-//    args("build",
-//            "-c", swiftBuildConfiguration(),
-//            "--product", "swift-java")
-//}
+def swiftProductsWithJExtractPlugin() {
+    def stdout = new ByteArrayOutputStream()
+    def stderr = new ByteArrayOutputStream()
+
+    def result = exec {
+        commandLine 'swift', 'package', 'describe', '--type', 'json'
+        standardOutput = stdout
+        errorOutput = stderr
+        ignoreExitValue = true
+    }
+
+    def jsonOutput = stdout.toString()
+
+    if (result.exitValue == 0) {
+        def json = new JsonSlurper().parseText(jsonOutput)
+        def products = json.targets
+                .findAll { target ->
+                    target.product_dependencies?.contains("JExtractSwiftPlugin")
+                }
+                .collectMany { target ->
+                    target.product_memberships ?: []
+                }
+        return products
+    } else {
+        logger.warn("Command failed: ${stderr.toString()}")
+        return []
+    }
+}
 
 def jextract = tasks.register("jextract", Exec) {
     description = "Generate Java wrappers for swift target"
@@ -73,12 +86,14 @@ def jextract = tasks.register("jextract", Exec) {
     inputs.file(new File(rootDir, "Package.swift"))
     inputs.dir(new File(rootDir, "Sources"))
 
+    // If the package description changes, we should execute jextract again, maybe we added jextract to new targets
     inputs.file(new File(projectDir, "Package.swift"))
-    inputs.dir(new File(projectDir, "Sources"))
 
-    // TODO: we can use package describe --type json to figure out which targets depend on JExtractSwiftPlugin and will produce outputs
-    //       Avoid adding this directory, but create the expected one specifically for all targets
-    //       which WILL produce sources because they have the plugin
+    // monitor all targets/products which depend on the JExtract plugin
+    swiftProductsWithJExtractPlugin().each {
+        logger.info("[swift-java:jextract (Gradle)] Swift input target: ${it}")
+        inputs.dir(new File(layout.projectDirectory.asFile, "Sources/${it}".toString()))
+    }
     outputs.dir(layout.buildDirectory.dir("../.build/plugins/outputs/${layout.projectDirectory.asFile.getName().toLowerCase()}"))
 
     File baseSwiftPluginOutputsDir = layout.buildDirectory.dir("../.build/plugins/outputs/").get().asFile
@@ -94,16 +109,16 @@ def jextract = tasks.register("jextract", Exec) {
 
     workingDir = layout.projectDirectory
     commandLine "swift"
-    args("run",
-            "swift-java", "jextract",
-            "--swift-module", "MySwiftLibrary",
-            "--java-module", "MyJavaLibrary",
-            // "--java-package", "com.example.myjava",
-            "--java-output", "${layout.buildDirectory.dir(".build/plugins/outputs/${layout.projectDirectory.asFile.getName().toLowerCase()}/JExtractSwiftPlugin/src/generated/java")}",
-            "--swift-output", "${layout.buildDirectory.dir(".build/plugins/outputs/${layout.projectDirectory.asFile.getName().toLowerCase()}/JExtractSwiftPlugin/Sources")}",
-//            "-v",
-//            "--log-level", "info" // TODO: pass log level from Gradle build
-    )
+    args("build") // since Swift targets which need to be jextract-ed have the jextract build plugin, we just need to build
+    // If we wanted to execute a specific subcommand, we can like this:
+    //     args("run",/*
+    //             "swift-java", "jextract",
+    //             "--swift-module", "MySwiftLibrary",
+    //             // java.package is obtained from the swift-java.config in the swift module
+    //             "--output-java", "${layout.buildDirectory.dir(".build/plugins/outputs/${layout.projectDirectory.asFile.getName().toLowerCase()}/JExtractSwiftPlugin/src/generated/java").get()}",
+    //             "--output-swift", "${layout.buildDirectory.dir(".build/plugins/outputs/${layout.projectDirectory.asFile.getName().toLowerCase()}/JExtractSwiftPlugin/Sources").get()}",
+    //             "--log-level", (logging.level <= LogLevel.INFO ? "debug" :  */"info")
+    //     )
 }
 
 

Plugins/JExtractSwiftPlugin/JExtractSwiftPlugin.swift

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+set -e
+set -x
+
+./gradlew jar
+
+# check if we can compile a plain Example file that uses the generated Java bindings that should be in the generated jar
+javac -cp bin/default/build/libs/*jar Example.java
+
+# Can we run the example?
+# - find libswiftCore.dylib
+SWIFT_DYLIB_PATHS=$(find "$(swiftly use --print-location)" | grep dylib$ | grep libswiftCore | grep macos | xargs dirname)
+# - find our library dylib
+SWIFT_DYLIB_PATHS="${SWIFT_DYLIB_PATHS}:$(find . | grep libMySwiftLibrary.dylib$ | sort | head -n1 | xargs dirname)"
+java -Djava.library.path="${SWIFT_DYLIB_PATHS}" -cp ".:bin/default/build/libs/*jar:../../SwiftKit/build/libs/*jar" Example

Samples/SwiftAndJavaJarSampleLib/build.gradle

@@ -34,24 +34,6 @@ java {
     }
 }
 
-
-// This is for development, when we edit the Swift swift-java project, the outputs of the generated sources may change.
-// Thus, we also need to watch and re-build the top level project.
-def compileSwiftJExtractPlugin = tasks.register("compileSwiftJExtractPlugin", Exec) {
-    description = "Rebuild the swift-java root project"
-
-    inputs.file(new File(rootDir, "Package.swift"))
-    inputs.dir(new File(rootDir, "Sources"))
-    outputs.dir(new File(rootDir, ".build"))
-
-    workingDir = rootDir
-    commandLine "swift"
-    args("build",
-            "--product", "SwiftKitSwift",
-            "--product", "JExtractSwiftPlugin",
-            "--product", "JExtractSwiftCommandPlugin")
-}
-
 def jextract = tasks.register("jextract", Exec) {
     description = "Builds swift sources, including swift-java source generation"
     dependsOn compileSwiftJExtractPlugin

Samples/SwiftAndJavaJarSampleLib/ci-validate.sh

@@ -27,7 +27,7 @@ import JavaKitShared
 
 /// Command-line utility to drive the export of Java classes into Swift types.
 @main
-struct SwiftJava: AsyncParsableCommand { // FIXME: this is just a normal async command, no parsing happening here
+struct SwiftJava: AsyncParsableCommand {
   static var _commandName: String { "swift-java" }
 
   static let configuration = CommandConfiguration(
@@ -39,10 +39,6 @@ struct SwiftJava: AsyncParsableCommand { // FIXME: this is just a normal async c
       JExtractCommand.self
     ])
 
-  var effectiveSwiftModule: String {
-    fatalError("SHOULD NOT BE USED")
-  }
-
   mutating func run() async throws {
     guard CommandLine.arguments.count >= 2 else {
       // there's no "default" command, print USAGE when no arguments/parameters are passed.

Samples/SwiftKitSampleApp/build.gradle

@@ -41,8 +41,8 @@ public static long addressByteSize() {
     public static final ValueLayout.OfLong SWIFT_INT64 = ValueLayout.JAVA_LONG;
     public static final ValueLayout.OfFloat SWIFT_FLOAT = ValueLayout.JAVA_FLOAT;
     public static final ValueLayout.OfDouble SWIFT_DOUBLE = ValueLayout.JAVA_DOUBLE;
-    public static final AddressLayout SWIFT_POINTER = ValueLayout.ADDRESS
-            .withTargetLayout(MemoryLayout.sequenceLayout(Long.MAX_VALUE, JAVA_BYTE));
+    public static final AddressLayout SWIFT_POINTER = ValueLayout.ADDRESS;
+            // .withTargetLayout(MemoryLayout.sequenceLayout(Long.MAX_VALUE, JAVA_BYTE));
     public static final SequenceLayout SWIFT_BYTE_ARRAY = MemoryLayout.sequenceLayout(8, ValueLayout.JAVA_BYTE);
 
     /**