vSphere-don't use template,ClusterOSImage together

This commit adds validation for vSphere.
Failure Domain templates should not be used
together with ClusterOSImage.

Co-Authored-By: Cursor [email protected]

Author: jcpowermac

pkg/types/vsphere/validation/platform.go

@@ -46,7 +46,7 @@ func ValidatePlatform(p *vsphere.Platform, agentBasedInstallation bool, fldPath
 		if len(p.FailureDomains) == 0 {
 			return append(allErrs, field.Required(fldPath.Child("failureDomains"), "must be defined"))
 		}
-		allErrs = append(allErrs, validateFailureDomains(p, fldPath.Child("failureDomains"), isLegacyUpi)...)
+		allErrs = append(allErrs, validateFailureDomains(p, fldPath, fldPath.Child("failureDomains"), isLegacyUpi)...)
 
 		// Validate hosts if configured for static IP
 		if p.Hosts != nil {
@@ -68,7 +68,7 @@ func ValidatePlatform(p *vsphere.Platform, agentBasedInstallation bool, fldPath
 			if p.FailureDomains[0].Name != conversion.GeneratedFailureDomainName &&
 				p.FailureDomains[0].Zone != conversion.GeneratedFailureDomainZone &&
 				p.FailureDomains[0].Region != conversion.GeneratedFailureDomainRegion {
-				allErrs = append(allErrs, validateFailureDomains(p, fldPath.Child("failureDomains"), isLegacyUpi)...)
+				allErrs = append(allErrs, validateFailureDomains(p, fldPath, fldPath.Child("failureDomains"), isLegacyUpi)...)
 			}
 		}
 	}
@@ -151,7 +151,7 @@ func validateVCenters(p *vsphere.Platform, fldPath *field.Path) field.ErrorList
 	return allErrs
 }
 
-func validateFailureDomains(p *vsphere.Platform, fldPath *field.Path, isLegacyUpi bool) field.ErrorList {
+func validateFailureDomains(p *vsphere.Platform, platformFldPath *field.Path, fldPath *field.Path, isLegacyUpi bool) field.ErrorList { //nolint:gocyclo
 	var fdNames []string
 	tagUrnPattern := regexp.MustCompile(`^(urn):(vmomi):(InventoryServiceTag):([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}):([^:]+)$`)
 	allErrs := field.ErrorList{}
@@ -320,6 +320,12 @@ func validateFailureDomains(p *vsphere.Platform, fldPath *field.Path, isLegacyUp
 			p.FailureDomains[index].Topology.ResourcePool = filepath.Clean(p.FailureDomains[index].Topology.ResourcePool)
 		}
 
+		// Validate that template and clusterOSImage are mutually exclusive
+		if len(failureDomain.Topology.Template) > 0 && len(p.ClusterOSImage) > 0 {
+			allErrs = append(allErrs, field.Invalid(topologyFld.Child("template"), failureDomain.Topology.Template, "cannot be specified when clusterOSImage is set"))
+			allErrs = append(allErrs, field.Invalid(platformFldPath.Child("clusterOSImage"), p.ClusterOSImage, "cannot be specified when failuredomain.topology.template is set"))
+		}
+
 		if len(failureDomain.Topology.Template) > 0 {
 			p.FailureDomains[index].Topology.Template = filepath.Clean(p.FailureDomains[index].Topology.Template)
 		}

pkg/types/vsphere/validation/platform_test.go

@@ -952,6 +952,32 @@ func TestValidatePlatform(t *testing.T) {
 			}(),
 			expectedError: `test-path.failureDomains.topology.networks: Required value: must specify a network`,
 		},
+		{
+			name: "Valid - template without clusterOSImage",
+			platform: func() *vsphere.Platform {
+				p := validPlatform()
+				p.FailureDomains[0].Topology.Template = "/test-datacenter/vm/test-template"
+				return p
+			}(),
+		},
+		{
+			name: "Valid - clusterOSImage without template",
+			platform: func() *vsphere.Platform {
+				p := validPlatform()
+				p.ClusterOSImage = "http://example.com/rhcos.ova"
+				return p
+			}(),
+		},
+		{
+			name: "Invalid - both template and clusterOSImage",
+			platform: func() *vsphere.Platform {
+				p := validPlatform()
+				p.FailureDomains[0].Topology.Template = "/test-datacenter/vm/test-template"
+				p.ClusterOSImage = "http://example.com/rhcos.ova"
+				return p
+			}(),
+			expectedError: `test-path.failureDomains.topology.template: Invalid value: "/test-datacenter/vm/test-template": cannot be specified when clusterOSImage is set, test-path.clusterOSImage: Invalid value: "http://example.com/rhcos.ova": cannot be specified when failuredomain.topology.template is set`,
+		},
 	}
 	for _, tc := range cases {
 		t.Run(tc.name, func(t *testing.T) {