Fix astra nuke, some tests, + some other minor things (#246)

* Fix `astra nuke`
* Add tenant prompter
* Fix tests
* Update various descriptions
* Some more stuff I don't remember

Author: toptobes

.gitignore

@@ -7,7 +7,9 @@ build/
 ### IntelliJ IDEA ###
 .idea/modules.xml
 .idea/jarRepositories.xml
+.idea/workspace.xml
 .idea/compiler.xml
+.idea/tasks.xml
 .idea/libraries/
 *.iws
 *.iml

.idea/dictionaries/project.xml

@@ -7,9 +7,5 @@
     "help",
     "docs"
   ],
-  "seeAlsoLinks": {
-    "upgrade": [
-      "xref:installation.adoc[]"
-    ]
-  }
+  "seeAlsoLinks": {}
 }

.idea/inspectionProfiles/Project_Default.xml

@@ -82,6 +82,25 @@ echo ""
 echo "                    Installer: $ASTRA_CLI_VERSION"
 echo "$RESET"
 
+# Options
+AUTO_YES_INSTALL=0
+
+if [ -t 0 ]; then
+  if [ "${1:-}" = "--yes" ] || [ "${1:-}" = "-y" ]; then
+    AUTO_YES_INSTALL=1
+  fi
+else
+  echo "${RED}Error: Script is running in a non-interactive terminal${RESET}"
+  echo ""
+  echo "Please use the following command instead to run the script interactively:"
+  echo ""
+  renderCommand "sh -c \"\$(curl -fsSL \"https://raw.githubusercontent.com/datastax/astra-cli/main/scripts/install.sh\")\""
+  echo ""
+  echo "If you really want to run this script in a non-interactively, pass the ${BLUE}--yes${RESET} flag to accept installing astra in the following location:"
+  echo "${BLUE}>${RESET} $(underline "$(tildify "$ASTRA_CLI_DIR/")")"
+  exit 1
+fi
+
 # Required tools check
 if ! command -v curl >/dev/null 2>&1; then
   error "Error: curl is not installed. Please install curl and try again."
@@ -156,6 +175,36 @@ else
   checklist "No existing installation found."
 fi
 
+# Verify installation path
+echo ""
+echo "${GREEN}Ready to install Astra CLI ✅${RESET}"
+echo ""
+echo "Do you want to install Astra CLI to $(underline "$(tildify "$ASTRA_CLI_DIR/")")? ${BLUE}[Y]es/[d]ifferent path/[c]ancel${RESET}"
+
+while [ "$AUTO_YES_INSTALL" = 0 ]; do
+  printf "%s" "${BLUE}> ${RESET}"
+  read -r res
+
+  case ${res:-y} in
+    [Yy]* )
+      for _ in $(seq 1 5); do color cuu1 && color el; done
+      break;;
+    [Dd]*)
+      echo ""
+      echo "${RED}To use a custom installation path, please globally set the ASTRA_HOME environment variable.${RESET}"
+      echo ""
+      echo "This variable $(color bold)must remain in place forever${RESET} (e.g. in your shell profile like $(underline "~/.zprofile"), $(underline "~/.bash_profile"), etc.) so that the CLI can always locate its home directory."
+      echo ""
+      echo "After setting it, restart your terminal or run 'source ~/.zprofile' (or the appropriate file) to apply the change."
+      exit 1
+      ;;
+    [Cc]* )
+      error "\nCancelling installation.";;
+    * )
+      echo "Please answer ${BLUE}yes${RESET}, ${BLUE}no${RESET}, or ${BLUE}cancel${RESET}.";;
+  esac
+done
+
 # Create installation directory
 if mkdir -p "$ASTRA_CLI_DIR"; then
   checklist "Using installation dir $(underline "$(tildify "$ASTRA_CLI_DIR/")")${RESET}${LIGHT_GRAY}."

.idea/workspace.xml

