testing file for internal yaml

go.mod

@@ -49,6 +49,7 @@ require (
 	golang.org/x/oauth2 v0.23.0
 	golang.org/x/sync v0.8.0
 	golang.org/x/time v0.6.0
+	gopkg.in/yaml.v3 v3.0.1
 	gorm.io/driver/postgres v1.5.9
 	gorm.io/driver/sqlite v1.5.6
 	gorm.io/gorm v1.25.12
@@ -148,7 +149,6 @@ require (
 	google.golang.org/grpc v1.66.1 // indirect
 	google.golang.org/protobuf v1.34.2 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	gopkg.in/yaml.v3 v3.0.1 // indirect
 	k8s.io/klog/v2 v2.130.1 // indirect
 	k8s.io/utils v0.0.0-20240711033017-18e509b52bc8 // indirect
 )

internal/testdata/buildkite.yml

@@ -0,0 +1,18 @@
+version: "legacy"
+
+aliases:
+  images:
+    alpine: &alpine-image
+      image: alpine:latest
+
+  env:
+    dev-env: &dev-environment
+      environment:
+        REGION: dev 
+
+steps:
+  - name: example
+    <<: *alpine-image
+    <<: *dev-environment
+    commands:
+      - echo $REGION

internal/testdata/go-yaml.yml

@@ -0,0 +1,19 @@
+version: "1"
+
+aliases:
+  images:
+    alpine: &alpine-image
+      image: alpine:latest
+
+  env:
+    dev-env: &dev-environment
+      environment:
+        REGION: dev 
+
+steps:
+  - name: example
+    <<:
+      - *alpine-image
+      - *dev-environment
+    commands:
+      - echo $REGION

internal/testdata/invalid.yml

@@ -0,0 +1,2 @@
+- sliceNodeA
+- sliceNodeB

internal/testdata/no_version.yml

@@ -0,0 +1,17 @@
+aliases:
+  images:
+    alpine: &alpine-image
+      image: alpine:latest
+
+  env:
+    dev-env: &dev-environment
+      environment:
+        REGION: dev 
+
+steps:
+  - name: example
+    <<:
+      - *alpine-image
+      - *dev-environment
+    commands:
+      - echo $REGION

internal/yaml_test.go

@@ -0,0 +1,88 @@
+// SPDX-License-Identifier: Apache-2.0
+
+package internal
+
+import (
+	"os"
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+
+	"github.com/go-vela/server/compiler/types/yaml/yaml"
+)
+
+func TestInternal_ParseYAML(t *testing.T) {
+	// wantBuild
+	wantBuild := &yaml.Build{
+		Version: "1",
+		Metadata: yaml.Metadata{
+			Environment: []string{"steps", "services", "secrets"},
+		},
+		Steps: yaml.StepSlice{
+			&yaml.Step{
+				Name:  "example",
+				Image: "alpine:latest",
+				Environment: map[string]string{
+					"REGION": "dev",
+				},
+				Pull: "not_present",
+				Commands: []string{
+					"echo $REGION",
+				},
+			},
+		},
+	}
+
+	// set up tests
+	tests := []struct {
+		file    string
+		want    *yaml.Build
+		wantErr bool
+	}{
+		{
+			file: "testdata/go-yaml.yml",
+			want: wantBuild,
+		},
+		{
+			file: "testdata/buildkite.yml",
+			want: wantBuild,
+		},
+		{
+			file: "testdata/no_version.yml",
+			want: wantBuild,
+		},
+		{
+			file:    "testdata/invalid.yml",
+			want:    nil,
+			wantErr: true,
+		},
+	}
+
+	// run tests
+	for _, test := range tests {
+		bytes, err := os.ReadFile(test.file)
+		if err != nil {
+			t.Errorf("unable to read file: %v", err)
+		}
+
+		gotBuild, err := ParseYAML(bytes)
+		if err != nil && !test.wantErr {
+			t.Errorf("ParseYAML returned err: %v", err)
+		}
+
+		if err == nil && test.wantErr {
+			t.Errorf("ParseYAML returned nil error")
+		}
+
+		if err != nil && test.wantErr {
+			continue
+		}
+
+		// different versions expected
+		wantBuild.Version = gotBuild.Version
+
+		if diff := cmp.Diff(gotBuild, test.want); diff != "" {
+			t.Errorf("ParseYAML returned diff (-got +want):\n%s", diff)
+		}
+	}
+}