Name the remote and rclone config file in rclone setup errors (closes #467)
check / check (push) Waiting to run
check / check (push) Waiting to run
A remote missing from the config and a remote that fails to open now both name the remote and the rclone config file vaultik read, and say when that file does not exist. Model: opus-5-5
This commit is contained in:
1 parent
d747ddef3a
commit
cd86db7416
2 files changed
+103
-9
No files matched your search
@@ -398,24 +398,100 @@ func TestNewRcloneStorerUnknownRemote(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// TestNewRcloneStorerReadsRcloneConfigEnv checks that a remote defined only
|
||||
// in the file RCLONE_CONFIG names is found and written to, as rclone itself
|
||||
// would.
|
||||
func TestNewRcloneStorerReadsRcloneConfigEnv(t *testing.T) {
|
||||
// setRcloneConfigEnv points RCLONE_CONFIG at path for the rest of the test.
|
||||
func setRcloneConfigEnv(t *testing.T, path string) {
|
||||
t.Helper()
|
||||
|
||||
// rclone keeps the config file path in a process-global variable, which
|
||||
// NewRcloneStorer leaves pointing at this test's file.
|
||||
// NewRcloneStorer leaves pointing at path.
|
||||
previous := config.GetConfigPath()
|
||||
|
||||
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")
|
||||
|
||||
err := os.WriteFile(confFile, []byte("[loc]\ntype = local\n"), 0o600)
|
||||
err := os.WriteFile(confFile, []byte(contents), 0o600)
|
||||
if err != nil {
|
||||
t.Fatalf("writing rclone config: %v", err)
|
||||
}
|
||||
|
||||
t.Setenv("RCLONE_CONFIG", confFile)
|
||||
return 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()
|
||||
ctx := context.Background()
|
||||
|
||||
Reference in new issue
Block a user