Migrate from legacy config classes (#247)

* Upgrade Quarkus to 3.25.0
* Updates to make the project buildable with JDK 21
* Migrate from legacy config classes to @ConfigMapping interfaces

Fixes #246

Author: jamesnetherton

.github/workflows/quarkus-build-native.yaml

@@ -11,21 +11,18 @@ jobs:
     strategy:
       matrix:
         java_version:
-          - '11'
-          # - '17'
+          - '17'
+          - '21'
     steps:
       - uses: actions/checkout@v3
       - uses: graalvm/setup-graalvm@v1
         with:
-          version: '22.3.1'
           java-version: ${{ matrix.java_version }}
-          components: 'native-image'
           github-token: ${{ secrets.GB_TOKEN }}
       - name: Build & test with native-image
         run: |
           echo "GRAALVM_HOME: $GRAALVM_HOME"
           echo "JAVA_HOME: $JAVA_HOME"
           java --version
-          gu --version
           native-image --version
           mvn verify -Prelease -Dnative -Dgpg.skip

.github/workflows/quarkus-build.yaml

@@ -7,8 +7,8 @@ jobs:
     strategy:
       matrix:
         java_version:
-          - '11'
           - '17'
+          - '21'
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-java@v3

deployment/src/main/java/com/datastax/oss/quarkus/deployment/api/CassandraClientBuildTimeConfig.java

@@ -18,9 +18,11 @@
 import com.datastax.oss.driver.api.core.metadata.NodeStateListener;
 import com.datastax.oss.driver.api.core.metadata.schema.SchemaChangeListener;
 import com.datastax.oss.driver.api.core.tracker.RequestTracker;
-import io.quarkus.runtime.annotations.ConfigItem;
 import io.quarkus.runtime.annotations.ConfigPhase;
 import io.quarkus.runtime.annotations.ConfigRoot;
+import io.smallrye.config.ConfigMapping;
+import io.smallrye.config.WithDefault;
+import io.smallrye.config.WithName;
 import java.util.List;
 import java.util.Optional;
 
@@ -30,14 +32,16 @@
  * <p>Settings specified in application.properties under the {@code quarkus.cassandra} prefix will
  * be mapped to fields in this class and its child configuration classes.
  */
-@ConfigRoot(name = "cassandra", phase = ConfigPhase.BUILD_TIME)
-public class CassandraClientBuildTimeConfig {
+@ConfigMapping(prefix = "quarkus.cassandra")
+@ConfigRoot(phase = ConfigPhase.BUILD_TIME)
+public interface CassandraClientBuildTimeConfig {
 
   /**
    * Whether or not an health check is published in case the smallrye-health extension is present.
    */
-  @ConfigItem(name = "health.enabled", defaultValue = "true")
-  public boolean healthEnabled;
+  @WithName("health.enabled")
+  @WithDefault("true")
+  boolean healthEnabled();
 
   /**
    * Whether or not metrics for the Cassandra driver should be published.
@@ -70,8 +74,9 @@ public class CassandraClientBuildTimeConfig {
    * href="https://docs.datastax.com/en/developer/java-driver/latest/manual/core/metrics/#configuration">
    * Metrics configuration</a> in the Java driver manual.
    */
-  @ConfigItem(name = "metrics.enabled", defaultValue = "false")
-  public boolean metricsEnabled;
+  @WithName("metrics.enabled")
+  @WithDefault("false")
+  boolean metricsEnabled();
 
   /**
    * The name of the algorithm used to compress protocol frames.
@@ -87,18 +92,16 @@ public class CassandraClientBuildTimeConfig {
    *       mode.</em>
    * </ul>
    */
-  @ConfigItem(name = "protocol.compression", defaultValue = "none")
-  public String protocolCompression;
+  @WithName("protocol.compression")
+  @WithDefault("none")
+  String protocolCompression();
 
   /** The classes of {@link RequestTracker} implementations to register. */
-  @ConfigItem(name = "request-trackers")
-  public Optional<List<String>> requestTrackers;
+  Optional<List<String>> requestTrackers();
 
   /** The classes of {@link NodeStateListener} implementations to register. */
-  @ConfigItem(name = "node-state-listeners")
-  public Optional<List<String>> nodeStateListeners;
+  Optional<List<String>> nodeStateListeners();
 
   /** The classes of {@link SchemaChangeListener} implementations to register. */
-  @ConfigItem(name = "schema-change-listeners")
-  public Optional<List<String>> schemaChangeListeners;
+  Optional<List<String>> schemaChangeListeners();
 }

deployment/src/main/java/com/datastax/oss/quarkus/deployment/internal/CassandraClientProcessor.java

@@ -109,7 +109,7 @@ List<ReflectiveClassBuildItem> registerReactiveForReflection() {
   @BuildStep
   List<ReflectiveClassBuildItem> registerLz4ForReflection(
       CassandraClientBuildTimeConfig buildTimeConfig) {
-    if (buildTimeConfig.protocolCompression.equalsIgnoreCase("lz4")) {
+    if (buildTimeConfig.protocolCompression().equalsIgnoreCase("lz4")) {
       return Collections.singletonList(
           ReflectiveClassBuildItem.builder(
                   "net.jpountz.lz4.LZ4Compressor",
@@ -135,7 +135,7 @@ List<ReflectiveClassBuildItem> registerRequestTrackersForReflection(
       CassandraClientRecorder recorder,
       BeanContainerBuildItem beanContainer) {
     return buildTimeConfig
-        .requestTrackers
+        .requestTrackers()
         .map(
             classes ->
                 classes.stream()
@@ -155,7 +155,7 @@ List<ReflectiveClassBuildItem> registerNodeStateListenersForReflection(
       CassandraClientRecorder recorder,
       BeanContainerBuildItem beanContainer) {
     return buildTimeConfig
-        .nodeStateListeners
+        .nodeStateListeners()
         .map(
             classes ->
                 classes.stream()
@@ -175,7 +175,7 @@ List<ReflectiveClassBuildItem> registerSchemaChangeListenersForReflection(
       CassandraClientRecorder recorder,
       BeanContainerBuildItem beanContainer) {
     return buildTimeConfig
-        .schemaChangeListeners
+        .schemaChangeListeners()
         .map(
             classes ->
                 classes.stream()
@@ -199,7 +199,7 @@ List<ReflectiveClassBuildItem> registerMetricsFactoriesForReflection(
       CassandraClientBuildTimeConfig buildTimeConfig,
       Optional<MetricsCapabilityBuildItem> metricsCapability) {
 
-    if (buildTimeConfig.metricsEnabled && metricsCapability.isPresent()) {
+    if (buildTimeConfig.metricsEnabled() && metricsCapability.isPresent()) {
 
       Stream<String> clzStream = Stream.empty();
       MetricsCapabilityBuildItem metricsCapabilityItem = metricsCapability.get();
@@ -249,7 +249,7 @@ void configureMetrics(
       CassandraClientBuildTimeConfig buildTimeConfig,
       Optional<MetricsCapabilityBuildItem> metricsCapability,
       BeanContainerBuildItem beanContainer) {
-    if (buildTimeConfig.metricsEnabled) {
+    if (buildTimeConfig.metricsEnabled()) {
       if (metricsCapability.isPresent()) {
         MetricsCapabilityBuildItem metricsCapabilityItem = metricsCapability.get();
         if (metricsCapabilityItem.metricsSupported(MetricsFactory.MICROMETER)) {
@@ -312,7 +312,7 @@ void configureCompression(
       CassandraClientRecorder recorder,
       CassandraClientBuildTimeConfig buildTimeConfig,
       BeanContainerBuildItem beanContainer) {
-    recorder.configureCompression(buildTimeConfig.protocolCompression);
+    recorder.configureCompression(buildTimeConfig.protocolCompression());
   }
 
   @BuildStep
@@ -339,7 +339,7 @@ CassandraClientBuildItem cassandraClient(
   HealthBuildItem addHealthCheck(CassandraClientBuildTimeConfig buildTimeConfig) {
     return new HealthBuildItem(
         "com.datastax.oss.quarkus.runtime.internal.health.CassandraAsyncHealthCheck",
-        buildTimeConfig.healthEnabled);
+        buildTimeConfig.healthEnabled());
   }
 
   /**

deployment/src/test/java/com/datastax/oss/quarkus/deployment/internal/metrics/CassandraMetricsDisabledTest.java

@@ -24,8 +24,8 @@
 import com.datastax.oss.quarkus.test.CassandraTestResource;
 import io.micrometer.core.instrument.Meter.Id;
 import io.micrometer.core.instrument.MeterRegistry;
-import io.quarkus.bootstrap.model.AppArtifact;
 import io.quarkus.builder.Version;
+import io.quarkus.maven.dependency.Dependency;
 import io.quarkus.test.QuarkusUnitTest;
 import io.quarkus.test.common.QuarkusTestResource;
 import jakarta.inject.Inject;
@@ -53,8 +53,8 @@ public class CassandraMetricsDisabledTest {
           // Micrometer is present...
           .setForcedDependencies(
               Arrays.asList(
-                  new AppArtifact("io.quarkus", "quarkus-micrometer", Version.getVersion()),
-                  new AppArtifact("io.quarkus", "quarkus-resteasy", Version.getVersion())))
+                  Dependency.of("io.quarkus", "quarkus-micrometer", Version.getVersion()),
+                  Dependency.of("io.quarkus", "quarkus-resteasy", Version.getVersion())))
           // but Cassandra metrics are disabled
           .overrideConfigKey("quarkus.cassandra.metrics.enabled", "false");
 
@@ -78,6 +78,6 @@ public void should_not_enable_metrics_when_metrics_disabled_by_configuration() {
   }
 
   private boolean filterAllCassandraMetrics(Id id) {
-    return id.getName().startsWith(config.cassandraClientMetricsConfig.prefix);
+    return id.getName().startsWith(config.cassandraClientMetricsConfig().prefix());
   }
 }

deployment/src/test/java/com/datastax/oss/quarkus/deployment/internal/metrics/CassandraMetricsMicroProfileTest.java

@@ -21,8 +21,8 @@
 import com.datastax.oss.quarkus.runtime.api.config.CassandraClientConfig;
 import com.datastax.oss.quarkus.runtime.api.session.QuarkusCqlSession;
 import com.datastax.oss.quarkus.test.CassandraTestResource;
-import io.quarkus.bootstrap.model.AppArtifact;
 import io.quarkus.builder.Version;
+import io.quarkus.maven.dependency.Dependency;
 import io.quarkus.test.QuarkusUnitTest;
 import io.quarkus.test.common.QuarkusTestResource;
 import jakarta.inject.Inject;
@@ -58,7 +58,7 @@ public class CassandraMetricsMicroProfileTest {
               () -> ShrinkWrap.create(JavaArchive.class).addClasses(CassandraTestResource.class))
           .setForcedDependencies(
               Collections.singletonList(
-                  new AppArtifact("io.quarkus", "quarkus-smallrye-metrics", Version.getVersion())))
+                  Dependency.of("io.quarkus", "quarkus-smallrye-metrics", Version.getVersion())))
           .overrideConfigKey("quarkus.cassandra.metrics.enabled", "true");
 
   @Test
@@ -102,6 +102,6 @@ public void should_expose_correct_number_of_metrics() {
   }
 
   private boolean filterAllCassandraMetrics(MetricID id) {
-    return id.getName().startsWith(config.cassandraClientMetricsConfig.prefix);
+    return id.getName().startsWith(config.cassandraClientMetricsConfig().prefix());
   }
 }

deployment/src/test/java/com/datastax/oss/quarkus/deployment/internal/metrics/CassandraMetricsMicrometerTest.java

@@ -26,8 +26,8 @@
 import io.micrometer.core.instrument.Meter.Id;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.Timer;
-import io.quarkus.bootstrap.model.AppArtifact;
 import io.quarkus.builder.Version;
+import io.quarkus.maven.dependency.Dependency;
 import io.quarkus.test.QuarkusUnitTest;
 import io.quarkus.test.common.QuarkusTestResource;
 import jakarta.inject.Inject;
@@ -53,8 +53,8 @@ public class CassandraMetricsMicrometerTest {
               () -> ShrinkWrap.create(JavaArchive.class).addClasses(CassandraTestResource.class))
           .setForcedDependencies(
               Arrays.asList(
-                  new AppArtifact("io.quarkus", "quarkus-micrometer", Version.getVersion()),
-                  new AppArtifact("io.quarkus", "quarkus-resteasy", Version.getVersion())))
+                  Dependency.of("io.quarkus", "quarkus-micrometer", Version.getVersion()),
+                  Dependency.of("io.quarkus", "quarkus-resteasy", Version.getVersion())))
           .overrideConfigKey("quarkus.cassandra.metrics.enabled", "true")
           // test a different prefix
           .overrideConfigKey("quarkus.cassandra.metrics.prefix", "custom.prefix");
@@ -97,7 +97,7 @@ public void should_expose_correct_number_of_metrics() {
   }
 
   private boolean filterAllCassandraMetrics(Id id) {
-    assertThat(config.cassandraClientMetricsConfig.prefix).isEqualTo("custom.prefix");
-    return id.getName().startsWith(config.cassandraClientMetricsConfig.prefix);
+    assertThat(config.cassandraClientMetricsConfig().prefix()).isEqualTo("custom.prefix");
+    return id.getName().startsWith(config.cassandraClientMetricsConfig().prefix());
   }
 }

integration-tests/dse/pom.xml

@@ -141,8 +141,8 @@
         </property>
       </activation>
       <properties>
-        <!-- This module cannot run in native mode so force the package type to jar and skip tests -->
-        <quarkus.package.type>jar</quarkus.package.type>
+        <!-- This module cannot run in native mode so skip tests -->
+        <quarkus.native.enabled>false</quarkus.native.enabled>
         <skipITs>true</skipITs>
       </properties>
     </profile>

integration-tests/pom.xml

@@ -116,7 +116,7 @@
         </property>
       </activation>
       <properties>
-        <quarkus.package.type>native</quarkus.package.type>
+        <quarkus.native.enabled>true</quarkus.native.enabled>
         <quarkus.native.enable-http-url-handler>true</quarkus.native.enable-http-url-handler>
         <failsafe.testGroups>native</failsafe.testGroups>
       </properties>

pom.xml

@@ -33,7 +33,7 @@
     Note: when upgrading the Quarkus version or the DataStax Java driver version, make sure that you
     upgrade them in the quickstart module too.
     -->
-    <quarkus.version>3.1.0.Final</quarkus.version>
+    <quarkus.version>3.25.0</quarkus.version>
     <datastax-java-driver.version>4.15.0</datastax-java-driver.version>
     <assertj.version>3.23.1</assertj.version>
     <maven.compiler.target>11</maven.compiler.target>
@@ -56,7 +56,7 @@
         <plugin>
           <groupId>com.spotify.fmt</groupId>
           <artifactId>fmt-maven-plugin</artifactId>
-          <version>2.19</version>
+          <version>2.27</version>
         </plugin>
         <plugin>
           <groupId>au.com.acegi</groupId>
@@ -76,7 +76,7 @@
         <plugin>
           <groupId>org.jacoco</groupId>
           <artifactId>jacoco-maven-plugin</artifactId>
-          <version>0.8.8</version>
+          <version>0.8.13</version>
         </plugin>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>