Add NOTES.txt check

Signed-off-by: Tayler Geiger <[email protected]>

internal/chartverifier/checks/checks.go

@@ -39,6 +39,8 @@ const (
 	APIVersion2                  = "v2"
 	ReadmeExist                  = "Chart has a README"
 	ReadmeDoesNotExist           = "Chart does not have a README"
+	NotesExist                   = "Chart does contain NOTES"
+	NotesDoesNotExist            = "Chart does not contain NOTES"
 	NotHelm3Reason               = "API version is not V2, used in Helm 3"
 	Helm3Reason                  = "API version is V2, used in Helm 3"
 	TestTemplatePrefix           = "templates/tests/"
@@ -111,6 +113,23 @@ func HasReadme(opts *CheckOptions) (Result, error) {
 	return r, nil
 }
 
+func HasNotes(opts *CheckOptions) (Result, error) {
+	c, _, err := LoadChartFromURI(opts)
+	if err != nil {
+		return Result{}, err
+	}
+
+	r := NewResult(false, NotesDoesNotExist)
+	for _, f := range c.Templates {
+		fmt.Println(f.Name)
+		if f.Name == "templates/NOTES.txt" {
+			r.SetResult(true, NotesExist)
+		}
+	}
+
+	return r, nil
+}
+
 func ContainsTest(opts *CheckOptions) (Result, error) {
 	c, _, err := LoadChartFromURI(opts)
 	if err != nil {

internal/chartverifier/checks/checks_test.go

@@ -105,6 +105,43 @@ func TestHasReadme(t *testing.T) {
 	}
 }
 
+func TestHasNotes(t *testing.T) {
+	type testCase struct {
+		description string
+		uri         string
+	}
+
+	positiveTestCases := []testCase{
+		{description: "chart with NOTES.txt", uri: "chart-0.1.0-v3.valid.tgz"},
+	}
+
+	for _, tc := range positiveTestCases {
+		t.Run(tc.description, func(t *testing.T) {
+			config := viper.New()
+			r, err := HasNotes(&CheckOptions{URI: tc.uri, ViperConfig: config, HelmEnvSettings: cli.New()})
+			require.NoError(t, err)
+			require.NotNil(t, r)
+			require.True(t, r.Ok)
+			require.Equal(t, NotesExist, r.Reason)
+		})
+	}
+
+	negativeTestCases := []testCase{
+		{description: "chart without NOTES.txt", uri: "chart-0.1.0-v3.without-notes.tgz"},
+	}
+
+	for _, tc := range negativeTestCases {
+		t.Run(tc.description, func(t *testing.T) {
+			config := viper.New()
+			r, err := HasNotes(&CheckOptions{URI: tc.uri, ViperConfig: config, HelmEnvSettings: cli.New()})
+			require.NoError(t, err)
+			require.NotNil(t, r)
+			require.False(t, r.Ok)
+			require.Equal(t, NotesDoesNotExist, r.Reason)
+		})
+	}
+}
+
 func TestContainsTest(t *testing.T) {
 	type testCase struct {
 		description string

internal/chartverifier/profiles/default.go

@@ -10,7 +10,7 @@ const (
 	CheckVersion10        = "v1.0"
 	CheckVersion11        = "v1.1"
 	DefaultProfile        = "partner"
-	DefaultProfileVersion = "v1.2"
+	DefaultProfileVersion = "v1.3"
 )
 
 func getDefaultProfile(msg string) *Profile {
@@ -43,6 +43,7 @@ func getDefaultProfile(msg string) *Profile {
 		{Name: fmt.Sprintf("%s/%s", CheckVersion10, apiChecks.ChartTesting), Type: apiChecks.MandatoryCheckType},
 		{Name: fmt.Sprintf("%s/%s", CheckVersion10, apiChecks.RequiredAnnotationsPresent), Type: apiChecks.MandatoryCheckType},
 		{Name: fmt.Sprintf("%s/%s", CheckVersion10, apiChecks.SignatureIsValid), Type: apiChecks.MandatoryCheckType},
+		{Name: fmt.Sprintf("%s/%s", CheckVersion10, apiChecks.HasNotes), Type: apiChecks.MandatoryCheckType},
 	}
 
 	return &profile

internal/chartverifier/profiles/profile_test.go

@@ -23,6 +23,7 @@ const (
 	configVersion10     string     = "v1.0"
 	configVersion11     string     = "v1.1"
 	configVersion12     string     = "v1.2"
+	configVersion13     string     = "v1.3"
 	checkVersion10      string     = CheckVersion10
 	checkVersion11      string     = "v1.1"
 	NoVendorType        VendorType = ""
@@ -33,7 +34,7 @@ const (
 
 func TestProfile(t *testing.T) {
 	testProfile := getDefaultProfile("test")
-	testProfile.Name = "profile-partner-1.2"
+	testProfile.Name = "profile-partner-1.3"
 	config := make(map[string]interface{})
 	config[VendorTypeConfigName] = PartnerVendorType
 
@@ -77,14 +78,14 @@ func TestGetProfiles(t *testing.T) {
 	getAndCheckProfile(t, RedhatVendorType, RedhatVendorType, configVersion11, configVersion11)
 	getAndCheckProfile(t, CommunityVendorType, CommunityVendorType, configVersion11, configVersion11)
 	getAndCheckProfile(t, NoVendorType, PartnerVendorType, configVersion11, configVersion11)
-	getAndCheckProfile(t, RedhatVendorType, RedhatVendorType, NoVersion, configVersion12)
-	getAndCheckProfile(t, NoVendorType, PartnerVendorType, NoVersion, configVersion12)
-	getAndCheckProfile(t, PartnerVendorType, PartnerVendorType, configVersion12, configVersion12)
-	getAndCheckProfile(t, PartnerVendorType, PartnerVendorType, configVersion00, configVersion12)
-	getAndCheckProfile(t, RedhatVendorType, RedhatVendorType, configVersion12, configVersion12)
-	getAndCheckProfile(t, RedhatVendorType, RedhatVendorType, configVersion00, configVersion12)
-	getAndCheckProfile(t, CommunityVendorType, CommunityVendorType, configVersion00, configVersion12)
-	getAndCheckProfile(t, CommunityVendorType, CommunityVendorType, configVersion12, configVersion12)
+	getAndCheckProfile(t, RedhatVendorType, RedhatVendorType, NoVersion, configVersion13)
+	getAndCheckProfile(t, NoVendorType, PartnerVendorType, NoVersion, configVersion13)
+	getAndCheckProfile(t, PartnerVendorType, PartnerVendorType, configVersion13, configVersion13)
+	getAndCheckProfile(t, PartnerVendorType, PartnerVendorType, configVersion00, configVersion13)
+	getAndCheckProfile(t, RedhatVendorType, RedhatVendorType, configVersion13, configVersion13)
+	getAndCheckProfile(t, RedhatVendorType, RedhatVendorType, configVersion00, configVersion13)
+	getAndCheckProfile(t, CommunityVendorType, CommunityVendorType, configVersion00, configVersion13)
+	getAndCheckProfile(t, CommunityVendorType, CommunityVendorType, configVersion13, configVersion13)
 }
 
 func getAndCheckProfile(t *testing.T, configVendorType, expectVendorType VendorType, configVersion, expectVersion string) {

internal/chartverifier/verifierbuilder.go

@@ -50,6 +50,7 @@ func init() {
 	defaultRegistry.Add(apiChecks.ChartTesting, "v1.0", checks.ChartTesting)
 	defaultRegistry.Add(apiChecks.RequiredAnnotationsPresent, "v1.0", checks.RequiredAnnotationsPresent)
 	defaultRegistry.Add(apiChecks.SignatureIsValid, "v1.0", checks.SignatureIsValid)
+	defaultRegistry.Add(apiChecks.HasNotes, "v1.0", checks.HasNotes)
 }
 
 func DefaultRegistry() checks.Registry {

internal/profileconfig/profiles/profile-community-1.3.yaml

@@ -0,0 +1,38 @@
+apiversion: v1
+kind: verifier-profile
+vendorType: community
+version: v1.3
+annotations:
+  - "Digest"
+  - "TestedOpenShiftVersion"
+  - "LastCertifiedTimestamp"
+  - "SupportedOpenShiftVersions"
+checks:
+    - name: v1.0/has-readme
+      type: Optional
+    - name: v1.0/is-helm-v3
+      type: Optional
+    - name: v1.0/contains-test
+      type: Optional
+    - name: v1.0/contains-values
+      type: Optional
+    - name: v1.0/contains-values-schema
+      type: Optional
+    - name: v1.1/has-kubeversion
+      type: Optional
+    - name: v1.0/not-contains-crds
+      type: Optional
+    - name: v1.0/helm-lint
+      type: Mandatory
+    - name: v1.0/not-contain-csi-objects
+      type: Optional
+    - name: v1.1/images-are-certified
+      type: Optional
+    - name: v1.0/chart-testing
+      type: Optional
+    - name: v1.0/required-annotations-present
+      type: Optional
+    - name: v1.0/signature-is-valid
+      type: Optional
+    - name: v1.0/has-notes
+      type: Optional

internal/profileconfig/profiles/profile-partner-1.3.yaml

@@ -0,0 +1,39 @@
+apiversion: v1
+kind: verifier-profile
+vendorType: partner
+version: v1.3
+annotations:
+  - "Digest"
+  - "TestedOpenShiftVersion"
+  - "LastCertifiedTimestamp"
+  - "SupportedOpenShiftVersions"
+checks:
+    - name: v1.0/has-readme
+      type: Mandatory
+    - name: v1.0/is-helm-v3
+      type: Mandatory
+    - name: v1.0/contains-test
+      type: Mandatory
+    - name: v1.0/contains-values
+      type: Mandatory
+    - name: v1.0/contains-values-schema
+      type: Mandatory
+    - name: v1.1/has-kubeversion
+      type: Mandatory
+    - name: v1.0/not-contains-crds
+      type: Mandatory
+    - name: v1.0/helm-lint
+      type: Mandatory
+    - name: v1.0/not-contain-csi-objects
+      type: Mandatory
+    - name: v1.1/images-are-certified
+      type: Mandatory
+    - name: v1.0/chart-testing
+      type: Mandatory
+    - name: v1.0/required-annotations-present
+      type: Mandatory
+    - name: v1.0/signature-is-valid
+      type: Mandatory
+    - name: v1.0/has-notes
+      type: Mandatory
+

internal/profileconfig/profiles/profile-redhat-1.3.yaml

@@ -0,0 +1,39 @@
+apiversion: v1
+kind: verifier-profile
+vendorType: redhat
+version: v1.3
+annotations:
+  - "Digest"
+  - "TestedOpenShiftVersion"
+  - "LastCertifiedTimestamp"
+  - "SupportedOpenShiftVersions"
+checks:
+    - name: v1.0/has-readme
+      type: Mandatory
+    - name: v1.0/is-helm-v3
+      type: Mandatory
+    - name: v1.0/contains-test
+      type: Mandatory
+    - name: v1.0/contains-values
+      type: Mandatory
+    - name: v1.0/contains-values-schema
+      type: Mandatory
+    - name: v1.1/has-kubeversion
+      type: Mandatory
+    - name: v1.0/not-contains-crds
+      type: Mandatory
+    - name: v1.0/helm-lint
+      type: Mandatory
+    - name: v1.0/not-contain-csi-objects
+      type: Mandatory
+    - name: v1.1/images-are-certified
+      type: Mandatory
+    - name: v1.0/chart-testing
+      type: Mandatory
+    - name: v1.0/required-annotations-present
+      type: Mandatory
+    - name: v1.0/signature-is-valid
+      type: Mandatory
+    - name: v1.0/has-notes
+      type: Mandatory
+

pkg/chartverifier/checks/checks.go

@@ -14,6 +14,7 @@ const (
 	ChartTesting               CheckName = "chart-testing"
 	RequiredAnnotationsPresent CheckName = "required-annotations-present"
 	SignatureIsValid           CheckName = "signature-is-valid"
+	HasNotes                   CheckName = "has-notes"
 	MandatoryCheckType         CheckType = "Mandatory"
 	OptionalCheckType          CheckType = "Optional"
 	ExperimentalCheckType      CheckType = "Experimental"
@@ -25,6 +26,7 @@ var setCheckNames = []CheckName{
 	ContainsValuesSchema,
 	ContainsValues,
 	HasKubeVersion,
+	HasNotes,
 	HasReadme,
 	HelmLint,
 	ImagesAreCertified,