Skip to content

Add CreateContextWithOptions #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 28, 2021
Merged

Add CreateContextWithOptions #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
244a173
Add CreateContextWithOptions for lintcontext
Mar 27, 2021
6c8a7b7
Switch new to newCtx(options Options)
Mar 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions pkg/lintcontext/context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package lintcontext

import (
"golang.stackrox.io/kube-linter/internal/k8sutil"
"k8s.io/apimachinery/pkg/runtime"
)

// ObjectMetadata is metadata about an object.
Expand Down Expand Up @@ -31,6 +32,8 @@ type LintContext interface {
type lintContextImpl struct {
objects []Object
invalidObjects []InvalidObject

customDecoder runtime.Decoder
}

// Objects returns the (valid) objects loaded from this LintContext.
Expand All @@ -54,6 +57,8 @@ func (l *lintContextImpl) addInvalidObjects(objs ...InvalidObject) {
}

// new returns a ready-to-use, empty, lintContextImpl.
func new() *lintContextImpl {
return &lintContextImpl{}
func newCtx(options Options) *lintContextImpl {
return &lintContextImpl{
customDecoder: options.CustomDecoder,
}
}
20 changes: 16 additions & 4 deletions pkg/lintcontext/create_contexts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,39 @@ 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")
)

// Options represent values that can be provided to modify how objects are parsed to create lint contexts
type Options struct {
// CustomDecoder allows users to supply a non-default decoder to parse k8s objects. This can be used
// to allow the linter to create contexts for k8s custom resources
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...)
}

// CreateContextsWithOptions creates a context with additional Options
func CreateContextsWithOptions(options Options, filesOrDirs ...string) ([]LintContext, error) {
contextsByDir := make(map[string]*lintContextImpl)
for _, fileOrDir := range filesOrDirs {
// Stdin
if fileOrDir == "-" {
if _, alreadyExists := contextsByDir["-"]; alreadyExists {
continue
}
ctx := new()
ctx := newCtx(options)
if err := ctx.loadObjectsFromReader("<standard input>", os.Stdin); err != nil {
return nil, err
}
Expand All @@ -48,7 +60,7 @@ func CreateContexts(filesOrDirs ...string) ([]LintContext, error) {

if !info.IsDir() {
if strings.HasSuffix(strings.ToLower(currentPath), ".tgz") {
ctx := new()
ctx := newCtx(options)
if err := ctx.loadObjectsFromTgzHelmChart(currentPath); err != nil {
return err
}
Expand All @@ -62,7 +74,7 @@ func CreateContexts(filesOrDirs ...string) ([]LintContext, error) {
if knownYAMLExtensions.Contains(strings.ToLower(filepath.Ext(currentPath))) || fileOrDir == currentPath {
ctx := contextsByDir[dirName]
if ctx == nil {
ctx = new()
ctx = newCtx(options)
contextsByDir[dirName] = ctx
}
if err := ctx.loadObjectsFromYAMLFile(currentPath, info); err != nil {
Expand All @@ -76,7 +88,7 @@ func CreateContexts(filesOrDirs ...string) ([]LintContext, error) {
if _, alreadyExists := contextsByDir[currentPath]; alreadyExists {
return nil
}
ctx := new()
ctx := newCtx(options)
contextsByDir[currentPath] = ctx
if err := ctx.loadObjectsFromHelmChart(currentPath); err != nil {
return err
Expand Down
12 changes: 8 additions & 4 deletions pkg/lintcontext/parse_yaml.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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)
}
Expand Down Expand Up @@ -197,7 +201,7 @@ func (l *lintContextImpl) loadObjectFromYAMLReader(filePath string, r *yaml.YAML
Raw: doc,
}

objs, err := parseObjects(doc)
objs, err := parseObjects(doc, l.customDecoder)
if err != nil {
l.addInvalidObjects(InvalidObject{
Metadata: metadata,
Expand Down