@@ -223,10 +223,12 @@ public static <T> T exit(int exitCode) {
     public static class SetupExampleProvider implements ExampleProvider {
         @Override
         public Pair<String, String> get(CliContext ctx) {
+
             try {
                 val configFileExists = Files.exists(AstraConfig.resolveDefaultAstraConfigFile(ctx));
 
-                if (!configFileExists) {
+                // keeps output deterministic for testing
+                if (!configFileExists || System.getProperty("cli.testing") != null) {
                     return Pair.create("Setup the Astra CLI", "${cli.name} setup");
                 }
 

docs_spec.json

@@ -86,7 +86,6 @@ private void setAnsi(boolean noColor) {
         names = { "--spinner" },
         description = { "Enable/disable loading spinners", SHOW_CUSTOM_DEFAULT + "enabled if tty" },
         negatable = true,
-        showDefaultValue = Visibility.NEVER,
         fallbackValue = "true"
     )
     private Optional<Boolean> enableSpinner;

scripts/install.sh

@@ -23,7 +23,7 @@
 @Command(
     name = "completions",
     aliases = { "compgen" },
-    description = "See the help for the @|code @{cli.name} shellenv!@ command to setup completions in your shell.",
+    description = "See the help for the @|code @{cli.name} shellenv|@ command to setup completions in your shell.",
     descriptionHeading = "%n",
     hidden = true
 )

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

@@ -92,14 +92,23 @@ private OutputAll handleNuked(NukeResult res) {
         val summary = new StringBuilder();
         val nothingToReport = new ArrayList<String>();
 
-        appendToSummary(summary, nothingToReport, "deleted", res.deletedFiles().stream().collect(HashMap::new, (m, v) -> m.put(v, Optional.of(" @|faint (contained binary)|@").filter((_) -> res.cliBinaryPath().startsWith(v))), Map::putAll));
-        appendToSummary(summary, nothingToReport, "needing updates", res.shellRcFilesToUpdate().stream().collect(HashMap::new, (m, v) -> m.put(v, Optional.empty()), Map::putAll));
-        appendToSummary(summary, nothingToReport, "skipped", res.skipped().entrySet().stream().collect(HashMap::new, (m, v) -> m.put(v.getKey(), Optional.of(" - " + v.getValue().reason())), Map::putAll));
+        appendToSummary("Files deleted", summary, nothingToReport, "deleted", res.deletedFiles().stream().collect(HashMap::new, (m, v) -> m.put(v, Optional.of(" @|faint (contained binary)|@").filter((_) -> res.cliBinaryPath().startsWith(v))), Map::putAll));
+        appendToSummary("Shell profiles containing @!astra!@", summary, nothingToReport, "needing updates", res.shellRcFilesToUpdate().stream().collect(HashMap::new, (m, v) -> m.put(v, Optional.empty()), Map::putAll));
+        appendToSummary("Files skipped", summary, nothingToReport, "skipped", res.skipped().entrySet().stream().collect(HashMap::new, (m, v) -> m.put(v.getKey(), Optional.of(" - " + v.getValue().reason())), Map::putAll));
 
         switch (nothingToReport.size()) {
-            case 3 -> summary.append(NL).append("@|faint No files were deleted, updated, or skipped.|@").append(NL);
-            case 2 -> summary.append(NL).append("@|faint No files ").append(nothingToReport.get(0)).append(" or ").append(nothingToReport.get(1)).append(".|@").append(NL);
-            case 1 -> summary.append(NL).append("@|faint No files ").append(nothingToReport.get(0)).append(".|@").append(NL);
+            case 3 -> summary
+                .append(NL)
+                .append("@|faint No files were deleted, needing updates, or skipped.|@")
+                .append(NL);
+            case 2 -> summary
+                .append(NL)
+                .append("@|faint No files ").append(nothingToReport.get(0)).append(" or ").append(nothingToReport.get(1)).append(".|@")
+                .append(NL);
+            case 1 -> summary
+                .append(NL)
+                .append("@|faint No files ").append(nothingToReport.get(0)).append(".|@")
+                .append(NL);
         }
 
         if (res.skipped().values().stream().anyMatch(s -> s instanceof NeedsSudo)) {
@@ -150,11 +159,11 @@ case BinaryNotWritable(var path) -> """
         return trimIndent(str);
     }
 
-    private void appendToSummary(StringBuilder sb, ArrayList<String> nothingToReport, String header, Map<Path, Optional<String>> files) {
+    private void appendToSummary(String header, StringBuilder sb, ArrayList<String> nothingToReport, String thingToReport, Map<Path, Optional<String>> files) {
         if (files.isEmpty()) {
-            nothingToReport.add(header);
+            nothingToReport.add(thingToReport);
         } else {
-            sb.append(NL).append("Files ").append(header).append(":").append(NL);
+            sb.append(NL).append(header).append(":").append(NL);
 
             for (val file : files.entrySet()) {
                 sb.append("→ ").append(ctx.highlight(file.getKey()));
@@ -181,7 +190,7 @@ protected Operation<NukeResult> mkOperation() {
 
     private boolean promptShouldDeleteAstrarc(List<Path> files, boolean isDryRun) {
         val secondLine = (isDryRun)
-            ? "@|faint This is a dry-run, so the file @|underline will not actually be deleted|@.|@"
+            ? "@|faint (This is a dry-run, so the file|@ @|faint,underline will not actually be deleted.|@@|faint )|@"
             : "Your credentials @!may be lost!@ if you do. A backup is recommended.";
 
         val filesStr = new StringJoiner(" and ");