restic/internal/walker/walker_test.go

454 lines
11 KiB
Go
Raw Normal View History

2018-06-09 16:19:27 +00:00
package walker
import (
"context"
"fmt"
"sort"
2018-06-09 16:19:27 +00:00
"testing"
"github.com/pkg/errors"
"github.com/restic/restic/internal/restic"
)
// TestTree is used to construct a list of trees for testing the walker.
type TestTree map[string]interface{}
// TestFile is used to test the walker.
type TestFile struct {
Size uint64
}
2018-06-09 16:19:27 +00:00
func BuildTreeMap(tree TestTree) (m TreeMap, root restic.ID) {
m = TreeMap{}
id := buildTreeMap(tree, m)
return m, id
}
func buildTreeMap(tree TestTree, m TreeMap) restic.ID {
tb := restic.NewTreeJSONBuilder()
var names []string
for name := range tree {
names = append(names, name)
}
sort.Strings(names)
2018-06-09 16:19:27 +00:00
for _, name := range names {
item := tree[name]
2018-06-09 16:19:27 +00:00
switch elem := item.(type) {
case TestFile:
err := tb.AddNode(&restic.Node{
2018-06-09 16:19:27 +00:00
Name: name,
Type: "file",
Size: elem.Size,
2018-06-09 16:19:27 +00:00
})
2021-01-30 15:46:34 +00:00
if err != nil {
panic(err)
}
2018-06-09 16:19:27 +00:00
case TestTree:
id := buildTreeMap(elem, m)
err := tb.AddNode(&restic.Node{
2018-06-09 16:19:27 +00:00
Name: name,
Subtree: &id,
Type: "dir",
})
2021-01-30 15:46:34 +00:00
if err != nil {
panic(err)
}
2018-06-09 16:19:27 +00:00
default:
panic(fmt.Sprintf("invalid type %T", elem))
}
}
buf, err := tb.Finalize()
2018-06-09 16:19:27 +00:00
if err != nil {
panic(err)
}
id := restic.Hash(buf)
if _, ok := m[id]; !ok {
m[id] = buf
2018-06-09 16:19:27 +00:00
}
return id
}
// TreeMap returns the trees from the map on LoadTree.
type TreeMap map[restic.ID][]byte
2018-06-09 16:19:27 +00:00
func (t TreeMap) LoadBlob(_ context.Context, tpe restic.BlobType, id restic.ID, _ []byte) ([]byte, error) {
if tpe != restic.TreeBlob {
return nil, errors.New("can only load trees")
}
2018-06-09 16:19:27 +00:00
tree, ok := t[id]
if !ok {
return nil, errors.New("tree not found")
}
return tree, nil
2018-06-09 16:19:27 +00:00
}
func (t TreeMap) Connections() uint {
return 2
}
2018-06-09 16:19:27 +00:00
// checkFunc returns a function suitable for walking the tree to check
// something, and a function which will check the final result.
2024-01-21 15:44:00 +00:00
type checkFunc func(t testing.TB) (walker WalkFunc, leaveDir func(path string), final func(testing.TB))
2018-06-09 16:19:27 +00:00
// checkItemOrder ensures that the order of the 'path' arguments is the one passed in as 'want'.
func checkItemOrder(want []string) checkFunc {
pos := 0
2024-01-21 15:44:00 +00:00
return func(t testing.TB) (walker WalkFunc, leaveDir func(path string), final func(testing.TB)) {
walker = func(treeID restic.ID, path string, node *restic.Node, err error) error {
2018-06-09 16:19:27 +00:00
if err != nil {
t.Errorf("error walking %v: %v", path, err)
return err
2018-06-09 16:19:27 +00:00
}
if pos >= len(want) {
t.Errorf("additional unexpected path found: %v", path)
return nil
2018-06-09 16:19:27 +00:00
}
if path != want[pos] {
t.Errorf("wrong path found, want %q, got %q", want[pos], path)
}
pos++
return nil
2018-06-09 16:19:27 +00:00
}
2024-01-21 15:44:00 +00:00
leaveDir = func(path string) {
_ = walker(restic.ID{}, "leave: "+path, nil, nil)
}
2018-06-09 16:19:27 +00:00
final = func(t testing.TB) {
if pos != len(want) {
t.Errorf("not enough items returned, want %d, got %d", len(want), pos)
}
}
2024-01-21 15:44:00 +00:00
return walker, leaveDir, final
2018-06-09 16:19:27 +00:00
}
}
2018-08-19 10:28:06 +00:00
// checkParentTreeOrder ensures that the order of the 'parentID' arguments is the one passed in as 'want'.
func checkParentTreeOrder(want []string) checkFunc {
pos := 0
2024-01-21 15:44:00 +00:00
return func(t testing.TB) (walker WalkFunc, leaveDir func(path string), final func(testing.TB)) {
walker = func(treeID restic.ID, path string, node *restic.Node, err error) error {
2018-08-19 10:28:06 +00:00
if err != nil {
t.Errorf("error walking %v: %v", path, err)
return err
2018-08-19 10:28:06 +00:00
}
if pos >= len(want) {
t.Errorf("additional unexpected parent tree ID found: %v", treeID)
return nil
2018-08-19 10:28:06 +00:00
}
if treeID.String() != want[pos] {
t.Errorf("wrong parent tree ID found, want %q, got %q", want[pos], treeID.String())
}
pos++
return nil
2018-08-19 10:28:06 +00:00
}
final = func(t testing.TB) {
if pos != len(want) {
t.Errorf("not enough items returned, want %d, got %d", len(want), pos)
}
}
2024-01-21 15:44:00 +00:00
return walker, nil, final
2018-08-19 10:28:06 +00:00
}
}
// checkSkipFor returns ErrSkipNode if path is in skipFor, it checks that the
2018-06-09 16:19:27 +00:00
// paths the walk func is called for are exactly the ones in wantPaths.
func checkSkipFor(skipFor map[string]struct{}, wantPaths []string) checkFunc {
var pos int
2024-01-21 15:44:00 +00:00
return func(t testing.TB) (walker WalkFunc, leaveDir func(path string), final func(testing.TB)) {
walker = func(treeID restic.ID, path string, node *restic.Node, err error) error {
2018-06-09 16:19:27 +00:00
if err != nil {
t.Errorf("error walking %v: %v", path, err)
return err
2018-06-09 16:19:27 +00:00
}
if pos >= len(wantPaths) {
t.Errorf("additional unexpected path found: %v", path)
return nil
2018-06-09 16:19:27 +00:00
}
if path != wantPaths[pos] {
t.Errorf("wrong path found, want %q, got %q", wantPaths[pos], path)
}
pos++
if _, ok := skipFor[path]; ok {
return ErrSkipNode
2018-06-09 16:19:27 +00:00
}
return nil
2018-06-09 16:19:27 +00:00
}
2024-01-21 15:44:00 +00:00
leaveDir = func(path string) {
_ = walker(restic.ID{}, "leave: "+path, nil, nil)
}
2018-06-09 16:19:27 +00:00
final = func(t testing.TB) {
if pos != len(wantPaths) {
t.Errorf("wrong number of paths returned, want %d, got %d", len(wantPaths), pos)
}
}
2024-01-21 15:44:00 +00:00
return walker, leaveDir, final
2018-06-09 16:19:27 +00:00
}
}
func TestWalker(t *testing.T) {
var tests = []struct {
tree TestTree
checks []checkFunc
}{
{
tree: TestTree{
"foo": TestFile{},
"subdir": TestTree{
"subfile": TestFile{},
},
},
checks: []checkFunc{
checkItemOrder([]string{
"/",
"/foo",
"/subdir",
"/subdir/subfile",
2024-01-21 15:44:00 +00:00
"leave: /subdir",
"leave: /",
2018-06-09 16:19:27 +00:00
}),
2018-08-19 10:28:06 +00:00
checkParentTreeOrder([]string{
"a760536a8fd64dd63f8dd95d85d788d71fd1bee6828619350daf6959dcb499a0", // tree /
"a760536a8fd64dd63f8dd95d85d788d71fd1bee6828619350daf6959dcb499a0", // tree /
"a760536a8fd64dd63f8dd95d85d788d71fd1bee6828619350daf6959dcb499a0", // tree /
"670046b44353a89b7cd6ef84c78422232438f10eb225c29c07989ae05283d797", // tree /subdir
2018-08-19 10:28:06 +00:00
}),
2018-06-09 16:19:27 +00:00
checkSkipFor(
map[string]struct{}{
"/subdir": {},
2018-06-09 16:19:27 +00:00
}, []string{
"/",
"/foo",
"/subdir",
2024-01-21 15:44:00 +00:00
"leave: /",
2018-06-09 16:19:27 +00:00
},
),
2024-01-19 20:14:31 +00:00
checkSkipFor(
map[string]struct{}{
"/": {},
}, []string{
"/",
},
),
2018-06-09 16:19:27 +00:00
},
},
{
tree: TestTree{
"foo": TestFile{},
"subdir1": TestTree{
"subfile1": TestFile{},
},
"subdir2": TestTree{
"subfile2": TestFile{},
"subsubdir2": TestTree{
"subsubfile3": TestFile{},
},
},
},
checks: []checkFunc{
checkItemOrder([]string{
"/",
"/foo",
"/subdir1",
"/subdir1/subfile1",
2024-01-21 15:44:00 +00:00
"leave: /subdir1",
2018-06-09 16:19:27 +00:00
"/subdir2",
"/subdir2/subfile2",
"/subdir2/subsubdir2",
"/subdir2/subsubdir2/subsubfile3",
2024-01-21 15:44:00 +00:00
"leave: /subdir2/subsubdir2",
"leave: /subdir2",
"leave: /",
2018-06-09 16:19:27 +00:00
}),
2018-08-19 10:28:06 +00:00
checkParentTreeOrder([]string{
"7a0e59b986cc83167d9fbeeefc54e4629770124c5825d391f7ee0598667fcdf1", // tree /
"7a0e59b986cc83167d9fbeeefc54e4629770124c5825d391f7ee0598667fcdf1", // tree /
"7a0e59b986cc83167d9fbeeefc54e4629770124c5825d391f7ee0598667fcdf1", // tree /
"22c9feefa0b9fabc7ec5383c90cfe84ba714babbe4d2968fcb78f0ec7612e82f", // tree /subdir1
"7a0e59b986cc83167d9fbeeefc54e4629770124c5825d391f7ee0598667fcdf1", // tree /
"9bfe4aab3ac0ad7a81909355d7221801441fb20f7ed06c0142196b3f10358493", // tree /subdir2
"9bfe4aab3ac0ad7a81909355d7221801441fb20f7ed06c0142196b3f10358493", // tree /subdir2
"6b962fef064ef9beecc27dfcd6e0f2e7beeebc9c1f1f4f477d4af59fc45f411d", // tree /subdir2/subsubdir2
2018-08-19 10:28:06 +00:00
}),
2018-06-09 16:19:27 +00:00
checkSkipFor(
map[string]struct{}{
"/subdir1": {},
2018-06-09 16:19:27 +00:00
}, []string{
"/",
"/foo",
"/subdir1",
"/subdir2",
"/subdir2/subfile2",
"/subdir2/subsubdir2",
"/subdir2/subsubdir2/subsubfile3",
2024-01-21 15:44:00 +00:00
"leave: /subdir2/subsubdir2",
"leave: /subdir2",
"leave: /",
2018-06-09 16:19:27 +00:00
},
),
checkSkipFor(
map[string]struct{}{
"/subdir1": {},
"/subdir2/subsubdir2": {},
2018-06-09 16:19:27 +00:00
}, []string{
"/",
"/foo",
"/subdir1",
"/subdir2",
"/subdir2/subfile2",
"/subdir2/subsubdir2",
2024-01-21 15:44:00 +00:00
"leave: /subdir2",
"leave: /",
2018-06-09 16:19:27 +00:00
},
),
checkSkipFor(
map[string]struct{}{
"/foo": {},
2018-06-09 16:19:27 +00:00
}, []string{
"/",
"/foo",
2024-01-21 15:44:00 +00:00
"leave: /",
2018-06-09 16:19:27 +00:00
},
),
},
},
{
tree: TestTree{
"foo": TestFile{},
"subdir1": TestTree{
"subfile1": TestFile{},
"subfile2": TestFile{},
"subfile3": TestFile{},
},
"subdir2": TestTree{
"subfile1": TestFile{},
"subfile2": TestFile{},
"subfile3": TestFile{},
},
"subdir3": TestTree{
"subfile1": TestFile{},
"subfile2": TestFile{},
"subfile3": TestFile{},
},
"zzz other": TestFile{},
},
checks: []checkFunc{
checkItemOrder([]string{
"/",
"/foo",
"/subdir1",
"/subdir1/subfile1",
"/subdir1/subfile2",
"/subdir1/subfile3",
2024-01-21 15:44:00 +00:00
"leave: /subdir1",
2018-06-09 16:19:27 +00:00
"/subdir2",
"/subdir2/subfile1",
"/subdir2/subfile2",
"/subdir2/subfile3",
2024-01-21 15:44:00 +00:00
"leave: /subdir2",
2018-06-09 16:19:27 +00:00
"/subdir3",
"/subdir3/subfile1",
"/subdir3/subfile2",
"/subdir3/subfile3",
2024-01-21 15:44:00 +00:00
"leave: /subdir3",
2018-06-09 16:19:27 +00:00
"/zzz other",
2024-01-21 15:44:00 +00:00
"leave: /",
2018-06-09 16:19:27 +00:00
}),
2018-08-19 10:28:06 +00:00
checkParentTreeOrder([]string{
"c2efeff7f217a4dfa12a16e8bb3cefedd37c00873605c29e5271c6061030672f", // tree /
"c2efeff7f217a4dfa12a16e8bb3cefedd37c00873605c29e5271c6061030672f", // tree /
"c2efeff7f217a4dfa12a16e8bb3cefedd37c00873605c29e5271c6061030672f", // tree /
"57ee8960c7a86859b090a76e5d013f83d10c0ce11d5460076ca8468706f784ab", // tree /subdir1
"57ee8960c7a86859b090a76e5d013f83d10c0ce11d5460076ca8468706f784ab", // tree /subdir1
"57ee8960c7a86859b090a76e5d013f83d10c0ce11d5460076ca8468706f784ab", // tree /subdir1
"c2efeff7f217a4dfa12a16e8bb3cefedd37c00873605c29e5271c6061030672f", // tree /
"57ee8960c7a86859b090a76e5d013f83d10c0ce11d5460076ca8468706f784ab", // tree /subdir2
"57ee8960c7a86859b090a76e5d013f83d10c0ce11d5460076ca8468706f784ab", // tree /subdir2
"57ee8960c7a86859b090a76e5d013f83d10c0ce11d5460076ca8468706f784ab", // tree /subdir2
"c2efeff7f217a4dfa12a16e8bb3cefedd37c00873605c29e5271c6061030672f", // tree /
"57ee8960c7a86859b090a76e5d013f83d10c0ce11d5460076ca8468706f784ab", // tree /subdir3
"57ee8960c7a86859b090a76e5d013f83d10c0ce11d5460076ca8468706f784ab", // tree /subdir3
"57ee8960c7a86859b090a76e5d013f83d10c0ce11d5460076ca8468706f784ab", // tree /subdir3
"c2efeff7f217a4dfa12a16e8bb3cefedd37c00873605c29e5271c6061030672f", // tree /
2018-08-19 10:28:06 +00:00
}),
2018-06-09 16:19:27 +00:00
},
},
{
tree: TestTree{
"subdir1": TestTree{},
"subdir2": TestTree{},
"subdir3": TestTree{
"file": TestFile{},
},
"subdir4": TestTree{
"file": TestFile{},
},
"subdir5": TestTree{},
"subdir6": TestTree{},
},
checks: []checkFunc{
checkItemOrder([]string{
"/",
"/subdir1",
2024-01-21 15:44:00 +00:00
"leave: /subdir1",
"/subdir2",
2024-01-21 15:44:00 +00:00
"leave: /subdir2",
"/subdir3",
"/subdir3/file",
2024-01-21 15:44:00 +00:00
"leave: /subdir3",
"/subdir4",
"/subdir4/file",
2024-01-21 15:44:00 +00:00
"leave: /subdir4",
"/subdir5",
2024-01-21 15:44:00 +00:00
"leave: /subdir5",
"/subdir6",
2024-01-21 15:44:00 +00:00
"leave: /subdir6",
"leave: /",
}),
},
},
2018-06-09 16:19:27 +00:00
}
for _, test := range tests {
t.Run("", func(t *testing.T) {
repo, root := BuildTreeMap(test.tree)
for _, check := range test.checks {
t.Run("", func(t *testing.T) {
ctx, cancel := context.WithCancel(context.TODO())
defer cancel()
2024-01-21 15:44:00 +00:00
fn, leaveDir, last := check(t)
err := Walk(ctx, repo, root, WalkVisitor{
ProcessNode: fn,
LeaveDir: leaveDir,
})
2018-06-09 16:19:27 +00:00
if err != nil {
t.Error(err)
}
last(t)
})
}
})
}
}