From aa1ce4957ce7f4fb5ebc2bdc9a25793ec3cda6ad Mon Sep 17 00:00:00 2001
From: Tayler Geiger <tayler@redhat.com>
Date: Fri, 29 Mar 2024 16:09:55 -0500
Subject: [PATCH] Add NOTES.txt check

Signed-off-by: Tayler Geiger <tayler@redhat.com>
---
 .../checks/chart-0.1.0-v3.without-notes.tgz   | Bin 0 -> 3671 bytes
 internal/chartverifier/checks/checks.go       |  19 +++++++++
 internal/chartverifier/checks/checks_test.go  |  37 ++++++++++++++++++
 internal/chartverifier/profiles/default.go    |   1 +
 internal/chartverifier/verifierbuilder.go     |   1 +
 pkg/chartverifier/checks/checks.go            |   2 +
 6 files changed, 60 insertions(+)
 create mode 100644 internal/chartverifier/checks/chart-0.1.0-v3.without-notes.tgz

diff --git a/internal/chartverifier/checks/chart-0.1.0-v3.without-notes.tgz b/internal/chartverifier/checks/chart-0.1.0-v3.without-notes.tgz
new file mode 100644
index 0000000000000000000000000000000000000000..a9867dbd5483a48f6d5727eb300e5ad3c8d0bf1e
GIT binary patch
literal 3671
zcmV-d4yf@TiwFP!000001MM9BZ`-!AKMTnJz~^qr)>p}rKNACcctP5?6>GDg={gL<
zFwhchbCE<<q?~$P-{1c3NJ*AtyH3|6ZTECQ9GN^Gj~{ouJ00yWXsWvRZWUaB@o<R$
zz46ek{x9I3Hy8}YqrNv9_U^f!Hw1Jtyj`{oWKz+Tkb8=*LYD5v+gJaYg0I*A6hEC6
zjl$dL0~dHS80=jCzB_{T?+?7e$n|=F=k*7p!9C*M1~X0gKVN^E@Rux=T*MQy>{&EP
z%CDZ|jU3ksnDkSgC|!0!zGGoT^sXT@k&^GTDNAFfn6$W$7z?EmIq7z<uC5&Rnnp>;
z9A89T-NZ&5CyD3QCA2GhI{eo+p3`$3_t1)I#3qKmrB(?%14|+IDfVwIix#fqIj+6z
zJ4+h!!1~y;`1yj7f0)ILNk{q%7E$MSDdL;#V~_lUwjVU)f9Q>St^D5wys-%Bd|?*8
zGa;Qqd~pxh`F;@Tyc?u+rfhfIHD&iZ53ymAiiD+#GYM^x6qNCZ&RO{t3MvW&dpH%b
zqC93Pd7?2N7I<5T>GG5%qE-TBs2Y%%R4I?=owDlf!*x4F=htp#HJX>0V){GtmBGww
zJE)`HF~AF!F1gQ$M%y4*?YbbCh*Z6U;5k;8gd!gED2t%N-5}0m#pWz+P)~&tz6h&5
zY~{wv+rW&!%6Q5G!1$#>qslQn{;Kg6SD_~NQtJ`3H<~l}w$;*~AQ=6x7@X4-4)I&@
z1g>ZQkKEpH)Ef=QX#Wl2NNDZ<JAmf;|F&QuXkqE7<i>n~J?DSFKj<~i|B*Xt&;L7t
zH*dNRtjDht8V5uz%%MfZOh4<r;aCs4Z{J#P-q<8yGdQ<N$CT^ijo9ltnuUru#+5un
zGLAV8H0BRrx~Du~<WHi~EcVH$uOE4Ik<DiOHR;$LlG9?q3p`qyx6_ot#w4`tVU~sA
zioD9e@SkxOpnssbcC4S6p{?;1_JEv9GG#u^BqLG)Q)`FCj1_2vfh06#B;*lSKv4-8
zK9}UH=}OPTqq7Udg@cmFg!x}P){_}YS;(l&C(JiCjm#Y*UB(r;;$aBA6X+cHgibW`
zIk!8e6*1~l%V*_G7M0~}<|sSsuQS`BEa`lqIiGxU{pDQqSk8eV;ygDKWZD*d)(YQ~
zxdcoVH6xubrTwMsG-#PlufMsrKi0NfWi3%Ua^DlzQLksdISf`vr!3sLruuWepv{3)
z=h!^wo-qspjNg!gG1>WNhjf1HyubK}C;~#7Ke>xPQ)?Im{U14UVf=Nl7~c>c`(YL|
z2jiITnza%Z#aAMInv--YJ0u_6Nf~3nIuKvyvXn`Oi*D)U1NF@&e}d=>#TtX%q!Q5>
zyo<n|t_-1Kw-na-w#mB4ncp*A%`w_r88DHI%^5Pn?QG{7<VVriXLX*dBD8I%HWjzb
z$4Gr&WU)ep23vOba5VObK|b51d+KP8Z@O-%|F0T@U28Mv>s^%M>gX!+UeN6151nff
z*pTUueZqd)(6s*o&^KZgvG@kV!TapLLBARQ9gRG<wg2t{s_|b?N3y&0tV<pT6Y{9s
z30A}u4XC0M@auP}wTh&p)RA0=PISCLtCBi?SRN36k{CLKe#ih@qKSpAa`h7nRmwfh
zl#o6ce(~I4F`b4iFn!@E$$ct~+RU-@!c(mRHCjb05K?Gy!(l{~zj#_<c`MVKr`wwO
zks(`%Qckuqa|O*St`;Sei3m<&7^9AFOG5&It_zE{rnM43gIv~nK3X@cjSwNM4e7lH
zRgx}NW$Pex$nP9Bzy*V2K~;v)tofj^Y#vnGHsZG9%&8Lbvy`h9h9TK&wVk2$;#}0x
zw{z+jA<fG8?6ss+4ZO0=J9*i`kKD<O*Q-<3^FASm6>-o-C=^0+SnU-w*r?4<(#b}J
zqH`!eZ1#XFdoDoARyD~pZIZIG&Kt%KWqqv0WMTBVR#BN-jDk+ck=v**B9jyH;`F>y
z7xE>GnUv?Ln6i3r*vq%9G2K9ks>OtKo29zj24i6R1pF4MOOd5MlY2KriMeAdY)EP>
z0#;hNC0e!ggCumLKMKxC3_G@>*z%H_?MDeXoSQndQur5p``D-R?L*W4TO{<x^8og}
z{~LKt`)}xtN3H#L7tnC>c34<7D{+m|UG}D6;1m|)cOvC~pt=UNADrZ9Ed4m<qwf0!
zP3KHKXEQ@*o3V@K8wRgdir3{d;_>rs_Gfi2D>!*0`g(t(HBR1$sg(QGN!h+~N)P+=
z{Kp>^5BVQj1)eiFCtz*nr40glP$yVC&kqr+e)_CcW}cIgWMzrz;A9Evb<QfC>>SGV
zIBMwmy(4_aA~0lba*&ax_@U#x249~_tfHy^VGuAk@<z{qJ^H`r_M7=1BX`_y_5WQ!
zL&l2bFLZwq2mAuH-dX-~;2jFF#FtAS4R%CtMC}~3d8+|N$s!Q2QxPTj5~hQ>VBWxX
zF)&UOIt3xZoDk>xb;g+UEmuW6*lrw8F;iC}y+mQWJTmcQ&m2-^e6iUCTqzdgqpaf^
znKXyP6EiW}&$9LGe9+Og&9lzegEnIX8}Wf1c5Q`lKAuK=rP-4T^Bz=n2q}%{Y&S0I
z*@ciz|2}V}YpOn=t<`5WlwWPt@cA)rQ2P4L`uo;HqxL1uLbi7dHRjAHOi%c<$s)RH
z>p`MZSM$;;{ph;7=WFL)Ad<(YdMzPS>R$r)P1i9OoU<L<Z40XLl@Ya&!y4w6b9UPd
zer(;;!tF!z{4bRB9iIR0aM0h(|7i2S?*wZ3--RQWza#xPj+?R9EB1A<C9%SEQHdbh
zc?fL_ep1tW#xg%|#@n`q4{Nc=`fGys44)4^c{RF2{_{7-H=_pj$^T&7wExG0K`Z}v
z0@r%U-!zz;iXun9mcDq$>zNz0n;YY}LG$@<W*;@>AO6%$X92&@{Xch%_x}cC&ujC4
z?*g{3KYrT2h+{a}(BJ;BV_;wWzdsz;^?%PDyKVgcPGGBAKNrCkUEbMe{Mn6d)A=Bs
zzM-N!MQY+gh|A7|U~i?>*n9<FyivXaqpzBaFd>IBUR`$AX?Hf>I-+2}6>qnF5k(ZI
z;g>^fefVqf<}#g2EZjE@lijvxPOD^&P3yd+3+ad5NW^myOzr;2PGQXBiD!?7wT3~;
zmn^Nf?QlQEaF?IJfZ{HnMt&%=z&7`9YzZR-Jliz=w_MQPa5S0u-gr9gv!mm{b>aWi
zoel9nJ?c|B9{R%`8}x%CHXQl09&=}4nT?0+xIbV3)8VXBV=D=>IgkGmTc&BjmOmQ}
z2ggTazkd|CgQKZ`%%EV_Kkgl|W1k(<9v#er!PsYR@2EcoM*96@-<uvE_l}R)h#^}k
zL&;V}dcqmQ8T;7c_Q`?K{|<^4pT{C)x6sF4|Gz(M-v1trhpqm<3%F0tsZyW{C1wem
zEkLdoEGE;8hXLMsNT`1aA}Ss0K6!!nB4n0m51dHYHX)gZVruf|0Q(_ci~y~@WIEPa
zDF>Ab1Y$PVI-Pu#q-@4tv%nbc|M=P=Kg8jRh*-BomIx?j5`t29Ea%b1Zx^5{7?8+Q
z+FzbtkbtMsa^_rh^`~Lqa;ATzUHw@UEaqMOD89;N++7pGsB4yx84sDX9yszUfzK(u
zgijUWvj95Qga1N{mo()fljO;x$Ix$*3e;hi!vjXU1|5nlXDNLVu<qxeZH)Xse|+-j
z*<&XPZl#ZX@(<oYQ~tpPXyyMdz^we|uv1&O4XFM8!!7*)%)b2p;i%vE{hvOVnXUZa
z1>7f(@@qC`59l9tF<#9<ao%&hx%l(Rv!^yxMtC*{`n1#-kC-3gd;29EjhHi_?T9I!
z;Sz7j@fg0YM3$C`@e-OHSk>hG3GuMVI1C4s<f}wTg>PwJg|_D!U&vIivzRCNYXx&I
zRl0Jh@8cWYlm!c_^pDOMf2v~|C6#35C$lr5&Ve*IoTgUMIneTKZ{&4KZmOB<<d<I$
ztm@rIKnKj`l}l54VAUg#dRX_#1$e7?YgM9&r50e`(2dJlav`!Xz$rA**8rQE#|d8k
zV}?}q)&NW~4f1=d8@Im>8oo4n^VU#!ajjcpjzNB6ZemEL^kv9AFbq2bIRfJ@zw;`|
zoW<x)!_sFGtw*F>%u%@q4%R^hJz4cz5Qarv+DN}&Ge48xrXouwqz4+r%=ZpVzmi0f
zF9QJwS|sHco18p-YQA7%H=3c(g;4)NgK#B*=jyztS$rbTM2r|4<v+q4!fq~E(i5ut
zF>kd_Lr^y?eR6(a6}jI>8a2;G(5QLt&4kQoDA|tX!!Daw2Tei)h$9dpF}TyOw_~bM
z+SJ#xkNj)#FxeXiwJZqplTF2sIEBKe;X(1*Oea2QkuaGe`Qv?TUCr63(XautnDk1I
z_lxX^tsSDSDDvUUMg0jcRc91$f~O1vHW-q}4GNo9Y9U*d_XpQW^7@jyAR(hmX0CYa
zOW8imtB-blzF`&u#Q+r{ZeEaq)G>+>)<a<IC&gQt`m%TIv;5Mx#2o<M3oPG~ry|BY
zQfYh}*n280wn@RvLvW+~1v2oA#~c^PK_LTGNdiHxXj~ghrCAo6@hT%)A`Hb9ti2(R
z-V)%@;CI+)h!9~9F+;^j)0OtZfLJ7!=GG|43{2rPrFwd1us6x!db$stf@;JoYvm`I
z-sDkHV6rBmtatQ`7vp@DG5H>i4y;NZ<qkQhW!icN%`{pM#jbeMyDQh!NF1`TH&?R|
z&f4{eTsKwk7U;bX{1-PH3iVaKTE<t&sLqVMf9xZ_g%(<9p@kM&XrYA`T4<q#7FuYb
pg%(<9p@kM&XrYA`T4<q#7FuYbg%(<9p@qKz{10|L_X_}c003*3OiBO%

literal 0
HcmV?d00001

diff --git a/internal/chartverifier/checks/checks.go b/internal/chartverifier/checks/checks.go
index efef631a..887a3203 100644
--- a/internal/chartverifier/checks/checks.go
+++ b/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 {
diff --git a/internal/chartverifier/checks/checks_test.go b/internal/chartverifier/checks/checks_test.go
index 135184b8..73d52129 100644
--- a/internal/chartverifier/checks/checks_test.go
+++ b/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
diff --git a/internal/chartverifier/profiles/default.go b/internal/chartverifier/profiles/default.go
index 774d9369..6687bf1a 100644
--- a/internal/chartverifier/profiles/default.go
+++ b/internal/chartverifier/profiles/default.go
@@ -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
diff --git a/internal/chartverifier/verifierbuilder.go b/internal/chartverifier/verifierbuilder.go
index 19f5f23b..b09ca3e3 100644
--- a/internal/chartverifier/verifierbuilder.go
+++ b/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 {
diff --git a/pkg/chartverifier/checks/checks.go b/pkg/chartverifier/checks/checks.go
index ed15d96f..9023aa94 100644
--- a/pkg/chartverifier/checks/checks.go
+++ b/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,