feat: add method to checkout step fields (#365)

Author: OompahLoompah

pkg/ast/step.go

@@ -82,7 +82,8 @@ func (step Run) GetName() string {
 
 type Checkout struct {
 	protocol.Range
-	Path string
+	Path   string
+	Method string
 }
 
 func (step Checkout) GetRange() protocol.Range {

pkg/parser/steps.go

@@ -302,6 +302,8 @@ func (doc *YamlDocument) parseCheckoutStep(checkoutNode *sitter.Node) ast.Checko
 			switch keyName {
 			case "path":
 				res.Path = doc.GetNodeText(valueNode)
+			case "method":
+				res.Method = doc.GetNodeText(valueNode)
 			}
 		})
 		return res

pkg/parser/validate/steps.go

@@ -31,6 +31,8 @@ func (val Validate) validateSteps(steps []ast.Step, name string, jobOrCommandPar
 			val.validateNamedStep(step, jobOrCommandParameters)
 		case ast.Steps:
 			val.validateStepSteps(step, name)
+		case ast.Checkout:
+			val.validateCheckout(step)
 		}
 	}
 	return nil
@@ -211,6 +213,21 @@ func (val Validate) validateStepSteps(step ast.Steps, name string) {
 	}
 }
 
+func (val Validate) validateCheckout(step ast.Checkout) {
+	if step.Method == "" {
+		return
+	}
+
+	m := []string{"blobless", "full"}
+	if !slices.Contains(m, step.Method) {
+		val.addDiagnostic(protocol.Diagnostic{
+			Severity: protocol.DiagnosticSeverityError,
+			Range:    step.Range,
+			Message:  fmt.Sprintf("Checkout method '%s' is invalid", step.Method),
+		})
+	}
+}
+
 func (val Validate) checkIfStepsContainStep(steps []ast.Step, stepName string) bool {
 	for _, step := range steps {
 		if step.GetName() == stepName {

pkg/parser/validate/steps_test.go

@@ -1,6 +1,7 @@
 package validate
 
 import (
+	"os"
 	"testing"
 
 	"go.lsp.dev/protocol"
@@ -69,3 +70,40 @@ workflows:
 
 	CheckYamlErrors(t, testCases)
 }
+
+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),
+			Diagnostics: []protocol.Diagnostic{},
+		},
+		{
+			Name:        "Specifying an invalid checkout method results in an error",
+			YamlContent: string(invalidConfig),
+			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 method 'invalid' is invalid",
+				},
+			},
+		},
+	}
+	CheckYamlErrors(t, testCases)
+}

pkg/parser/validate/testdata/invalid_checkout_method.yml

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

pkg/parser/validate/testdata/valid_checkout_method.yml

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

publicschema.json

@@ -687,7 +687,10 @@
                         "path": {
                             "description": "Checkout directory (default: job's `working_directory`)",
                             "type": "string"
-                        }
+                        },
+                        "method": {
+                            "description": "The checkout method to be used ('blobless' or 'full', default 'full')",
+                            "type": "string"
                     }
                 },
                 "setup_remote_docker": {