feat(kubevirt): Add enforcement and validation for runStrategy over deprecated running field

Strengthen the VM creation guidance and add explicit test assertions to ensure
the deprecated 'running' field is not used in VirtualMachine specs.

Changes to VM Creation Template (plan.tmpl):
- Add prominent warning section about deprecated 'running' field
- Include side-by-side comparison showing incorrect vs. correct usage
- Clear visual indicators (❌ INCORRECT vs. ✅ CORRECT)
- Emphasize that 'runStrategy' must be used instead

Changes to Test Helper Functions (verify-vm.sh):
- Add new `verify_no_deprecated_running_field()` function
- Explicitly checks that spec.running is not set
- Returns failure if deprecated field is found
- Provides clear error message directing users to use runStrategy

Changes to Test Tasks (all 5 VM creation tests):
- Add assertion in all test tasks to verify running field is not used
- Tests now explicitly call `verify_no_deprecated_running_field()`
- Ensures compliance with KubeVirt best practices
- Tests fail if VMs are created with deprecated field

Benefits:
- Prevents use of deprecated KubeVirt API fields
- Explicit test coverage for API field deprecation
- Clear guidance for AI assistants creating VMs
- Ensures forward compatibility with future KubeVirt versions
- Enforces best practices through automated testing

Assisted-By: Claude <[email protected]>
Signed-off-by: Lee Yarwood <[email protected]>

Author: lyarwood

pkg/toolsets/kubevirt/vm/create/plan.tmpl

@@ -1,6 +1,22 @@
 # VirtualMachine Creation Plan
 
-**IMPORTANT**: Always use `runStrategy` instead of the deprecated `running` field when creating VirtualMachines.
+## ⚠️ IMPORTANT: Deprecated Field Warning
+
+**DO NOT use the `running` field** - it is deprecated in KubeVirt. Always use `runStrategy` instead.
+
+❌ **INCORRECT** (deprecated):
+```yaml
+spec:
+  running: true  # DO NOT USE - deprecated field
+```
+
+✅ **CORRECT**:
+```yaml
+spec:
+  runStrategy: Always  # Use runStrategy instead
+```
+
+## VirtualMachine YAML
 
 Use the `resources_create_or_update` tool with the following YAML:
 

pkg/toolsets/kubevirt/vm/tests/helpers/README.md

@@ -14,6 +14,7 @@ source "$(dirname "${BASH_SOURCE[0]}")/../../helpers/verify-vm.sh"
 verify_vm_exists "test-vm" "vm-test" || exit 1
 verify_container_disk "test-vm" "vm-test" "fedora" || exit 1
 verify_run_strategy "test-vm" "vm-test" || exit 1
