-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
k8smanifests.go
106 lines (92 loc) · 2.92 KB
/
k8smanifests.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/*
Copyright 2021 The Skaffold Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package lint
import (
"context"
"path/filepath"
"go.lsp.dev/protocol"
"sigs.k8s.io/kustomize/kyaml/yaml"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/config"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/output/log"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/util"
)
// for testing
var k8sManifestRules = &k8sManifestLintRules
var K8sManifestLinters = []Linter{
&YamlFieldLinter{},
}
var k8sManifestLintRules = []Rule{
{
RuleID: K8sManifestManagedByLabelInUse,
RuleType: YamlFieldLintRule,
Severity: protocol.DiagnosticSeverityWarning,
Filter: YamlFieldFilter{
Filter: yaml.Lookup("metadata", "labels"),
FieldMatch: "app.kubernetes.io/managed-by",
},
ExplanationTemplate: "Found usage of label 'app.kubernetes.io/managed-by'. skaffold overwrites the 'app.kubernetes.io/managed-by' field to 'app.kubernetes.io/managed-by: skaffold'. " +
"and as such is recommended to remove this label",
},
}
func GetK8sManifestsLintResults(ctx context.Context, opts Options) (*[]Result, error) {
cfgs, err := getConfigSet(ctx, config.SkaffoldOptions{
ConfigurationFile: opts.Filename,
ConfigurationFilter: opts.Modules,
RemoteCacheDir: opts.RemoteCacheDir,
Profiles: opts.Profiles,
})
if err != nil {
return nil, err
}
l := []Result{}
workdir, err := realWorkDir()
if err != nil {
return nil, err
}
for _, c := range cfgs {
for _, pattern := range c.Render.RawK8s {
// NOTE: pattern is a pattern that can have wildcards, eg: leeroy-app/kubernetes/*
if util.IsURL(pattern) {
log.Entry(ctx).Debugf("skaffold lint found url manifest and is skipping lint rules for: %s", pattern)
continue
}
// filepaths are all absolute from config parsing step via tags.MakeFilePathsAbsolute
expanded, err := filepath.Glob(pattern)
if err != nil {
return nil, err
}
for _, relPath := range expanded {
b, err := util.ReadFile(relPath)
if err != nil {
return nil, err
}
k8syaml := ConfigFile{
AbsPath: filepath.Join(workdir, relPath),
RelPath: relPath,
Text: string(b),
}
for _, r := range K8sManifestLinters {
recs, err := r.Lint(InputParams{
ConfigFile: k8syaml,
SkaffoldConfig: c,
}, k8sManifestRules)
if err != nil {
return nil, err
}
l = append(l, *recs...)
}
}
}
}
return &l, nil
}