api: Report ImageID in Machine.Status

We use the opportunity to streamline some logic in the process.

Signed-off-by: Stephen Finucane <[email protected]>

Author: stephenfin

api/v1alpha5/conversion.go

@@ -219,6 +219,7 @@ func Convert_v1alpha7_OpenStackMachineStatus_To_v1alpha5_OpenStackMachineStatus(
 	}
 
 	in.ServerGroupID = ""
+	in.ImageID = ""
 
 	return nil
 }

api/v1alpha5/zz_generated.conversion.go

@@ -66,6 +66,7 @@ func restorev1alpha7MachineSpec(previous *infrav1.OpenStackMachineSpec, dst *inf
 
 func restorev1alpha7MachineStatus(previous *infrav1.OpenStackMachineStatus, dst *infrav1.OpenStackMachineStatus) {
 	dst.ServerGroupID = previous.ServerGroupID
+	dst.ImageID = previous.ImageID
 }
 
 func restorev1alpha7Bastion(previous **infrav1.Bastion, dst **infrav1.Bastion) {
@@ -369,6 +370,7 @@ func Convert_v1alpha7_OpenStackMachineStatus_To_v1alpha6_OpenStackMachineStatus(
 	}
 
 	in.ServerGroupID = ""
+	in.ImageID = ""
 
 	return nil
 }

api/v1alpha6/conversion.go

@@ -113,6 +113,9 @@ type OpenStackMachineStatus struct {
 	// Addresses contains the OpenStack instance associated addresses.
 	Addresses []corev1.NodeAddress `json:"addresses,omitempty"`
 
+	// ImageID contains the ID of the image this machine was created with.
+	ImageID string `json:"imageID,omitempty"`
+
 	// ServerGroupID contains the ID of the server group this machine is assigned to.
 	ServerGroupID string `json:"serverGroupID,omitempty"`
 

api/v1alpha6/zz_generated.conversion.go

@@ -1609,6 +1609,10 @@ spec:
                 description: MachineStatusError defines errors states for Machine
                   objects.
                 type: string
+              imageID:
+                description: ImageID contains the ID of the image this machine was
+                  created with.
+                type: string
               instanceState:
                 description: InstanceState is the state of the OpenStack instance
                   for this machine.

api/v1alpha7/openstackmachine_types.go

@@ -358,6 +358,14 @@ func (r *OpenStackMachineReconciler) reconcileNormal(ctx context.Context, scope
 	})
 	openStackMachine.Status.Addresses = addresses
 
+	if openStackMachine.Status.ImageID == "" {
+		imageID, err := computeService.GetImageID(openStackMachine.Spec.ImageUUID, openStackMachine.Spec.Image)
+		if err != nil {
+			return ctrl.Result{}, fmt.Errorf("get image: %w", err)
+		}
+		openStackMachine.Status.ImageID = imageID
+	}
+
 	if openStackMachine.Status.ServerGroupID == "" {
 		serverGroupID, err := computeService.GetServerGroupID(openStackMachine.Spec.ServerGroupID, openStackMachine.Spec.ServerGroup) //nolint:staticcheck
 		if err != nil {

config/crd/bases/infrastructure.cluster.x-k8s.io_openstackmachines.yaml

@@ -239,7 +239,7 @@ func (s *Service) createInstanceImpl(eventObject runtime.Object, openStackCluste
 	var server *clients.ServerExt
 	portList := []servers.Network{}
 
-	imageID, err := s.getImageID(instanceSpec.ImageUUID, instanceSpec.Image)
+	imageID, err := s.GetImageID(instanceSpec.ImageUUID, instanceSpec.Image)
 	if err != nil {
 		return nil, fmt.Errorf("error getting image ID: %v", err)
 	}
@@ -568,8 +568,18 @@ func applyServerGroupID(opts servers.CreateOptsBuilder, serverGroupID string) se
 	return opts
 }
 
-// Helper function for getting image id from name.
-func (s *Service) getImageIDFromName(imageName string) (string, error) {
+// Helper function for getting image ID from name or ID.
+func (s *Service) GetImageID(imageUUID, imageName string) (string, error) {
+	if imageUUID != "" {
+		// we return imageUUID without check
+		return imageUUID, nil
+	}
+
+	if imageName == "" {
+		// nothing to lookup if unset
+		return "", nil
+	}
+
 	var opts images.ListOpts
 
 	opts.Name = imageName
@@ -590,18 +600,6 @@ func (s *Service) getImageIDFromName(imageName string) (string, error) {
 	}
 }
 
-// Helper function for getting image ID from name or ID.
-func (s *Service) getImageID(imageUUID, imageName string) (string, error) {
-	if imageUUID != "" {
-		// we return imageUUID without check
-		return imageUUID, nil
-	} else if imageName != "" {
-		return s.getImageIDFromName(imageName)
-	}
-
-	return "", nil
-}
-
 func (s *Service) GetServerGroupID(serverGroupID string, serverGroupFilter *infrav1.ServerGroupFilter) (string, error) {
 	if serverGroupFilter == nil {
 		if serverGroupID == "" {

controllers/openstackmachine_controller.go

@@ -324,13 +324,13 @@ func TestService_getImageID(t *testing.T) {
 			}
 			tt.expect(mockScopeFactory.ImageClient.EXPECT())
 
-			got, err := s.getImageID(tt.imageUUID, tt.imageName)
+			got, err := s.GetImageID(tt.imageUUID, tt.imageName)
 			if (err != nil) != tt.wantErr {
-				t.Errorf("Service.getImageID() error = %v, wantErr %v", err, tt.wantErr)
+				t.Errorf("Service.GetImageID() error = %v, wantErr %v", err, tt.wantErr)
 				return
 			}
 			if got != tt.want {
-				t.Errorf("Service.getImageID() = %v, want %v", got, tt.want)
+				t.Errorf("Service.GetImageID() = %v, want %v", got, tt.want)
 			}
 		})
 	}