lot of work (#300)

Author: toptobes

.gitignore

@@ -51,4 +51,3 @@ bin/
 /*fake*
 /.env
 /.direnv
-/.bob

.idea/inspectionProfiles/Project_Default.xml

@@ -10,7 +10,9 @@
 import com.dtsx.astra.cli.commands.streaming.StreamingCmd;
 import com.dtsx.astra.cli.commands.token.TokenCmd;
 import com.dtsx.astra.cli.commands.user.UserCmd;
+import com.dtsx.astra.cli.commands.dotenv.DotEnvCmd;
 import com.dtsx.astra.cli.core.CliContext;
+import com.dtsx.astra.cli.commands.dotenv.DotEnvCmd;
 import com.dtsx.astra.cli.core.TypeConverters;
 import com.dtsx.astra.cli.core.config.AstraConfig;
 import com.dtsx.astra.cli.core.config.AstraHome;
@@ -69,6 +71,7 @@
         SetupCmd.class,
         ConfigCmd.class,
         DbCmd.class,
+        DotEnvCmd.class,
         PcuCmd.class,
         OrgCmd.class,
         RoleCmd.class,

src/main/java/com/dtsx/astra/cli/AstraCli.java

@@ -10,6 +10,7 @@
 import com.dtsx.astra.cli.core.output.Hint;
 import com.dtsx.astra.cli.core.output.formats.OutputAll;
 import com.dtsx.astra.cli.operations.db.DbCreateDotEnvOperation;
+
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import lombok.val;
@@ -34,7 +35,8 @@
 
 @Command(
     name = "create-dotenv",
-    description = "Create a env file to help you connect to your Astra DB instance."
+    description = "Create a env file to help you connect to your Astra DB instance.",
+    hidden = true
 )
 @Example(
     comment = "Create a fully-populated .env file, updating the existing one if it exists",
@@ -129,6 +131,9 @@ enum Preset {
 
     @Override
     protected final OutputAll execute(Supplier<CreateDotEnvResult> result) {
+        ctx.log().warn("@'!astra db create-dotenv!@ is deprecated");
+        ctx.log().warn("Use the new commands under @'!astra dotenv!@ instead");
+
         return switch (result.get()) {
             case CreatedDotEnvContent(var content) -> OutputAll.response(
                 content.render(ctx.colors()),
@@ -166,12 +171,7 @@ case NothingToUpdate(var outputFile) -> OutputAll.response("""
                 new Hint("View the env file", "cat " + outputFile)
             ));
 
-            case FailedToDownloadSCB(var reason) -> throw new AstraCliException(DOWNLOAD_ISSUE, """
-              @|bold, red Error: Failed to download the secure connect bundle.|@
-            
-              Cause:
-              %s
-            """.formatted(reason));
+
         };
     }
 

src/main/java/com/dtsx/astra/cli/commands/db/DbCreateDotEnvCmd.java

@@ -7,6 +7,7 @@
 import com.dtsx.astra.cli.core.output.Hint;
 import com.dtsx.astra.cli.core.output.formats.OutputAll;
 import com.dtsx.astra.cli.operations.db.DbDownloadScbOperation;
+
 import lombok.val;
 import picocli.CommandLine.Command;
 import picocli.CommandLine.Option;
@@ -73,7 +74,7 @@ protected final OutputAll execute(Supplier<DownloadScbResult> result) {
             case ScbDownloaded(var path) -> handleScbDownloaded(path);
             case ScbDownloadedAndMoved(var path) -> handleScbDownloaded(path);
             case ScbDownloadedAndMoveFailed fail -> throwScbDownloadedAndMoveFailed(fail);
-            case ScbDownloadFailed (var error) -> throwScbDownloadFailed(error);
+
             case ScbDestinationAlreadyExists() -> throwScbDestinationAlreadyExists();
             case ScbInvalidDestination(var reason) -> throwScbInvalidDestination(reason);
         };
@@ -125,14 +126,7 @@ private <T> T throwScbDownloadedAndMoveFailed(ScbDownloadedAndMoveFailed fail) {
         ));
     }
 
-    private <T> T throwScbDownloadFailed(String error) {
-        throw new AstraCliException(DOWNLOAD_ISSUE, trimIndent("""
-          @|bold,red Error: Failed to download secure connect bundle.|@
 
-          Cause:
-          %s
-        """).formatted(error));
-    }
 
     private <T> T throwScbDestinationAlreadyExists() {
         throw new AstraCliException(FILE_ISSUE, trimIndent("""

src/main/java/com/dtsx/astra/cli/commands/db/DbDownloadScbCmd.java

@@ -11,6 +11,7 @@
 import com.dtsx.astra.cli.gateways.downloads.DownloadsGateway;
 import com.dtsx.astra.cli.gateways.pcu.vendored.domain.PcuGroupStatusType;
 import com.dtsx.astra.cli.operations.Operation;
+
 import com.dtsx.astra.cli.operations.db.cqlsh.AbstractCqlshExeOperation.*;
 import com.dtsx.astra.sdk.db.domain.DatabaseStatusType;
 import lombok.val;
@@ -71,8 +72,8 @@ protected Operation<CqlshExecResult> mkOperation() {
     protected final OutputHuman executeHuman(Supplier<CqlshExecResult> result) {
         return switch (result.get()) {
             case CqlshInstallFailed(var msg) -> throwCqlshInstallationFailed(msg);
-            case ScbDownloadFailed(var msg) -> throwScbInstallationFailed(msg);
             case InvalidDbStatus(var status) -> throwInvalidDbStatus(status);
+
             case Executed(var exitCode) -> AstraCli.exit(exitCode);
             case ExecutedWithOutput _ -> throw new CongratsYouFoundABugException("Should not be able to get to `executeHuman` with `ExecutedWithOutput` when output is `HUMAN`");
         };
@@ -86,8 +87,8 @@ protected final OutputAll execute(Supplier<CqlshExecResult> result) {
 
         return switch (result.get()) {
             case CqlshInstallFailed(var msg) -> throwCqlshInstallationFailed(msg);
-            case ScbDownloadFailed(var msg) -> throwScbInstallationFailed(msg);
             case InvalidDbStatus(var status) -> throwInvalidDbStatus(status);
+
             case Executed _ -> throw new CongratsYouFoundABugException("Should not be able to get to `execute` with `Executed` when output is `" + ctx.outputType() + "`");
             case ExecutedWithOutput res -> handleExecutedWithOutput(res);
         };
@@ -104,15 +105,6 @@ public static <T> T throwCqlshInstallationFailed(String error) {
         ));
     }
 
-    private <T> T throwScbInstallationFailed(String error) {
-        throw new AstraCliException(FILE_ISSUE, """
-          @|bold,red Failed to download secure connect bundle: %s|@
-        
-          Please ensure you have a stable network connection and sufficient permissions, then try again.
-        """.formatted(error), List.of(
-            new Hint("Retry download:", "${cli.name} db cqlsh version")
-        ));
-    }
 
     private <T> T throwInvalidDbStatus(DatabaseStatusType status) {
         throw new AstraCliException(STATUS_ISSUE, """
@@ -124,6 +116,7 @@ private <T> T throwInvalidDbStatus(DatabaseStatusType status) {
         ));
     }
 
+
     private OutputAll handleExecutedWithOutput(ExecutedWithOutput res) {
         val msg = "Cqlsh executed with exit code %d, with %d lines in stdout and %d lines in stderr."
             .formatted(res.exitCode(), res.stdout().size(), res.stderr().size());

src/main/java/com/dtsx/astra/cli/commands/db/cqlsh/AbstractCqlshExecCmd.java

@@ -10,7 +10,8 @@
 import com.dtsx.astra.cli.operations.db.dsbulk.AbstractDsbulkExeOperation.DsbulkExecResult;
 import com.dtsx.astra.cli.operations.db.dsbulk.AbstractDsbulkExeOperation.DsbulkInstallFailed;
 import com.dtsx.astra.cli.operations.db.dsbulk.AbstractDsbulkExeOperation.Executed;
-import com.dtsx.astra.cli.operations.db.dsbulk.AbstractDsbulkExeOperation.ScbDownloadFailed;
+
+
 import org.jetbrains.annotations.MustBeInvokedByOverriders;
 
 import java.util.List;
@@ -33,7 +34,7 @@ protected void prelude() {
     protected final OutputHuman executeHuman(Supplier<DsbulkExecResult> result) {
         return switch (result.get()) {
             case DsbulkInstallFailed(var msg) -> throwDsbulkInstallationFailed(msg);
-            case ScbDownloadFailed(var msg) -> throwDsbulkInstallationFailed(msg);
+
             case Executed(var exitCode) -> AstraCli.exit(exitCode);
         };
     }

src/main/java/com/dtsx/astra/cli/commands/db/dsbulk/AbstractDsbulkExecCmd.java

@@ -0,0 +1,148 @@
+package com.dtsx.astra.cli.commands.dotenv;
+
+import com.dtsx.astra.cli.commands.db.AbstractDbCmd;
+import com.dtsx.astra.cli.core.CliConstants.$Db;
+import com.dtsx.astra.cli.core.CliConstants.$Keyspace;
+import com.dtsx.astra.cli.core.CliConstants.$Regions;
+import com.dtsx.astra.cli.core.completions.impls.DbNamesCompletion;
+import com.dtsx.astra.cli.core.exceptions.AstraCliException;
+import com.dtsx.astra.cli.core.models.DbRef;
+import com.dtsx.astra.cli.core.models.KeyspaceRef;
+import com.dtsx.astra.cli.core.models.RegionName;
+import com.dtsx.astra.cli.core.output.ExitCode;
+import com.dtsx.astra.cli.core.output.prompters.specific.DbRefPrompter;
+import com.dtsx.astra.cli.operations.dotenv.DotEnvOperation;
+import com.dtsx.astra.cli.operations.dotenv.DotEnvOperation.DotEnvRequest;
+import com.dtsx.astra.cli.operations.dotenv.DotEnvOperation.DotEnvResult;
+import com.dtsx.astra.cli.operations.dotenv.EnvKey;
+import lombok.val;
+import org.jetbrains.annotations.Nullable;
+import picocli.CommandLine.Option;
+
+import java.nio.file.Path;
+import java.util.*;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
+public abstract class AbstractDotEnvGenCmd extends AbstractDbCmd<DotEnvResult> {
+    @Option(
+        names = { "--file", "-f" },
+        description = "The target .env file to update.",
+        paramLabel = "FILE"
+    )
+    protected Optional<Path> $file;
+
+    @Option(
+        names = { "--keys", "-k" },
+        description = "Comma-separated EnvKey names to filter the resolved binding set.",
+        mapFallbackValue = "",
+        split = ","
+    )
+    protected Map<EnvKey, String> $keys = Map.of();
+
+    @Option(
+        names = { "--overwrite" },
+        description = "Always overwrite non-empty values.",
+        negatable = true
+    )
+    protected Optional<Boolean> $overwrite;
+
+    @Option(
+        names = { "--db" },
+        description = "Database to bind to.",
+        completionCandidates = DbNamesCompletion.class,
+        paramLabel = $Db.LABEL
+    )
+    protected @Nullable DbRef $dbRef;
+
+    @Option(
+        names = { $Keyspace.LONG },
+        description = "The keyspace to use.",
+        paramLabel = $Keyspace.LABEL
+    )
+    protected Optional<String> $keyspace;
+
+    @Option(
+        names = { $Regions.LONG },
+        description = "The region to use.",
+        paramLabel = $Regions.LABEL
+    )
+    protected Optional<RegionName> $region;
+
+    protected abstract boolean isPrint();
+
+    @Override
+    protected DotEnvOperation mkOperation() {
+        val ksRef = $keyspace.map(ks -> KeyspaceRef.parse($dbRef, ks).fold(
+            err -> {
+                throw new AstraCliException(ExitCode.VALIDATION_ISSUE, "keyspace " + err);
+            },
+            Function.identity()
+        ));
+
+        val downloadsGateway = ctx.gateways().mkDownloadsGateway();
+        val orgGateway = ctx.gateways().mkOrgGateway(profile().token(), profile().env());
+
+        return new DotEnvOperation(ctx, dbGateway, orgGateway, downloadsGateway, new DotEnvRequest(
+            profile(),
+            $dbRef,
+            ksRef,
+            $region,
+            $file,
+            isPrint(),
+            $keys,
+            $overwrite,
+            this::askForKeys,
+            this::askForDbRef,
+            this::askIfShouldOverwrite
+        ));
+    }
+
+    private DbRef askForDbRef() {
+        return DbRefPrompter.prompt(ctx, dbGateway, "Select database to bind to", f -> f.fallbackFlag("--db").fix(originalArgs(), "--db"));
+    }
+
+    private Set<EnvKey> askForKeys() {
+        val allKeys = Arrays.asList(EnvKey.values());
+
+        val selected = new HashSet<>(
+            ctx.console().select("Select the keys you want to generate in your .env file")
+                .multiOptions(allKeys.toArray(new EnvKey[0]))
+                .requireAnswer()
+                .mapper(EnvKey::name)
+                .fallbackFlag("--keys")
+                .fix(originalArgs(), "--keys ASTRA_ORG_TOKEN")
+                .clearAfterSelection()
+        );
+
+        if (selected.isEmpty()) {
+            throw new AstraCliException(ExitCode.VALIDATION_ISSUE, "No keys selected");
+        }
+
+        return selected;
+    }
+
+    private boolean askIfShouldOverwrite(Set<String> duplicates) {
+        var duplicatesStr = duplicates.stream()
+            .limit(4)
+            .map(k -> "- " + ctx.highlight(k))
+            .collect(Collectors.joining("\n"));
+
+        if (duplicates.size() > 4) {
+            duplicatesStr += "\n- and %s more...".formatted(ctx.colors().PURPLE_300.use(String.valueOf(duplicates.size() - 5)));
+        }
+
+        val msg = """
+        Pre-existing keys with values found in the .env file:
+        %s
+        
+        Do you want to overwrite them?
+        """.formatted(duplicatesStr);
+
+        return ctx.console().confirm(msg)
+            .defaultNo()
+            .fallbackFlag("--overwrite")
+            .fix(originalArgs(), "--overwrite")
+            .dontClearAfterSelection();
+    }
+}

src/main/java/com/dtsx/astra/cli/commands/dotenv/AbstractDotEnvGenCmd.java

@@ -0,0 +1,19 @@
+package com.dtsx.astra.cli.commands.dotenv;
+
+import com.dtsx.astra.cli.core.mixins.HelpMixin;
+import picocli.CommandLine.Command;
+import picocli.CommandLine.Mixin;
+
+@Command(
+    name = "dotenv",
+    description = "Easily create and update your .env files",
+    subcommands = {
+        DotEnvWriteCmd.class,
+        DotEnvPrintCmd.class,
+        DotEnvListKeysCmd.class,
+    }
+)
+public class DotEnvCmd {
+    @Mixin
+    public HelpMixin help;
+}

src/main/java/com/dtsx/astra/cli/commands/dotenv/DotEnvCmd.java

@@ -0,0 +1,35 @@
+package com.dtsx.astra.cli.commands.dotenv;
+
+import com.dtsx.astra.cli.commands.AbstractCmd;
+import com.dtsx.astra.cli.core.output.formats.OutputAll;
+import com.dtsx.astra.cli.core.output.table.ShellTable;
+import com.dtsx.astra.cli.operations.Operation;
+import com.dtsx.astra.cli.operations.dotenv.EnvKey;
+import lombok.val;
+import picocli.CommandLine.Command;
+
+import java.util.ArrayList;
+import java.util.Map;
+import java.util.function.Supplier;
+
+@Command(
+    name = "list-keys",
+    description = "List all available Astra keys (no values resolved)."
+)
+public class DotEnvListKeysCmd extends AbstractCmd<Void> {
+    @Override
+    protected Operation<Void> mkOperation() {
+        return () -> null;
+    }
+
+    @Override
+    protected OutputAll execute(Supplier<Void> val) {
+        val data = new ArrayList<Map<String, String>>();
+
+        for (val key : EnvKey.values()) {
+            data.add(Map.of("Key", key.name()));
+        }
+
+        return new ShellTable(data).withColumns("Key");
+    }
+}