config: check config names more carefully and report errors - fixes #3506
Before this change it was possible to make a remote with an invalid name in the config file, either manually or with `rclone config create` (but not with `rclone config`). When this remote was used, because it was invalid, rclone would presume this remote name was a local directory for a very suprising user experience! This change checks remote names more carefully and returns errors - when the user tries to use an invalid remote name on the command line - when an invalid remote name is used in `rclone config create/update/password` - when the user tries to enter an invalid remote name in `rclone config` This does not prevent the user entering a remote name with invalid characters in the config manually, but such a remote will fail immediately when it is used on the command line.
This commit is contained in:
Nick Craig-Wood
parent
27a730ef8f
commit
f1347139fa
6 changed files with 177 additions and 44 deletions
|
|
@ -2,23 +2,85 @@ package fspath
|
|||
|
||||
import (
|
||||
"fmt"
|
||||
"runtime"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestCheckConfigName(t *testing.T) {
|
||||
for _, test := range []struct {
|
||||
in string
|
||||
want error
|
||||
}{
|
||||
{"remote", nil},
|
||||
{"", errInvalidCharacters},
|
||||
{":remote:", errInvalidCharacters},
|
||||
{"remote:", errInvalidCharacters},
|
||||
{"rem:ote", errInvalidCharacters},
|
||||
{"rem/ote", errInvalidCharacters},
|
||||
{"rem\\ote", errInvalidCharacters},
|
||||
{"[remote", errInvalidCharacters},
|
||||
{"*", errInvalidCharacters},
|
||||
} {
|
||||
got := CheckConfigName(test.in)
|
||||
assert.Equal(t, test.want, got, test.in)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCheckRemoteName(t *testing.T) {
|
||||
for _, test := range []struct {
|
||||
in string
|
||||
want error
|
||||
}{
|
||||
{":remote:", nil},
|
||||
{"remote:", nil},
|
||||
{"", errInvalidCharacters},
|
||||
{"rem:ote", errInvalidCharacters},
|
||||
{"rem:ote:", errInvalidCharacters},
|
||||
{"remote", errInvalidCharacters},
|
||||
{"rem/ote:", errInvalidCharacters},
|
||||
{"rem\\ote:", errInvalidCharacters},
|
||||
{"[remote:", errInvalidCharacters},
|
||||
{"*:", errInvalidCharacters},
|
||||
} {
|
||||
got := CheckRemoteName(test.in)
|
||||
assert.Equal(t, test.want, got, test.in)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParse(t *testing.T) {
|
||||
for _, test := range []struct {
|
||||
in, wantConfigName, wantFsPath string
|
||||
wantErr error
|
||||
}{
|
||||
{"", "", ""},
|
||||
{"/path/to/file", "", "/path/to/file"},
|
||||
{"path/to/file", "", "path/to/file"},
|
||||
{"remote:path/to/file", "remote", "path/to/file"},
|
||||
{"remote:/path/to/file", "remote", "/path/to/file"},
|
||||
{":backend:/path/to/file", ":backend", "/path/to/file"},
|
||||
{"", "", "", nil},
|
||||
{":", "", "", errInvalidCharacters},
|
||||
{"::", ":", "", errInvalidCharacters},
|
||||
{":/:", "", "/:", errInvalidCharacters},
|
||||
{"/:", "", "/:", nil},
|
||||
{"\\backslash:", "", "\\backslash:", nil},
|
||||
{"/slash:", "", "/slash:", nil},
|
||||
{"with\\backslash:", "", "with\\backslash:", nil},
|
||||
{"with/slash:", "", "with/slash:", nil},
|
||||
{"/path/to/file", "", "/path/to/file", nil},
|
||||
{"/path:/to/file", "", "/path:/to/file", nil},
|
||||
{"./path:/to/file", "", "./path:/to/file", nil},
|
||||
{"./:colon.txt", "", "./:colon.txt", nil},
|
||||
{"path/to/file", "", "path/to/file", nil},
|
||||
{"remote:path/to/file", "remote", "path/to/file", nil},
|
||||
{"rem*ote:path/to/file", "rem*ote", "path/to/file", errInvalidCharacters},
|
||||
{"remote:/path/to/file", "remote", "/path/to/file", nil},
|
||||
{"rem.ote:/path/to/file", "rem.ote", "/path/to/file", errInvalidCharacters},
|
||||
{":backend:/path/to/file", ":backend", "/path/to/file", nil},
|
||||
{":bac*kend:/path/to/file", ":bac*kend", "/path/to/file", errInvalidCharacters},
|
||||
} {
|
||||
gotConfigName, gotFsPath := Parse(test.in)
|
||||
gotConfigName, gotFsPath, gotErr := Parse(test.in)
|
||||
if runtime.GOOS == "windows" {
|
||||
test.wantFsPath = strings.Replace(test.wantFsPath, `\`, `/`, -1)
|
||||
}
|
||||
assert.Equal(t, test.wantErr, gotErr)
|
||||
assert.Equal(t, test.wantConfigName, gotConfigName)
|
||||
assert.Equal(t, test.wantFsPath, gotFsPath)
|
||||
}
|
||||
|
|
@ -27,35 +89,41 @@ func TestParse(t *testing.T) {
|
|||
func TestSplit(t *testing.T) {
|
||||
for _, test := range []struct {
|
||||
remote, wantParent, wantLeaf string
|
||||
wantErr error
|
||||
}{
|
||||
{"", "", ""},
|
||||
{"", "", "", nil},
|
||||
|
||||
{"remote:", "remote:", ""},
|
||||
{"remote:potato", "remote:", "potato"},
|
||||
{"remote:/", "remote:/", ""},
|
||||
{"remote:/potato", "remote:/", "potato"},
|
||||
{"remote:/potato/potato", "remote:/potato/", "potato"},
|
||||
{"remote:potato/sausage", "remote:potato/", "sausage"},
|
||||
{"remote:", "remote:", "", nil},
|
||||
{"remote:potato", "remote:", "potato", nil},
|
||||
{"remote:/", "remote:/", "", nil},
|
||||
{"remote:/potato", "remote:/", "potato", nil},
|
||||
{"remote:/potato/potato", "remote:/potato/", "potato", nil},
|
||||
{"remote:potato/sausage", "remote:potato/", "sausage", nil},
|
||||
{"rem.ote:potato/sausage", "", "", errInvalidCharacters},
|
||||
|
||||
{":remote:", ":remote:", ""},
|
||||
{":remote:potato", ":remote:", "potato"},
|
||||
{":remote:/", ":remote:/", ""},
|
||||
{":remote:/potato", ":remote:/", "potato"},
|
||||
{":remote:/potato/potato", ":remote:/potato/", "potato"},
|
||||
{":remote:potato/sausage", ":remote:potato/", "sausage"},
|
||||
{":remote:", ":remote:", "", nil},
|
||||
{":remote:potato", ":remote:", "potato", nil},
|
||||
{":remote:/", ":remote:/", "", nil},
|
||||
{":remote:/potato", ":remote:/", "potato", nil},
|
||||
{":remote:/potato/potato", ":remote:/potato/", "potato", nil},
|
||||
{":remote:potato/sausage", ":remote:potato/", "sausage", nil},
|
||||
{":rem[ote:potato/sausage", "", "", errInvalidCharacters},
|
||||
|
||||
{"/", "/", ""},
|
||||
{"/root", "/", "root"},
|
||||
{"/a/b", "/a/", "b"},
|
||||
{"root", "", "root"},
|
||||
{"a/b", "a/", "b"},
|
||||
{"root/", "root/", ""},
|
||||
{"a/b/", "a/b/", ""},
|
||||
{"/", "/", "", nil},
|
||||
{"/root", "/", "root", nil},
|
||||
{"/a/b", "/a/", "b", nil},
|
||||
{"root", "", "root", nil},
|
||||
{"a/b", "a/", "b", nil},
|
||||
{"root/", "root/", "", nil},
|
||||
{"a/b/", "a/b/", "", nil},
|
||||
} {
|
||||
gotParent, gotLeaf := Split(test.remote)
|
||||
gotParent, gotLeaf, gotErr := Split(test.remote)
|
||||
assert.Equal(t, test.wantErr, gotErr)
|
||||
assert.Equal(t, test.wantParent, gotParent, test.remote)
|
||||
assert.Equal(t, test.wantLeaf, gotLeaf, test.remote)
|
||||
assert.Equal(t, test.remote, gotParent+gotLeaf, fmt.Sprintf("%s: %q + %q != %q", test.remote, gotParent, gotLeaf, test.remote))
|
||||
if gotErr == nil {
|
||||
assert.Equal(t, test.remote, gotParent+gotLeaf, fmt.Sprintf("%s: %q + %q != %q", test.remote, gotParent, gotLeaf, test.remote))
|
||||
}
|
||||
}
|
||||
}
|
||||
func TestJoinRootPath(t *testing.T) {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue