Merge pull request #650 from hexagonkt/develop

Native image metadata :fix and documentation update

build.gradle.kts

@@ -83,27 +83,52 @@ task("nativeTestModules") {
         val entries = subprojects
             .filter { sp -> sp.tasks.any { t -> t.name == "nativeTest" } }
             .joinToString(",\n") { sp ->
-                val spd = gitHub + sp.projectDir.absolutePath.removePrefix(rootDir.absolutePath)
-                """
-                {
-                  "artifact": "${sp.group}:${sp.name}",
-                  "description": "${sp.description}",
-                  "details": [
+                val n = sp.name
+                val g = sp.group
+                val d = gitHub + sp.projectDir.absolutePath.removePrefix(rootDir.absolutePath)
+                val r = sp.projectDir.resolve("src/main/resources/META-INF/native-image/$g/$n")
+                val t = "$d/src/test"
+                if (r.exists())
+                    """
                     {
-                      "minimum_version": "${sp.version}",
-                      "test_level": "fully-tested"
-                      "metadata_locations": [
-                        "$spd"
-                      ],
-                      "tests_locations": [
-                        "$spd"
-                      ],
+                      "artifact": "$g:$n",
+                      "description": "${sp.description}",
+                      "details": [
+                        {
+                          "minimum_version": "${sp.version}",
+                          "test_level": "fully-tested",
+                          "metadata_locations": [
+                            "$gitHub${r.absolutePath.removePrefix(rootDir.absolutePath)}"
+                          ],
+                          "tests_locations": [
+                            "$t",
+                            "https://github.com/hexagonkt/hexagon/actions/workflows/nightly.yml"
+                          ]
+                        }
+                      ]
                     }
-                  ]
-                }
-                """.trimIndent()
+                    """.trimIndent()
+                else
+                    """
+                    {
+                      "artifact": "$g:$n",
+                      "description": "${sp.description}",
+                      "details": [
+                        {
+                          "minimum_version": "${sp.version}",
+                          "test_level": "fully-tested",
+                          "tests_locations": [
+                            "$t",
+                            "https://github.com/hexagonkt/hexagon/actions/workflows/nightly.yml"
+                          ]
+                        }
+                      ]
+                    }
+                    """.trimIndent()
             }
-        println(entries)
+            .lines()
+            .joinToString("") { "  $it\n" }
+        println("[\n$entries\n]")
     }
 }
 

gradle.properties

@@ -5,7 +5,7 @@ org.gradle.warning.mode=all
 org.gradle.console=plain
 
 # Gradle
-version=3.0.0
+version=3.0.1
 group=com.hexagonkt
 description=The atoms of your platform
 
@@ -33,7 +33,7 @@ iconsDirectory=content
 # VERSIONS
 kotlinVersion=1.9.0
 dokkaVersion=1.8.20
-mockkVersion=1.13.5
+mockkVersion=1.13.7
 junitVersion=5.10.0
 gatlingVersion=3.9.5
 jmhVersion=1.37

http/http_client/build.gradle.kts

@@ -9,6 +9,9 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description =
+    "HTTP client supporting SSL, cookies, WebSockets, and HTTP/2. Requires an adapter to be used."
+
 dependencies {
     "api"(project(":http:http_handlers"))
 }

http/http_client_jetty/build.gradle.kts

