diff --git a/src/restic/backend/layout.go b/src/restic/backend/layout.go index d14f47f89..43fa223b7 100644 --- a/src/restic/backend/layout.go +++ b/src/restic/backend/layout.go @@ -10,49 +10,3 @@ type Layout interface { Dirname(restic.Handle) string Paths() []string } - -// DefaultLayout implements the default layout for local and sftp backends, as -// described in the Design document. The `data` directory has one level of -// subdirs, two characters each (taken from the first two characters of the -// file name). -type DefaultLayout struct { - Path string - Join func(...string) string -} - -var defaultLayoutPaths = map[restic.FileType]string{ - restic.DataFile: "data", - restic.SnapshotFile: "snapshots", - restic.IndexFile: "index", - restic.LockFile: "locks", - restic.KeyFile: "keys", -} - -// Dirname returns the directory path for a given file type and name. -func (l *DefaultLayout) Dirname(h restic.Handle) string { - p := defaultLayoutPaths[h.Type] - - if h.Type == restic.DataFile && len(h.Name) > 2 { - p = l.Join(p, h.Name[:2]) - } - - return l.Join(l.Path, p) -} - -// Filename returns a path to a file, including its name. -func (l *DefaultLayout) Filename(h restic.Handle) string { - name := h.Name - if h.Type == restic.ConfigFile { - name = "config" - } - - return l.Join(l.Dirname(h), name) -} - -// Paths returns all directory names -func (l *DefaultLayout) Paths() (dirs []string) { - for _, p := range defaultLayoutPaths { - dirs = append(dirs, l.Join(l.Path, p)) - } - return dirs -} diff --git a/src/restic/backend/layout_cloud.go b/src/restic/backend/layout_cloud.go new file mode 100644 index 000000000..6f65be484 --- /dev/null +++ b/src/restic/backend/layout_cloud.go @@ -0,0 +1,36 @@ +package backend + +import "restic" + +// CloudLayout implements the default layout for cloud storage backends, as +// described in the Design document. +type CloudLayout struct { + Path string + Join func(...string) string +} + +var cloudLayoutPaths = defaultLayoutPaths + +// Dirname returns the directory path for a given file type and name. +func (l *CloudLayout) Dirname(h restic.Handle) string { + return l.Join(l.Path, cloudLayoutPaths[h.Type]) +} + +// Filename returns a path to a file, including its name. +func (l *CloudLayout) Filename(h restic.Handle) string { + name := h.Name + + if h.Type == restic.ConfigFile { + name = "config" + } + + return l.Join(l.Dirname(h), name) +} + +// Paths returns all directory names +func (l *CloudLayout) Paths() (dirs []string) { + for _, p := range cloudLayoutPaths { + dirs = append(dirs, l.Join(l.Path, p)) + } + return dirs +} diff --git a/src/restic/backend/layout_default.go b/src/restic/backend/layout_default.go new file mode 100644 index 000000000..fd6364b80 --- /dev/null +++ b/src/restic/backend/layout_default.go @@ -0,0 +1,49 @@ +package backend + +import "restic" + +// DefaultLayout implements the default layout for local and sftp backends, as +// described in the Design document. The `data` directory has one level of +// subdirs, two characters each (taken from the first two characters of the +// file name). +type DefaultLayout struct { + Path string + Join func(...string) string +} + +var defaultLayoutPaths = map[restic.FileType]string{ + restic.DataFile: "data", + restic.SnapshotFile: "snapshots", + restic.IndexFile: "index", + restic.LockFile: "locks", + restic.KeyFile: "keys", +} + +// Dirname returns the directory path for a given file type and name. +func (l *DefaultLayout) Dirname(h restic.Handle) string { + p := defaultLayoutPaths[h.Type] + + if h.Type == restic.DataFile && len(h.Name) > 2 { + p = l.Join(p, h.Name[:2]) + } + + return l.Join(l.Path, p) +} + +// Filename returns a path to a file, including its name. +func (l *DefaultLayout) Filename(h restic.Handle) string { + name := h.Name + if h.Type == restic.ConfigFile { + name = "config" + } + + return l.Join(l.Dirname(h), name) +} + +// Paths returns all directory names +func (l *DefaultLayout) Paths() (dirs []string) { + for _, p := range defaultLayoutPaths { + dirs = append(dirs, l.Join(l.Path, p)) + } + return dirs +} diff --git a/src/restic/backend/layout_s3.go b/src/restic/backend/layout_s3.go new file mode 100644 index 000000000..571d36335 --- /dev/null +++ b/src/restic/backend/layout_s3.go @@ -0,0 +1,42 @@ +package backend + +import "restic" + +// S3Layout implements the old layout used for s3 cloud storage backends, as +// described in the Design document. +type S3Layout struct { + Path string + Join func(...string) string +} + +var s3LayoutPaths = map[restic.FileType]string{ + restic.DataFile: "data", + restic.SnapshotFile: "snapshot", + restic.IndexFile: "index", + restic.LockFile: "lock", + restic.KeyFile: "key", +} + +// Dirname returns the directory path for a given file type and name. +func (l *S3Layout) Dirname(h restic.Handle) string { + return l.Join(l.Path, s3LayoutPaths[h.Type]) +} + +// Filename returns a path to a file, including its name. +func (l *S3Layout) Filename(h restic.Handle) string { + name := h.Name + + if h.Type == restic.ConfigFile { + name = "config" + } + + return l.Join(l.Dirname(h), name) +} + +// Paths returns all directory names +func (l *S3Layout) Paths() (dirs []string) { + for _, p := range s3LayoutPaths { + dirs = append(dirs, l.Join(l.Path, p)) + } + return dirs +} diff --git a/src/restic/backend/layout_test.go b/src/restic/backend/layout_test.go index 17d3a30a3..806329b71 100644 --- a/src/restic/backend/layout_test.go +++ b/src/restic/backend/layout_test.go @@ -64,7 +64,143 @@ func TestDefaultLayout(t *testing.T) { sort.Sort(sort.StringSlice(dirs)) if !reflect.DeepEqual(dirs, want) { - t.Fatalf("wrong paths returned, want:\v %v\ngot:\n %v", want, dirs) + t.Fatalf("wrong paths returned, want:\n %v\ngot:\n %v", want, dirs) + } + }) + + for _, test := range tests { + t.Run(fmt.Sprintf("%v/%v", test.Type, test.Handle.Name), func(t *testing.T) { + filename := l.Filename(test.Handle) + if filename != test.filename { + t.Fatalf("wrong filename, want %v, got %v", test.filename, filename) + } + }) + } +} + +func TestCloudLayout(t *testing.T) { + path, cleanup := test.TempDir(t) + defer cleanup() + + var tests = []struct { + restic.Handle + filename string + }{ + { + restic.Handle{Type: restic.DataFile, Name: "0123456"}, + filepath.Join(path, "data", "0123456"), + }, + { + restic.Handle{Type: restic.ConfigFile, Name: "CFG"}, + filepath.Join(path, "config"), + }, + { + restic.Handle{Type: restic.SnapshotFile, Name: "123456"}, + filepath.Join(path, "snapshots", "123456"), + }, + { + restic.Handle{Type: restic.IndexFile, Name: "123456"}, + filepath.Join(path, "index", "123456"), + }, + { + restic.Handle{Type: restic.LockFile, Name: "123456"}, + filepath.Join(path, "locks", "123456"), + }, + { + restic.Handle{Type: restic.KeyFile, Name: "123456"}, + filepath.Join(path, "keys", "123456"), + }, + } + + l := &CloudLayout{ + Path: path, + Join: filepath.Join, + } + + t.Run("Paths", func(t *testing.T) { + dirs := l.Paths() + + want := []string{ + filepath.Join(path, "data"), + filepath.Join(path, "snapshots"), + filepath.Join(path, "index"), + filepath.Join(path, "locks"), + filepath.Join(path, "keys"), + } + + sort.Sort(sort.StringSlice(want)) + sort.Sort(sort.StringSlice(dirs)) + + if !reflect.DeepEqual(dirs, want) { + t.Fatalf("wrong paths returned, want:\n %v\ngot:\n %v", want, dirs) + } + }) + + for _, test := range tests { + t.Run(fmt.Sprintf("%v/%v", test.Type, test.Handle.Name), func(t *testing.T) { + filename := l.Filename(test.Handle) + if filename != test.filename { + t.Fatalf("wrong filename, want %v, got %v", test.filename, filename) + } + }) + } +} + +func TestS3Layout(t *testing.T) { + path, cleanup := test.TempDir(t) + defer cleanup() + + var tests = []struct { + restic.Handle + filename string + }{ + { + restic.Handle{Type: restic.DataFile, Name: "0123456"}, + filepath.Join(path, "data", "0123456"), + }, + { + restic.Handle{Type: restic.ConfigFile, Name: "CFG"}, + filepath.Join(path, "config"), + }, + { + restic.Handle{Type: restic.SnapshotFile, Name: "123456"}, + filepath.Join(path, "snapshot", "123456"), + }, + { + restic.Handle{Type: restic.IndexFile, Name: "123456"}, + filepath.Join(path, "index", "123456"), + }, + { + restic.Handle{Type: restic.LockFile, Name: "123456"}, + filepath.Join(path, "lock", "123456"), + }, + { + restic.Handle{Type: restic.KeyFile, Name: "123456"}, + filepath.Join(path, "key", "123456"), + }, + } + + l := &S3Layout{ + Path: path, + Join: filepath.Join, + } + + t.Run("Paths", func(t *testing.T) { + dirs := l.Paths() + + want := []string{ + filepath.Join(path, "data"), + filepath.Join(path, "snapshot"), + filepath.Join(path, "index"), + filepath.Join(path, "lock"), + filepath.Join(path, "key"), + } + + sort.Sort(sort.StringSlice(want)) + sort.Sort(sort.StringSlice(dirs)) + + if !reflect.DeepEqual(dirs, want) { + t.Fatalf("wrong paths returned, want:\n %v\ngot:\n %v", want, dirs) } })