Merge branch '4.x' into JAVA-2841

Author: tomekl007

CONTRIBUTING.md

@@ -28,6 +28,11 @@ mvn xml-format:xml-format
 The formatter does not enforce a maximum line length, but please try to keep it below 100 characters
 to keep files readable across all mediums (IDE, terminal, Github...).
 
+### Other text files (markdown, etc)
+
+Similarly, enforce a right margin of 100 characters in those files. Editors and IDEs generally have
+a way to configure this (for IDEA, install the "Wrap to column" plugin).
+
 ## Coding style -- production code
 
 Do not use static imports. They make things harder to understand when you look at the code 
@@ -213,6 +218,10 @@ Static imports are permitted in a couple of places:
   when(codecRegistry.codecFor(DataTypes.INT)).thenReturn(codec);
   verify(codec).decodePrimitive(any(ByteBuffer.class), eq(ProtocolVersion.DEFAULT));
   ```
+* All Awaitility methods, e.g.:
+  ```java
+  await().until(() -> somethingBecomesTrue());
+  ```
 
 Test methods names use lower snake case, generally start with `should`, and clearly indicate the
 purpose of the test, for example: `should_fail_if_key_already_exists`. If you have trouble coming 

changelog/README.md

@@ -5,6 +5,8 @@
 ### 4.8.0 (in progress)
 
 - [improvement] JAVA-2841: Raise timeouts during connection initialization
+- [improvement] JAVA-2850: Ignore credentials in secure connect bundle [DataStax Astra]
+- [improvement] JAVA-2813: Don't fail when secure bundle is specified together with other options
 - [bug] JAVA-2800: Exclude SLF4J from mapper-processor dependencies
 - [new feature] JAVA-2819: Add DriverConfigLoader.fromString
 - [improvement] JAVA-2431: Set all occurrences when bound variables are used multiple times

core/src/main/java/com/datastax/oss/driver/api/core/session/ProgrammaticArguments.java

@@ -212,6 +212,12 @@ public Builder withLocalDatacenter(
       return this;
     }
 
+    @NonNull
+    public Builder clearDatacenters() {
+      this.localDatacentersBuilder = ImmutableMap.builder();
+      return this;
+    }
+
     @NonNull
     public Builder withLocalDatacenters(Map<String, String> localDatacenters) {
       for (Map.Entry<String, String> entry : localDatacenters.entrySet()) {

core/src/main/java/com/datastax/oss/driver/api/core/session/SessionBuilder.java

@@ -20,6 +20,7 @@
 import com.datastax.oss.driver.api.core.auth.AuthProvider;
 import com.datastax.oss.driver.api.core.auth.PlainTextAuthProviderBase;
 import com.datastax.oss.driver.api.core.config.DefaultDriverOption;
+import com.datastax.oss.driver.api.core.config.DriverConfig;
 import com.datastax.oss.driver.api.core.config.DriverConfigLoader;
 import com.datastax.oss.driver.api.core.config.DriverExecutionProfile;
 import com.datastax.oss.driver.api.core.context.DriverContext;
@@ -65,6 +66,8 @@
 import java.util.function.Predicate;
 import javax.net.ssl.SSLContext;
 import net.jcip.annotations.NotThreadSafe;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Base implementation to build session instances.
@@ -77,6 +80,8 @@
 @NotThreadSafe
 public abstract class SessionBuilder<SelfT extends SessionBuilder, SessionT> {
 
+  private static final Logger LOG = LoggerFactory.getLogger(SessionBuilder.class);
+
   @SuppressWarnings("unchecked")
   protected final SelfT self = (SelfT) this;
 
@@ -87,7 +92,8 @@ public abstract class SessionBuilder<SelfT extends SessionBuilder, SessionT> {
 
   protected ProgrammaticArguments.Builder programmaticArgumentsBuilder =
       ProgrammaticArguments.builder();
-  private boolean sslConfigured = false;
+  private boolean programmaticSslFactory = false;
+  private boolean programmaticLocalDatacenter = false;
 
   /**
    * Sets the configuration loader to use.
@@ -314,7 +320,7 @@ public SelfT withAuthCredentials(
    */
   @NonNull
   public SelfT withSslEngineFactory(@Nullable SslEngineFactory sslEngineFactory) {
-    this.sslConfigured = true;
+    this.programmaticSslFactory = true;
     this.programmaticArgumentsBuilder.withSslEngineFactory(sslEngineFactory);
     return self;
   }
@@ -352,6 +358,7 @@ public SelfT withSslContext(@Nullable SSLContext sslContext) {
    * if you use a third-party implementation, refer to their documentation.
    */
   public SelfT withLocalDatacenter(@NonNull String profileName, @NonNull String localDatacenter) {
+    this.programmaticLocalDatacenter = true;
     this.programmaticArgumentsBuilder.withLocalDatacenter(profileName, localDatacenter);
     return self;
   }
@@ -671,24 +678,32 @@ protected final CompletionStage<CqlSession> buildDefaultSessionAsync() {
           defaultConfig.getStringList(DefaultDriverOption.CONTACT_POINTS, Collections.emptyList());
       if (cloudConfigInputStream != null) {
         if (!programmaticContactPoints.isEmpty() || !configContactPoints.isEmpty()) {
-          throw new IllegalStateException(
-              "Can't use withCloudSecureConnectBundle and addContactPoint(s). They are mutually exclusive.");
+          LOG.info(
+              "Both a secure connect bundle and contact points were provided. These are mutually exclusive. The contact points from the secure bundle will have priority.");
+          // clear the contact points provided in the setting file and via addContactPoints
+          configContactPoints = Collections.emptyList();
+          programmaticContactPoints = new HashSet<>();
         }
-        String configuredSSLFactory =
-            defaultConfig.getString(DefaultDriverOption.SSL_ENGINE_FACTORY_CLASS, null);
-        if (sslConfigured || configuredSSLFactory != null) {
-          throw new IllegalStateException(
-              "Can't use withCloudSecureConnectBundle and explicitly specify ssl configuration. They are mutually exclusive.");
+
+        if (programmaticSslFactory
+            || defaultConfig.isDefined(DefaultDriverOption.SSL_ENGINE_FACTORY_CLASS)) {
+          LOG.info(
+              "Both a secure connect bundle and SSL options were provided. They are mutually exclusive. The SSL options from the secure bundle will have priority.");
         }
         CloudConfig cloudConfig =
             new CloudConfigFactory().createCloudConfig(cloudConfigInputStream.call());
         addContactEndPoints(cloudConfig.getEndPoints());
+
+        boolean localDataCenterDefined =
+            anyProfileHasDatacenterDefined(configLoader.getInitialConfig());
+        if (programmaticLocalDatacenter || localDataCenterDefined) {
+          LOG.info(
+              "Both a secure connect bundle and a local datacenter were provided. They are mutually exclusive. The local datacenter from the secure bundle will have priority.");
+          programmaticArgumentsBuilder.clearDatacenters();
+        }
         withLocalDatacenter(cloudConfig.getLocalDatacenter());
         withSslEngineFactory(cloudConfig.getSslEngineFactory());
         withCloudProxyAddress(cloudConfig.getProxyAddress());
-        if (cloudConfig.getAuthProvider().isPresent()) {
-          withAuthProvider(cloudConfig.getAuthProvider().get());
-        }
         programmaticArguments = programmaticArgumentsBuilder.build();
       }
 
@@ -715,6 +730,15 @@ protected final CompletionStage<CqlSession> buildDefaultSessionAsync() {
     }
   }
 
+  private boolean anyProfileHasDatacenterDefined(DriverConfig driverConfig) {
+    for (DriverExecutionProfile driverExecutionProfile : driverConfig.getProfiles().values()) {
+      if (driverExecutionProfile.isDefined(DefaultDriverOption.LOAD_BALANCING_LOCAL_DATACENTER)) {
+        return true;
+      }
+    }
+    return false;
+  }
+
   /**
    * Returns URL based on the configUrl setting. If the configUrl has no protocol provided, the
    * method will fallback to file:// protocol and return URL that has file protocol specified.

core/src/main/java/com/datastax/oss/driver/internal/core/config/cloud/CloudConfig.java

@@ -15,15 +15,12 @@
  */
 package com.datastax.oss.driver.internal.core.config.cloud;
 
-import com.datastax.oss.driver.api.core.auth.AuthProvider;
 import com.datastax.oss.driver.api.core.metadata.EndPoint;
 import com.datastax.oss.driver.api.core.ssl.SslEngineFactory;
 import com.datastax.oss.driver.shaded.guava.common.collect.ImmutableList;
 import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
 import java.net.InetSocketAddress;
 import java.util.List;
-import java.util.Optional;
 import net.jcip.annotations.ThreadSafe;
 
 @ThreadSafe
@@ -33,19 +30,16 @@ public class CloudConfig {
   private final List<EndPoint> endPoints;
   private final String localDatacenter;
   private final SslEngineFactory sslEngineFactory;
-  @Nullable private final AuthProvider authProvider;
 
   CloudConfig(
       @NonNull InetSocketAddress proxyAddress,
       @NonNull List<EndPoint> endPoints,
       @NonNull String localDatacenter,
-      @NonNull SslEngineFactory sslEngineFactory,
-      @Nullable AuthProvider authProvider) {
+      @NonNull SslEngineFactory sslEngineFactory) {
     this.proxyAddress = proxyAddress;
     this.endPoints = ImmutableList.copyOf(endPoints);
     this.localDatacenter = localDatacenter;
     this.sslEngineFactory = sslEngineFactory;
-    this.authProvider = authProvider;
   }
 
   @NonNull
@@ -67,9 +61,4 @@ public String getLocalDatacenter() {
   public SslEngineFactory getSslEngineFactory() {
     return sslEngineFactory;
   }
-
-  @NonNull
-  public Optional<AuthProvider> getAuthProvider() {
-    return Optional.ofNullable(authProvider);
-  }
 }

core/src/main/java/com/datastax/oss/driver/internal/core/config/cloud/CloudConfigFactory.java

@@ -15,9 +15,7 @@
  */
 package com.datastax.oss.driver.internal.core.config.cloud;
 
-import com.datastax.oss.driver.api.core.auth.AuthProvider;
 import com.datastax.oss.driver.api.core.metadata.EndPoint;
-import com.datastax.oss.driver.internal.core.auth.ProgrammaticPlainTextAuthProvider;
 import com.datastax.oss.driver.internal.core.metadata.SniEndPoint;
 import com.datastax.oss.driver.internal.core.ssl.SniSslEngineFactory;
 import com.datastax.oss.driver.shaded.guava.common.io.ByteStreams;
@@ -26,7 +24,6 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
 import java.io.BufferedReader;
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
@@ -53,10 +50,12 @@
 import javax.net.ssl.SSLContext;
 import javax.net.ssl.TrustManagerFactory;
 import net.jcip.annotations.ThreadSafe;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 @ThreadSafe
 public class CloudConfigFactory {
-
+  private static final Logger LOG = LoggerFactory.getLogger(CloudConfigFactory.class);
   /**
    * Creates a {@link CloudConfig} with information fetched from the specified Cloud configuration
    * URL.
@@ -138,9 +137,8 @@ public CloudConfig createCloudConfig(@NonNull InputStream cloudConfig)
     List<EndPoint> endPoints = getEndPoints(proxyMetadataJson, sniProxyAddress);
     String localDatacenter = getLocalDatacenter(proxyMetadataJson);
     SniSslEngineFactory sslEngineFactory = new SniSslEngineFactory(sslContext);
-    AuthProvider authProvider = getAuthProvider(configJson);
-    return new CloudConfig(
-        sniProxyAddress, endPoints, localDatacenter, sslEngineFactory, authProvider);
+    validateIfBundleContainsUsernamePassword(configJson);
+    return new CloudConfig(sniProxyAddress, endPoints, localDatacenter, sslEngineFactory);
   }
 
   @NonNull
@@ -176,16 +174,11 @@ protected URL getMetadataServiceUrl(JsonNode configFile) throws MalformedURLExce
     }
   }
 
-  @Nullable
-  protected AuthProvider getAuthProvider(JsonNode configFile) {
-    if (configFile.has("username")) {
-      String username = configFile.get("username").asText();
-      if (configFile.has("password")) {
-        String password = configFile.get("password").asText();
-        return new ProgrammaticPlainTextAuthProvider(username, password);
-      }
+  protected void validateIfBundleContainsUsernamePassword(JsonNode configFile) {
+    if (configFile.has("username") || configFile.has("password")) {
+      LOG.info(
+          "The bundle contains config.json with username and/or password. Providing it in the bundle is deprecated and ignored.");
     }
-    return null;
   }
 
   @NonNull

examples/src/main/java/com/datastax/oss/driver/examples/astra/AstraReadCassandraVersion.java

@@ -16,7 +16,6 @@
 package com.datastax.oss.driver.examples.astra;
 
 import com.datastax.oss.driver.api.core.CqlSession;
-import com.datastax.oss.driver.api.core.config.DriverConfigLoader;
 import com.datastax.oss.driver.api.core.cql.ResultSet;
 import com.datastax.oss.driver.api.core.cql.Row;
 import java.nio.file.Paths;
@@ -57,7 +56,6 @@ public static void main(String[] args) {
             .withCloudSecureConnectBundle(Paths.get("/path/to/secure-connect-database_name.zip"))
             // Change the user_name and password here for the Astra instance
             .withAuthCredentials("user_name", "fakePasswordForTests")
-            .withConfigLoader(DriverConfigLoader.fromClasspath("application-astra"))
             // Uncomment the next line to use a specific keyspace
             // .withKeyspace("keyspace_name")
             .build()) {