feat: CLI purge command

cli/cli.go

@@ -142,6 +142,7 @@ func NewDefraCommand() *cobra.Command {
 		MakeStartCommand(),
 		MakeServerDumpCmd(),
 		MakeVersionCommand(),
+		MakePurgeCommand(),
 	)
 
 	return root

cli/errors.go

@@ -40,6 +40,7 @@ var (
 	ErrSchemaVersionNotOfSchema   = errors.New(errSchemaVersionNotOfSchema)
 	ErrViewAddMissingArgs         = errors.New("please provide a base query and output SDL for this view")
 	ErrPolicyFileArgCanNotBeEmpty = errors.New("policy file argument can not be empty")
+	ErrPurgeForceFlagRequired     = errors.New("run this command again with --force if you really want to purge all data")
 )
 
 func NewErrRequiredFlagEmpty(longName string, shortName string) error {

cli/purge.go

@@ -0,0 +1,42 @@
+// Copyright 2024 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package cli
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+func MakePurgeCommand() *cobra.Command {
+	var force bool
+	var cmd = &cobra.Command{
+		Use:   "purge",
+		Short: "Delete all persisted DefraDB data",
+		Long: `Delete all persisted DefraDB data.
+WARNING this operation will delete all data and cannot be reversed.`,
+		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
+			if err := setContextRootDir(cmd); err != nil {
+				return err
+			}
+			return setContextConfig(cmd)
+		},
+		RunE: func(cmd *cobra.Command, args []string) error {
+			if !force {
+				return ErrPurgeForceFlagRequired
+			}
+			cfg := mustGetContextConfig(cmd)
+			return os.RemoveAll(cfg.GetString("datastore.badger.path"))
+		},
+	}
+	cmd.Flags().BoolVarP(&force, "force", "f", false, "Must be set for the operation to run")
+	return cmd
+}

cli/purge_test.go

@@ -0,0 +1,67 @@
+// Copyright 2024 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package cli
+
+import (
+	"os"
+	"testing"
+
+	"github.com/spf13/pflag"
+	"github.com/spf13/viper"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestPurgeCommandWithoutForceFlag_ReturnsError(t *testing.T) {
+	rootDir := t.TempDir()
+
+	cmd := NewDefraCommand()
+	cmd.SetArgs([]string{"purge", "--rootdir", rootDir})
+
+	err := cmd.Execute()
+	require.ErrorIs(t, err, ErrPurgeForceFlagRequired)
+}
+
+func TestPurgeCommandWithEmptyDirectory_DoesNothing(t *testing.T) {
+	rootDir := t.TempDir()
+
+	cmd := NewDefraCommand()
+	cmd.SetArgs([]string{"purge", "--force", "--rootdir", rootDir})
+
+	err := cmd.Execute()
+	assert.NoError(t, err)
+}
+
+func TestPurgeCommandWithForceFlag_Succeeds(t *testing.T) {
+	rootDir := t.TempDir()
+
+	var dataDir string
+	// load the config and create the data directory
+	configLoader = func(rootdir string, flags *pflag.FlagSet) (*viper.Viper, error) {
+		cfg, err := loadConfig(rootdir, flags)
+		if err != nil {
+			return nil, err
+		}
+		dataDir = cfg.GetString("datastore.badger.path")
+		if err := os.MkdirAll(dataDir, 0755); err != nil {
+			return nil, err
+		}
+		return cfg, nil
+	}
+
+	cmd := NewDefraCommand()
+	cmd.SetArgs([]string{"purge", "--force", "--rootdir", rootDir})
+
+	err := cmd.Execute()
+	require.NoError(t, err)
+
+	assert.NoDirExists(t, dataDir)
+}

cli/utils.go

@@ -22,6 +22,7 @@ import (
 	"github.com/decred/dcrd/dcrec/secp256k1/v4"
 	"github.com/sourcenetwork/immutable"
 	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 	"golang.org/x/term"
 
@@ -66,6 +67,12 @@ var readPassword = func(cmd *cobra.Command, msg string) ([]byte, error) {
 	return pass, err
 }
 
+// configLoader loads a config for the current command. This can be swapped
+// during tests to force a common config for a command.
+var configLoader = func(rootdir string, flags *pflag.FlagSet) (*viper.Viper, error) {
+	return loadConfig(rootdir, flags)
+}
+
 // mustGetContextDB returns the db for the current command context.
 //
 // If a db is not set in the current context this function panics.
@@ -123,7 +130,7 @@ func setContextDB(cmd *cobra.Command) error {
 // setContextConfig sets teh config for the current command context.
 func setContextConfig(cmd *cobra.Command) error {
 	rootdir := mustGetContextRootDir(cmd)
-	cfg, err := loadConfig(rootdir, cmd.Flags())
+	cfg, err := configLoader(rootdir, cmd.Flags())
 	if err != nil {
 		return err
 	}

docs/website/references/cli/defradb.md

@@ -34,6 +34,7 @@ Start a DefraDB node, interact with a local or remote node, and much more.
 * [defradb client](defradb_client.md)	 - Interact with a DefraDB node
 * [defradb identity](defradb_identity.md)	 - Interact with identity features of DefraDB instance
 * [defradb keyring](defradb_keyring.md)	 - Manage DefraDB private keys
+* [defradb purge](defradb_purge.md)	 - Delete all persisted DefraDB data
 * [defradb server-dump](defradb_server-dump.md)	 - Dumps the state of the entire database
 * [defradb start](defradb_start.md)	 - Start a DefraDB node
 * [defradb version](defradb_version.md)	 - Display the version information of DefraDB and its components

docs/website/references/cli/defradb_purge.md

@@ -0,0 +1,43 @@
+## defradb purge
+
+Delete all persisted DefraDB data
+
+### Synopsis
+
+Delete all persisted DefraDB data.
+WARNING this operation will delete all data and cannot be reversed.
+
+```
+defradb purge [flags]
+```
+
+### Options
+
+```
+  -f, --force   Must be set for the operation to run
+  -h, --help    help for purge
+```
+
+### Options inherited from parent commands
+
+```
+      --keyring-backend string      Keyring backend to use. Options are file or system (default "file")
+      --keyring-namespace string    Service name to use when using the system backend (default "defradb")
+      --keyring-path string         Path to store encrypted keys when using the file backend (default "keys")
+      --log-format string           Log format to use. Options are text or json (default "text")
+      --log-level string            Log level to use. Options are debug, info, error, fatal (default "info")
+      --log-output string           Log output path. Options are stderr or stdout. (default "stderr")
+      --log-overrides string        Logger config overrides. Format <name>,<key>=<val>,...;<name>,...
+      --log-source                  Include source location in logs
+      --log-stacktrace              Include stacktrace in error and fatal logs
+      --no-keyring                  Disable the keyring and generate ephemeral keys
+      --no-log-color                Disable colored log output
+      --rootdir string              Directory for persistent data (default: $HOME/.defradb)
+      --source-hub-address string   The SourceHub address authorized by the client to make SourceHub transactions on behalf of the actor
+      --url string                  URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
+```
+
+### SEE ALSO
+
+* [defradb](defradb.md)	 - DefraDB Edge Database
+