Adding lint check for apiVersion which is a required field

Fixes #5727

Signed-off-by: Matt Farina <matt@mattfarina.com>
pull/5729/head
Matt Farina 6 years ago
parent 2106d6c97f
commit d4053b38cd
No known key found for this signature in database
GPG Key ID: 9436E80BFBA46909

@ -37,12 +37,12 @@ const (
func TestBadChart(t *testing.T) { func TestBadChart(t *testing.T) {
m := All(badChartDir, values, namespace, strict).Messages m := All(badChartDir, values, namespace, strict).Messages
if len(m) != 5 { if len(m) != 6 {
t.Errorf("Number of errors %v", len(m)) t.Errorf("Number of errors %v", len(m))
t.Errorf("All didn't fail with expected errors, got %#v", m) t.Errorf("All didn't fail with expected errors, got %#v", m)
} }
// There should be one INFO, 2 WARNINGs and one ERROR messages, check for them // There should be one INFO, 2 WARNINGs and one ERROR messages, check for them
var i, w, e, e2, e3 bool var i, w, e, e2, e3, e4 bool
for _, msg := range m { for _, msg := range m {
if msg.Severity == support.InfoSev { if msg.Severity == support.InfoSev {
if strings.Contains(msg.Err.Error(), "icon is recommended") { if strings.Contains(msg.Err.Error(), "icon is recommended") {
@ -64,9 +64,13 @@ func TestBadChart(t *testing.T) {
if strings.Contains(msg.Err.Error(), "directory name (badchartfile) and chart name () must be the same") { if strings.Contains(msg.Err.Error(), "directory name (badchartfile) and chart name () must be the same") {
e3 = true e3 = true
} }
if strings.Contains(msg.Err.Error(), "apiVersion is required") {
e4 = true
}
} }
} }
if !e || !e2 || !e3 || !w || !i { if !e || !e2 || !e3 || !e4 || !w || !i {
t.Errorf("Didn't find all the expected errors, got %#v", m) t.Errorf("Didn't find all the expected errors, got %#v", m)
} }
} }

@ -51,6 +51,7 @@ func Chartfile(linter *support.Linter) {
linter.RunLinterRule(support.ErrorSev, chartFileName, validateChartNameDirMatch(linter.ChartDir, chartFile)) linter.RunLinterRule(support.ErrorSev, chartFileName, validateChartNameDirMatch(linter.ChartDir, chartFile))
// Chart metadata // Chart metadata
linter.RunLinterRule(support.ErrorSev, chartFileName, validateChartApiVersion(chartFile))
linter.RunLinterRule(support.ErrorSev, chartFileName, validateChartVersion(chartFile)) linter.RunLinterRule(support.ErrorSev, chartFileName, validateChartVersion(chartFile))
linter.RunLinterRule(support.ErrorSev, chartFileName, validateChartEngine(chartFile)) linter.RunLinterRule(support.ErrorSev, chartFileName, validateChartEngine(chartFile))
linter.RunLinterRule(support.ErrorSev, chartFileName, validateChartMaintainer(chartFile)) linter.RunLinterRule(support.ErrorSev, chartFileName, validateChartMaintainer(chartFile))
@ -96,6 +97,18 @@ func validateChartNameDirMatch(chartDir string, cf *chart.Metadata) error {
return nil return nil
} }
func validateChartApiVersion(cf *chart.Metadata) error {
if cf.ApiVersion == "" {
return errors.New("apiVersion is required")
}
if cf.ApiVersion != "v1" {
return fmt.Errorf("apiVersion '%s' is not valid. The value must be \"v1\"", cf.ApiVersion)
}
return nil
}
func validateChartVersion(cf *chart.Metadata) error { func validateChartVersion(cf *chart.Metadata) error {
if cf.Version == "" { if cf.Version == "" {
return errors.New("version is required") return errors.New("version is required")

@ -236,8 +236,8 @@ func TestChartfile(t *testing.T) {
Chartfile(&linter) Chartfile(&linter)
msgs := linter.Messages msgs := linter.Messages
if len(msgs) != 4 { if len(msgs) != 5 {
t.Errorf("Expected 3 errors, got %d", len(msgs)) t.Errorf("Expected 4 errors, got %d", len(msgs))
} }
if !strings.Contains(msgs[0].Err.Error(), "name is required") { if !strings.Contains(msgs[0].Err.Error(), "name is required") {
@ -248,12 +248,16 @@ func TestChartfile(t *testing.T) {
t.Errorf("Unexpected message 1: %s", msgs[1].Err) t.Errorf("Unexpected message 1: %s", msgs[1].Err)
} }
if !strings.Contains(msgs[2].Err.Error(), "version 0.0.0 is less than or equal to 0") { if !strings.Contains(msgs[2].Err.Error(), "apiVersion is required") {
t.Errorf("Unexpected message 2: %s", msgs[2].Err) t.Errorf("Unexpected message 2: %s", msgs[2].Err)
} }
if !strings.Contains(msgs[3].Err.Error(), "icon is recommended") { if !strings.Contains(msgs[3].Err.Error(), "version 0.0.0 is less than or equal to 0") {
t.Errorf("Unexpected message 3: %s", msgs[3].Err) t.Errorf("Unexpected message 3: %s", msgs[2].Err)
}
if !strings.Contains(msgs[4].Err.Error(), "icon is recommended") {
t.Errorf("Unexpected message 4: %s", msgs[3].Err)
} }
} }

@ -1,3 +1,4 @@
apiVersion: v1
name: albatross name: albatross
description: testing chart description: testing chart
version: 199.44.12345-Alpha.1+cafe009 version: 199.44.12345-Alpha.1+cafe009

@ -1,3 +1,4 @@
apiVersion: v1
name: badvaluesfile name: badvaluesfile
description: A Helm chart for Kubernetes description: A Helm chart for Kubernetes
version: 0.0.1 version: 0.0.1

@ -1,3 +1,4 @@
apiVersion: v1
name: goodone name: goodone
description: good testing chart description: good testing chart
version: 199.44.12345-Alpha.1+cafe009 version: 199.44.12345-Alpha.1+cafe009

Loading…
Cancel
Save