feat: dedicated setup script

internal/templates/0-setup.yaml.tmpl

@@ -0,0 +1,16 @@
+# This file belongs to the resource setup step.
+apiVersion: chainsaw.kyverno.io/v1alpha1
+kind: Test
+metadata:
+  name: setup
+spec:
+  timeouts:
+    exec: {{ .TestCase.Timeout }}
+  steps:
+  {{- if .TestCase.SetupScriptPath }}
+  - name: Run Setup Script
+    description: Setup the test environment by running the setup script.
+    try:
+    - command:
+        entrypoint: {{ .TestCase.SetupScriptPath }}
+  {{- end }}

internal/templates/0-setup.yaml.tmpl.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2024 The Crossplane Authors <https://crossplane.io>
+
+SPDX-License-Identifier: CC0-1.0

internal/templates/00-apply.yaml.tmpl

@@ -9,13 +9,6 @@ spec:
     assert: {{ .TestCase.Timeout }}
     exec: {{ .TestCase.Timeout }}
   steps:
-  {{- if .TestCase.SetupScriptPath }}
-  - name: Run Setup Script
-    description: Setup the test environment by running the setup script.
-    try:
-    - command:
-        entrypoint: {{ .TestCase.SetupScriptPath }}
-  {{- end }}
   - name: Apply Resources
     description: Apply resources to the cluster.
     try:

internal/templates/embed.go

@@ -6,6 +6,11 @@ package templates
 
 import _ "embed"
 
+// setupFileTemplate is the template for the setup file.
+//
+//go:embed 0-setup.yaml.tmpl
+var setupFileTemplate string
+
 // inputFileTemplate is the template for the input file.
 //
 //go:embed 00-apply.yaml.tmpl

internal/templates/renderer.go

