define filetree interfaces

Signed-off-by: Alex Goodman <alex.goodman@anchore.com>
anchore · Jan 30, 2023 · 4d50b37 · 4d50b37
1 parent 073c529
commit 4d50b37
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 14 deletions.
diff --git a/pkg/filetree/filetree.go b/pkg/filetree/filetree.go
@@ -19,15 +19,13 @@ var ErrRemovingRoot = errors.New("cannot remove the root path (`/`) from the Fil
 var ErrLinkCycleDetected = errors.New("cycle during symlink resolution")
 
 type Reader interface {
-	AllRealPaths() []file.Path
-	AllFiles(types ...file.Type) []file.Reference
-	ListPaths(dir file.Path) ([]file.Path, error)
 	File(path file.Path, options ...LinkResolutionOption) (bool, *file.ReferenceAccessVia, error)
-	Reader() tree.Reader
-	Equal(other *FileTree) bool
-	PathDiff(other *FileTree) (extra, missing []file.Path)
+	FilesByGlob(query string, options ...LinkResolutionOption) ([]file.ReferenceAccessVia, error)
+	// note: there are more reader-like functions, however, let's try to keep this interface small and simple for now
+}
+
+type Walker interface {
 	Walk(fn func(path file.Path, f filenode.FileNode) error, conditions *WalkConditions) error
-	HasPath(path file.Path, options ...LinkResolutionOption) bool
 }
 
 type Writer interface {

diff --git a/pkg/filetree/glob_test.go b/pkg/filetree/glob_test.go
@@ -240,20 +240,20 @@ func TestOSAdapter_ReadDir(t *testing.T) {
 			expected: []fileinfoAdapter{
 				{
 					VirtualPath: "/home/thing.txt",
-					Node:        filenode.FileNode{RealPath: "/home/thing.txt", FileType: 48},
+					Node:        filenode.FileNode{RealPath: "/home/thing.txt", FileType: file.TypeReg},
 				},
 
 				{
 					VirtualPath: "/home/wagoodman",
-					Node:        filenode.FileNode{RealPath: "/home/wagoodman", FileType: 53},
+					Node:        filenode.FileNode{RealPath: "/home/wagoodman", FileType: file.TypeDir},
 				},
 				{
 					VirtualPath: "/home/thing",
-					Node:        filenode.FileNode{RealPath: "/home/thing", FileType: 50, LinkPath: "./thing.txt"},
+					Node:        filenode.FileNode{RealPath: "/home/thing", FileType: file.TypeSymlink, LinkPath: "./thing.txt"},
 				},
 				{
 					VirtualPath: "/home/place",
-					Node:        filenode.FileNode{RealPath: "/home/place", FileType: 49, LinkPath: "/somewhere-else"},
+					Node:        filenode.FileNode{RealPath: "/home/place", FileType: file.TypeHardLink, LinkPath: "/somewhere-else"},
 				},
 			},
 			shouldErr: false,

diff --git a/pkg/filetree/search.go b/pkg/filetree/search.go
@@ -15,11 +15,11 @@ type Searcher interface {
 }
 
 type searchContext struct {
-	tree  *FileTree // this is the tree which all index search results are filtered against
-	index Index     // this index is relative to one or more trees, not just necessarily one
+	tree  Reader // this is the tree which all index search results are filtered against
+	index Index  // this index is relative to one or more trees, not just necessarily one
 }
 
-func NewSearchContext(tree *FileTree, index Index) Searcher {
+func NewSearchContext(tree Reader, index Index) Searcher {
 	return &searchContext{
 		tree:  tree,
 		index: index,