Use laher/mergefs - remove custom code (#34571)

pkg/cmd/grafana-cli/commands/mergefs.go

@@ -1,92 +0,0 @@
-package commands
-
-import (
-	"errors"
-	"io/fs"
-	"os"
-	"sort"
-
-	"github.com/grafana/grafana/pkg/cmd/grafana-cli/logger"
-)
-
-// MergeFS contains a slice of different filesystems that can be merged together
-type MergeFS struct {
-	filesystems []fs.FS
-}
-
-// Merge filesystems
-func Merge(filesystems ...fs.FS) fs.FS {
-	return MergeFS{filesystems: filesystems}
-}
-
-// Open opens the named file.
-func (mfs MergeFS) Open(name string) (fs.File, error) {
-	for _, filesystem := range mfs.filesystems {
-		file, err := filesystem.Open(name)
-		if err == nil {
-			return file, nil
-		}
-	}
-	return nil, os.ErrNotExist
-}
-
-// ReadDir reads from the directory, and produces a DirEntry array of different
-// directories.
-//
-// It iterates through all different filesystems that exist in the mfs MergeFS
-// filesystem slice and it identifies overlapping directories that exist in different
-// filesystems
-func (mfs MergeFS) ReadDir(name string) ([]fs.DirEntry, error) {
-	dirsMap := make(map[string]fs.DirEntry)
-	for _, filesystem := range mfs.filesystems {
-		if fsys, ok := filesystem.(fs.ReadDirFS); ok {
-			dir, err := fsys.ReadDir(name)
-			if err != nil {
-				if errors.Is(err, fs.ErrNotExist) {
-					logger.Debugf("directory in filepath %s was not found in filesystem", name)
-					continue
-				}
-				return nil, err
-			}
-			for _, v := range dir {
-				if _, ok := dirsMap[v.Name()]; !ok {
-					dirsMap[v.Name()] = v
-				}
-			}
-			continue
-		}
-
-		file, err := filesystem.Open(name)
-		if err != nil {
-			logger.Debugf("filepath %s was not found in filesystem", name)
-			continue
-		}
-
-		dir, ok := file.(fs.ReadDirFile)
-		if !ok {
-			return nil, &fs.PathError{Op: "readdir", Path: name, Err: errors.New("not implemented")}
-		}
-
-		fsDirs, err := dir.ReadDir(-1)
-		if err != nil {
-			return nil, err
-		}
-		sort.Slice(fsDirs, func(i, j int) bool { return fsDirs[i].Name() < fsDirs[j].Name() })
-		for _, v := range fsDirs {
-			if _, ok := dirsMap[v.Name()]; !ok {
-				dirsMap[v.Name()] = v
-			}
-		}
-		if err := file.Close(); err != nil {
-			logger.Error("failed to close file", "err", err)
-		}
-	}
-	dirs := make([]fs.DirEntry, 0, len(dirsMap))
-
-	for _, value := range dirsMap {
-		dirs = append(dirs, value)
-	}
-
-	sort.Slice(dirs, func(i, j int) bool { return dirs[i].Name() < dirs[j].Name() })
-	return dirs, nil
-}

pkg/cmd/grafana-cli/commands/mergefs_test.go

@@ -1,68 +0,0 @@
-package commands
-
-import (
-	"io/fs"
-	"os"
-	"path/filepath"
-	"testing"
-	"testing/fstest"
-
-	"github.com/stretchr/testify/require"
-)
-
-func TestMergeFS(t *testing.T) {
-	var filePaths = []struct {
-		path           string
-		dirArrayLength int
-		child          string
-	}{
-		// MapFS takes in account the current directory in addition to all included directories and produces a "" dir
-		{"a", 1, "z"},
-		{"a/z", 1, "bar.cue"},
-		{"b", 1, "z"},
-		{"b/z", 1, "foo.cue"},
-	}
-
-	tempDir := os.DirFS(filepath.Join("testdata", "mergefs"))
-	a := fstest.MapFS{
-		"a":           &fstest.MapFile{Mode: fs.ModeDir},
-		"a/z":         &fstest.MapFile{Mode: fs.ModeDir},
-		"a/z/bar.cue": &fstest.MapFile{Data: []byte("bar")},
-	}
-
-	filesystem := Merge(tempDir, a)
-
-	t.Run("testing mergefs.ReadDir", func(t *testing.T) {
-		for _, fp := range filePaths {
-			t.Run("testing path: "+fp.path, func(t *testing.T) {
-				dirs, err := fs.ReadDir(filesystem, fp.path)
-				require.NoError(t, err)
-				require.Len(t, dirs, fp.dirArrayLength)
-
-				for i := 0; i < len(dirs); i++ {
-					require.Equal(t, dirs[i].Name(), fp.child)
-				}
-			})
-		}
-	})
-
-	t.Run("testing mergefs.Open", func(t *testing.T) {
-		data := make([]byte, 3)
-		file, err := filesystem.Open("a/z/bar.cue")
-		require.NoError(t, err)
-
-		_, err = file.Read(data)
-		require.NoError(t, err)
-		require.Equal(t, "bar", string(data))
-
-		file, err = filesystem.Open("b/z/foo.cue")
-		require.NoError(t, err)
-
-		_, err = file.Read(data)
-		require.NoError(t, err)
-		require.Equal(t, "foo", string(data))
-
-		err = file.Close()
-		require.NoError(t, err)
-	})
-}

pkg/cmd/grafana-cli/commands/scuemata_validation_command_test.go

@@ -8,6 +8,7 @@ import (
 	"testing/fstest"
 
 	"github.com/grafana/grafana/pkg/schema/load"
+	"github.com/laher/mergefs"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -35,7 +36,7 @@ func TestValidateScuemataBasics(t *testing.T) {
 		filesystem := fstest.MapFS{
 			"cue/data/gen.cue": &fstest.MapFile{Data: genCue},
 		}
-		mergedFS := Merge(filesystem, defaultBaseLoadPaths.BaseCueFS)
+		mergedFS := mergefs.Merge(filesystem, defaultBaseLoadPaths.BaseCueFS)
 
 		var baseLoadPaths = load.BaseLoadPaths{
 			BaseCueFS:       mergedFS,
@@ -53,7 +54,7 @@ func TestValidateScuemataBasics(t *testing.T) {
 		filesystem := fstest.MapFS{
 			"cue/data/gen.cue": &fstest.MapFile{Data: genCue},
 		}
-		mergedFS := Merge(filesystem, defaultBaseLoadPaths.BaseCueFS)
+		mergedFS := mergefs.Merge(filesystem, defaultBaseLoadPaths.BaseCueFS)
 
 		var baseLoadPaths = load.BaseLoadPaths{
 			BaseCueFS:       mergedFS,
@@ -78,7 +79,7 @@ func TestValidateScuemataBasics(t *testing.T) {
 			"valid.json":   &fstest.MapFile{Data: validPanel},
 			"invalid.json": &fstest.MapFile{Data: invalidPanel},
 		}
-		mergedFS := Merge(filesystem, defaultBaseLoadPaths.BaseCueFS)
+		mergedFS := mergefs.Merge(filesystem, defaultBaseLoadPaths.BaseCueFS)
 
 		var baseLoadPaths = load.BaseLoadPaths{
 			BaseCueFS:       mergedFS,