feat: Update checkout validation messages and add test cases for shallow method

Author: uruemu

pkg/parser/validate/steps.go

@@ -229,11 +229,19 @@ func (val Validate) validateCheckout(step ast.Checkout) {
 
 	if step.Method == "shallow" {
 		depth, err := strconv.Atoi(step.Depth)
-		if err != nil || depth <= 0 {
+		if err != nil {
+			val.addDiagnostic(protocol.Diagnostic{
+				Severity: protocol.DiagnosticSeverityError,
+				Range:    step.Range,
+				Message:  "Checkout depth must be a valid integer when using the shallow checkout method",
+			})
+			return
+		}
+		if depth <= 0 {
 			val.addDiagnostic(protocol.Diagnostic{
 				Severity: protocol.DiagnosticSeverityError,
 				Range:    step.Range,
-				Message:  "Checkout depth must be a positive integer",
+				Message:  "Checkout depth must be a positive integer when using the shallow checkout method",
 			})
 		}
 	}

pkg/parser/validate/steps_test.go

@@ -1,12 +1,26 @@
 package validate
 
 import (
-	"os"
+	_ "embed"
 	"testing"
 
 	"go.lsp.dev/protocol"
 )
 
+var (
+	//go:embed testdata/valid_checkout_method.yml
+	validCheckoutMethodYml string
+
+	//go:embed testdata/invalid_checkout_method.yml
+	invalidCheckoutMethodYml string
+
+	//go:embed testdata/invalid_checkout_method_shallow.yml
+	invalidCheckoutMethodShallowYml string
+
+	//go:embed testdata/valid_checkout_method_shallow.yml
+	validCheckoutMethodShallowYml string
+)
+
 func TestStepsValidation(t *testing.T) {
 	testCases := []ValidateTestCase{
 		{
@@ -72,27 +86,15 @@ workflows:
 }
 
 func TestYamlDocument_parseCheckout(t *testing.T) {
-	validConfigFilePath := "./testdata/valid_checkout_method.yml"
-	validConfig, err := os.ReadFile(validConfigFilePath)
-	if err != nil {
-		t.Fatal("Failed to read valid_checkout_method.yml")
-	}
-
-	invalidConfigFilePath := "./testdata/invalid_checkout_method.yml"
-	invalidConfig, err := os.ReadFile(invalidConfigFilePath)
-	if err != nil {
-		t.Fatal("Failed to read invalid_checkout_method.yml")
-	}
-
 	testCases := []ValidateTestCase{
 		{
 			Name:        "Specifying checkout method full does not result in an error",
-			YamlContent: string(validConfig),
+			YamlContent: validCheckoutMethodYml,
 			Diagnostics: []protocol.Diagnostic{},
 		},
 		{
 			Name:        "Specifying an invalid checkout method results in an error",
-			YamlContent: string(invalidConfig),
+			YamlContent: invalidCheckoutMethodYml,
 			Diagnostics: []protocol.Diagnostic{
 				{
 					Severity: protocol.DiagnosticSeverityError,
@@ -102,6 +104,33 @@ func TestYamlDocument_parseCheckout(t *testing.T) {
 					},
 					Message: "Checkout method 'invalid' is invalid",
 				},
+				{
+					Severity: protocol.DiagnosticSeverityError,
+					Range: protocol.Range{
+						Start: protocol.Position{Line: 7, Character: 8},
+						End:   protocol.Position{Line: 7, Character: 16},
+					},
+					Message: "Checkout depth can only be used with the shallow checkout method",
+				},
+			},
+		},
+		{
+			Name:        "Specifying checkout method shallow with depth does not result in an error",
+			YamlContent: validCheckoutMethodShallowYml,
+			Diagnostics: []protocol.Diagnostic{},
+		},
+		{
+			Name:        "Specifying checkout method shallow without depth results in an error",
+			YamlContent: invalidCheckoutMethodShallowYml,
+			Diagnostics: []protocol.Diagnostic{
+				{
+					Severity: protocol.DiagnosticSeverityError,
+					Range: protocol.Range{
+						Start: protocol.Position{Line: 7, Character: 8},
+						End:   protocol.Position{Line: 7, Character: 16},
+					},
+					Message: "Checkout depth must be a valid integer when using the shallow checkout method",
+				},
 			},
 		},
 	}

pkg/parser/validate/testdata/invalid_checkout_method.yml

@@ -7,6 +7,7 @@ jobs:
     steps:
       - checkout:
           method: "invalid"
+          depth: 1
       - run: echo "hello world"
 
 workflows:

pkg/parser/validate/testdata/invalid_checkout_method_shallow.yml

@@ -0,0 +1,15 @@
+version: 2.1
+
+jobs:
+  build:
+    docker:
+      - image: cimg/base:stable
+    steps:
+      - checkout:
+          method: shallow
+      - run: echo "hello world"
+
+workflows:
+  test-build:
+    jobs:
+      - build

pkg/parser/validate/testdata/valid_checkout_method_shallow.yml

@@ -0,0 +1,16 @@
+version: 2.1
+
+jobs:
+  build:
+    docker:
+      - image: cimg/base:stable
+    steps:
+      - checkout:
+          method: shallow
+          depth: 1
+      - run: echo "hello world"
+
+workflows:
+  test-build:
+    jobs:
+      - build