Skip to content

Commit

Permalink
Ensure walkFn is called for all errors
Browse files Browse the repository at this point in the history
  • Loading branch information
twpayne committed Feb 24, 2024
1 parent 8a30e71 commit abfa11b
Show file tree
Hide file tree
Showing 2 changed files with 104 additions and 3 deletions.
90 changes: 90 additions & 0 deletions vfst/fs_test.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
package vfst_test

import (
"errors"
"io/fs"
"path/filepath"
"runtime"
"testing"

"github.com/alecthomas/assert/v2"
Expand Down Expand Up @@ -38,3 +40,91 @@ func TestWalk(t *testing.T) {
}
assert.Equal(t, expectedPathTypeMap, pathTypeMap)
}

func TestWalkErrors(t *testing.T) {
if runtime.GOOS == "windows" {
t.Skip("test uses UNIX file permissions")
}
for _, tc := range []struct {
name string
root any
postFunc func(vfs.FS) error
expectedPaths []string
}{
{
name: "empty",
expectedPaths: []string{
"/",
},
},
{
name: "simple",
root: map[string]any{
"/dir/subdir/subsubdir/file": "",
},
expectedPaths: []string{
"/",
"/dir",
"/dir/subdir",
"/dir/subdir/subsubdir",
"/dir/subdir/subsubdir/file",
},
},
{
name: "private_subdir",
root: map[string]any{
"/dir/subdir/subsubdir/file": "",
},
postFunc: func(fileSystem vfs.FS) error {
return fileSystem.Chmod("/dir/subdir", 0)
},
expectedPaths: []string{
"/",
"/dir",
"/dir/subdir",
},
},
{
name: "private_subdir_keep_going",
root: map[string]any{
"/dir/subdir/subsubdir/file": "",
"/dir/subdir2/file": "",
},
postFunc: func(fileSystem vfs.FS) error {
return fileSystem.Chmod("/dir/subdir", 0)
},
expectedPaths: []string{
"/",
"/dir",
"/dir/subdir",
"/dir/subdir2",
"/dir/subdir2/file",
},
},
} {
t.Run(tc.name, func(t *testing.T) {
fileSystem, cleanup, err := vfst.NewTestFS(tc.root)
assert.NoError(t, err)
if tc.postFunc != nil {
assert.NoError(t, tc.postFunc(fileSystem))
}
defer cleanup()
var actualPaths []string
assert.NoError(t, vfs.Walk(fileSystem, "/", func(path string, info fs.FileInfo, err error) error {
switch {
case errors.Is(err, fs.ErrPermission):
if info.IsDir() {
return vfs.SkipDir
}
return nil
case err != nil:
return err
default:
actualPaths = append(actualPaths, path)
return nil
}
}))
assert.Equal(t, tc.expectedPaths, actualPaths)
})
}
}
17 changes: 14 additions & 3 deletions walk.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,30 @@ func walk(fileSystem LstatReadDirer, path string, walkFn filepath.WalkFunc, info
}
dirEntries, err := fileSystem.ReadDir(path)
if err != nil {
return err
switch err := walkFn(path, info, err); {
case errors.Is(err, fs.SkipDir):
return nil
case err != nil:
return err
}
}
sort.Sort(dirEntriesByName(dirEntries))
for _, dirEntry := range dirEntries {
name := dirEntry.Name()
if name == "." || name == ".." {
continue
}
path := filepath.Join(path, dirEntry.Name())
info, err := dirEntry.Info()
if err != nil {
return err
switch err := walkFn(path, info, err); {
case errors.Is(err, fs.SkipDir) && info.IsDir():
// Do nothing.
case err != nil:
return err
}
}
if err := walk(fileSystem, filepath.Join(path, dirEntry.Name()), walkFn, info, nil); err != nil {
if err := walk(fileSystem, path, walkFn, info, nil); err != nil {
return err
}
}
Expand Down

0 comments on commit abfa11b

Please sign in to comment.