Merge branch 'main' into si/vpn-waiter

Author: s-inter

CHANGELOG.md

@@ -178,6 +178,9 @@
     - **Dependencies:** Bump STACKIT SDK core module from `v0.24.1` to `v0.25.0`
   - [v1.12.2](services/loadbalancer/CHANGELOG.md#v1122)
     - **Dependencies:** Bump STACKIT SDK core module to `v0.26.0`
+  - [v1.13.0](services/loadbalancer/CHANGELOG.md#v1130)
+    - **Improvement:** Use new WaiterHelper for LoadBalancer waiters
+    - **Breaking Change:** `v2api/wait/DeleteLoadBalancerWaitHandler` now returns a `LoadBalancer` instead of `struct{}`
 - `logme`: 
   - [v0.27.3](services/logme/CHANGELOG.md#v0273) 
     - **Dependencies:** Bump STACKIT SDK core module from `v0.24.0` to `v0.24.1`
@@ -196,6 +199,8 @@
     - **Dependencies:** Bump STACKIT SDK core module from `v0.24.1` to `v0.25.0`
   - [v0.8.2](services/logs/CHANGELOG.md#v082)
     - **Dependencies:** Bump STACKIT SDK core module from `v0.25.0` to `v0.26.0`
+  - [v0.9.0](services/logs/CHANGELOG.md#v090)
+    - **Improvement:** Use new WaiterHelper for Logs waiters
 - `mariadb`:
   - [v0.27.3](services/mariadb/CHANGELOG.md#v0273) 
     - **Dependencies:** Bump STACKIT SDK core module from `v0.24.0` to `v0.24.1`

services/loadbalancer/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.13.0
+- **Improvement:** Use new WaiterHelper for LoadBalancer waiters
+- **Breaking Change:** `v2api/wait/DeleteLoadBalancerWaitHandler` now returns a `LoadBalancer` instead of `struct{}`
+
 ## v1.12.2
 - **Dependencies:** Bump STACKIT SDK core module to `v0.26.0`
 

services/loadbalancer/VERSION

@@ -1 +1 @@
-v1.12.2
+v1.13.0

services/loadbalancer/v2api/wait/wait.go

@@ -2,12 +2,11 @@ package wait
 
 import (
 	"context"
+	"errors"
 	"fmt"
-	"net/http"
 	"strings"
 	"time"
 
-	"github.com/stackitcloud/stackit-sdk-go/core/oapierror"
 	"github.com/stackitcloud/stackit-sdk-go/core/wait"
 	loadbalancer "github.com/stackitcloud/stackit-sdk-go/services/loadbalancer/v2api"
 )
@@ -23,58 +22,42 @@ const (
 
 // CreateLoadBalancerWaitHandler will wait for load balancer creation
 func CreateLoadBalancerWaitHandler(ctx context.Context, a loadbalancer.DefaultAPI, projectId, region, instanceName string) *wait.AsyncActionHandler[loadbalancer.LoadBalancer] {
-	handler := wait.New(func() (waitFinished bool, response *loadbalancer.LoadBalancer, err error) {
-		s, err := a.GetLoadBalancer(ctx, projectId, region, instanceName).Execute()
-		if err != nil {
-			return false, nil, err
-		}
-		if s == nil || s.Name == nil || *s.Name != instanceName || s.Status == nil {
-			return false, nil, nil
-		}
-
-		var errors []string
-		if len(s.Errors) > 0 {
-			for _, err := range s.Errors {
-				errors = append(errors, fmt.Sprintf("%s: %s", *err.Type, *err.Description))
+	waitConfig := wait.WaiterHelper[loadbalancer.LoadBalancer, string]{
+		FetchInstance: a.GetLoadBalancer(ctx, projectId, region, instanceName).Execute,
+		GetState: func(r *loadbalancer.LoadBalancer) (string, error) {
+			if r == nil || r.Status == nil {
+				return "", errors.New("response or status is nil")
 			}
-			return true, s, fmt.Errorf("create failed for instance with name %s, got status %s and errors: %s", instanceName, *s.Status, strings.Join(errors, ";"))
-		}
-
-		switch *s.Status {
-		case LOADBALANCERSTATUS_READY:
-			return true, s, nil
-		case LOADBALANCERSTATUS_UNSPECIFIED:
-			return false, nil, nil
-		case LOADBALANCERSTATUS_PENDING:
-			return false, nil, nil
-		case LOADBALANCERSTATUS_TERMINATING:
-			return true, s, fmt.Errorf("create failed for instance with name %s, got status %s", instanceName, LOADBALANCERSTATUS_TERMINATING)
-		case LOADBALANCERSTATUS_ERROR:
-			return true, s, fmt.Errorf("create failed for instance with name %s, got status %s", instanceName, LOADBALANCERSTATUS_ERROR)
-		default:
-			return true, s, fmt.Errorf("instance with name %s has unexpected status %s", instanceName, *s.Status)
-		}
-	})
+			var sb strings.Builder
+			if r.Errors != nil {
+				for _, err := range r.Errors {
+					sb.WriteString(fmt.Sprintf("%s: %s; ", *err.Type, *err.Description))
+				}
+				return "", fmt.Errorf("create failed for instance with name %s, got status %s and errors: %s", instanceName, *r.Status, sb.String())
+			}
+			return *r.Status, nil
+		},
+		ActiveState: []string{LOADBALANCERSTATUS_READY},
+		ErrorState:  []string{LOADBALANCERSTATUS_TERMINATING, LOADBALANCERSTATUS_ERROR},
+	}
+	handler := wait.New(waitConfig.Wait())
 	handler.SetTimeout(45 * time.Minute)
 	return handler
 }
 
 // DeleteLoadBalancerWaitHandler will wait for load balancer deletion
-func DeleteLoadBalancerWaitHandler(ctx context.Context, a loadbalancer.DefaultAPI, projectId, region, instanceId string) *wait.AsyncActionHandler[struct{}] {
-	handler := wait.New(func() (waitFinished bool, response *struct{}, err error) {
-		_, err = a.GetLoadBalancer(ctx, projectId, region, instanceId).Execute()
-		if err == 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, nil, fmt.Errorf("could not convert error to oapierror.GenericOpenAPIError")
-		}
-		if oapiErr.StatusCode != http.StatusNotFound {
-			return false, nil, err
-		}
-		return true, nil, nil
-	})
+func DeleteLoadBalancerWaitHandler(ctx context.Context, a loadbalancer.DefaultAPI, projectId, region, instanceId string) *wait.AsyncActionHandler[loadbalancer.LoadBalancer] {
+	waitConfig := wait.WaiterHelper[loadbalancer.LoadBalancer, string]{
+		FetchInstance: a.GetLoadBalancer(ctx, projectId, region, instanceId).Execute,
+		GetState: func(l *loadbalancer.LoadBalancer) (string, error) {
+			if l == nil || l.Status == nil {
+				return "", errors.New("response or status is nil")
+			}
+			return *l.Status, nil
+		},
+		ErrorState: []string{LOADBALANCERSTATUS_ERROR},
+	}
+	handler := wait.New(waitConfig.Wait())
 	handler.SetTimeout(15 * time.Minute)
 	return handler
 }

services/logs/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v0.9.0
+- **Improvement:** Use new WaiterHelper for Logs waiters
+
 ## v0.8.2
 - **Dependencies:** Bump STACKIT SDK core module from `v0.25.0` to `v0.26.0`
 

services/logs/VERSION

@@ -1 +1 @@
-v0.8.2
+v0.9.0

services/logs/v1api/wait/wait.go

@@ -7,7 +7,6 @@ import (
 	"net/http"
 	"time"
 
-	"github.com/stackitcloud/stackit-sdk-go/core/oapierror"
 	"github.com/stackitcloud/stackit-sdk-go/core/wait"
 	logs "github.com/stackitcloud/stackit-sdk-go/services/logs/v1api"
 )
@@ -17,39 +16,42 @@ const (
 	instanceStatusDeleting = "deleting"
 )
 
+// CreateLogsInstanceWaitHandler will wait for logs instance creation
 func CreateLogsInstanceWaitHandler(ctx context.Context, client logs.DefaultAPI, projectID, region, instanceID string) *wait.AsyncActionHandler[logs.LogsInstance] {
-	handler := wait.New(func() (waitFinished bool, response *logs.LogsInstance, err error) {
-		instance, err := client.GetLogsInstance(ctx, projectID, region, instanceID).Execute()
-		if err != nil {
-			return false, nil, err
-		}
-		if instance.Id == instanceID && instance.Status == instanceStatusActive {
-			return true, instance, nil
-		}
-		if instance.Status == instanceStatusDeleting {
-			return true, nil, fmt.Errorf("creating log instance failed, instance is being deleted")
-		}
-		return false, nil, nil
-	})
+	waitConfig := wait.WaiterHelper[logs.LogsInstance, string]{
+		FetchInstance: client.GetLogsInstance(ctx, projectID, region, instanceID).Execute,
+		GetState: func(l *logs.LogsInstance) (string, error) {
+			if l == nil {
+				return "", fmt.Errorf("empty response")
+			}
+			if l.Status == "" {
+				return "", fmt.Errorf("instance status is empty")
+			}
+			return l.Status, nil
+		},
+		ActiveState: []string{instanceStatusActive},
+		ErrorState:  []string{instanceStatusDeleting},
+	}
+
+	handler := wait.New(waitConfig.Wait())
 	handler.SetTimeout(10 * time.Minute)
 	return handler
 }
 
+// DeleteLogsInstanceWaitHandler will wait for logs instance deletion
 func DeleteLogsInstanceWaitHandler(ctx context.Context, client logs.DefaultAPI, projectID, region, instanceID string) *wait.AsyncActionHandler[logs.LogsInstance] {
-	handler := wait.New(func() (waitFinished bool, response *logs.LogsInstance, err error) {
-		_, err = client.GetLogsInstance(ctx, projectID, region, instanceID).Execute()
-		// the instances is still gettable, e.g. not deleted, when the errors is null
-		if err == nil {
-			return false, nil, nil
-		}
-		var oapiError *oapierror.GenericOpenAPIError
-		if errors.As(err, &oapiError) {
-			if statusCode := oapiError.StatusCode; statusCode == http.StatusNotFound {
-				return true, nil, nil
+	waitConfig := wait.WaiterHelper[logs.LogsInstance, string]{
+		FetchInstance: client.GetLogsInstance(ctx, projectID, region, instanceID).Execute,
+		GetState: func(l *logs.LogsInstance) (string, error) {
+			if l == nil {
+				return "", errors.New("empty response")
 			}
-		}
-		return false, nil, err
-	})
+			return l.Status, nil
+		},
+		DeleteHttpErrorStatusCodes: []int{http.StatusNotFound},
+	}
+
+	handler := wait.New(waitConfig.Wait())
 	handler.SetTimeout(10 * time.Minute)
 	return handler
 }

services/logs/v1api/wait/wait_test.go

@@ -74,16 +74,6 @@ func TestCreateLogsInstanceWaitHandler(t *testing.T) {
 				Status: instanceStatusActive,
 			},
 		},
-		{
-			description:    "create without id",
-			getFails:       false,
-			wantErr:        true,
-			wantResp:       false,
-			returnInstance: true,
-			getLogsResponse: &logs.LogsInstance{
-				Status: instanceStatusActive,
-			},
-		},
 		{
 			description:    "create without status",
 			getFails:       false,
@@ -99,7 +89,7 @@ func TestCreateLogsInstanceWaitHandler(t *testing.T) {
 			getFails:       false,
 			wantErr:        true,
 			wantResp:       false,
-			returnInstance: true,
+			returnInstance: false,
 			getLogsResponse: &logs.LogsInstance{
 				Id:     instanceId,
 				Status: instanceStatusDeleting,