Add volume attachment waiters

Author: vicentepinto98

services/iaasalpha/wait/wait.go

@@ -34,6 +34,7 @@ type APIClientInterface interface {
 	GetVolumeExecute(ctx context.Context, projectId string, volumeId string) (*iaasalpha.Volume, error)
 	GetServerExecute(ctx context.Context, projectId string, serverId string) (*iaasalpha.Server, error)
 	GetProjectRequestExecute(ctx context.Context, projectId string, requestId string) (*iaasalpha.Request, error)
+	GetAttachedVolumeExecute(ctx context.Context, projectId string, serverId string, volumeId string) (*iaasalpha.VolumeAttachment, error)
 }
 
 // CreateVolumeWaitHandler will wait for volume creation
@@ -234,3 +235,56 @@ func ProjectRequestWaitHandler(ctx context.Context, a APIClientInterface, projec
 	handler.SetTimeout(20 * time.Minute)
 	return handler
 }
+
+// AddVolumeToServerWaitHandler will wait for a volume to be attached to a server
+func AddVolumeToServerWaitHandler(ctx context.Context, a APIClientInterface, projectId, serverId, volumeId string) *wait.AsyncActionHandler[iaasalpha.VolumeAttachment] {
+	handler := wait.New(func() (waitFinished bool, response *iaasalpha.VolumeAttachment, err error) {
+		volumeAttachment, err := a.GetAttachedVolumeExecute(ctx, projectId, serverId, volumeId)
+		if err == nil {
+			if volumeAttachment != nil {
+				if volumeAttachment.VolumeId == nil {
+					return false, volumeAttachment, fmt.Errorf("attachment failed for server with id %s and volume with id %s, the response is not valid: the volume id is missing", serverId, volumeId)
+				}
+				if *volumeAttachment.VolumeId == volumeId {
+					return true, volumeAttachment, nil
+				}
+			}
+			return false, nil, nil
+		}
+		oapiErr, ok := err.(*oapierror.GenericOpenAPIError) //nolint:errorlint //complaining that error.As should be used to catch wrapped errors, but this error should not be wrapped
+		if !ok {
+			return false, volumeAttachment, fmt.Errorf("could not convert error to oapierror.GenericOpenAPIError: %w", err)
+		}
+		if oapiErr.StatusCode != http.StatusNotFound {
+			return false, volumeAttachment, err
+		}
+		return false, nil, nil
+	})
+	handler.SetTimeout(10 * time.Minute)
+	return handler
+}
+
+// RemoveVolumeFromServerWaitHandler will wait for a volume to be attached to a server
+func RemoveVolumeFromServerWaitHandler(ctx context.Context, a APIClientInterface, projectId, serverId, volumeId string) *wait.AsyncActionHandler[iaasalpha.VolumeAttachment] {
+	handler := wait.New(func() (waitFinished bool, response *iaasalpha.VolumeAttachment, err error) {
+		volumeAttachment, err := a.GetAttachedVolumeExecute(ctx, projectId, serverId, volumeId)
+		if err == nil {
+			if volumeAttachment != nil {
+				if volumeAttachment.VolumeId == nil {
+					return false, volumeAttachment, fmt.Errorf("remove volume failed for server with id %s and volume with id %s, the response is not valid: the volume id is missing", serverId, volumeId)
+				}
+			}
+			return false, nil, nil
+		}
+		oapiErr, ok := err.(*oapierror.GenericOpenAPIError) //nolint:errorlint //complaining that error.As should be used to catch wrapped errors, but this error should not be wrapped
+		if !ok {
+			return false, volumeAttachment, fmt.Errorf("could not convert error to oapierror.GenericOpenAPIError: %w", err)
+		}
+		if oapiErr.StatusCode != http.StatusNotFound {
+			return false, volumeAttachment, err
+		}
+		return true, nil, nil
+	})
+	handler.SetTimeout(10 * time.Minute)
+	return handler
+}

services/iaasalpha/wait/wait_test.go

@@ -15,7 +15,9 @@ type apiClientMocked struct {
 	getVolumeFails         bool
 	getServerFails         bool
 	getProjectRequestFails bool
+	getAttachedVolumeFails bool
 	isDeleted              bool
+	isAttached             bool
 	resourceState          string
 	requestAction          string
 	returnResizing         bool
@@ -81,6 +83,25 @@ func (a *apiClientMocked) GetProjectRequestExecute(_ context.Context, _, _ strin
 	}, nil
 }
 
