Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2e962a79c9 |
No files matched your search
@@ -183,6 +183,7 @@ vaultik [--config <path>] remote nuke --force
|
|||||||
vaultik [--config <path>] database delete [--force]
|
vaultik [--config <path>] database delete [--force]
|
||||||
vaultik completion <bash|zsh|fish|powershell>
|
vaultik completion <bash|zsh|fish|powershell>
|
||||||
vaultik version
|
vaultik version
|
||||||
|
vaultik --version
|
||||||
```
|
```
|
||||||
|
|
||||||
### global flags
|
### global flags
|
||||||
|
|||||||
+18
-4
@@ -32,6 +32,8 @@ var rootFlags RootFlags
|
|||||||
// It sets up the command structure, global flags, and adds all subcommands.
|
// It sets up the command structure, global flags, and adds all subcommands.
|
||||||
// This is the main entry point for the CLI command hierarchy.
|
// This is the main entry point for the CLI command hierarchy.
|
||||||
func NewRootCommand() *cobra.Command {
|
func NewRootCommand() *cobra.Command {
|
||||||
|
var showVersion bool
|
||||||
|
|
||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
Use: "vaultik",
|
Use: "vaultik",
|
||||||
Short: "Secure incremental backup tool with asymmetric encryption",
|
Short: "Secure incremental backup tool with asymmetric encryption",
|
||||||
@@ -39,15 +41,27 @@ func NewRootCommand() *cobra.Command {
|
|||||||
public keys and uploads to S3-compatible storage. No private keys are needed
|
public keys and uploads to S3-compatible storage. No private keys are needed
|
||||||
on the source system.`,
|
on the source system.`,
|
||||||
SilenceUsage: true,
|
SilenceUsage: true,
|
||||||
// Bare 'vaultik' (no subcommand): print help. The banner is
|
// Bare 'vaultik' (no subcommand): print help, or with --version
|
||||||
// printed once at process startup by Entry, before cobra
|
// the report of the version command. The banner is printed once
|
||||||
// parses arguments, so it appears even when cobra rejects
|
// at process startup by Entry, before cobra parses arguments, so
|
||||||
// args (e.g. "requires at least 2 arg(s)") and on --help.
|
// it appears even when cobra rejects args (e.g. "requires at
|
||||||
|
// least 2 arg(s)") and on --help.
|
||||||
Run: func(cmd *cobra.Command, _ []string) {
|
Run: func(cmd *cobra.Command, _ []string) {
|
||||||
|
if showVersion {
|
||||||
|
writeVersion(commandUI(cmd))
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
_ = cmd.Help()
|
_ = cmd.Help()
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// cobra's own --version prints a template, not the version report,
|
||||||
|
// so vaultik defines the flag itself.
|
||||||
|
cmd.Flags().BoolVar(&showVersion, "version", false,
|
||||||
|
"Print version information (same as 'vaultik version')")
|
||||||
|
|
||||||
// Add global flags
|
// Add global flags
|
||||||
cmd.PersistentFlags().StringVar(&rootFlags.ConfigPath, "config", "",
|
cmd.PersistentFlags().StringVar(&rootFlags.ConfigPath, "config", "",
|
||||||
"Path to config file (default: $VAULTIK_CONFIG or platform config dir)")
|
"Path to config file (default: $VAULTIK_CONFIG or platform config dir)")
|
||||||
|
|||||||
@@ -86,6 +86,30 @@ func TestVersionCommandReportLines(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestVersionFlagPrintsVersionReport checks that `vaultik --version`
|
||||||
|
// prints exactly the report of `vaultik version`.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // executes commands that read the global rootFlags
|
||||||
|
func TestVersionFlagPrintsVersionReport(t *testing.T) {
|
||||||
|
cmd := cli.NewRootCommand()
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
|
||||||
|
cmd.SetOut(&out)
|
||||||
|
cmd.SetErr(&out)
|
||||||
|
cmd.SetArgs([]string{"--version"})
|
||||||
|
|
||||||
|
err := cmd.Execute()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("vaultik --version failed: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
want := runVersionCommand(t)
|
||||||
|
if out.String() != want {
|
||||||
|
t.Errorf("vaultik --version printed:\n%s\nwant:\n%s", out.String(), want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// TestVersionCommandFlagsDevelopmentBuild is the regression test for
|
// TestVersionCommandFlagsDevelopmentBuild is the regression test for
|
||||||
// the thing this command exists to prevent: a build that is not a
|
// the thing this command exists to prevent: a build that is not a
|
||||||
// release must say so. The notice used to be gated on the version
|
// release must say so. The notice used to be gated on the version
|
||||||
|
|||||||
@@ -67,12 +67,10 @@ func NewRcloneStorer(ctx context.Context, remote, path string) (*RcloneStorer, e
|
|||||||
// Check for remote not found error
|
// Check for remote not found error
|
||||||
if strings.Contains(err.Error(), "didn't find section in config file") ||
|
if strings.Contains(err.Error(), "didn't find section in config file") ||
|
||||||
strings.Contains(err.Error(), "failed to find remote") {
|
strings.Contains(err.Error(), "failed to find remote") {
|
||||||
return nil, fmt.Errorf("%w: %q (%s)",
|
return nil, fmt.Errorf("%w: %s", ErrRemoteNotFound, remote)
|
||||||
ErrRemoteNotFound, remote, describeRcloneConfigFile())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil, fmt.Errorf("opening rclone remote %q (%s): %w",
|
return nil, fmt.Errorf("creating rclone filesystem: %w", err)
|
||||||
remote, describeRcloneConfigFile(), err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return &RcloneStorer{
|
return &RcloneStorer{
|
||||||
@@ -326,22 +324,6 @@ func (r *RcloneStorer) upload(ctx context.Context, key string, data io.Reader) e
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// describeRcloneConfigFile names the rclone config file for an error
|
|
||||||
// message, and says so when that file does not exist.
|
|
||||||
func describeRcloneConfigFile() string {
|
|
||||||
path := config.GetConfigPath()
|
|
||||||
if path == "" {
|
|
||||||
return "no config file"
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := os.Stat(path)
|
|
||||||
if errors.Is(err, os.ErrNotExist) {
|
|
||||||
return fmt.Sprintf("config file %q, which does not exist", path)
|
|
||||||
}
|
|
||||||
|
|
||||||
return fmt.Sprintf("config file %q", path)
|
|
||||||
}
|
|
||||||
|
|
||||||
// progressReader wraps an io.Reader to track read progress.
|
// progressReader wraps an io.Reader to track read progress.
|
||||||
type progressReader struct {
|
type progressReader struct {
|
||||||
reader io.Reader
|
reader io.Reader
|
||||||
|
|||||||
@@ -398,100 +398,24 @@ func TestNewRcloneStorerUnknownRemote(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// setRcloneConfigEnv points RCLONE_CONFIG at path for the rest of the test.
|
// TestNewRcloneStorerReadsRcloneConfigEnv checks that a remote defined only
|
||||||
func setRcloneConfigEnv(t *testing.T, path string) {
|
// in the file RCLONE_CONFIG names is found and written to, as rclone itself
|
||||||
t.Helper()
|
// would.
|
||||||
|
func TestNewRcloneStorerReadsRcloneConfigEnv(t *testing.T) {
|
||||||
// rclone keeps the config file path in a process-global variable, which
|
// rclone keeps the config file path in a process-global variable, which
|
||||||
// NewRcloneStorer leaves pointing at path.
|
// NewRcloneStorer leaves pointing at this test's file.
|
||||||
previous := config.GetConfigPath()
|
previous := config.GetConfigPath()
|
||||||
|
|
||||||
t.Cleanup(func() { _ = config.SetConfigPath(previous) })
|
t.Cleanup(func() { _ = config.SetConfigPath(previous) })
|
||||||
|
|
||||||
t.Setenv("RCLONE_CONFIG", path)
|
|
||||||
}
|
|
||||||
|
|
||||||
// writeRcloneConfigFile writes contents to a new rclone config file and
|
|
||||||
// returns its path.
|
|
||||||
func writeRcloneConfigFile(t *testing.T, contents string) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
confFile := filepath.Join(t.TempDir(), "rclone.conf")
|
confFile := filepath.Join(t.TempDir(), "rclone.conf")
|
||||||
|
|
||||||
err := os.WriteFile(confFile, []byte(contents), 0o600)
|
err := os.WriteFile(confFile, []byte("[loc]\ntype = local\n"), 0o600)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("writing rclone config: %v", err)
|
t.Fatalf("writing rclone config: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return confFile
|
t.Setenv("RCLONE_CONFIG", confFile)
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewRcloneStorerErrorsNameRemoteAndConfigFile checks that each error
|
|
||||||
// from opening a remote names the remote and the rclone config file, and
|
|
||||||
// says when that file does not exist.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // sets RCLONE_CONFIG and the process-global rclone config
|
|
||||||
func TestNewRcloneStorerErrorsNameRemoteAndConfigFile(t *testing.T) {
|
|
||||||
const doesNotExist = "which does not exist"
|
|
||||||
|
|
||||||
missingFile := filepath.Join(t.TempDir(), "missing.conf")
|
|
||||||
emptyFile := writeRcloneConfigFile(t, "")
|
|
||||||
badRemoteFile := writeRcloneConfigFile(t,
|
|
||||||
"[bad]\ntype = vaultik-no-such-backend\n")
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
configFile string
|
|
||||||
remote string
|
|
||||||
wantNotFound bool
|
|
||||||
wantNoSuchFile bool
|
|
||||||
}{
|
|
||||||
{"config file missing", missingFile, "dav", true, true},
|
|
||||||
{"remote not in config file", emptyFile, "dav", true, false},
|
|
||||||
{"remote fails to open", badRemoteFile, "bad", false, false},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.name, func(t *testing.T) {
|
|
||||||
setRcloneConfigEnv(t, tt.configFile)
|
|
||||||
|
|
||||||
_, err := storage.NewRcloneStorer(
|
|
||||||
context.Background(), tt.remote, "path")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("NewRcloneStorer succeeded, want an error")
|
|
||||||
}
|
|
||||||
|
|
||||||
msg := err.Error()
|
|
||||||
|
|
||||||
if errors.Is(err, storage.ErrRemoteNotFound) != tt.wantNotFound {
|
|
||||||
t.Errorf("error = %v, want ErrRemoteNotFound: %v",
|
|
||||||
err, tt.wantNotFound)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(msg, `"`+tt.remote+`"`) {
|
|
||||||
t.Errorf("error %q does not name remote %q", msg, tt.remote)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(msg, tt.configFile) {
|
|
||||||
t.Errorf("error %q does not name config file %q",
|
|
||||||
msg, tt.configFile)
|
|
||||||
}
|
|
||||||
|
|
||||||
if strings.Contains(msg, doesNotExist) != tt.wantNoSuchFile {
|
|
||||||
t.Errorf("error %q, want it to say the file does not exist: %v",
|
|
||||||
msg, tt.wantNoSuchFile)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNewRcloneStorerReadsRcloneConfigEnv checks that a remote defined only
|
|
||||||
// in the file RCLONE_CONFIG names is found and written to, as rclone itself
|
|
||||||
// would.
|
|
||||||
//
|
|
||||||
//nolint:paralleltest // sets RCLONE_CONFIG and the process-global rclone config
|
|
||||||
func TestNewRcloneStorerReadsRcloneConfigEnv(t *testing.T) {
|
|
||||||
setRcloneConfigEnv(t, writeRcloneConfigFile(t, "[loc]\ntype = local\n"))
|
|
||||||
|
|
||||||
dir := t.TempDir()
|
dir := t.TempDir()
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
|
|||||||
Reference in new issue
Block a user