cleanup install jdk script

working on samples validation

fixed name deduplication logic

Author: ktoso

.github/scripts/validate_samples.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+# shellcheck disable=SC2034
+declare -r GREEN='\033[0;31m'
+declare -r BOLD='\033[1m'
+declare -r RESET='\033[0m'
+
+# shellcheck disable=SC2155
+declare -r SAMPLE_PACKAGES=$(find Samples -name Package.swift -maxdepth 2)
+declare -r CI_VALIDATE_SCRIPT='ci-validate.sh'
+
+for samplePackage in ${SAMPLE_PACKAGES} ; do
+  sampleDir=$(dirname "$samplePackage")
+
+  echo ""
+  echo ""
+  echo "========================================================================"
+  printf "Validate sample: '${BOLD}%s${RESET}' using: " "$sampleDir"
+  cd "$sampleDir" || exit
+  if [[ $(find . -name ${CI_VALIDATE_SCRIPT} -maxdepth 1) ]]; then
+    echo -e "Custom ${BOLD}${CI_VALIDATE_SCRIPT}${RESET} script..."
+    ./${CI_VALIDATE_SCRIPT} || exit
+  elif [[ $(find . -name 'build.gradle*' -maxdepth 1) ]]; then
+    echo -e "${BOLD}Gradle${RESET} build..."
+    ./gradlew build --info || exit
+  else
+    echo -e "${BOLD}SwiftPM${RESET} build..."
+    swift build || exit
+  fi
+
+  cd - || exit
+done
+
+
+printf "Done validating samples: "
+echo "${GREEN}done${RESET}."

.github/workflows/pull_request.yml

@@ -134,8 +134,7 @@ jobs:
       - name: Test Swift
         run: "swift test"
       - name: Build (Swift) Sample Apps
-        run: |
-          find Samples/ -name Package.swift -maxdepth 2 -exec swift build --package-path $(dirname {}) \;;
+        run: .github/scripts/validate_samples.sh
       # TODO: Benchmark compile crashes in CI, enable when nightly toolchains in better shape.
       # - name: Build (Swift) Benchmarks
       #  run: "swift package --package-path Benchmarks/ benchmark list"

Package.swift

@@ -150,7 +150,7 @@ let package = Package(
 
   ],
   dependencies: [
-    .package(url: "https://github.com/swiftlang/swift-syntax.git", branch: "main"),
+    .package(url: "https://github.com/swiftlang/swift-syntax", from: "600.0.1"),
     .package(url: "https://github.com/apple/swift-argument-parser", from: "1.5.0"),
     .package(url: "https://github.com/ordo-one/package-benchmark", .upToNextMajor(from: "1.4.0")),
   ],

Plugins/JExtractSwiftCommandPlugin/JExtractSwiftCommandPlugin.swift

@@ -17,41 +17,45 @@ import PackagePlugin
 
 @main
 final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
-  
+
   var verbose: Bool = false
-  
+
   /// Build the target before attempting to extract from it.
   /// This avoids trying to extract from broken sources.
   ///
   /// You may disable this if confident that input targets sources are correct and there's no need to kick off a pre-build for some reason.
   var buildInputs: Bool = true
-  
+
   /// Build the target once swift-java sources have been generated.
   /// This helps verify that the generated output is correct, and won't miscompile on the next build.
   var buildOutputs: Bool = true
-  
+
   func createBuildCommands(context: PackagePlugin.PluginContext, target: any PackagePlugin.Target) async throws -> [PackagePlugin.Command] {
     // FIXME: This is not a build plugin but SwiftPM forces us to impleme the protocol anyway? rdar://139556637
     return []
   }
-  
+
   func performCommand(context: PluginContext, arguments: [String]) throws {
+    // Plugin can't have dependencies, so we have some naive argument parsing instead:
     self.verbose = arguments.contains("-v") || arguments.contains("--verbose")
-    
+    if !self.verbose {
+        fatalError("Plugin should be verbose")
+    }
+
     let selectedTargets: [String] =
       if let last = arguments.lastIndex(where: { $0.starts(with: "-")}),
          last < arguments.endIndex {
         Array(arguments[..<last])
       } else {
         []
       }
-    
+
     for target in context.package.targets {
       guard let configPath = getSwiftJavaConfig(target: target) else {
         log("Skipping target '\(target.name), has no 'swift-java.config' file")
         continue
       }
-      
+
       do {
         print("[swift-java] Extracting Java wrappers from target: '\(target.name)'...")
         try performCommand(context: context, target: target, arguments: arguments)
@@ -60,24 +64,19 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
       }
     }
   }
-  
+
   /// Perform the command on a specific target.
   func performCommand(context: PluginContext, target: Target, arguments: [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 {
       log("Pre-building target '\(target.name)' before extracting sources...")
       try self.packageManager.build(.target(target.name), parameters: .init())
     }
-    
-    if self.buildOutputs {
-      log("Post-building target '\(target.name)' to verify generated sources...")
-      try self.packageManager.build(.target(target.name), parameters: .init())
-    }
-    
+
     // Note: Target doesn't have a directoryURL counterpart to directory,
     // so we cannot eliminate this deprecation warning.
     let sourceDir = target.directory.string
@@ -91,8 +90,6 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
       .appending(path: "generated")
       .appending(path: "java")
     let outputDirectorySwift = context.pluginWorkDirectoryURL
-      .appending(path: "src")
-      .appending(path: "generated")
       .appending(path: "Sources")
 
     var arguments: [String] = [
@@ -108,28 +105,42 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
     arguments.append(sourceDir)
 
     try runExtract(context: context, target: target, arguments: arguments)
+    
+    if self.buildOutputs {
+      // Building the *products* since we need to build the dylib that contains our newly generated sources,
+      // so just building the target again would not be enough. We build all products which we affected using
+      // our source generation, which usually would be just a product dylib with our library.
+      //
+      // In practice, we'll always want to build after generating; either here,
+      // or via some other task before we run any Java code, calling into Swift.
+      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())
+      }
+    }
   }
