MLE-25059 Defaulting port and auth type for cloud auth

Author: rjrudin

docs/common-options.md

@@ -183,29 +183,27 @@ threads available on each host, and also write directly to a forest on the host
 
 ### Connecting to Progress Data Cloud
 
-To connect to Progress Data Cloud (PDC), you must set at least the following options:
+To connect to Progress Data Cloud (PDC), if you are using Flux 2.0 or higher, you must set at least the following options:
 
 {% tabs log %}
 {% tab log Unix %}
 ```
 --host your-pdc-host-name \
---port 443 \
---auth-type cloud \
 --cloud-api-key your-key-goes-here \
 --base-path your-integration-endpoint
 ```
 {% endtab %}
 {% tab log Windows %}
 ```
 --host your-pdc-host-name ^
---port 443 ^
---auth-type cloud ^
 --cloud-api-key your-key-goes-here ^
 --base-path your-integration-endpoint
 ```
 {% endtab %}
 {% endtabs %}
 
+If you are using Flux 1.x, you must also include `--auth-type cloud`. 
+
 The value of `--cloud-api-key` is an API key that you have generated in your PDC tenancy. Please see the 
 [PDC documentation on API keys](https://docs.progress.com/bundle/progress-data-cloud-use/page/topics/account-settings/manage-api-key.html)
 for more information.

flux-cli/src/main/java/com/marklogic/flux/impl/ConnectionParamsValidator.java

@@ -23,6 +23,9 @@ public void validate(ConnectionInputs connectionInputs) {
             throw new FluxException(String.format("Must specify a MarkLogic host via %s or %s.",
                 paramNames.host, paramNames.connectionString));
         }
+
+        setDefaultValuesIfCloudApiKeyIsSet(connectionInputs);
+
         if (connectionInputs.port <= 0 && !AuthenticationType.CLOUD.equals(connectionInputs.authType)) {
             throw new FluxException(String.format("Must specify a MarkLogic app server port via %s or %s.",
                 paramNames.port, paramNames.connectionString));
@@ -35,6 +38,18 @@ public void validate(ConnectionInputs connectionInputs) {
         }
     }
 
+    private void setDefaultValuesIfCloudApiKeyIsSet(ConnectionInputs connectionInputs) {
+        final String cloudApiKey = connectionInputs.cloudApiKey;
+        if (cloudApiKey != null && !cloudApiKey.trim().isEmpty()) {
+            if (connectionInputs.port <= 0) {
+                connectionInputs.port = 443;
+            }
+            if (connectionInputs.authType == null) {
+                connectionInputs.authType = AuthenticationType.CLOUD;
+            }
+        }
+    }
+
     private void validateUsernameAndPassword(ConnectionInputs connectionInputs) {
         if (connectionInputs.username == null) {
             throw new FluxException(String.format("Must specify a MarkLogic user via %s when using 'BASIC' or 'DIGEST' authentication.",

flux-cli/src/test/java/com/marklogic/flux/impl/ConnectionParamsValidatorTest.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2024-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+ */
+package com.marklogic.flux.impl;
+
+import com.marklogic.flux.api.AuthenticationType;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+class ConnectionParamsValidatorTest {
+
+    ConnectionParamsValidator validator = new ConnectionParamsValidator(false);
+    ConnectionInputs inputs = new ConnectionParams();
+
+    @Test
+    void cloudAuth() {
+        inputs.host = "anyhost";
+        inputs.cloudApiKey = "anything";
+
+        assertEquals(0, inputs.port);
+        assertNull(inputs.authType);
+
+        validator.validate(inputs);
+
+        assertEquals(443, inputs.port, "If a cloud API key is specified, we can assume " +
+            "that the port should be 443.");
+        assertEquals(AuthenticationType.CLOUD, inputs.authType, "If a cloud API key is " +
+            "specified, we can assume that the auth type should be CLOUD.");
+    }
+
+    @Test
+    void cloudAuthAndPortAlreadySet() {
+        inputs.host = "anyhost";
+        inputs.cloudApiKey = "anything";
+        inputs.port = 8443;
+
+        validator.validate(inputs);
+
+        assertEquals(8443, inputs.port,
+            "There may be a use case in the future where a port other than 443 " +
+                "should be used. So we allow the user to override the default of 443 " +
+                "when a cloud API key is specified.");
+        assertEquals(AuthenticationType.CLOUD, inputs.authType);
+    }
+}

flux-cli/src/test/java/com/marklogic/flux/impl/ValidateMarkLogicConnectionTest.java

@@ -71,15 +71,16 @@ void connectionStringWithoutUserOrPassword() {
     }
 
     @Test
-    void cloudAuthDoesntRequirePort() {
+    void cloudAuthDoesntRequirePortOrAuthType() {
         // The expected error message verifies that the user does not need to provide a port when auth-type=cloud.
         // Otherwise, the validation for a missing port would trigger and no connection attempt would be made.
+        // Enhanced in 2.0.0 to not require authType either. We can assume that if the user specifies a cloud-api-key,
+        // then port should be 443 and auth type should be cloud.
         assertStderrContains(
             "Unable to call token endpoint at https://localhost/token",
             "import-files",
             "--path", "src/test/resources/mixed-files",
-            "--host", getDatabaseClient().getHost(),
-            "--auth-type", "cloud",
+            "--host", "localhost",
             "--cloud-api-key", "doesnt-matter-for-this-test"
         );
     }