overdue

.rclone_repo/backend/alias/alias.go

@@ -0,0 +1,59 @@
+package alias
+
+import (
+	"errors"
+	"path"
+	"path/filepath"
+	"strings"
+
+	"github.com/ncw/rclone/fs"
+	"github.com/ncw/rclone/fs/config/configmap"
+	"github.com/ncw/rclone/fs/config/configstruct"
+)
+
+// Register with Fs
+func init() {
+	fsi := &fs.RegInfo{
+		Name:        "alias",
+		Description: "Alias for a existing remote",
+		NewFs:       NewFs,
+		Options: []fs.Option{{
+			Name:     "remote",
+			Help:     "Remote or path to alias.\nCan be \"myremote:path/to/dir\", \"myremote:bucket\", \"myremote:\" or \"/local/path\".",
+			Required: true,
+		}},
+	}
+	fs.Register(fsi)
+}
+
+// Options defines the configuration for this backend
+type Options struct {
+	Remote string `config:"remote"`
+}
+
+// NewFs contstructs an Fs from the path.
+//
+// The returned Fs is the actual Fs, referenced by remote in the config
+func NewFs(name, root string, m configmap.Mapper) (fs.Fs, error) {
+	// Parse config into Options struct
+	opt := new(Options)
+	err := configstruct.Set(m, opt)
+	if err != nil {
+		return nil, err
+	}
+	if opt.Remote == "" {
+		return nil, errors.New("alias can't point to an empty remote - check the value of the remote setting")
+	}
+	if strings.HasPrefix(opt.Remote, name+":") {
+		return nil, errors.New("can't point alias remote at itself - check the value of the remote setting")
+	}
+	_, configName, fsPath, err := fs.ParseRemote(opt.Remote)
+	if err != nil {
+		return nil, err
+	}
+	root = path.Join(fsPath, filepath.ToSlash(root))
+	if configName == "local" {
+		return fs.NewFs(root)
+	}
+	return fs.NewFs(configName + ":" + root)
+}

.rclone_repo/backend/alias/alias_internal_test.go

@@ -0,0 +1,104 @@
+package alias
+
+import (
+	"fmt"
+	"path"
+	"path/filepath"
+	"sort"
+	"testing"
+
+	_ "github.com/ncw/rclone/backend/local" // pull in test backend
+	"github.com/ncw/rclone/fs"
+	"github.com/ncw/rclone/fs/config"
+	"github.com/stretchr/testify/require"
+)
+
+var (
+	remoteName = "TestAlias"
+)
+
+func prepare(t *testing.T, root string) {
+	config.LoadConfig()
+
+	// Configure the remote
+	config.FileSet(remoteName, "type", "alias")
+	config.FileSet(remoteName, "remote", root)
+}
+
+func TestNewFS(t *testing.T) {
+	type testEntry struct {
+		remote string
+		size   int64
+		isDir  bool
+	}
+	for testi, test := range []struct {
+		remoteRoot string
+		fsRoot     string
+		fsList     string
+		wantOK     bool
+		entries    []testEntry
+	}{
+		{"", "", "", true, []testEntry{
+			{"four", -1, true},
+			{"one%.txt", 6, false},
+			{"three", -1, true},
+			{"two.html", 7, false},
+		}},
+		{"", "four", "", true, []testEntry{
+			{"five", -1, true},
+			{"under four.txt", 9, false},
+		}},
+		{"", "", "four", true, []testEntry{
+			{"four/five", -1, true},
+			{"four/under four.txt", 9, false},
+		}},
+		{"four", "..", "", true, []testEntry{
+			{"four", -1, true},
+			{"one%.txt", 6, false},
+			{"three", -1, true},
+			{"two.html", 7, false},
+		}},
+		{"four", "../three", "", true, []testEntry{
+			{"underthree.txt", 9, false},
+		}},
+	} {
+		what := fmt.Sprintf("test %d remoteRoot=%q, fsRoot=%q, fsList=%q", testi, test.remoteRoot, test.fsRoot, test.fsList)
+
+		remoteRoot, err := filepath.Abs(filepath.FromSlash(path.Join("test/files", test.remoteRoot)))
+		require.NoError(t, err, what)
+		prepare(t, remoteRoot)
+		f, err := fs.NewFs(fmt.Sprintf("%s:%s", remoteName, test.fsRoot))
+		require.NoError(t, err, what)
+		gotEntries, err := f.List(test.fsList)
+		require.NoError(t, err, what)
+
+		sort.Sort(gotEntries)
+
+		require.Equal(t, len(test.entries), len(gotEntries), what)
+		for i, gotEntry := range gotEntries {
+			what := fmt.Sprintf("%s, entry=%d", what, i)
+			wantEntry := test.entries[i]
+
+			require.Equal(t, wantEntry.remote, gotEntry.Remote(), what)
+			require.Equal(t, wantEntry.size, int64(gotEntry.Size()), what)
+			_, isDir := gotEntry.(fs.Directory)
+			require.Equal(t, wantEntry.isDir, isDir, what)
+		}
+	}
+}
+
+func TestNewFSNoRemote(t *testing.T) {
+	prepare(t, "")
+	f, err := fs.NewFs(fmt.Sprintf("%s:", remoteName))
+
+	require.Error(t, err)
+	require.Nil(t, f)
+}
+
+func TestNewFSInvalidRemote(t *testing.T) {
+	prepare(t, "not_existing_test_remote:")
+	f, err := fs.NewFs(fmt.Sprintf("%s:", remoteName))
+
+	require.Error(t, err)
+	require.Nil(t, f)
+}

.rclone_repo/backend/alias/test/files/four/five/underfive.txt

@@ -0,0 +1 @@
+apple

.rclone_repo/backend/alias/test/files/four/under four.txt

@@ -0,0 +1 @@
+beetroot

.rclone_repo/backend/alias/test/files/one%.txt

@@ -0,0 +1 @@
+hello

.rclone_repo/backend/alias/test/files/three/underthree.txt

@@ -0,0 +1 @@
+rutabaga

.rclone_repo/backend/alias/test/files/two.html

@@ -0,0 +1 @@
+potato