chore: internal refactor to reduce duplicate code

cmd/lagoon-linter/validate.go

@@ -1,6 +1,11 @@
 package main
 
-import "github.com/uselagoon/lagoon-linter/internal/lagoonyml"
+import (
+	"fmt"
+	"os"
+
+	"github.com/uselagoon/lagoon-linter/internal/lagoonyml"
+)
 
 // ValidateCmd represents the validate command.
 type ValidateCmd struct {
@@ -9,5 +14,9 @@ type ValidateCmd struct {
 
 // Run the validation of the Lagoon YAML.
 func (cmd *ValidateCmd) Run() error {
-	return lagoonyml.LintFile(cmd.LagoonYAML, lagoonyml.RouteAnnotation())
+	rawYAML, err := os.ReadFile(cmd.LagoonYAML)
+	if err != nil {
+		return fmt.Errorf("couldn't read %v: %v", cmd.LagoonYAML, err)
+	}
+	return lagoonyml.Lint(rawYAML, lagoonyml.RouteAnnotation())
 }

cmd/lagoon-linter/validateconfigmapjson.go

@@ -39,7 +39,7 @@ func (cmd *ValidateConfigMapJSONCmd) Run() error {
 	// lint it
 	for _, cm := range cml.ConfigMaps {
 		if lagoonYAML, ok := cm.Data[".lagoon.yml"]; ok {
-			err := lagoonyml.LintYAML([]byte(lagoonYAML),
+			err := lagoonyml.Lint([]byte(lagoonYAML),
 				lagoonyml.RouteAnnotation())
 			if err != nil {
 				fmt.Printf("bad .lagoon.yml: %s: %v\n", cm.Metadata["namespace"], err)

internal/lagoonyml/lint.go

@@ -2,43 +2,18 @@ package lagoonyml
 
 import (
 	"fmt"
-	"os"
 
 	"sigs.k8s.io/yaml"
 )
 
 // Linter validates the given Lagoon struct.
 type Linter func(*Lagoon) error
 
-// LintFile takes a file path, reads it, and applies `.lagoon.yml` lint policy to
-// it. Lint returns an error of type ErrLint if it finds problems with the
-// file, a regular error if something else went wrong, and nil if the
+// Lint takes a byte slice containing raw YAML and applies `.lagoon.yml` lint
+// policy to it. Lint returns an error of type ErrLint if it finds problems
+// with the file, a regular error if something else went wrong, and nil if the
 // `.lagoon.yml` is valid.
-func LintFile(path string, linters ...Linter) error {
-	var l Lagoon
-	rawYAML, err := os.ReadFile(path)
-	if err != nil {
-		return fmt.Errorf("couldn't read %v: %v", path, err)
-	}
-	err = yaml.Unmarshal(rawYAML, &l)
-	if err != nil {
-		return fmt.Errorf("couldn't unmarshal %v: %v", path, err)
-	}
-	for _, linter := range linters {
-		if err := linter(&l); err != nil {
-			return &ErrLint{
-				Detail: err.Error(),
-			}
-		}
-	}
-	return nil
-}
-
-// LintYAML takes a byte slice containing raw YAML and applies `.lagoon.yml` lint policy to
-// it. Lint returns an error of type ErrLint if it finds problems with the
-// file, a regular error if something else went wrong, and nil if the
-// `.lagoon.yml` is valid.
-func LintYAML(rawYAML []byte, linters ...Linter) error {
+func Lint(rawYAML []byte, linters ...Linter) error {
 	var l Lagoon
 	if err := yaml.Unmarshal(rawYAML, &l); err != nil {
 		return fmt.Errorf("couldn't unmarshal YAML: %v", err)

internal/lagoonyml/lint_test.go

@@ -1,6 +1,7 @@
 package lagoonyml_test
 
 import (
+	"os"
 	"testing"
 
 	"github.com/uselagoon/lagoon-linter/internal/lagoonyml"
@@ -58,7 +59,11 @@ func TestLint(t *testing.T) {
 	}
 	for name, tc := range testCases {
 		t.Run(name, func(tt *testing.T) {
-			err := lagoonyml.LintFile(tc.input, lagoonyml.RouteAnnotation())
+			rawYAML, err := os.ReadFile(tc.input)
+			if err != nil {
+				tt.Fatalf("couldn't read %v: %v", tc.input, err)
+			}
+			err = lagoonyml.Lint(rawYAML, lagoonyml.RouteAnnotation())
 			if tc.valid {
 				if err != nil {
 					tt.Fatalf("unexpected error %v", err)