Added metadata for eclipse paho mqttv3 and mqttv5 clients (#332)

msupic · web-flow · commit 58a306bea1f5 · 2023-07-26T17:03:38.000+02:00
* Added metadata for org.eclipse.paho:org.eclipse.paho.client.mqttv3:1.2.5

* Added metadata for org.eclipse.paho:org.eclipse.paho.mqttv5.client:1.2.5
diff --git a/metadata/index.json b/metadata/index.json
@@ -380,6 +380,20 @@
       "org.eclipse"
     ]
   },
+  {
+    "directory" : "org.eclipse.paho/org.eclipse.paho.client.mqttv3",
+    "module" : "org.eclipse.paho:org.eclipse.paho.client.mqttv3",
+    "allowed-packages" : [
+      "org.eclipse.paho.client.mqttv3"
+    ]
+  },
+  {
+    "directory" : "org.eclipse.paho/org.eclipse.paho.mqttv5.client",
+    "module" : "org.eclipse.paho:org.eclipse.paho.mqttv5.client",
+    "allowed-packages" : [
+      "org.eclipse.paho.mqttv5"
+    ]
+  },
   {
     "directory": "org.liquibase/liquibase-core",
     "module": "org.liquibase:liquibase-core",
diff --git a/metadata/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/index.json b/metadata/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/index.json
@@ -0,0 +1,4 @@
+[
+  "reflect-config.json",
+  "resource-config.json"
+]
diff --git a/metadata/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/reflect-config.json b/metadata/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/reflect-config.json
@@ -0,0 +1,16 @@
+[
+  {
+    "name": "org.eclipse.paho.client.mqttv3.logging.JSR47Logger",
+    "condition": {
+      "typeReachable": "org.eclipse.paho.client.mqttv3.logging.LoggerFactory"
+    },
+    "methods": [
+      {
+        "name": "<init>",
+        "parameterTypes": [
+
+        ]
+      }
+    ]
+  }
+]
diff --git a/metadata/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/resource-config.json b/metadata/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/resource-config.json
@@ -0,0 +1,17 @@
+{
+  "resources": {
+    "includes": [
+      {
+        "pattern": "\\QMETA-INF/services/org.eclipse.paho.client.mqttv3.spi.NetworkModuleFactory\\E",
+        "condition": {
+          "typeReachable": "org.eclipse.paho.client.mqttv3.internal.NetworkModuleService"
+        }
+      }
+    ]
+  },
+  "bundles": [
+    {
+      "name": "org.eclipse.paho.client.mqttv3.internal.nls.logcat"
+    }
+  ]
+}
diff --git a/metadata/org.eclipse.paho/org.eclipse.paho.client.mqttv3/index.json b/metadata/org.eclipse.paho/org.eclipse.paho.client.mqttv3/index.json
@@ -0,0 +1,10 @@
+[
+  {
+    "latest": true,
+    "metadata-version": "1.2.5",
+    "module": "org.eclipse.paho:org.eclipse.paho.client.mqttv3",
+    "tested-versions": [
+      "1.2.5"
+    ]
+  }
+]
diff --git a/metadata/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/index.json b/metadata/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/index.json
@@ -0,0 +1,4 @@
+[
+  "reflect-config.json",
+  "resource-config.json"
+]
diff --git a/metadata/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/reflect-config.json b/metadata/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/reflect-config.json
@@ -0,0 +1,16 @@
+[
+  {
+    "name": "org.eclipse.paho.mqttv5.client.logging.JSR47Logger",
+    "condition": {
+      "typeReachable": "org.eclipse.paho.mqttv5.client.logging.LoggerFactory"
+    },
+    "methods": [
+      {
+        "name": "<init>",
+        "parameterTypes": [
+
+        ]
+      }
+    ]
+  }
+]
diff --git a/metadata/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/resource-config.json b/metadata/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/resource-config.json
@@ -0,0 +1,17 @@
+{
+  "resources": {
+    "includes": [
+      {
+        "pattern": "\\QMETA-INF/services/org.eclipse.paho.mqttv5.client.spi.NetworkModuleFactory\\E",
+        "condition": {
+          "typeReachable": "org.eclipse.paho.mqttv5.client.internal.NetworkModuleService"
+        }
+      }
+    ]
+  },
+  "bundles": [
+    {
+      "name": "org.eclipse.paho.mqttv5.client.internal.nls.logcat"
+    }
+  ]
+}
diff --git a/metadata/org.eclipse.paho/org.eclipse.paho.mqttv5.client/index.json b/metadata/org.eclipse.paho/org.eclipse.paho.mqttv5.client/index.json
@@ -0,0 +1,10 @@
+[
+  {
+    "latest": true,
+    "metadata-version": "1.2.5",
+    "module": "org.eclipse.paho:org.eclipse.paho.mqttv5.client",
+    "tested-versions": [
+      "1.2.5"
+    ]
+  }
+]
diff --git a/tests/src/index.json b/tests/src/index.json
@@ -571,6 +571,28 @@
       }
     ]
   },
