feat: add skip field to test steps

Implements #2297 - Add ability to skip steps based on conditions

This PR adds a new 'skip' field to TestStepSpec that allows steps to be conditionally skipped based on a boolean value or a template expression.

- Added Skip field to TestStepSpec

- Added unit tests for the Skip field

- Added documentation for the skip feature

Signed-off-by: Karthik babu Manam <karthikmanam@gmail.com>

Author: karthikmanam

pkg/apis/v1alpha1/step.go

@@ -102,6 +102,10 @@ type TestStepSpec struct {
 	// +optional
 	Clusters Clusters `json:"clusters,omitempty"`
 
+	// Skip determines whether the step should be skipped. Can be a boolean or a template expression.
+	// +optional
+	Skip *string `json:"skip,omitempty"`
+
 	// SkipDelete determines whether the resources created by the step should be deleted after the test step is executed.
 	// +optional
 	SkipDelete *bool `json:"skipDelete,omitempty"`

pkg/apis/v1alpha1/step_test.go

@@ -0,0 +1,74 @@
+package v1alpha1
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+)
+
+func TestSkipField(t *testing.T) {
+	// Create a test resource
+	testResource := map[string]interface{}{
+		"apiVersion": "v1",
+		"kind":       "ConfigMap",
+		"metadata": map[string]interface{}{
+			"name": "test-configmap",
+		},
+		"data": map[string]interface{}{
+			"key": "value",
+		},
+	}
+
+	// Convert to unstructured
+	unstructuredObj := &unstructured.Unstructured{
+		Object: testResource,
+	}
+
+	// Test with skip field set to true
+	step := TestStep{
+		Name: "Test Step",
+		TestStepSpec: TestStepSpec{
+			Skip: stringPtr("true"),
+			Try: []Operation{
+				{
+					Apply: &Apply{
+						ActionResourceRef: ActionResourceRef{
+							Resource: unstructuredObj,
+						},
+					},
+				},
+			},
+		},
+	}
+
+	// Verify the skip field is properly set
+	assert.NotNil(t, step.Skip)
+	assert.Equal(t, "true", *step.Skip)
+
+	// Test with skip field set to a template expression
+	step = TestStep{
+		Name: "Test Step with Template",
+		TestStepSpec: TestStepSpec{
+			Skip: stringPtr("{{ .SKIP_STEP }}"),
+			Try: []Operation{
+				{
+					Apply: &Apply{
+						ActionResourceRef: ActionResourceRef{
+							Resource: unstructuredObj,
+						},
+					},
+				},
+			},
+		},
+	}
+
+	// Verify the skip field is properly set
+	assert.NotNil(t, step.Skip)
+	assert.Equal(t, "{{ .SKIP_STEP }}", *step.Skip)
+}
+
+// Helper function to create a string pointer
+func stringPtr(s string) *string {
+	return &s
+}

website/docs/step/skip.md

@@ -0,0 +1,55 @@
+# Skipping Steps
+
+Chainsaw allows you to conditionally skip steps in your tests. This is useful when you want to run different steps based on environment variables or other conditions.
+
+## Basic Usage
+
+To skip a step, add the `skip` field to your step definition:
+
+```yaml
+steps:
+  - name: Check if resource is deployed
+    skip: true
+    try:
+      - assert:
+          file: ../assert-resources.yaml
+```
+
+When the `skip` field is set to `true`, Chainsaw will skip the step and continue with the next one.
+
+## Dynamic Skipping with Templates
+
+You can also use template expressions to dynamically determine whether to skip a step:
+
+```yaml
+steps:
+  - name: Check if resource is deployed
+    skip: "{{ .SKIP_STEP }}"
+    try:
+      - assert:
+          file: ../assert-resources.yaml
+```
+
+In this example, the step will be skipped if the `SKIP_STEP` environment variable is set to `true`.
+
+## Conditional Skipping
+
+You can use more complex expressions to conditionally skip steps:
+
+```yaml
+steps:
+  - name: Skip in development environment
+    skip: "{{ eq .ENV \"development\" }}"
+    try:
+      - apply:
+          file: ../production-resources.yaml
+```
+
+This step will be skipped if the `ENV` environment variable is set to `development`.
+
+## Notes
+
+- The `skip` field accepts a string value that will be evaluated as a boolean.
+- Valid values are `true`, `false`, `"true"`, `"false"`, or any template expression that evaluates to a boolean.
+- If the template expression cannot be evaluated or does not result in a valid boolean value, an error will be reported.
+- Skipped steps will be logged with a "SKIP" status in the test output.