@@ -16,6 +16,7 @@ import (
 )
 
 var fileTemplates = map[string]string{
+	"0-setup.yaml":   setupFileTemplate,
 	"00-apply.yaml":  inputFileTemplate,
 	"01-update.yaml": updateFileTemplate,
 	"02-import.yaml": importFileTemplate,
@@ -24,6 +25,8 @@ var fileTemplates = map[string]string{
 
 // Render renders the specified list of resources as a test case
 // with the specified configuration.
+//
+// nolint:gocyclo
 func Render(tc *config.TestCase, resources []config.Resource, skipDelete bool) (map[string]string, error) {
 	data := struct {
 		Resources []config.Resource
@@ -35,6 +38,11 @@ func Render(tc *config.TestCase, resources []config.Resource, skipDelete bool) (
 
 	res := make(map[string]string, len(fileTemplates))
 	for name, tmpl := range fileTemplates {
+		// Skip templates with names starting with "0-" if no setup script is set
+		if tc.SetupScriptPath == "" && strings.HasPrefix(name, "0-") {
+			continue
+		}
+
 		// Skip templates with names starting with "01-" if skipUpdate is true
 		if tc.SkipUpdate && strings.HasPrefix(name, "01-") {
 			continue

internal/templates/renderer_test.go

@@ -79,22 +79,32 @@ func TestRender(t *testing.T) {
 			},
 			want: want{
 				out: map[string]string{
-					"00-apply.yaml": `# This file belongs to the resource apply step.
+					"0-setup.yaml": `# This file belongs to the resource setup step.
 apiVersion: chainsaw.kyverno.io/v1alpha1
 kind: Test
 metadata:
-  name: apply
+  name: setup
 spec:
   timeouts:
-    apply: 10m0s
-    assert: 10m0s
     exec: 10m0s
   steps:
   - name: Run Setup Script
     description: Setup the test environment by running the setup script.
     try:
     - command:
         entrypoint: /tmp/setup.sh
+`,
+					"00-apply.yaml": `# This file belongs to the resource apply step.
+apiVersion: chainsaw.kyverno.io/v1alpha1
+kind: Test
+metadata:
+  name: apply
+spec:
+  timeouts:
+    apply: 10m0s
+    assert: 10m0s
+    exec: 10m0s
+  steps:
   - name: Apply Resources
     description: Apply resources to the cluster.
     try:
@@ -648,22 +658,32 @@ spec:
 			},
 			want: want{
 				out: map[string]string{
-					"00-apply.yaml": `# This file belongs to the resource apply step.
+					"0-setup.yaml": `# This file belongs to the resource setup step.
 apiVersion: chainsaw.kyverno.io/v1alpha1
 kind: Test
 metadata:
-  name: apply
+  name: setup
 spec:
   timeouts:
-    apply: 10m0s
-    assert: 10m0s
     exec: 10m0s
   steps:
   - name: Run Setup Script
     description: Setup the test environment by running the setup script.
     try:
     - command:
         entrypoint: /tmp/setup.sh
+`,
+					"00-apply.yaml": `# This file belongs to the resource apply step.
+apiVersion: chainsaw.kyverno.io/v1alpha1
+kind: Test
+metadata:
+  name: apply
+spec:
+  timeouts:
+    apply: 10m0s
+    assert: 10m0s
+    exec: 10m0s
+  steps:
   - name: Apply Resources
     description: Apply resources to the cluster.
     try:
@@ -979,22 +999,32 @@ func TestRenderWithSkipDelete(t *testing.T) {
 			},
 			want: want{
 				out: map[string]string{
-					"00-apply.yaml": `# This file belongs to the resource apply step.
+					"0-setup.yaml": `# This file belongs to the resource setup step.
 apiVersion: chainsaw.kyverno.io/v1alpha1
 kind: Test
 metadata:
-  name: apply
+  name: setup
 spec:
   timeouts:
-    apply: 10m0s
-    assert: 10m0s
     exec: 10m0s
   steps:
   - name: Run Setup Script
     description: Setup the test environment by running the setup script.
     try:
     - command:
         entrypoint: /tmp/setup.sh
+`,
+					"00-apply.yaml": `# This file belongs to the resource apply step.
+apiVersion: chainsaw.kyverno.io/v1alpha1
+kind: Test
+metadata:
+  name: apply
+spec:
+  timeouts:
+    apply: 10m0s
+    assert: 10m0s
+    exec: 10m0s
+  steps:
   - name: Apply Resources
     description: Apply resources to the cluster.
     try:
@@ -1231,22 +1261,32 @@ spec:
 			},
 			want: want{
 				out: map[string]string{
-					"00-apply.yaml": `# This file belongs to the resource apply step.
+					"0-setup.yaml": `# This file belongs to the resource setup step.
 apiVersion: chainsaw.kyverno.io/v1alpha1
 kind: Test
 metadata:
-  name: apply
+  name: setup
 spec:
   timeouts:
-    apply: 10m0s
-    assert: 10m0s
     exec: 10m0s
   steps:
   - name: Run Setup Script
     description: Setup the test environment by running the setup script.
     try:
     - command:
         entrypoint: /tmp/setup.sh
+`,
+					"00-apply.yaml": `# This file belongs to the resource apply step.
+apiVersion: chainsaw.kyverno.io/v1alpha1
+kind: Test
+metadata:
+  name: apply
+spec:
+  timeouts:
+    apply: 10m0s
+    assert: 10m0s
+    exec: 10m0s
+  steps:
   - name: Apply Resources
     description: Apply resources to the cluster.
     try:
@@ -1385,22 +1425,32 @@ spec:
 			},
 			want: want{
 				out: map[string]string{
-					"00-apply.yaml": `# This file belongs to the resource apply step.
+					"0-setup.yaml": `# This file belongs to the resource setup step.
 apiVersion: chainsaw.kyverno.io/v1alpha1
 kind: Test
 metadata:
-  name: apply
+  name: setup
 spec:
   timeouts:
-    apply: 10m0s
-    assert: 10m0s
     exec: 10m0s
   steps:
   - name: Run Setup Script
     description: Setup the test environment by running the setup script.
     try:
     - command:
         entrypoint: /tmp/setup.sh
+`,
+					"00-apply.yaml": `# This file belongs to the resource apply step.
+apiVersion: chainsaw.kyverno.io/v1alpha1
+kind: Test
+metadata:
+  name: apply
+spec:
+  timeouts:
+    apply: 10m0s
+    assert: 10m0s
+    exec: 10m0s
+  steps:
   - name: Apply Resources
     description: Apply resources to the cluster.
     try:
@@ -1639,22 +1689,32 @@ spec:
 			},
 			want: want{
 				out: map[string]string{
-					"00-apply.yaml": `# This file belongs to the resource apply step.
+					"0-setup.yaml": `# This file belongs to the resource setup step.
 apiVersion: chainsaw.kyverno.io/v1alpha1
 kind: Test
 metadata:
-  name: apply
+  name: setup
 spec:
   timeouts:
-    apply: 10m0s
-    assert: 10m0s
     exec: 10m0s
   steps:
   - name: Run Setup Script
     description: Setup the test environment by running the setup script.
     try:
     - command:
         entrypoint: /tmp/setup.sh
+`,
+					"00-apply.yaml": `# This file belongs to the resource apply step.
+apiVersion: chainsaw.kyverno.io/v1alpha1
+kind: Test
+metadata:
+  name: apply
+spec:
+  timeouts:
+    apply: 10m0s
+    assert: 10m0s
+    exec: 10m0s
+  steps:
   - name: Apply Resources
     description: Apply resources to the cluster.
     try:
@@ -1755,22 +1815,32 @@ spec:
 			},
 			want: want{
 				out: map[string]string{
-					"00-apply.yaml": `# This file belongs to the resource apply step.
+					"0-setup.yaml": `# This file belongs to the resource setup step.
 apiVersion: chainsaw.kyverno.io/v1alpha1
 kind: Test
 metadata:
-  name: apply
+  name: setup
 spec:
   timeouts:
-    apply: 10m0s
-    assert: 10m0s
     exec: 10m0s
   steps:
   - name: Run Setup Script
     description: Setup the test environment by running the setup script.
     try:
     - command:
         entrypoint: /tmp/setup.sh
+`,
+					"00-apply.yaml": `# This file belongs to the resource apply step.
+apiVersion: chainsaw.kyverno.io/v1alpha1
+kind: Test
+metadata:
+  name: apply
+spec:
+  timeouts:
+    apply: 10m0s
+    assert: 10m0s
+    exec: 10m0s
+  steps:
   - name: Apply Resources
     description: Apply resources to the cluster.
     try:

internal/tester.go

@@ -42,6 +42,7 @@ import (
 )
 
 var testFiles = []string{
+	"0-setup.yaml",
 	"00-apply.yaml",
 	"01-update.yaml",
 	"02-import.yaml",