cscli machines add: example with "-f -", split creds to stdout and me…

…ssages to stderr
crowdsecurity · Jan 24, 2024 · e7b2d3c · e7b2d3c
1 parent 8896b38
commit e7b2d3c
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/cmd/crowdsec-cli/bouncers.go b/cmd/crowdsec-cli/bouncers.go
@@ -4,6 +4,7 @@ import (
 	"encoding/csv"
 	"encoding/json"
 	"fmt"
+	"os"
 	"slices"
 	"strings"
 	"time"
@@ -283,7 +284,7 @@ func (cli *cliBouncers) prune(duration time.Duration, force bool) error {
 		return fmt.Errorf("unable to prune bouncers: %s", err)
 	}
 
-	fmt.Printf("Successfully deleted %d bouncers\n", deleted)
+	fmt.Fprintf(os.Stderr, "Successfully deleted %d bouncers\n", deleted)
 
 	return nil
 }

diff --git a/cmd/crowdsec-cli/machines.go b/cmd/crowdsec-cli/machines.go
@@ -223,11 +223,10 @@ func (cli *cliMachines) NewAddCmd() *cobra.Command {
 		Short:             "add a single machine to the database",
 		DisableAutoGenTag: true,
 		Long:              `Register a new machine in the database. cscli should be on the same machine as LAPI.`,
-		Example: `
-cscli machines add --auto
+		Example: `cscli machines add --auto
 cscli machines add MyTestMachine --auto
 cscli machines add MyTestMachine --password MyPassword
-`,
+cscli machines add -f- --auto > /tmp/mycreds.yaml`,
 		RunE: func(_ *cobra.Command, args []string) error {
 			return cli.add(args, machinePassword, dumpFile, apiURL, interactive, autoAdd, force)
 		},
@@ -307,7 +306,7 @@ func (cli *cliMachines) add(args []string, machinePassword string, dumpFile stri
 		return fmt.Errorf("unable to create machine: %s", err)
 	}
 
-	fmt.Printf("Machine '%s' successfully added to the local API.\n", machineID)
+	fmt.Fprintf(os.Stderr, "Machine '%s' successfully added to the local API.\n", machineID)
 
 	if apiURL == "" {
 		if clientCfg != nil && clientCfg.Credentials != nil && clientCfg.Credentials.URL != "" {
@@ -335,9 +334,9 @@ func (cli *cliMachines) add(args []string, machinePassword string, dumpFile stri
 		if err != nil {
 			return fmt.Errorf("write api credentials in '%s' failed: %s", dumpFile, err)
 		}
-		fmt.Printf("API credentials written to '%s'.\n", dumpFile)
+		fmt.Fprintf(os.Stderr, "API credentials written to '%s'.\n", dumpFile)
 	} else {
-		fmt.Println(string(apiConfigDump))
+		fmt.Print(string(apiConfigDump))
 	}
 
 	return nil
@@ -436,7 +435,7 @@ func (cli *cliMachines) prune(duration time.Duration, notValidOnly bool, force b
 		return fmt.Errorf("unable to prune machines: %s", err)
 	}
 
-	fmt.Printf("successfully delete %d machines\n", deleted)
+	fmt.Fprintf(os.Stderr, "successfully delete %d machines\n", deleted)
 
 	return nil
 }

diff --git a/test/bats/30_machines.bats b/test/bats/30_machines.bats
@@ -34,13 +34,13 @@ teardown() {
     rune -0 jq -r '.msg' <(stderr)
     assert_output --partial 'already exists: please remove it, use "--force" or specify a different file with "-f"'
     rune -0 cscli machines add local -a --force
-    assert_output --partial "Machine 'local' successfully added to the local API."
+    assert_stderr --partial "Machine 'local' successfully added to the local API."
 }
 
 @test "add a new machine and delete it" {
     rune -0 cscli machines add -a -f /dev/null CiTestMachine -o human
-    assert_output --partial "Machine 'CiTestMachine' successfully added to the local API"
-    assert_output --partial "API credentials written to '/dev/null'"
+    assert_stderr --partial "Machine 'CiTestMachine' successfully added to the local API"
+    assert_stderr --partial "API credentials written to '/dev/null'"
 
     # we now have two machines
     rune -0 cscli machines list -o json