Add CreateContextWithOptions for lintcontext

Allows users to provide options for creating lint context.

Related Issue: stackrox#141

Signed-off-by: Arvind Iyengar <[email protected]>

Author: Arvind Iyengar

pkg/lintcontext/create_contexts.go

@@ -9,18 +9,27 @@ import (
 	"github.com/pkg/errors"
 	"golang.stackrox.io/kube-linter/internal/set"
 	"helm.sh/helm/v3/pkg/chartutil"
+	"k8s.io/apimachinery/pkg/runtime"
 )
 
 var (
 	knownYAMLExtensions = set.NewFrozenStringSet(".yaml", ".yml")
 )
 
+type Options struct {
+	customDecoder runtime.Decoder
+}
+
 // CreateContexts creates a context. Each context contains a set of files that should be linted
 // as a group.
 // Currently, each directory of Kube YAML files (or Helm charts) are treated as a separate context.
 // TODO: Figure out if it's useful to allow people to specify that files spanning different directories
 // should be treated as being in the same context.
 func CreateContexts(filesOrDirs ...string) ([]LintContext, error) {
+	return CreateContextsWithOptions(Options{}, filesOrDirs...)
+}
+
+func CreateContextsWithOptions(options Options, filesOrDirs ...string) ([]LintContext, error) {
 
 	contextsByDir := make(map[string]*lintContextImpl)
 	for _, fileOrDir := range filesOrDirs {
@@ -30,7 +39,7 @@ func CreateContexts(filesOrDirs ...string) ([]LintContext, error) {
 				continue
 			}
 			ctx := new()
-			if err := ctx.loadObjectsFromReader("<standard input>", os.Stdin); err != nil {
+			if err := ctx.loadObjectsFromReader("<standard input>", os.Stdin, options.customDecoder); err != nil {
 				return nil, err
 			}
 			contextsByDir["-"] = ctx
@@ -49,7 +58,7 @@ func CreateContexts(filesOrDirs ...string) ([]LintContext, error) {
 			if !info.IsDir() {
 				if strings.HasSuffix(strings.ToLower(currentPath), ".tgz") {
 					ctx := new()
-					if err := ctx.loadObjectsFromTgzHelmChart(currentPath); err != nil {
+					if err := ctx.loadObjectsFromTgzHelmChart(currentPath, options.customDecoder); err != nil {
 						return err
 					}
 
@@ -65,7 +74,7 @@ func CreateContexts(filesOrDirs ...string) ([]LintContext, error) {
 						ctx = new()
 						contextsByDir[dirName] = ctx
 					}
-					if err := ctx.loadObjectsFromYAMLFile(currentPath, info); err != nil {
+					if err := ctx.loadObjectsFromYAMLFile(currentPath, info, options.customDecoder); err != nil {
 						return err
 					}
 				}
@@ -78,7 +87,7 @@ func CreateContexts(filesOrDirs ...string) ([]LintContext, error) {
 				}
 				ctx := new()
 				contextsByDir[currentPath] = ctx
-				if err := ctx.loadObjectsFromHelmChart(currentPath); err != nil {
+				if err := ctx.loadObjectsFromHelmChart(currentPath, options.customDecoder); err != nil {
 					return err
 				}
 				return filepath.SkipDir

pkg/lintcontext/parse_yaml.go

@@ -18,6 +18,7 @@ import (
 	"helm.sh/helm/v3/pkg/cli/values"
 	"helm.sh/helm/v3/pkg/engine"
 	v1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/serializer"
 	"k8s.io/apimachinery/pkg/util/yaml"
 	"k8s.io/client-go/kubernetes/scheme"
@@ -34,15 +35,18 @@ var (
 	decoder      = serializer.NewCodecFactory(clientSchema).UniversalDeserializer()
 )
 
-func parseObjects(data []byte) ([]k8sutil.Object, error) {
-	obj, _, err := decoder.Decode(data, nil, nil)
+func parseObjects(data []byte, d runtime.Decoder) ([]k8sutil.Object, error) {
+	if d == nil {
+		d = decoder
+	}
+	obj, _, err := d.Decode(data, nil, nil)
 	if err != nil {
 		return nil, errors.Wrap(err, "failed to decode")
 	}
 	if list, ok := obj.(*v1.List); ok {
 		objs := make([]k8sutil.Object, 0, len(list.Items))
 		for i, item := range list.Items {
-			obj, _, err := decoder.Decode(item.Raw, nil, nil)
+			obj, _, err := d.Decode(item.Raw, nil, nil)
 			if err != nil {
 				return nil, errors.Wrapf(err, "decoding item %d in the list", i)
 			}
@@ -103,7 +107,7 @@ func (l *lintContextImpl) renderValues(chrt *chart.Chart, values map[string]inte
 	return rendered, nil
 }
 
-func (l *lintContextImpl) loadObjectsFromHelmChart(dir string) error {
+func (l *lintContextImpl) loadObjectsFromHelmChart(dir string, d runtime.Decoder) error {
 	metadata := ObjectMetadata{FilePath: dir}
 	renderedFiles, err := l.renderHelmChart(dir)
 	if err != nil {
@@ -114,14 +118,14 @@ func (l *lintContextImpl) loadObjectsFromHelmChart(dir string) error {
 		// The first element of path will be the same as the last element of dir, because
 		// Helm duplicates it.
 		pathToTemplate := filepath.Join(filepath.Dir(dir), path)
-		if err := l.loadObjectsFromReader(pathToTemplate, strings.NewReader(contents)); err != nil {
+		if err := l.loadObjectsFromReader(pathToTemplate, strings.NewReader(contents), d); err != nil {
 			return errors.Wrapf(err, "loading objects from rendered helm chart %s/%s", dir, pathToTemplate)
 		}
 	}
 	return nil
 }
 
-func (l *lintContextImpl) loadObjectsFromTgzHelmChart(tgzFile string) error {
+func (l *lintContextImpl) loadObjectsFromTgzHelmChart(tgzFile string, d runtime.Decoder) error {
 	metadata := ObjectMetadata{FilePath: tgzFile}
 	renderedFiles, err := l.renderTgzHelmChart(tgzFile)
 	if err != nil {
@@ -132,7 +136,7 @@ func (l *lintContextImpl) loadObjectsFromTgzHelmChart(tgzFile string) error {
 		// The first element of path will be the same as the last element of tgzFile, because
 		// Helm duplicates it.
 		pathToTemplate := filepath.Join(filepath.Dir(tgzFile), path)
-		if err := l.loadObjectsFromReader(pathToTemplate, strings.NewReader(contents)); err != nil {
+		if err := l.loadObjectsFromReader(pathToTemplate, strings.NewReader(contents), d); err != nil {
 			return errors.Wrapf(err, "loading objects from rendered helm chart %s/%s", tgzFile, pathToTemplate)
 		}
 	}
@@ -182,7 +186,7 @@ func (l *lintContextImpl) parseValues(filePath string, bytes []byte) (map[string
 	return currentMap, nil
 }
 
-func (l *lintContextImpl) loadObjectFromYAMLReader(filePath string, r *yaml.YAMLReader) error {
+func (l *lintContextImpl) loadObjectFromYAMLReader(filePath string, r *yaml.YAMLReader, d runtime.Decoder) error {
 	doc, err := r.Read()
 	if err != nil {
 		return err
@@ -197,7 +201,7 @@ func (l *lintContextImpl) loadObjectFromYAMLReader(filePath string, r *yaml.YAML
 		Raw:      doc,
 	}
 
-	objs, err := parseObjects(doc)
+	objs, err := parseObjects(doc, d)
 	if err != nil {
 		l.addInvalidObjects(InvalidObject{
 			Metadata: metadata,
@@ -214,7 +218,7 @@ func (l *lintContextImpl) loadObjectFromYAMLReader(filePath string, r *yaml.YAML
 	return nil
 }
 
-func (l *lintContextImpl) loadObjectsFromYAMLFile(filePath string, info os.FileInfo) error {
+func (l *lintContextImpl) loadObjectsFromYAMLFile(filePath string, info os.FileInfo, d runtime.Decoder) error {
 	if info.Size() > maxFileSizeBytes {
 		return nil
 	}
@@ -226,13 +230,13 @@ func (l *lintContextImpl) loadObjectsFromYAMLFile(filePath string, info os.FileI
 		_ = file.Close()
 	}()
 
-	return l.loadObjectsFromReader(filePath, file)
+	return l.loadObjectsFromReader(filePath, file, d)
 }
 
-func (l *lintContextImpl) loadObjectsFromReader(filePath string, reader io.Reader) error {
+func (l *lintContextImpl) loadObjectsFromReader(filePath string, reader io.Reader, d runtime.Decoder) error {
 	yamlReader := yaml.NewYAMLReader(bufio.NewReader(reader))
 	for {
-		if err := l.loadObjectFromYAMLReader(filePath, yamlReader); err != nil {
+		if err := l.loadObjectFromYAMLReader(filePath, yamlReader, d); err != nil {
 			if err == io.EOF {
 				return nil
 			}