Convert baremetalSetTemplate field to pointer

As this field is optional we should make it a
pointer which ensures proper optional validation
i.e  struct is optional, but if it is provided,
some of its internal fields can be required.

Depends-On: openstack-k8s-operators/openstack-baremetal-operator#328
Signed-off-by: rabi <ramishra@redhat.com>

Author: rabi

apis/dataplane/v1beta1/openstackdataplanenodeset_types.go

@@ -37,7 +37,7 @@ import (
 type OpenStackDataPlaneNodeSetSpec struct {
 	// +kubebuilder:validation:Optional
 	// BaremetalSetTemplate Template for BaremetalSet for the NodeSet
-	BaremetalSetTemplate baremetalv1.OpenStackBaremetalSetTemplateSpec `json:"baremetalSetTemplate,omitempty"`
+	BaremetalSetTemplate *baremetalv1.OpenStackBaremetalSetTemplateSpec `json:"baremetalSetTemplate,omitempty"`
 
 	// +kubebuilder:validation:Required
 	// NodeTemplate - node attributes specific to nodes defined by this resource. These

apis/dataplane/v1beta1/openstackdataplanenodeset_webhook.go

@@ -68,7 +68,11 @@ func (r *OpenStackDataPlaneNodeSet) Default() {
 
 // Default - set defaults for this OpenStackDataPlaneNodeSet Spec
 func (spec *OpenStackDataPlaneNodeSetSpec) Default() {
-	domain := spec.BaremetalSetTemplate.DomainName
+	var domain string
+	if spec.BaremetalSetTemplate != nil {
+		domain = spec.BaremetalSetTemplate.DomainName
+	}
+
 	for nodeName, node := range spec.Nodes {
 		if node.HostName == "" {
 			node.HostName = nodeName
@@ -82,7 +86,7 @@ func (spec *OpenStackDataPlaneNodeSetSpec) Default() {
 		spec.Nodes[nodeName] = *node.DeepCopy()
 	}
 
-	if !spec.PreProvisioned {
+	if !spec.PreProvisioned && spec.BaremetalSetTemplate != nil {
 		spec.NodeTemplate.Ansible.AnsibleUser = spec.BaremetalSetTemplate.CloudUserName
 		if spec.BaremetalSetTemplate.DeploymentSSHSecret == "" {
 			spec.BaremetalSetTemplate.DeploymentSSHSecret = spec.NodeTemplate.AnsibleSSHPrivateKeySecret
@@ -212,12 +216,14 @@ func (r *OpenStackDataPlaneNodeSetSpec) ValidateUpdate(oldSpec *OpenStackDataPla
 	// to the openstack-baremetal-operator webhook to avoid duplicating logic.
 	if !reflect.DeepEqual(r.BaremetalSetTemplate, oldSpec.BaremetalSetTemplate) {
 		// Call openstack-baremetal-operator webhook Validate() to parse changes
-		err := r.BaremetalSetTemplate.ValidateTemplate(
-			len(oldSpec.Nodes), oldSpec.BaremetalSetTemplate)
-		if err != nil {
-			errors = append(errors, field.Forbidden(
-				field.NewPath("spec.baremetalSetTemplate"),
-				fmt.Sprintf("%s", err)))
+		if r.BaremetalSetTemplate != nil && oldSpec.BaremetalSetTemplate != nil {
+			err := r.BaremetalSetTemplate.ValidateTemplate(
+				len(oldSpec.Nodes), *oldSpec.BaremetalSetTemplate)
+			if err != nil {
+				errors = append(errors, field.Forbidden(
+					field.NewPath("spec.baremetalSetTemplate"),
+					fmt.Sprintf("%s", err)))
+			}
 		}
 	}
 

apis/dataplane/v1beta1/zz_generated.deepcopy.go

@@ -61,16 +61,18 @@ func DeployBaremetalSet(
 		ownerLabels := labels.GetLabels(instance, labels.GetGroupLabel(NodeSetLabel), map[string]string{})
 		baremetalSet.Labels = utils.MergeStringMaps(baremetalSet.GetLabels(), ownerLabels)
 		baremetalSet.Spec.BaremetalHosts = make(map[string]baremetalv1.InstanceSpec)
-		instance.Spec.BaremetalSetTemplate.DeepCopyInto(&baremetalSet.Spec.OpenStackBaremetalSetTemplateSpec)
-		// Set Images
-		if containerImages.OsContainerImage != nil && instance.Spec.BaremetalSetTemplate.OSContainerImageURL == "" {
-			baremetalSet.Spec.OSContainerImageURL = *containerImages.OsContainerImage
-		}
-		if containerImages.AgentImage != nil && instance.Spec.BaremetalSetTemplate.AgentImageURL == "" {
-			baremetalSet.Spec.AgentImageURL = *containerImages.AgentImage
-		}
-		if containerImages.ApacheImage != nil && instance.Spec.BaremetalSetTemplate.ApacheImageURL == "" {
-			baremetalSet.Spec.ApacheImageURL = *containerImages.ApacheImage
+		if instance.Spec.BaremetalSetTemplate != nil {
+			instance.Spec.BaremetalSetTemplate.DeepCopyInto(&baremetalSet.Spec.OpenStackBaremetalSetTemplateSpec)
+			// Set Images
+			if containerImages.OsContainerImage != nil && instance.Spec.BaremetalSetTemplate.OSContainerImageURL == "" {
+				baremetalSet.Spec.OSContainerImageURL = *containerImages.OsContainerImage
+			}
+			if containerImages.AgentImage != nil && instance.Spec.BaremetalSetTemplate.AgentImageURL == "" {
+				baremetalSet.Spec.AgentImageURL = *containerImages.AgentImage
+			}
+			if containerImages.ApacheImage != nil && instance.Spec.BaremetalSetTemplate.ApacheImageURL == "" {
+				baremetalSet.Spec.ApacheImageURL = *containerImages.ApacheImage
+			}
 		}
 
 		for _, node := range instance.Spec.Nodes {

pkg/dataplane/baremetal.go

@@ -51,8 +51,10 @@ var _ = Describe("DataplaneNodeSet Webhook", func() {
 		It("Should block changes to the BmhLabelSelector object in baremetalSetTemplate spec", func() {
 			Eventually(func(_ Gomega) string {
 				instance := GetDataplaneNodeSet(dataplaneNodeSetName)
-				instance.Spec.BaremetalSetTemplate.BmhLabelSelector = map[string]string{
-					"app": "openstack1",
+				if instance.Spec.BaremetalSetTemplate != nil {
+					instance.Spec.BaremetalSetTemplate.BmhLabelSelector = map[string]string{
+						"app": "openstack1",
+					}
 				}
 				err := th.K8sClient.Update(th.Ctx, instance)
 				return fmt.Sprintf("%s", err)
@@ -80,9 +82,11 @@ var _ = Describe("DataplaneNodeSet Webhook", func() {
 		It("Should allow changes to the CloudUserName", func() {
 			Eventually(func(_ Gomega) error {
 				instance := GetDataplaneNodeSet(dataplaneNodeSetName)
-				instance.Spec.BaremetalSetTemplate.CloudUserName = "new-user"
-				instance.Spec.BaremetalSetTemplate.BmhLabelSelector = map[string]string{
-					"app": "test-openstack",
+				if instance.Spec.BaremetalSetTemplate != nil {
+					instance.Spec.BaremetalSetTemplate.CloudUserName = "new-user"
+					instance.Spec.BaremetalSetTemplate.BmhLabelSelector = map[string]string{
+						"app": "test-openstack",
+					}
 				}
 
 				return th.K8sClient.Update(th.Ctx, instance)