Prepare for Linux build and CI (#14)

Co-authored-by: Mishal Shah <mishal_shah@apple.com>

Author: ktoso

.github/workflows/pull_request.yml

@@ -0,0 +1,73 @@
+name: pull_request
+
+on:
+  pull_request:
+    types: [ opened, reopened, synchronize ]
+
+jobs:
+  soundness:
+    uses: swiftlang/github-workflows/.github/workflows/soundness.yml@main
+    with:
+      api_breakage_check_enabled: false
+      # FIXME: Something is off with the format task and it gets "stuck", need to investigate
+      format_check_enabled: false
+      license_header_check_project_name: Swift.org
+      # FIXME: we're about to remove _Subprocess immediately anyway, so rather than fixing it one by one remove this adjusted list and use the default again ASAP
+      # swift-subprocess includes the word "kill" because SIGKILL signal handling so we allow it
+      unacceptable_language_check_word_list: "blacklist whitelist slave master sane sanity insane insanity killed killing hang hung hanged hanging" #ignore-unacceptable-language
+
+  test-java:
+    name: Java tests (swift:${{ matrix.swift_version }} jdk:${{matrix.jdk_vendor}} os:${{ matrix.os_version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        swift_version: [ 'nightly-main' ]
+        os_version: [ 'jammy' ]
+        jdk_vendor: [ 'Corretto' ]
+    container:
+      image: ${{ (contains(matrix.swift_version, 'nightly') && 'swiftlang/swift') || 'swift' }}:${{ matrix.swift_version }}-${{ matrix.os_version }}
+    env:
+      JAVA_HOME: "/usr/lib/jvm/default-jdk"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Make
+        run: apt-get -qq update && apt-get -qq install -y make
+      - name: Install JDK
+        run: "bash -xc 'JDK_VENDOR=${{ matrix.jdk_vendor }} ./docker/install_jdk.sh'"
+        # TODO: not using setup-java since incompatible with the swiftlang/swift base image
+        #      - uses: actions/setup-java@v4
+        #        with:
+        #          distribution: 'zulu'
+        #          java-version: '22'
+        #          cache: 'gradle'
+      - name: Generate sources (make) (Temporary)
+        # TODO: this should be triggered by the respective builds
+        run: make jextract-run
+      - name: Gradle build
+        run: ./gradlew build --no-daemon
+
+  test-swift:
+    name: Swift tests (swift:${{ matrix.swift_version }} jdk:${{matrix.jdk_vendor}} os:${{ matrix.os_version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        swift_version: [ 'nightly-main' ]
+        os_version: [ 'jammy' ]
+        jdk_vendor: [ 'Corretto' ]
+    container:
+      image: ${{ (contains(matrix.swift_version, 'nightly') && 'swiftlang/swift') || 'swift' }}:${{ matrix.swift_version }}-${{ matrix.os_version }}
+    env:
+      JAVA_HOME: "/usr/lib/jvm/default-jdk"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Make
+        run: apt-get -qq update && apt-get -qq install -y make
+      - name: Install JDK
+        run: "bash -xc 'JDK_VENDOR=${{ matrix.jdk_vendor }} ./docker/install_jdk.sh'"
+      - name: Generate sources (make) (Temporary)
+        # TODO: this should be triggered by the respective builds
+        run: "make jextract-run"
+      - name: Test Swift
+        run: "swift test"

.gitignore

@@ -8,6 +8,7 @@ DerivedData/
 .swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
 .netrc
 *.class
+bin/
 
 # Ignore gradle build artifacts
 .gradle

.licenseignore

@@ -0,0 +1,46 @@
+.gitignore
+.licenseignore
+.swiftformatignore
+.spi.yml
+.swift-format
+.github/*
+*.md
+CONTRIBUTORS.txt
+LICENSE.txt
+NOTICE.txt
+Package.swift
+Package.resolved
+README.md
+SECURITY.md
+scripts/unacceptable-language.txt
+docker/*
+**/*.docc/*
+**/.gitignore
+**/Package.swift
+**/Package.resolved
+**/*.md
+**/openapi.yml
+**/petstore.yaml
+**/openapi-generator-config.yaml
+**/openapi-generator-config.yml
+**/docker-compose.yaml
+**/docker/*
+**/.dockerignore
+JavaSwiftKitDemo/src/main/java/com/example/swift/generated/*
+Makefile
+**/Makefile
+**/*.html
+**/CMakeLists.txt
+**/*.jar
+gradle/wrapper/gradle-wrapper.properties
+gradlew
+gradlew.bat
+**/*.swift2java
+Sources/JavaKit/generated/*
+Sources/JavaKitJar/generated/*
+Sources/JavaKitNetwork/generated/*
+Sources/JavaKitReflection/generated/*
+Sources/_Subprocess/*
+Sources/_Subprocess/**/*
+Sources/_SubprocessCShims/*
+Sources/_SubprocessCShims/**/*

BuildLogic/build.gradle.kts

@@ -6,6 +6,7 @@
 // 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
 //

BuildLogic/settings.gradle.kts

@@ -6,6 +6,7 @@
 // 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
 //

BuildLogic/src/main/kotlin/build-logic.java-application-conventions.gradle.kts

@@ -6,6 +6,7 @@
 // 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
 //

BuildLogic/src/main/kotlin/build-logic.java-common-conventions.gradle.kts

@@ -6,6 +6,7 @@
 // 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
 //

BuildLogic/src/main/kotlin/build-logic.java-library-conventions.gradle.kts

@@ -6,6 +6,7 @@
 // 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
 //

JavaSwiftKitDemo/build.gradle.kts

@@ -6,6 +6,7 @@
 // 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
 //

JavaSwiftKitDemo/src/main/java/com/example/swift/HelloSubclass.java

@@ -6,12 +6,14 @@
 // 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
 //
 //===----------------------------------------------------------------------===//
 
 package com.example.swift;
+
 import com.example.swift.HelloSwift;
 
 public class HelloSubclass extends HelloSwift {

JavaSwiftKitDemo/src/main/java/com/example/swift/HelloSwift.java

@@ -6,12 +6,14 @@
 // 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
 //
 //===----------------------------------------------------------------------===//
 
 package com.example.swift;
+
 import com.example.swift.HelloSubclass;
 
 public class HelloSwift {

JavaSwiftKitDemo/src/main/java/org/example/CallMe.java

@@ -6,6 +6,7 @@
 // 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
 //

JavaSwiftKitDemo/src/main/java/org/example/HelloJava2Swift.java

@@ -6,6 +6,7 @@
 // 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
 //

JavaSwiftKitDemo/src/main/java/org/example/swift/ManualJavaKitExample.java

@@ -6,6 +6,7 @@
 // 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
 //
@@ -199,14 +200,13 @@ public static void globalCallJavaCallback(Runnable callMe) {
         var mh$ = globalCallJavaCallback.HANDLE;
 
         try {
+             // signature of 'void run()'
              FunctionDescriptor callMe_run_desc = FunctionDescriptor.ofVoid(
-                     // replicate signature of run()
              );
              MethodHandle callMe_run_handle = MethodHandles.lookup()
                      .findVirtual(Runnable.class,
                              "run",
-                             callMe_run_desc.toMethodType()
-                     );
+                             callMe_run_desc.toMethodType());
             callMe_run_handle = callMe_run_handle.bindTo(callMe); // set the first parameter to the Runnable as the "this" of the callback pretty much
 
             try (Arena arena = Arena.ofConfined()) {

JavaSwiftKitDemo/src/main/java/org/example/swift/ManualMySwiftClass.java

@@ -6,6 +6,7 @@
 // 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
 //

JavaSwiftKitDemo/src/main/java/org/example/swift/Manual_MySwiftClass.java

@@ -6,6 +6,7 @@
 // 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
 //

JavaSwiftKitDemo/src/main/java/org/swift/javakit/ManagedSwiftType.java

@@ -6,6 +6,7 @@
 // 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
 //

JavaSwiftKitDemo/src/main/java/org/swift/javakit/SwiftKit.java

@@ -6,6 +6,7 @@
 // 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
 //

JavaSwiftKitDemo/src/main/java/org/swift/swiftkit/SwiftArena.java

@@ -6,6 +6,7 @@
 // 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
 //

JavaSwiftKitDemo/src/main/java/org/swift/swiftkit/SwiftHeapObject.java

@@ -6,6 +6,7 @@
 // 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
 //

JavaSwiftKitDemo/src/test/java/org/example/swift/GlobalFunctionsTest.java

@@ -6,6 +6,7 @@
 // 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
 //

JavaSwiftKitDemo/src/test/java/org/example/swift/JavaKitTest.java

@@ -6,6 +6,7 @@
 // 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
 //

JavaSwiftKitDemo/src/test/java/org/example/swift/SwiftKitTest.java

@@ -6,6 +6,7 @@
 // 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
 //

Makefile

@@ -15,23 +15,38 @@
 .PHONY: run clean all
 
 ARCH := $(shell arch)
+UNAME := $(shell uname)
+
+ifeq ($(UNAME), Linux)
+ifeq ($(ARCH), 'i386')
+  ARCH_SUBDIR := x86_64
+else
+  ARCH_SUBDIR := aarch64
+endif
+BUILD_DIR := .build/$(ARCH_SUBDIR)-unknown-linux-gnu
+LIB_SUFFIX := so
+endif
+
+ifeq ($(UNAME), Darwin)
 ifeq ($(ARCH), 'i386')
   ARCH_SUBDIR := x86_64
 else
   ARCH_SUBDIR := arm64
 endif
+BUILD_DIR := .build/$(ARCH_SUBDIR)-apple-macosx
+LIB_SUFFIX := dylib
+endif
 
-BUILD_DIR=".build/$(ARCH_SUBDIR)-apple-macosx"
 
 all: generate-all
 
-$(BUILD_DIR)/debug/libJavaKit.dylib $(BUILD_DIR)/debug/libJavaKitExample.dylib $(BUILD_DIR)/debug/Java2Swift:
+$(BUILD_DIR)/debug/libJavaKit.$(LIB_SUFFIX) $(BUILD_DIR)/debug/libJavaKitExample.$(LIB_SUFFIX) $(BUILD_DIR)/debug/Java2Swift:
 	swift build
 
 ./JavaSwiftKitDemo/build/classes/java/main/com/example/swift/HelloSubclass.class: JavaSwiftKitDemo/src/main/java/com/example/swift
 	./gradlew build
 
-run: $(BUILD_DIR)/debug/libJavaKit.dylib $(BUILD_DIR)/debug/libJavaKitExample.dylib JavaSwiftKitDemo/src/main/java/com/example/swift
+run: $(BUILD_DIR)/debug/libJavaKit.$(LIB_SUFFIX) $(BUILD_DIR)/debug/libJavaKitExample.$(LIB_SUFFIX) JavaSwiftKitDemo/src/main/java/com/example/swift
 	java -cp JavaSwiftKitDemo/build/classes/java/main -Djava.library.path=$(BUILD_DIR)/debug/ com.example.swift.HelloSwift
 
 Java2Swift: $(BUILD_DIR)/debug/Java2Swift
@@ -82,7 +97,7 @@ endef
 jextract-swift: generate-JExtract-interface-files
 	swift build
 
-generate-JExtract-interface-files: $(BUILD_DIR)/debug/libJavaKit.dylib
+generate-JExtract-interface-files: $(BUILD_DIR)/debug/libJavaKit.$(LIB_SUFFIX)
 	echo "Generate .swiftinterface files..."
 	@$(call make_swiftinterface, "JavaKitExample", "MySwiftLibrary")
 	@$(call make_swiftinterface, "JavaKitExample", "SwiftKit")
@@ -92,8 +107,8 @@ jextract-run: jextract-swift generate-JExtract-interface-files
 		--package-name com.example.swift.generated \
 		--swift-module JavaKitExample \
 		--output-directory JavaSwiftKitDemo/src/main/java \
-		.build/arm64-apple-macosx/jextract/JavaKitExample/MySwiftLibrary.swiftinterface \
-		.build/arm64-apple-macosx/jextract/JavaKitExample/SwiftKit.swiftinterface
+		$(BUILD_DIR)/jextract/JavaKitExample/MySwiftLibrary.swiftinterface \
+		$(BUILD_DIR)/jextract/JavaKitExample/SwiftKit.swiftinterface
 
 
 jextract-run-java: jextract-swift generate-JExtract-interface-files