+  {
+    "test-project-path" : "org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5",
+    "libraries" : [
+      {
+        "name" : "org.eclipse.paho:org.eclipse.paho.client.mqttv3",
+        "versions" : [
+          "1.2.5"
+        ]
+      }
+    ]
+  },
+  {
+    "test-project-path" : "org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5",
+    "libraries" : [
+      {
+        "name" : "org.eclipse.paho:org.eclipse.paho.mqttv5.client",
+        "versions" : [
+          "1.2.5"
+        ]
+      }
+    ]
+  },
   {
     "test-project-path": "org.liquibase/liquibase-core/4.17.0",
     "libraries": [
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/.gitignore b/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/.gitignore
@@ -0,0 +1,4 @@
+gradlew.bat
+gradlew
+gradle/
+build/
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/build.gradle b/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/build.gradle
@@ -0,0 +1,29 @@
+/*
+ * Copyright and related rights waived via CC0
+ *
+ * You should have received a copy of the CC0 legalcode along with this
+ * work. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
+ */
+
+plugins {
+    id "org.graalvm.internal.tck"
+}
+
+String libraryVersion = tck.testedLibraryVersion.get()
+
+dependencies {
+    testImplementation "org.eclipse.paho:org.eclipse.paho.client.mqttv3:$libraryVersion"
+    testImplementation 'org.assertj:assertj-core:3.22.0'
+}
+
+graalvmNative {
+    agent {
+        defaultMode = "conditional"
+        modes {
+            conditional {
+                userCodeFilterPath = "metadata-user-code-filter.json"
+                extraFilterPath = "metadata-extra-filter.json"
+            }
+        }
+    }
+}
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/gradle.properties b/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/gradle.properties
@@ -0,0 +1,2 @@
+library.version = 1.2.5
+metadata.dir = org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/metadata-extra-filter.json b/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/metadata-extra-filter.json
@@ -0,0 +1,5 @@
+{
+  "rules": [
+    {"includeClasses": "org.eclipse.paho.**"}
+  ]
+}
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/metadata-user-code-filter.json b/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/metadata-user-code-filter.json
@@ -0,0 +1,5 @@
+{
+  "rules": [
+    {"includeClasses": "org.eclipse.paho.**"}
+  ]
+}
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/required-docker-images.txt b/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/required-docker-images.txt
@@ -0,0 +1 @@
+eclipse-mosquitto:2.0.15
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/settings.gradle b/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/settings.gradle
@@ -0,0 +1,13 @@
+pluginManagement {
+    def tckPath = Objects.requireNonNullElse(
+            System.getenv("GVM_TCK_TCKDIR"),
+            "../../../../tck-build-logic"
+    )
+    includeBuild(tckPath)
+}
+
+plugins {
+    id "org.graalvm.internal.tck-settings" version "1.0.0-SNAPSHOT"
+}
+
+rootProject.name = 'org.eclipse.paho.org.eclipse.paho.client.mqttv3_tests'
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/src/test/java/org_eclipse_paho/org_eclipse_paho_client_mqttv3/Mqttv3Test.java b/tests/src/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.5/src/test/java/org_eclipse_paho/org_eclipse_paho_client_mqttv3/Mqttv3Test.java
@@ -0,0 +1,124 @@
+/*
+ * Copyright and related rights waived via CC0
+ *
+ * You should have received a copy of the CC0 legalcode along with this
+ * work. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
+ */
+package org_eclipse_paho.org_eclipse_paho_client_mqttv3;
+
+import org.eclipse.paho.client.mqttv3.IMqttDeliveryToken;
+import org.eclipse.paho.client.mqttv3.MqttAsyncClient;
+import org.eclipse.paho.client.mqttv3.MqttCallback;
+import org.eclipse.paho.client.mqttv3.MqttClient;
+import org.eclipse.paho.client.mqttv3.MqttException;
+import org.eclipse.paho.client.mqttv3.MqttMessage;
+import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInstance;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.Callable;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+class Mqttv3Test {
+
+    private static final String BROKER = "tcp://localhost:1883";
+
+    private static final String CLIENT_ID = MqttAsyncClient.generateClientId();
+
+    private static final String TOPIC = "Metadata Topic";
+
+    private final MemoryPersistence persistence = new MemoryPersistence();
+
+    private Process process;
+
+    private MqttClient client;
+
+    @BeforeAll
+    void beforeAll() throws IOException, MqttException {
+        System.out.println("Starting MQTT broker ...");
+        process = new ProcessBuilder("docker", "run", "--rm", "-p", "1883:1883", "eclipse-mosquitto:2.0.15", "mosquitto", "-c", "/mosquitto-no-auth.conf")
+                .inheritIO()
+                .start();
+
+        client = new MqttClient(BROKER, CLIENT_ID, persistence);
+
+        waitUntil(() -> {
+            client.connect();
+            return true;
+        }, 120, 1);
+
+        System.out.println("MQTT broker started");
+    }
+
+    @AfterAll
+    public void close() throws MqttException {
+        if (client != null) {
+            client.disconnect();
+            client.close();
+        }
+        if (process != null && process.isAlive()) {
+            System.out.println("Shutting down MQTT broker");
+            process.destroy();
+        }
+    }
+
+    // not using Awaitility library because of `com.oracle.svm.core.jdk.UnsupportedFeatureError: ThreadMXBean methods` issue
+    // which happens if a condition is not fulfilled when a test is running in a native image
+    private void waitUntil(Callable<Boolean> conditionEvaluator, int timeoutSeconds, int sleepTimeSeconds) {
+        Exception lastException = null;
+
+        long end  = System.currentTimeMillis() + timeoutSeconds * 1000L;
+        while (System.currentTimeMillis() < end) {
+            try {
+                Thread.sleep(sleepTimeSeconds * 1000L);
+            } catch (InterruptedException e) {
+                // continue
+            }
+            try {
+                if (conditionEvaluator.call()) {
+                    return;
+                }
+            } catch (Exception e) {
+                lastException = e;
+            }
+        }
+        String errorMessage = "Condition was not fulfilled within " + timeoutSeconds + " seconds";
+        throw lastException == null ? new IllegalStateException(errorMessage) : new IllegalStateException(errorMessage, lastException);
+    }
+
+    @Test
+    void test() throws Exception {
+        final List<String> receivedMessages = new ArrayList<>();
+        client.setCallback(new MqttCallback() {
+
+            public void messageArrived(String topic, MqttMessage message) throws Exception {
+                receivedMessages.add(new String(message.getPayload()));
+            }
+
+            public void connectionLost(Throwable cause) {
+                receivedMessages.add("Connection to MQTT broker lost: " + cause.getMessage());
+            }
+
+            public void deliveryComplete(IMqttDeliveryToken token) {
+            }
+        });
+        client.subscribe(TOPIC, 0);
+
+        MqttMessage message = new MqttMessage("test-message".getBytes());
+        message.setQos(0);
+        client.publish(TOPIC, message);
+
+        waitUntil(() -> !receivedMessages.isEmpty(), 10, 1);
+
+        assertThat(receivedMessages)
+                .hasSize(1)
+                .containsExactly("test-message");
+    }
+}
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/.gitignore b/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/.gitignore
@@ -0,0 +1,4 @@
+gradlew.bat
+gradlew
+gradle/
+build/
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/build.gradle b/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/build.gradle
@@ -0,0 +1,29 @@
+/*
+ * Copyright and related rights waived via CC0
+ *
+ * You should have received a copy of the CC0 legalcode along with this
+ * work. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
+ */
+
+plugins {
+    id "org.graalvm.internal.tck"
+}
+
+String libraryVersion = tck.testedLibraryVersion.get()
+
+dependencies {
+    testImplementation "org.eclipse.paho:org.eclipse.paho.mqttv5.client:$libraryVersion"
+    testImplementation 'org.assertj:assertj-core:3.22.0'
+}
+
+graalvmNative {
+    agent {
+        defaultMode = "conditional"
+        modes {
+            conditional {
+                userCodeFilterPath = "metadata-user-code-filter.json"
+                extraFilterPath = "metadata-extra-filter.json"
+            }
+        }
+    }
+}
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/gradle.properties b/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/gradle.properties
@@ -0,0 +1,2 @@
+library.version = 1.2.5
+metadata.dir = org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/metadata-extra-filter.json b/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/metadata-extra-filter.json
@@ -0,0 +1,5 @@
+{
+  "rules": [
+    {"includeClasses": "org.eclipse.paho.**"}
+  ]
+}
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/metadata-user-code-filter.json b/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/metadata-user-code-filter.json
@@ -0,0 +1,5 @@
+{
+  "rules": [
+    {"includeClasses": "org.eclipse.paho.**"}
+  ]
+}
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/required-docker-images.txt b/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/required-docker-images.txt
@@ -0,0 +1 @@
+eclipse-mosquitto:2.0.15
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/settings.gradle b/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/settings.gradle
diff --git a/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/src/test/java/org_eclipse_paho/org_eclipse_paho_mqttv5_client/Mqttv5ClientTest.java b/tests/src/org.eclipse.paho/org.eclipse.paho.mqttv5.client/1.2.5/src/test/java/org_eclipse_paho/org_eclipse_paho_mqttv5_client/Mqttv5ClientTest.java

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +[
 +  "reflect-config.json",
 +  "resource-config.json"
 +]