Separate out package and build lints

There are currently no separate lints, but there will soon be. Prepare for this eventuality now. Signed-off-by: Elizabeth Myers <[email protected]>
chainguard-dev · Oct 26, 2023 · 2ccb5ff · 2ccb5ff
1 parent 818204c
commit 2ccb5ff
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 6 deletions.
diff --git a/pkg/cli/lint.go b/pkg/cli/lint.go
@@ -50,7 +50,7 @@ func Lint() *cobra.Command {
 			linterSet := map[string]struct{}{}
 
 			// Get all default linters, ignoring disabled ones
-			for _, e := range linter_defaults.DefaultLinters {
+			for _, e := range linter_defaults.GetDefaultLinters(linter_defaults.LintersApk) {
 				if !slices.Contains(disabled, e) {
 					linterSet[e] = struct{}{}
 				}

diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -208,7 +208,7 @@ func (p *Package) FullCopyright() string {
 // Computes the list of package or subpackage linters, taking into account default linters.
 // This includes the default linters as well, unless disabled.
 func (chk *Checks) GetLinters() []string {
-	linters := linter_defaults.DefaultLinters
+	linters := linter_defaults.GetDefaultLinters(linter_defaults.LintersBuild)
 
 	// Enable non-default linters
 	for _, v := range chk.Enabled {

diff --git a/pkg/linter/defaults/defaults.go b/pkg/linter/defaults/defaults.go
@@ -17,7 +17,20 @@
 
 package defaults
 
-var DefaultLinters = []string{
+import (
+	"slices"
+)
+
+type LinterSet int
+
+const (
+	LintersDefault LinterSet = iota
+	LintersBuild   LinterSet = iota
+	LintersApk     LinterSet = iota
+)
+
+// Default linters run regardless of whether we are dealing with an APK or build
+var defaultLinters = []string{
 	"dev",
 	"empty",
 	"opt",
@@ -32,3 +45,26 @@ var DefaultLinters = []string{
 	"varempty",
 	"worldwrite",
 }
+
+// Linters run by default on builds but not on APKs
+var defaultBuildLinters = []string{}
+
+// Linters run by default on APKs but not during build
+var defaultApkLinters = []string{}
+
+// Get the set of default linters for a given task
+func GetDefaultLinters(linterSet LinterSet) (linters []string) {
+	linters = slices.Clone(defaultLinters)
+	switch linterSet {
+	case LintersDefault:
+		// Do nothing
+	case LintersBuild:
+		linters = append(linters, slices.Clone(defaultBuildLinters)...)
+	case LintersApk:
+		linters = append(linters, slices.Clone(defaultApkLinters)...)
+	default:
+		panic("Invalid linter set called")
+	}
+
+	return
+}
diff --git a/pkg/linter/linter_test.go b/pkg/linter/linter_test.go
@@ -29,7 +29,7 @@ import (
 
 func checksOnly(onlyLint string) config.Checks {
 	checksDisabled := []string{}
-	for _, lint := range linter_defaults.DefaultLinters {
+	for _, lint := range linter_defaults.GetDefaultLinters(linter_defaults.LintersBuild) {
 		if lint != onlyLint {
 			checksDisabled = append(checksDisabled, lint)
 		}
@@ -607,11 +607,11 @@ func Test_lintApk(t *testing.T) {
 	called := false
 	assert.NoError(t, LintApk(ctx, filepath.Join("testdata", "hello-wolfi-2.12.1-r1.apk"), func(err error) {
 		called = true
-	}, linter_defaults.DefaultLinters))
+	}, linter_defaults.GetDefaultLinters(linter_defaults.LintersApk)))
 	assert.False(t, called)
 
 	assert.NoError(t, LintApk(ctx, filepath.Join("testdata", "kubeflow-pipelines-2.1.3-r7.apk"), func(err error) {
 		called = true
-	}, linter_defaults.DefaultLinters))
+	}, linter_defaults.GetDefaultLinters(linter_defaults.LintersApk)))
 	assert.True(t, called)
 }