From 6faf911a29a7ea4404afae80475c6883752983bb Mon Sep 17 00:00:00 2001
From: Dentrax <furkan.turkal@chainguard.dev>
Date: Sat, 28 Sep 2024 13:00:46 +0300
Subject: [PATCH] linter: add test-disabled-reason

Checks to make sure that there's a reason attached whenever test are disabled

Signed-off-by: Dentrax <furkan.turkal@chainguard.dev>
---
 pkg/lint/rules.go                          | 15 ++++++++++++
 pkg/lint/rules_test.go                     | 18 ++++++++++++++
 pkg/lint/testdata/files/test-disabled.yaml | 28 ++++++++++++++++++++++
 3 files changed, 61 insertions(+)
 create mode 100644 pkg/lint/testdata/files/test-disabled.yaml

diff --git a/pkg/lint/rules.go b/pkg/lint/rules.go
index a00321fa..e6638251 100644
--- a/pkg/lint/rules.go
+++ b/pkg/lint/rules.go
@@ -456,6 +456,21 @@ var AllRules = func(l *Linter) Rules { //nolint:gocyclo
 				return fmt.Errorf("auto-update is disabled but no reason is provided")
 			},
 		},
+		{
+			Name:        "test-disabled-reason",
+			Description: "packages with test disabled should have a reason",
+			// TODO: Change to SeverityError when current packages are compliant.
+			Severity: SeverityWarning,
+			LintFunc: func(c config.Configuration) error {
+				if c.Test != nil && c.Test.Enabled {
+					return nil
+				}
+				if c.Test != nil && !c.Test.Enabled && c.Test.ExcludeReason != "" {
+					return nil
+				}
+				return fmt.Errorf("test is disabled but no reason is provided")
+			},
+		},
 		{
 			Name:        "valid-update-schedule",
 			Description: "update schedule config should contain a valid period",
diff --git a/pkg/lint/rules_test.go b/pkg/lint/rules_test.go
index bca989ef..f963009b 100644
--- a/pkg/lint/rules_test.go
+++ b/pkg/lint/rules_test.go
@@ -415,6 +415,24 @@ func TestLinter_Rules(t *testing.T) {
 			wantErr: false,
 			matches: 1,
 		},
+		{
+			file:        "test-disabled.yaml",
+			minSeverity: SeverityInfo,
+			want: EvalResult{
+				File: "test-disabled",
+				Errors: EvalRuleErrors{
+					{
+						Rule: Rule{
+							Name:     "test-disabled-reason",
+							Severity: SeverityWarning,
+						},
+						Error: fmt.Errorf("[test-disabled-reason]: test is disabled but no reason is provided (WARNING)"),
+					},
+				},
+			},
+			wantErr: false,
+			matches: 1,
+		},
 		{
 			file:        "valid-update-schedule.yaml",
 			minSeverity: SeverityWarning,
diff --git a/pkg/lint/testdata/files/test-disabled.yaml b/pkg/lint/testdata/files/test-disabled.yaml
new file mode 100644
index 00000000..dab16c94
--- /dev/null
+++ b/pkg/lint/testdata/files/test-disabled.yaml
@@ -0,0 +1,28 @@
+package:
+  name: update-disabled
+  version: 1.0.0
+  epoch: 0
+  description: A valid package
+  target-architecture:
+    - all
+  copyright:
+    - license: Apache-2.0
+      paths:
+        - "*"
+environment:
+  contents:
+    packages:
+      - foo
+      - bar
+      - baz
+pipeline:
+  - uses: fetch
+    with:
+      uri: https://test.com/foo/bar/baz.tar.gz
+      expected-sha512: 6d8e828fa406518b4b3f55b0e5f62bbd5cf25cb5782d1884b9d5eaf61fb0614deaacad4236ab7420fa5b3868c79df226ae1aa5193bb136c556aa52853eeca553
+  - runs: |
+      go build .
+test:
+  enabled: false
+update:
+  enabled: true