[#3106] Allow nested HotRod config keys to be in camel-case.

Also add support for configuring
"infinispan.client.hotrod.default_executor_factory.*"
HotRod client properties.

Signed-off-by: Carsten Lohmann <[email protected]>

Author: calohmn

client-device-connection-infinispan/src/main/java/org/eclipse/hono/deviceconnection/infinispan/client/InfinispanRemoteConfigurationOptions.java

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2021 Contributors to the Eclipse Foundation
+ * Copyright (c) 2021, 2022 Contributors to the Eclipse Foundation
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -35,6 +35,13 @@ public interface InfinispanRemoteConfigurationOptions {
      */
     Map<String, String> connectionPool();
 
+    /**
+     * Gets the default executor factory options.
+     *
+     * @return The options.
+     */
+    Map<String, String> defaultExecutorFactory();
+
     /**
      * Gets the SASL properties.
      *

client-device-connection-infinispan/src/main/java/org/eclipse/hono/deviceconnection/infinispan/client/InfinispanRemoteConfigurationProperties.java

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020, 2021 Contributors to the Eclipse Foundation
+ * Copyright (c) 2020, 2022 Contributors to the Eclipse Foundation
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -15,12 +15,13 @@
 package org.eclipse.hono.deviceconnection.infinispan.client;
 
 import java.util.Map;
+import java.util.Optional;
+import java.util.function.Function;
 
 import org.infinispan.client.hotrod.configuration.ConfigurationBuilder;
 import org.infinispan.client.hotrod.impl.ConfigurationProperties;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
+import com.google.common.base.CaseFormat;
 import com.google.common.base.MoreObjects;
 
 
@@ -30,7 +31,8 @@
  */
 public class InfinispanRemoteConfigurationProperties extends ConfigurationProperties {
 
-    private static final Logger LOG = LoggerFactory.getLogger(InfinispanRemoteConfigurationProperties.class);
+    private static final String DEFAULT_EXECUTOR_FACTORY_PREFIX = "infinispan.client.hotrod.default_executor_factory";
+    private static final String CONNECTION_POOL_PREFIX = "infinispan.client.hotrod.connection_pool";
 
     /**
      * Creates properties using default values.
@@ -57,6 +59,8 @@ public InfinispanRemoteConfigurationProperties(final InfinispanRemoteConfigurati
         setConnectionPool(options.connectionPool());
         setConnectTimeout(options.connectTimeout());
 
+        setDefaultExecutorFactory(options.defaultExecutorFactory());
+
         options.keyAlias().ifPresent(this::setKeyAlias);
         options.keyStoreCertificatePassword().ifPresent(this::setKeyStoreCertificatePassword);
         options.keyStoreFileName().ifPresent(this::setKeyStoreFileName);
@@ -91,15 +95,24 @@ public final ConfigurationBuilder getConfigurationBuilder() {
 
     /**
      * Sets the properties related to the connection pool.
+     * <p>
+     * Property keys may be in camel case or snake case.
      *
      * @param poolProperties The properties.
      */
     public final void setConnectionPool(final Map<String, String> poolProperties) {
-       poolProperties.forEach((k, v) -> {
-           final String key = String.format("%s.%s", "infinispan.client.hotrod.connection_pool", k);
-           LOG.debug("setting configuration property [{}: {}]", key, v);
-           getProperties().setProperty(key, v);
-       });
+        setProperties(poolProperties, CONNECTION_POOL_PREFIX, this::toSnakeCase);
+    }
+
+    /**
+     * Sets the properties related to the default executor factory.
+     * <p>
+     * Property keys may be in camel case or snake case.
+     *
+     * @param factoryProperties The properties.
+     */
+    public final void setDefaultExecutorFactory(final Map<String, String> factoryProperties) {
+        setProperties(factoryProperties, DEFAULT_EXECUTOR_FACTORY_PREFIX, this::toSnakeCase);
     }
 
     /**
@@ -108,25 +121,45 @@ public final void setConnectionPool(final Map<String, String> poolProperties) {
      * @param saslProperties The properties.
      */
     public final void setSaslProperties(final Map<String, String> saslProperties) {
-       saslProperties.forEach((k, v) -> {
-           final String key = String.format("%s.%s", SASL_PROPERTIES_PREFIX, k);
-           getProperties().setProperty(key, v);
-       });
+        setProperties(saslProperties, SASL_PROPERTIES_PREFIX, null);
     }
 
     /**
      * Sets the properties related to cluster configuration.
      *
-     * @param cluster The properties.
+     * @param clusterProperties The properties.
      */
-    public final void setCluster(final Map<String, String> cluster) {
-       cluster.forEach((k, v) -> {
-           final String key = String.format("%s.%s", CLUSTER_PROPERTIES_PREFIX, k);
-           getProperties().setProperty(key, v);
-       });
+    public final void setCluster(final Map<String, String> clusterProperties) {
+        setProperties(clusterProperties, CLUSTER_PROPERTIES_PREFIX, null);
+    }
+
+    private String toSnakeCase(final String key) {
+        return CaseFormat.LOWER_CAMEL.to(CaseFormat.LOWER_UNDERSCORE, key);
+    }
+
+    private void setProperties(
+            final Map<String, String> properties,
+            final String keyPrefix,
+            final Function<String, String> keyConverter) {
+
+        properties.forEach((k, v) -> {
+            final String keySuffix = Optional.ofNullable(keyConverter).map(f -> f.apply(k)).orElse(k);
+            final String key = String.format("%s.%s", keyPrefix, keySuffix);
+            getProperties().setProperty(key, v);
+        });
     }
 
     // ------- Getters/setters missing in the parent ConfigurationProperties class -------
+
+    /**
+     * Gets the keystore certificate password.
+     *
+     * @return The password.
+     */
+    public String getKeyStoreCertificatePassword() {
+        return getProperties().getProperty(KEY_STORE_CERTIFICATE_PASSWORD);
+    }
+
     /**
      * Gets the SSL ciphers.
      *

client-device-connection-infinispan/src/test/java/org/eclipse/hono/deviceconnection/infinispan/client/InfinispanRemoteConfigurationPropertiesTest.java

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020 Contributors to the Eclipse Foundation
+ * Copyright (c) 2020, 2022 Contributors to the Eclipse Foundation
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -47,4 +47,10 @@ void testConnectionPoolProperties() {
         assertThat(config.connectionPool().minEvictableIdleTime()).isGreaterThan(0L);
     }
 
+    @Test
+    void testDefaultExecutorFactoryProperties() {
+        props.setDefaultExecutorFactory(Map.of("pool_size", "50"));
+        assertThat(props.getDefaultExecutorFactoryPoolSize()).isEqualTo(50);
+    }
+
 }

client-device-connection-infinispan/src/test/java/org/eclipse/hono/deviceconnection/infinispan/client/QuarkusPropertyBindingTest.java

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2021 Contributors to the Eclipse Foundation
+ * Copyright (c) 2021, 2022 Contributors to the Eclipse Foundation
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -16,9 +16,14 @@
 
 import static com.google.common.truth.Truth.assertThat;
 
+import java.util.List;
+
 import javax.inject.Inject;
+import javax.security.sasl.Sasl;
 
-import org.infinispan.client.hotrod.impl.ConfigurationProperties;
+import org.infinispan.client.hotrod.configuration.ClusterConfiguration;
+import org.infinispan.client.hotrod.configuration.Configuration;
+import org.infinispan.client.hotrod.configuration.ConfigurationBuilder;
 import org.junit.jupiter.api.Test;
 
 import io.quarkus.test.junit.QuarkusTest;
@@ -52,19 +57,40 @@ void testCommonCacheConfigurationPropertiesArePickedUp() {
     void testRemoteCacheConfigurationPropertiesArePickedUp() {
         assertThat(remoteCacheOptions).isNotNull();
         final var remoteCacheConfig = new InfinispanRemoteConfigurationProperties(remoteCacheOptions);
+        final Configuration builtRemoteCacheConfig = new ConfigurationBuilder()
+                .withProperties(remoteCacheConfig.getProperties()).build(false);
+
         assertThat(remoteCacheConfig.getServerList()).contains("data-grid:11222");
         assertThat(remoteCacheConfig.getAuthUsername()).isEqualTo("user");
         assertThat(remoteCacheConfig.getAuthPassword()).isEqualTo("secret");
         assertThat(remoteCacheConfig.getAuthRealm()).isEqualTo("ApplicationRealm");
+
+        final List<ClusterConfiguration> clusters = builtRemoteCacheConfig.clusters();
+        assertThat(clusters.size()).isEqualTo(2);
+        assertThat(clusters.get(0).getClusterName()).isEqualTo("siteA");
+        assertThat(clusters.get(0).getCluster().size()).isEqualTo(2);
+        assertThat(clusters.get(0).getCluster().get(0).host()).isEqualTo("hostA1");
+        assertThat(clusters.get(0).getCluster().get(0).port()).isEqualTo(11222);
+        assertThat(clusters.get(1).getClusterName()).isEqualTo("siteB");
+
+        assertThat(remoteCacheConfig.gtConnectionPoolMinIdle()).isEqualTo(10);
+        assertThat(remoteCacheConfig.getConnectionPoolMaxActive()).isEqualTo(10);
+        assertThat(remoteCacheConfig.getConnectionPoolMaxPendingRequests()).isEqualTo(400);
+        assertThat(remoteCacheConfig.getConnectionPoolMaxWait()).isEqualTo(500);
+
+        assertThat(remoteCacheConfig.getDefaultExecutorFactoryPoolSize()).isEqualTo(200);
+
         assertThat(remoteCacheConfig.getSaslMechanism()).contains("DIGEST-MD5");
+        final var saslProperties = builtRemoteCacheConfig.security().authentication().saslProperties();
+        assertThat(saslProperties.get(Sasl.QOP)).isEqualTo("auth");
+
         assertThat(remoteCacheConfig.getSoTimeout()).isEqualTo(5000);
         assertThat(remoteCacheConfig.getConnectTimeout()).isEqualTo(5000);
         assertThat(remoteCacheConfig.getKeyStoreFileName()).isEqualTo("/etc/hono/key-store.p12");
         assertThat(remoteCacheConfig.getKeyStoreType()).isEqualTo("PKCS12");
         assertThat(remoteCacheConfig.getKeyStorePassword()).isEqualTo("key-store-secret");
         assertThat(remoteCacheConfig.getKeyAlias()).isEqualTo("infinispan");
-        assertThat(remoteCacheConfig.getProperties().getProperty(ConfigurationProperties.KEY_STORE_CERTIFICATE_PASSWORD))
-            .isEqualTo("cert-secret");
+        assertThat(remoteCacheConfig.getKeyStoreCertificatePassword()).isEqualTo("cert-secret");
         assertThat(remoteCacheConfig.getTrustStoreFileName()).isEqualTo("/etc/hono/trust-store-file.p12");
         assertThat(remoteCacheConfig.getTrustStorePath()).isEqualTo("/etc/hono/trust-store.p12");
         assertThat(remoteCacheConfig.getTrustStoreType()).isEqualTo("PKCS12");

client-device-connection-infinispan/src/test/resources/application.yaml

@@ -10,7 +10,19 @@ hono:
       authUsername: "user"
       authPassword: "secret"
       authRealm: "ApplicationRealm"
+      cluster:
+        siteA: "hostA1:11222; hostA2:11223"
+        siteB: "hostB1:11222; hostB2:11223"
+      connectionPool:
+        minIdle: 10
+        maxActive: 10
+        maxPendingRequests: 400
+        maxWait: 500
+      defaultExecutorFactory:
+        poolSize: 200
       saslMechanism: "DIGEST-MD5"
+      saslProperties:
+        "javax.security.sasl.qop": "auth"
       socketTimeout: 5000
       connectTimeout: 5000
       keyStoreFileName: "/etc/hono/key-store.p12"

site/homepage/content/release-notes.md

@@ -13,6 +13,8 @@ description = "Information about changes in recent Hono releases. Includes new f
   *hono.mongodb.connectionString* property. This has been fixed.
 * Using OpenSSL with the Quarkus based variant of Hono components did not work as described in the Secure Communication
   guide. This has been fixed.
+* The connection pool configuration for the HotRod client in the Quarkus variant of the Command Router component
+  didn't support using property names in camel-case. This has been fixed.
 
 ## 1.12.0