+func (a *apiClientMocked) GetAttachedVolumeExecute(_ context.Context, _, _, _ string) (*iaasalpha.VolumeAttachment, error) {
+	if a.getAttachedVolumeFails {
+		return nil, &oapierror.GenericOpenAPIError{
+			StatusCode: 500,
+		}
+	}
+
+	if !a.isAttached {
+		return nil, &oapierror.GenericOpenAPIError{
+			StatusCode: 404,
+		}
+	}
+
+	return &iaasalpha.VolumeAttachment{
+		ServerId: utils.Ptr("sid"),
+		VolumeId: utils.Ptr("vid"),
+	}, nil
+}
+
 func TestCreateVolumeWaitHandler(t *testing.T) {
 	tests := []struct {
 		desc          string
@@ -507,3 +528,119 @@ func TestProjectRequestWaitHandler(t *testing.T) {
 		})
 	}
 }
+
+func TestAddVolumeToServerWaitHandler(t *testing.T) {
+	tests := []struct {
+		desc       string
+		getFails   bool
+		isAttached bool
+		wantErr    bool
+		wantResp   bool
+	}{
+		{
+			desc:       "attachment_succeeded",
+			getFails:   false,
+			isAttached: true,
+			wantErr:    false,
+			wantResp:   true,
+		},
+		{
+			desc:     "get_fails",
+			getFails: true,
+			wantErr:  true,
+			wantResp: false,
+		},
+		{
+			desc:       "timeout",
+			getFails:   false,
+			isAttached: false,
+			wantErr:    true,
+			wantResp:   false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.desc, func(t *testing.T) {
+			apiClient := &apiClientMocked{
+				getAttachedVolumeFails: tt.getFails,
+				isAttached:             tt.isAttached,
+			}
+
+			var wantRes *iaasalpha.VolumeAttachment
+			if tt.wantResp {
+				wantRes = &iaasalpha.VolumeAttachment{
+					ServerId: utils.Ptr("sid"),
+					VolumeId: utils.Ptr("vid"),
+				}
+			}
+
+			handler := AddVolumeToServerWaitHandler(context.Background(), apiClient, "pid", "sid", "vid")
+
+			gotRes, err := handler.SetTimeout(10 * time.Millisecond).WaitWithContext(context.Background())
+
+			if (err != nil) != tt.wantErr {
+				t.Fatalf("handler error = %v, wantErr %v", err, tt.wantErr)
+			}
+			if !cmp.Equal(gotRes, wantRes) {
+				t.Fatalf("handler gotRes = %v, want %v", gotRes, wantRes)
+			}
+		})
+	}
+}
+
+func TestRemoveVolumeFromServerWaitHandler(t *testing.T) {
+	tests := []struct {
+		desc       string
+		getFails   bool
+		isAttached bool
+		wantErr    bool
+		wantResp   bool
+	}{
+		{
+			desc:       "removal_succeeded",
+			getFails:   false,
+			isAttached: false,
+			wantErr:    false,
+			wantResp:   false,
+		},
+		{
+			desc:     "get_fails",
+			getFails: true,
+			wantErr:  true,
+			wantResp: false,
+		},
+		{
+			desc:       "timeout",
+			getFails:   false,
+			isAttached: true,
+			wantErr:    true,
+			wantResp:   false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.desc, func(t *testing.T) {
+			apiClient := &apiClientMocked{
+				getAttachedVolumeFails: tt.getFails,
+				isAttached:             tt.isAttached,
+			}
+
+			var wantRes *iaasalpha.VolumeAttachment
+			if tt.wantResp {
+				wantRes = &iaasalpha.VolumeAttachment{
+					ServerId: utils.Ptr("sid"),
+					VolumeId: utils.Ptr("vid"),
+				}
+			}
+
+			handler := RemoveVolumeFromServerWaitHandler(context.Background(), apiClient, "pid", "sid", "vid")
+
+			gotRes, err := handler.SetTimeout(10 * time.Millisecond).WaitWithContext(context.Background())
+
+			if (err != nil) != tt.wantErr {
+				t.Fatalf("handler error = %v, wantErr %v", err, tt.wantErr)
+			}
+			if !cmp.Equal(gotRes, wantRes) {
+				t.Fatalf("handler gotRes = %v, want %v", gotRes, wantRes)
+			}
+		})
+	}
+}