-  
+
   func runExtract(context: PluginContext, target: Target, arguments: [String]) throws {
     let process = Process()
     process.executableURL = try context.tool(named: "JExtractSwiftTool").url
     process.arguments = arguments
-    
+
     do {
-      log("Execute: \(process.executableURL) \(arguments)")
-      
+      log("Execute: \(process.executableURL!.absoluteURL.relativePath) \(arguments.joined(separator: " "))")
+
       try process.run()
       process.waitUntilExit()
-      
+
       assert(process.terminationStatus == 0, "Process failed with exit code: \(process.terminationStatus)")
     } catch {
-      print("[swift-java][command] Failed to extract Java sources for target: '\(target.name); Error: \(error)")
+      print("[swift-java-command] Failed to extract Java sources for target: '\(target.name); Error: \(error)")
     }
   }
-  
-  func log(_ message: @autoclosure () -> String) {
+
+  func log(_ message: @autoclosure () -> String, terminator: String = "\n") {
     if self.verbose {
-      print("[swift-java] \(message())")
+      print("[swift-java-command] \(message())", terminator: terminator)
     }
   }
 }

Samples/JExtractPluginSampleApp/JExtractPluginSampleLibModule+SwiftJava.swiftdeps~

@@ -35,8 +35,7 @@ let javaIncludePath = "\(javaHome)/include"
 #elseif os(macOS)
   let javaPlatformIncludePath = "\(javaIncludePath)/darwin"
 #else
-  // TODO: Handle windows as well
-  #error("Currently only macOS and Linux platforms are supported, this may change in the future.")
+  let javaPlatformIncludePath = "\(javaIncludePath)/win32"
 #endif
 
 let package = Package(
@@ -58,6 +57,9 @@ let package = Package(
     .target(
       name: "JExtractPluginSampleLib",
       dependencies: [],
+      exclude: [
+        "swift-java.config"
+      ],
       swiftSettings: [
         .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
       ],

Samples/JExtractPluginSampleApp/MyCoolSwiftClass+SwiftJava.swiftdeps~

@@ -18,7 +18,6 @@ import java.nio.file.*
 
 plugins {
     id("build-logic.java-application-conventions")
-//     id("me.champeau.jmh") version "0.7.2"
 }
 
 group = "org.swift.swiftkit"
@@ -61,22 +60,24 @@ def jextract = tasks.register("jextract", Exec) {
     inputs.dir(layout.projectDirectory.dir("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
+    //       Avoid adding this directory, but create the expected one specifically for all targets
+    //       which WILL produce sources because they have the plugin
     outputs.dir(layout.buildDirectory.dir("../.build/plugins/outputs/${layout.projectDirectory.asFile.getName().toLowerCase()}"))
 
     File baseSwiftPluginOutputsDir = layout.buildDirectory.dir("../.build/plugins/outputs/").get().asFile
     if (!baseSwiftPluginOutputsDir.exists()) {
         baseSwiftPluginOutputsDir.mkdirs()
     }
     Files.walk(layout.buildDirectory.dir("../.build/plugins/outputs/").get().asFile.toPath()).each {
+        // Add any Java sources generated by the plugin to our sourceSet
         if (it.endsWith("JExtractSwiftPlugin/src/generated/java")) {
             outputs.dir(it)
         }
     }
 
     workingDir = layout.projectDirectory
     commandLine "swift"
-    args("package", "jextract")
+    args("package", "jextract", "-v", "--log-level", "info") // TODO: pass log level from Gradle build
 }
 
 // Add the java-swift generated Java sources
@@ -97,8 +98,6 @@ dependencies {
 
     testImplementation(platform("org.junit:junit-bom:5.10.0"))
     testImplementation("org.junit.jupiter:junit-jupiter")
-
-    // implementation(swiftDynamicLibrary('')
 }
 
 tasks.named('test', Test) {

Samples/JExtractPluginSampleApp/Package.swift

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+./gradlew check && ./gradlew run

Samples/JExtractPluginSampleApp/build.gradle

@@ -22,15 +22,7 @@ public static void main(String[] args) {
         System.out.println("java.library.path = " + SwiftKit.getJavaLibraryPath());
         System.out.println("jextract.trace.downcalls = " + SwiftKit.getJextractTraceDowncalls());
 
-        try {
-            var o = new MyCoolSwiftClass(12);
-            o.exposedToJava();
-        } catch (UnsatisfiedLinkError linkError) {
-            if (linkError.getMessage().startsWith("unresolved symbol: ")) {
-                var unresolvedSymbolName = linkError.getMessage().substring("unresolved symbol: ".length());
-
-
-            }
-        }
+        var o = new MyCoolSwiftClass(12);
+        o.exposedToJava();
     }
 }