Merge remote-tracking branch 'oracle/master' into zstd-jni

# Conflicts: # metadata/index.json # tests/src/index.json
oracle · Dec 12, 2022 · 4999878 · 4999878
2 parents 04375b0 + dd4331c
commit 4999878
Show file tree

Hide file tree

Showing 34 changed files with 1,366 additions and 7 deletions.
diff --git a/.github/workflows/library-and-framework-list-validation.yml b/.github/workflows/library-and-framework-list-validation.yml
@@ -6,6 +6,7 @@ jobs:
   validate-library-and-framework-list-json:
     name: "📋 Checks if the json file is written according to the existing schema"
     runs-on: "ubuntu-20.04"
+    timeout-minutes: 5
     steps:
       - name: "☁️ Checkout repository"
         uses: actions/checkout@v3

diff --git a/.github/workflows/test-all-metadata.yml b/.github/workflows/test-all-metadata.yml
@@ -18,6 +18,7 @@ jobs:
   get-all-metadata:
     name: "📋 Get list of all supported libraries"
     runs-on: "ubuntu-20.04"
+    timeout-minutes: 5
     outputs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
     steps:
@@ -37,6 +38,7 @@ jobs:
   test-all-metadata:
     name: "🧪 ${{ matrix.coordinates }} (GraalVM ${{ matrix.version }} ${{ matrix.java-version }} @ ${{ matrix.os }})"
     runs-on: ${{ matrix.os }}
+    timeout-minutes: 20
     needs: get-all-metadata
     strategy:
       fail-fast: false

diff --git a/.github/workflows/test-changed-metadata.yml b/.github/workflows/test-changed-metadata.yml
@@ -17,6 +17,7 @@ jobs:
   get-changed-metadata:
     name: "📋 Get a list of all changed libraries"
     runs-on: "ubuntu-20.04"
+    timeout-minutes: 5
     outputs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
       none-found: ${{ steps.set-matrix.outputs.none-found }}
@@ -40,6 +41,7 @@ jobs:
     name: "🧪 ${{ matrix.coordinates }} (GraalVM ${{ matrix.version }} ${{ matrix.java-version }} @ ${{ matrix.os }})"
     if: needs.get-changed-metadata.result == 'success' && needs.get-changed-metadata.outputs.none-found != 'true'
     runs-on: ${{ matrix.os }}
+    timeout-minutes: 20
     needs: get-changed-metadata
 
     strategy:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -196,3 +196,39 @@ In this example this can be done by invoking following command from the reposito
 ```bash
 ./gradlew test -Pcoordinates=org.example:library:0.0.1
 ```