@@ -9,6 +9,8 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "HTTP client adapter for Jetty (without WebSockets support)."
+
 dependencies {
     val jettyVersion = properties["jettyVersion"]
 

http/http_client_jetty_ws/build.gradle.kts

@@ -9,6 +9,8 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "HTTP client adapter for Jetty (with WebSockets support)."
+
 dependencies {
     "api"(project(":http:http_client_jetty"))
     "api"("org.eclipse.jetty.websocket:jetty-websocket-jetty-client")

http/http_handlers/build.gradle.kts

@@ -9,6 +9,8 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "HTTP handlers used to apply many callbacks to HTTP calls."
+
 dependencies {
     "api"(project(":http:http"))
     "api"(project(":handlers"))

http/http_server/build.gradle.kts

@@ -9,6 +9,9 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description =
+    "HTTP server supporting SSL, cookies, WebSockets, and HTTP/2. Requires an adapter to be used."
+
 dependencies {
     "api"(project(":http:http_handlers"))
 }

http/http_server_jetty/build.gradle.kts

@@ -9,6 +9,8 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "HTTP server adapter for Jetty (using Servlets under the hood)."
+
 dependencies {
     val jettyVersion = properties["jettyVersion"]
 

http/http_server_jetty/src/main/resources/META-INF/native-image/com.hexagonkt/http_server_jetty/native-image.properties

@@ -1 +1,3 @@
-Args=--enable-preview
+Args= \
+  --enable-preview \
+  -H:IncludeResources=.*\\.css

http/http_server_jetty/src/test/resources/META-INF/native-image/com.hexagonkt/http_server_jetty/native-image.properties

@@ -1,5 +1,4 @@
 Args= \
-  -H:IncludeResources=.* \
   --initialize-at-build-time=org.junit.platform.launcher.core.LauncherConfig \
   --initialize-at-build-time=org.junit.jupiter.engine.config.InstantiatingConfigurationParameterConverter \
   --initialize-at-build-time=org.junit.jupiter.api.condition.OS \

http/http_server_netty/build.gradle.kts

@@ -9,6 +9,8 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "HTTP server adapter for Netty."
+
 dependencies {
     val nettyVersion = properties["nettyVersion"]
     val nettyTcNativeVersion = properties["nettyTcNativeVersion"]

http/http_server_netty_epoll/build.gradle.kts

@@ -9,6 +9,8 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "HTTP server adapter for Netty (using Linux Epoll)."
+
 dependencies {
     "api"(project(":http:http_server_netty"))
     "api"("io.netty:netty-transport-native-epoll")

http/http_server_nima/build.gradle.kts

@@ -9,6 +9,8 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "HTTP server adapter for Helidon Nima (using Java Virtual Threads)."
+
 dependencies {
     val nimaVersion = properties["nimaVersion"]
 

http/http_server_servlet/build.gradle.kts

@@ -8,6 +8,8 @@ apply(from = "$rootDir/gradle/publish.gradle")
 apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "HTTP server adapter to be used on JEE Web Applications (deployed inside a server)."
+
 dependencies {
     val servletVersion = properties["servletVersion"]
     val jettyVersion = properties["jettyVersion"]

http/rest/build.gradle.kts

@@ -9,6 +9,8 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "HTTP server extensions to ease the development of REST APIs."
+
 dependencies {
     "api"(project(":http:http_handlers"))
     "api"(project(":serialization:serialization"))

http/rest_tools/build.gradle.kts

@@ -9,7 +9,7 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
-description = "Test cases for HTTP client and server adapters."
+description = "Tools to test and document REST services."
 
 dependencies {
     val swaggerParserVersion = properties["swaggerParserVersion"]

http/web/build.gradle.kts

@@ -9,6 +9,8 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "HTTP server extensions to ease the development of dynamic Web applications."
+
 dependencies {
     "api"(project(":http:http_server"))
     "api"(project(":templates:templates"))

templates/templates/build.gradle.kts

@@ -9,6 +9,10 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description =
+    "Template processing port. Supports template loading and context passing. " +
+    "Allow multiple adapters at once."
+
 dependencies {
     "api"(project(":core"))
 

templates/templates_freemarker/build.gradle.kts

@@ -9,6 +9,8 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "Template processor adapter for Freemarker."
+
 dependencies {
     "api"(project(":templates:templates"))
     "api"("org.freemarker:freemarker:${properties["freemarkerVersion"]}")

templates/templates_pebble/build.gradle.kts

@@ -9,6 +9,8 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "Template processor adapter for Pebble."
+
 dependencies {
     "api"(project(":templates:templates"))
     "api"("io.pebbletemplates:pebble:${properties["pebbleVersion"]}")

templates/templates_rocker/build.gradle.kts

@@ -10,6 +10,8 @@ apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/native.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "Template processor adapter for Rocker. Don't support dynamic template loading."
+
 dependencies {
     val rockerVersion = properties["rockerVersion"]
 

templates/templates_test/build.gradle.kts

@@ -8,6 +8,8 @@ apply(from = "$rootDir/gradle/publish.gradle")
 apply(from = "$rootDir/gradle/dokka.gradle")
 apply(from = "$rootDir/gradle/detekt.gradle")
 
+description = "Test suite to verify template processing adapters."
+
 dependencies {
     val junitVersion = properties["junitVersion"]