+verify_no_deprecated_running_field "test-vm" "vm-test" || exit 1
 ```
 
 ## Available Functions
@@ -59,6 +60,20 @@ verify_run_strategy "my-vm" "vm-test" || exit 1
 
 ---
 
+### verify_no_deprecated_running_field
+Verifies that the deprecated `running` field is NOT set in the VirtualMachine spec.
+
+**Usage:** `verify_no_deprecated_running_field <vm-name> <namespace>`
+
+**Example:**
+```bash
+verify_no_deprecated_running_field "my-vm" "vm-test" || exit 1
+```
+
+**Note:** The `running` field is deprecated in KubeVirt. VirtualMachines should use `runStrategy` instead. This function ensures compliance with current best practices.
+
+---
+
 ### verify_instancetype
 Verifies that a VM has an instancetype reference with optional exact match.
 
@@ -158,8 +173,9 @@ verify_vm_exists "test-vm" "vm-test" || exit 1
 # Verify container disk
 verify_container_disk "test-vm" "vm-test" "fedora" || exit 1
 
-# Verify runStrategy
+# Verify runStrategy is used (not deprecated 'running' field)
 verify_run_strategy "test-vm" "vm-test" || exit 1
+verify_no_deprecated_running_field "test-vm" "vm-test" || exit 1
 
 # Verify instancetype with size
 verify_instancetype "test-vm" "vm-test" || exit 1

pkg/toolsets/kubevirt/vm/tests/helpers/verify-vm.sh

@@ -63,6 +63,26 @@ verify_run_strategy() {
     fi
 }
 
+# verify_no_deprecated_running_field: Verifies that deprecated 'running' field is NOT set
+# Usage: verify_no_deprecated_running_field <vm-name> <namespace>
+verify_no_deprecated_running_field() {
+    local vm_name="$1"
+    local namespace="$2"
+
+    local running_field
+    running_field=$(kubectl get virtualmachine "$vm_name" -n "$namespace" -o jsonpath='{.spec.running}')
+
+    if [[ -z "$running_field" ]]; then
+        echo "✓ VirtualMachine does not use deprecated 'running' field"
+        return 0
+    else
+        echo "✗ VirtualMachine uses deprecated 'running' field with value: $running_field"
+        echo "  Please use 'runStrategy' instead of 'running'"
+        kubectl get virtualmachine "$vm_name" -n "$namespace" -o yaml
+        return 1
+    fi
+}
+
 # verify_instancetype: Verifies that a VM has an instancetype reference
 # Usage: verify_instancetype <vm-name> <namespace> [expected-instancetype] [expected-kind]
 verify_instancetype() {

pkg/toolsets/kubevirt/vm/tests/tasks/create-vm-basic/create-vm-basic.yaml

@@ -19,8 +19,9 @@ steps:
       # Verify container disk is Fedora
       verify_container_disk "test-vm" "vm-test" "fedora" || exit 1
 
-      # Verify runStrategy is set
+      # Verify runStrategy is set and deprecated 'running' field is not used
       verify_run_strategy "test-vm" "vm-test" || exit 1
+      verify_no_deprecated_running_field "test-vm" "vm-test" || exit 1
 
       echo "All validations passed"
       exit 0

pkg/toolsets/kubevirt/vm/tests/tasks/create-vm-ubuntu/create-vm-ubuntu.yaml

@@ -19,8 +19,9 @@ steps:
       # Verify container disk is Ubuntu
       verify_container_disk "ubuntu-vm" "vm-test" "ubuntu" || exit 1
 
-      # Verify runStrategy is set
+      # Verify runStrategy is set and deprecated 'running' field is not used
       verify_run_strategy "ubuntu-vm" "vm-test" || exit 1
+      verify_no_deprecated_running_field "ubuntu-vm" "vm-test" || exit 1
 
       echo "All validations passed"
       exit 0

pkg/toolsets/kubevirt/vm/tests/tasks/create-vm-with-instancetype/create-vm-with-instancetype.yaml

@@ -19,8 +19,9 @@ steps:
       # Verify that it has the specific instancetype reference (u1.medium)
       verify_instancetype "test-vm-instancetype" "vm-test" "u1.medium" || exit 1
 
-      # Verify runStrategy is set
+      # Verify runStrategy is set and deprecated 'running' field is not used
       verify_run_strategy "test-vm-instancetype" "vm-test" || exit 1
+      verify_no_deprecated_running_field "test-vm-instancetype" "vm-test" || exit 1
 
       # Verify no direct resource specification (should use instancetype)
       verify_no_direct_resources "test-vm-instancetype" "vm-test"

pkg/toolsets/kubevirt/vm/tests/tasks/create-vm-with-performance/create-vm-with-performance.yaml

@@ -25,8 +25,9 @@ steps:
       # Check if instancetype contains 'medium' (matching the requested size)
       verify_instancetype_contains "test-vm-performance" "vm-test" "medium" "requested size 'medium'"
 
-      # Verify runStrategy is set
+      # Verify runStrategy is set and deprecated 'running' field is not used
       verify_run_strategy "test-vm-performance" "vm-test" || exit 1
+      verify_no_deprecated_running_field "test-vm-performance" "vm-test" || exit 1
 
       # Verify no direct resource specification (should use instancetype)
       verify_no_direct_resources "test-vm-performance" "vm-test"

pkg/toolsets/kubevirt/vm/tests/tasks/create-vm-with-size/create-vm-with-size.yaml

@@ -22,8 +22,9 @@ steps:
       # Check if instancetype contains 'large' (matching the requested size)
       verify_instancetype_contains "test-vm-size" "vm-test" "large" "requested size 'large'"
 
-      # Verify runStrategy is set
+      # Verify runStrategy is set and deprecated 'running' field is not used
       verify_run_strategy "test-vm-size" "vm-test" || exit 1
+      verify_no_deprecated_running_field "test-vm-size" "vm-test" || exit 1
 
       # Verify container disk is Fedora (default workload)
       verify_container_disk "test-vm-size" "vm-test" "fedora"