+
+## Tested Libraries and Frameworks
+
+If your library or framework is tested with GraalVM Native Image, consider adding it to [this list](https://github.com/oracle/graalvm-reachability-metadata/blob/master/library-and-framework-list.json).
+
+Write an entry as follows:
+```json
+{
+    "artifact": "<groupId>:<artifactId>",
+    "description": "<artifactDescription>",
+    "details": [
+      {
+        "minimum_version": "<minimumVersion>",
+        "maximum_version": "<maximumVersion>",
+        "metadata_locations": ["<metadataLocations>"],
+        "tests_locations": ["<testLocations>"],
+        "test_level": "<testLevel>"
+      }
+    ]
+}
+```
+Where:
+ * `<groupId>` and `<artifactId>` - part of the standard Maven coordinates ([see this](https://maven.apache.org/pom.html#maven-coordinates))
+ * `<artifactDescription>` - short description of the library or framework (_not required_) 
+ * `<minimumVersion>` - minimal version for which this entry applies
+ * `<maximumVersion>` - maximal version for which this entry applies (_not required_)
+ * `<metadataLocations>` - list of web URLs providing metadata
+ * `<testLocations>` - list of URLs to test sources, CI dashboards, etc.
+ * `<testLevel>` - one of the following values:
+   * untested (there are no provided tests that can confirm library usage with Native Image)
+   * community-tested (the library is partially tested through some project, e.g. [Reachability Metadata Repository](https://github.com/oracle/graalvm-reachability-metadata/tree/master/tests/src))
+   * fully-tested (the library is fully tested for each released library version)
+
+**Note:** To pass format and style checks, please run `./gradlew :spotlessApply` from the project root, before submitting a PR.  
+**Note:** The entries you add will be validated against [library-and-framework-list-schema.json](https://github.com/oracle/graalvm-reachability-metadata/blob/master/library-and-framework-list-schema.json)
+
diff --git a/README.md b/README.md
@@ -9,3 +9,10 @@ The GraalVM Reachability Metadata Repository enables Native Image users to share
 
 We welcome contributions from the community. Before submitting a pull
 request, please [review our contribution guide](./CONTRIBUTING.md).
+
+
+### Tested Libraries and Frameworks
+
+We track the libraries and frameworks that are tested with GraalVM Native Image. If you would like to see your library/framework
+in the list too, please open a pull request and extend [this JSON file](https://github.com/oracle/graalvm-reachability-metadata/blob/master/library-and-framework-list.json).
+Before submitting a pull request, please read [this guide](./CONTRIBUTING.md#tested-libraries-and-frameworks).
diff --git a/library-and-framework-list.json b/library-and-framework-list.json
@@ -1 +1,142 @@
-[]
+[
+  {
+    "artifact": "io.netty:netty5-parent",
+    "description": "Netty project - an event-driven asynchronous network application framework",
+    "details": [
+      {
+        "minimum_version": "5.0",
+        "metadata_locations": [
+          "https://github.com/netty/netty/tree/main/common/src/main/resources/META-INF/native-image"
+        ],
+        "tests_locations": [
+          "https://github.com/netty/netty/actions"
+        ],
+        "test_level": "community-tested"
+      }
+    ]
+  },
+  {
+    "artifact": "org.apache.tomcat.embed:tomcat-embed-core",
+    "description": "Apache Tomcat",
+    "details": [
+      {
+        "minimum_version": "9.0",
+        "metadata_locations": [
+          "https://github.com/apache/tomcat/tree/9.0.x/res/graal"
+        ],
+        "tests_locations": [
+          "https://github.com/micronaut-projects/micronaut-servlet/actions/workflows/graalvm.yml",
+          "https://github.com/spring-projects/spring-aot-smoke-tests"
+        ],
+        "test_level": "community-tested"
+      }
+    ]
+  },
+  {
+    "artifact": "com.datastax.oss:java-driver-core",
+    "description": "DataStax Java Driver for Apache Cassandra",
+    "details": [
+      {
+        "minimum_version": "4.1.5",
+        "metadata_locations": [
+          "https://github.com/datastax/java-driver/tree/4.x/core/src/main/resources/META-INF/native-image"
+        ],
+        "tests_locations": [
+          "https://github.com/micronaut-projects/micronaut-cassandra/actions/workflows/graalvm.yml",
+          "https://github.com/spring-projects/spring-aot-smoke-tests"
+        ],
+        "test_level": "community-tested"
+      }
+    ]
+  },
+  {
+    "artifact": "io.helidon.config:helidon-config",
+    "description": "Helidon Configuration.",
+    "details": [
+      {
+        "minimum_version": "1.0.0",
+        "metadata_locations": [
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/config/config/src/main/resources/META-INF/native-image/io.helidon.config/helidon-config"
+        ],
+        "tests_locations": [
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/tests/integration/native-image/se-1"
+        ],
+        "test_level": "fully-tested"
+      }
+    ]
+  },
+  {
+    "artifact": "io.helidon.webserver:helidon-webserver",
+    "description": "Helidon Reactive WebServer. Requires Helidon native image feature.",
+    "details": [
+      {
+        "minimum_version": "1.0.0",
+        "maximal_version": "4.0",
+        "metadata_locations": [
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/webserver/webserver/src/main/resources/META-INF/native-image/io.helidon.webserver/helidon-webserver",
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/webserver/webserver/src/main/resources/META-INF/helidon/native-image",
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/integrations/graal/native-image-extension"
+        ],
+        "tests_locations": [
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/tests/integration/native-image/se-1"
+        ],
+        "test_level": "fully-tested"
+      }
+    ]
+  },
+  {
+    "artifact": "io.helidon.webclient:helidon-webclient",
+    "description": "Helidon Reactive WebClient.",
+    "details": [
+      {
+        "minimum_version": "1.0.0",
+        "maximal_version": "4.0",
+        "metadata_locations": [
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/webclient/webclient/src/main/resources/META-INF/native-image/io.helidon.webclient/helidon-webclient"
+        ],
+        "tests_locations": [
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/tests/integration/native-image/se-1"
+        ],
+        "test_level": "fully-tested"
+      }
+    ]
+  },
+  {
+    "artifact": "io.helidon.microprofile.bundles:helidon-microprofile",
+    "description": "Helidon MicroProfile Bundle. Requires Helidon native image features.",
+    "details": [
+      {
+        "minimum_version": "2.0.0",
+        "metadata_locations": [
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/microprofile",
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/integrations/graal/mp-native-image-extension"
+        ],
+        "tests_locations": [
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/tests/integration/native-image/mp-1",
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/tests/integration/native-image/mp-2",
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/tests/integration/native-image/mp-3"
+        ],
+        "test_level": "fully-tested"
+      }
+    ]
+  },
+  {
+    "artifact": "io.helidon.microprofile.bundles:helidon-microprofile-core",
+    "description": "Helidon MicroProfile Core Bundle. Requires Helidon native image features.",
+    "details": [
+      {
+        "minimum_version": "2.0.0",
+        "metadata_locations": [
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/microprofile",
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/integrations/graal/mp-native-image-extension"
+        ],
+        "tests_locations": [
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/tests/integration/native-image/mp-1",
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/tests/integration/native-image/mp-2",
+          "https://github.com/helidon-io/helidon/tree/helidon-3.x/tests/integration/native-image/mp-3"
+        ],
+        "test_level": "fully-tested"
+      }
+    ]
+  }
+]
diff --git a/metadata/index.json b/metadata/index.json
@@ -146,12 +146,20 @@
     "directory": "net.java.dev.jna/jna",
     "module": "net.java.dev.jna:jna"
   },
+  {
+    "directory": "com.github.luben/zstd-jni",
+    "module": "com.github.luben:zstd-jni"
+  },
   {
     "directory": "org.testcontainers/testcontainers",
     "module": "org.testcontainers:testcontainers"
   },
   {
-    "directory": "com.github.luben/zstd-jni",
-    "module": "com.github.luben:zstd-jni"
+    "directory": "org.mockito/mockito-core",
+    "module": "org.mockito:mockito-core"
+  },
+  {
+    "directory": "org.eclipse.jetty/jetty-client",
+    "module": "org.eclipse.jetty:jetty-client"
   }
 ]
diff --git a/metadata/org.eclipse.jetty/jetty-client/11.0.12/index.json b/metadata/org.eclipse.jetty/jetty-client/11.0.12/index.json
@@ -0,0 +1,4 @@
+[
+  "reflect-config.json",
+  "resource-config.json"
+]