Merge pull request #680 from joelanford/declcfg-load-fs

declcfg: change LoadDir to LoadFS

Author: openshift-merge-robot

cmd/opm/alpha/serve/serve.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"net"
+	"os"
 
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -72,7 +73,7 @@ func (s *serve) run(ctx context.Context) error {
 
 	s.logger = s.logger.WithFields(logrus.Fields{"configs": s.configDir, "port": s.port})
 
-	cfg, err := declcfg.LoadDir(s.configDir)
+	cfg, err := declcfg.LoadFS(os.DirFS(s.configDir))
 	if err != nil {
 		return fmt.Errorf("load declarative config directory: %v", err)
 	}

internal/action/render.go

@@ -51,7 +51,7 @@ func (r Render) Run(ctx context.Context) (*declcfg.DeclarativeConfig, error) {
 		)
 		// TODO(joelanford): Add support for detecting and rendering sqlite files.
 		if stat, serr := os.Stat(ref); serr == nil && stat.IsDir() {
-			cfg, err = declcfg.LoadDir(ref)
+			cfg, err = declcfg.LoadFS(os.DirFS(ref))
 		} else {
 			cfg, err = r.imageToDeclcfg(ctx, ref)
 		}
@@ -111,7 +111,7 @@ func (r Render) imageToDeclcfg(ctx context.Context, imageRef string) (*declcfg.D
 		}
 	} else if configsDir, ok := labels["operators.operatorframework.io.index.configs.v1"]; ok {
 		// TODO(joelanford): Make a constant for above configs location label
-		cfg, err = declcfg.LoadDir(filepath.Join(tmpDir, configsDir))
+		cfg, err = declcfg.LoadFS(os.DirFS(filepath.Join(tmpDir, configsDir)))
 		if err != nil {
 			return nil, err
 		}

internal/declcfg/load.go

@@ -5,7 +5,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
-	"os"
+	"io/fs"
 	"path/filepath"
 	"strings"
 
@@ -17,20 +17,23 @@ import (
 	"github.com/operator-framework/operator-registry/internal/property"
 )
 
-func LoadDir(configDir string) (*DeclarativeConfig, error) {
-	w := &dirWalker{}
-	return loadFS(configDir, w)
-}
-
-func loadFS(root string, w fsWalker) (*DeclarativeConfig, error) {
+// LoadFS loads a declarative config from the provided root FS. LoadFS walks the
+// filesystem from root and uses a gitignore-style filename matcher to skip files
+// that match patterns found in .indexignore files found throughout the filesystem.
+// If LoadFS encounters an error loading or parsing any file, the error will be
+// immedidately returned.
+func LoadFS(root fs.FS) (*DeclarativeConfig, error) {
+	if root == nil {
+		return nil, fmt.Errorf("no declarative config filesystem provided")
+	}
 	cfg := &DeclarativeConfig{}
 
-	matcher, err := ignore.NewMatcher(os.DirFS(root), ".indexignore")
+	matcher, err := ignore.NewMatcher(root, ".indexignore")
 	if err != nil {
 		return nil, err
 	}
 
-	if err := w.WalkFiles(root, func(path string, r io.Reader) error {
+	if err := walkFiles(root, func(path string, r io.Reader) error {
 		if matcher.Match(path, false) {
 			return nil
 		}
@@ -52,7 +55,7 @@ func loadFS(root string, w fsWalker) (*DeclarativeConfig, error) {
 	return cfg, nil
 }
 
-func readBundleObjects(bundles []Bundle, root, path string) error {
+func readBundleObjects(bundles []Bundle, root fs.FS, path string) error {
 	for bi, b := range bundles {
 		props, err := property.Parse(b.Properties)
 		if err != nil {
@@ -123,21 +126,15 @@ func readYAMLOrJSON(r io.Reader) (*DeclarativeConfig, error) {
 	return cfg, nil
 }
 
-type fsWalker interface {
-	WalkFiles(root string, f func(path string, r io.Reader) error) error
-}
-
-type dirWalker struct{}
-
-func (w dirWalker) WalkFiles(root string, f func(string, io.Reader) error) error {
-	return filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
+func walkFiles(root fs.FS, f func(string, io.Reader) error) error {
+	return fs.WalkDir(root, ".", func(path string, info fs.DirEntry, err error) error {
 		if err != nil {
 			return err
 		}
 		if info.IsDir() {
 			return nil
 		}
-		file, err := os.Open(path)
+		file, err := root.Open(path)
 		if err != nil {
 			return err
 		}