add ReadyForNetworkAreaDeletionWaitHandler

services/iaas/go.mod

@@ -5,6 +5,7 @@ go 1.21
 require (
 	github.com/google/go-cmp v0.7.0
 	github.com/stackitcloud/stackit-sdk-go/core v0.17.3
+	github.com/stackitcloud/stackit-sdk-go/services/resourcemanager v0.17.1
 )
 
 require (

services/iaas/go.sum

@@ -6,3 +6,5 @@ github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/stackitcloud/stackit-sdk-go/core v0.17.3 h1:GsZGmRRc/3GJLmCUnsZswirr5wfLRrwavbnL/renOqg=
 github.com/stackitcloud/stackit-sdk-go/core v0.17.3/go.mod h1:HBCXJGPgdRulplDzhrmwC+Dak9B/x0nzNtmOpu+1Ahg=
+github.com/stackitcloud/stackit-sdk-go/services/resourcemanager v0.17.1 h1:r7oaINTwLmIG31AaqKTuQHHFF8YNuYGzi+46DOuSjw4=
+github.com/stackitcloud/stackit-sdk-go/services/resourcemanager v0.17.1/go.mod h1:ipcrPRbwfQXHH18dJVfY7K5ujHF5dTT6isoXgmA7YwQ=

services/iaas/wait/wait.go

@@ -2,15 +2,16 @@ package wait
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"net/http"
+	"strings"
 	"time"
 
-	"errors"
-
 	"github.com/stackitcloud/stackit-sdk-go/core/oapierror"
 	"github.com/stackitcloud/stackit-sdk-go/core/wait"
 	"github.com/stackitcloud/stackit-sdk-go/services/iaas"
+	"github.com/stackitcloud/stackit-sdk-go/services/resourcemanager"
 )
 
 const (
@@ -48,6 +49,7 @@ const (
 // Interfaces needed for tests
 type APIClientInterface interface {
 	GetNetworkAreaExecute(ctx context.Context, organizationId, areaId string) (*iaas.NetworkArea, error)
+	ListNetworkAreaProjectsExecute(ctx context.Context, organizationId, areaId string) (*iaas.ProjectListResponse, error)
 	GetProjectRequestExecute(ctx context.Context, projectId string, requestId string) (*iaas.Request, error)
 	GetNetworkExecute(ctx context.Context, projectId, networkId string) (*iaas.Network, error)
 	GetVolumeExecute(ctx context.Context, projectId string, volumeId string) (*iaas.Volume, error)
@@ -58,6 +60,10 @@ type APIClientInterface interface {
 	GetSnapshotExecute(ctx context.Context, projectId string, snapshotId string) (*iaas.Snapshot, error)
 }
 
+type ResourceManagerAPIClientInterface interface {
+	GetProjectExecute(ctx context.Context, id string) (*resourcemanager.GetProjectResponse, error)
+}
+
 // CreateNetworkAreaWaitHandler will wait for network area creation
 func CreateNetworkAreaWaitHandler(ctx context.Context, a APIClientInterface, organizationId, areaId string) *wait.AsyncActionHandler[iaas.NetworkArea] {
 	handler := wait.New(func() (waitFinished bool, response *iaas.NetworkArea, err error) {
@@ -98,6 +104,53 @@ func UpdateNetworkAreaWaitHandler(ctx context.Context, a APIClientInterface, org
 	return handler
 }
 
+// ReadyForNetworkAreaDeletionWaitHandler will wait until a deletion of network area is possible
+// Workaround for https://github.com/stackitcloud/terraform-provider-stackit/issues/907.
+// When the deletion for a project is triggered, the backend starts a workflow in the background which cleans up all resources
+// within a project and deletes the project in each service. When the project is attached to an SNA, the SNA can't be
+// deleted until the workflow inform the IaaS-API that the project is deleted.
+func ReadyForNetworkAreaDeletionWaitHandler(ctx context.Context, a APIClientInterface, r ResourceManagerAPIClientInterface, organizationId, areaId string) *wait.AsyncActionHandler[iaas.ProjectListResponse] {
+	handler := wait.New(func() (waitFinished bool, response *iaas.ProjectListResponse, err error) {
+		projectList, err := a.ListNetworkAreaProjectsExecute(ctx, organizationId, areaId)
+		if err != nil {
+			return false, projectList, err
+		}
+		if projectList.Items == nil {
+			return false, nil, fmt.Errorf("read failed for projects in network area with id %s, the response is not valid: the items are missing", areaId)
+		}
+		if len(*projectList.Items) == 0 {
+			return true, projectList, nil
+		}
+		var activeProjects []string
+		var forbiddenProjects []string
+		for _, projectId := range *projectList.Items {
+			_, err := r.GetProjectExecute(ctx, projectId)
+			if err == nil {
+				activeProjects = append(activeProjects, projectId)
+				continue
+			}
+			var oapiErr *oapierror.GenericOpenAPIError
+			ok := errors.As(err, &oapiErr)
+			if !ok {
+				return false, nil, fmt.Errorf("could not convert error to oapierror.GenericOpenAPIError")
+			}
+			// The resource manager api responds with StatusForbidden(=403) when a project is deleted or if the project does not exist
+			if oapiErr.StatusCode == http.StatusNotFound || oapiErr.StatusCode == http.StatusForbidden {
+				forbiddenProjects = append(forbiddenProjects, projectId)
+			}
+		}
+		if len(activeProjects) > 0 {
+			return false, nil, fmt.Errorf("network area with id %s has still active projects: %s", areaId, strings.Join(activeProjects, ","))
+		}
+		if len(forbiddenProjects) > 0 {
+			return false, nil, nil
+		}
+		return true, projectList, nil
+	})
+	handler.SetTimeout(1 * time.Minute)
+	return handler
+}
+
 // DeleteNetworkAreaWaitHandler will wait for network area deletion
 func DeleteNetworkAreaWaitHandler(ctx context.Context, a APIClientInterface, organizationId, areaId string) *wait.AsyncActionHandler[iaas.NetworkArea] {
 	handler := wait.New(func() (waitFinished bool, response *iaas.NetworkArea, err error) {

services/iaas/wait/wait_test.go

@@ -2,30 +2,63 @@ package wait
 
 import (
 	"context"
+	"net/http"
 	"testing"
 	"time"
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/stackitcloud/stackit-sdk-go/core/oapierror"
 	"github.com/stackitcloud/stackit-sdk-go/core/utils"
 	"github.com/stackitcloud/stackit-sdk-go/services/iaas"
+	"github.com/stackitcloud/stackit-sdk-go/services/resourcemanager"
 )
 
 type apiClientMocked struct {
-	getNetworkAreaFails    bool
-	getNetworkFails        bool
-	getProjectRequestFails bool
-	isDeleted              bool
-	resourceState          string
-	getVolumeFails         bool
-	getServerFails         bool
-	getAttachedVolumeFails bool
-	getImageFails          bool
-	getBackupFails         bool
-	isAttached             bool
-	requestAction          string
-	returnResizing         bool
-	getSnapshotFails       bool
+	getNetworkAreaFails      bool
+	getNetworkFails          bool
+	getProjectRequestFails   bool
+	isDeleted                bool
+	resourceState            string
+	getVolumeFails           bool
+	getServerFails           bool
+	getAttachedVolumeFails   bool
+	getImageFails            bool
+	getBackupFails           bool
+	isAttached               bool
+	requestAction            string
+	returnResizing           bool
+	getSnapshotFails         bool
+	listProjectsResponses    []listProjectsResponses
+	listProjectsResponsesIdx int
+}
+
+type listProjectsResponses struct {
+	resp *iaas.ProjectListResponse
+	err  error
+}
+
+type resourceManagerClientMocked struct {
+	getProjectResponses    []getProjectResponse
+	getProjectResponsesIdx int
+}
+
+type getProjectResponse struct {
+	resp *resourcemanager.GetProjectResponse
+	err  error
+}
+
+func (r *resourceManagerClientMocked) GetProjectExecute(_ context.Context, _ string) (*resourcemanager.GetProjectResponse, error) {
+	resp := r.getProjectResponses[r.getProjectResponsesIdx].resp
+	err := r.getProjectResponses[r.getProjectResponsesIdx].err
+	r.getProjectResponsesIdx = (r.getProjectResponsesIdx + 1) % len(r.getProjectResponses)
+	return resp, err
+}
+
+func (a *apiClientMocked) ListNetworkAreaProjectsExecute(_ context.Context, _, _ string) (*iaas.ProjectListResponse, error) {
+	resp := a.listProjectsResponses[a.listProjectsResponsesIdx].resp
+	err := a.listProjectsResponses[a.listProjectsResponsesIdx].err
+	a.listProjectsResponsesIdx = (a.listProjectsResponsesIdx + 1) % len(a.listProjectsResponses)
+	return resp, err
 }
 
 func (a *apiClientMocked) GetNetworkAreaExecute(_ context.Context, _, _ string) (*iaas.NetworkArea, error) {
@@ -1856,3 +1889,152 @@ func TestDeleteSnapshotWaitHandler(t *testing.T) {
 		})
 	}
 }
+
+func TestReadyForNetworkAreaDeletionWaitHandler(t *testing.T) {
+	tests := []struct {
+		desc                  string
+		listProjectsResponses []listProjectsResponses
+		getProjectResponses   []getProjectResponse
+		wantErr               bool
+		wantResp              bool
+	}{
+		{
+			desc: "projects still active",
+			listProjectsResponses: []listProjectsResponses{
+				{
+					resp: &iaas.ProjectListResponse{
+						Items: utils.Ptr([]string{"project1", "project2"}),
+					},
+					err: nil,
+				},
+			},
+			getProjectResponses: []getProjectResponse{
+				{&resourcemanager.GetProjectResponse{}, nil},
+				{&resourcemanager.GetProjectResponse{}, nil},
+			},
+			wantErr:  true,
+			wantResp: false,
+		},
+		{
+			desc: "no projects - ready for deletion",
+			listProjectsResponses: []listProjectsResponses{
+				{
+					resp: &iaas.ProjectListResponse{
+						Items: utils.Ptr([]string{}),
+					},
+					err: nil,
+				},
+			},
+			getProjectResponses: []getProjectResponse{},
+			wantErr:             false,
+			wantResp:            true,
+		},
+		{
+			desc: "projects in deletion state",
+			listProjectsResponses: []listProjectsResponses{
+				{
+					resp: &iaas.ProjectListResponse{
+						Items: utils.Ptr([]string{"project1", "project2"}),
+					},
+					err: nil,
+				},
+				{
+					resp: &iaas.ProjectListResponse{
+						Items: utils.Ptr([]string{}),
+					},
+					err: nil,
+				},
+			},
+			getProjectResponses: []getProjectResponse{
+				{nil, oapierror.NewError(http.StatusForbidden, "")},
+				{nil, oapierror.NewError(http.StatusForbidden, "")},
+			},
+			wantErr:  false,
+			wantResp: true,
+		},
+		{
+			desc: "network area includes one active project",
+			listProjectsResponses: []listProjectsResponses{
+				{
+					resp: &iaas.ProjectListResponse{
+						Items: utils.Ptr([]string{"project1", "project2", "project3"}),
+					},
+					err: nil,
+				},
+			},
+			getProjectResponses: []getProjectResponse{
+				{nil, oapierror.NewError(http.StatusForbidden, "")},
+				{nil, oapierror.NewError(http.StatusForbidden, "")},
+				{&resourcemanager.GetProjectResponse{}, nil},
+			},
+			wantErr:  true,
+			wantResp: false,
+		},
+		{
+			desc: "network area not found",
+			listProjectsResponses: []listProjectsResponses{
+				{
+					resp: nil,
+					err:  oapierror.NewError(http.StatusNotFound, "not found"),
+				},
+			},
+			getProjectResponses: []getProjectResponse{},
+			wantErr:             true,
+			wantResp:            false,
+		},
+		{
+			desc: "network area items is nil",
+			listProjectsResponses: []listProjectsResponses{
+				{
+					resp: &iaas.ProjectListResponse{
+						Items: nil,
+					},
+				},
+			},
+			wantErr:  true,
+			wantResp: false,
+		},
+		{
+			desc: "timeout",
+			listProjectsResponses: []listProjectsResponses{
+				{
+					resp: &iaas.ProjectListResponse{
+						Items: utils.Ptr([]string{"project1"}),
+					},
+					err: nil,
+				},
+			},
+			getProjectResponses: []getProjectResponse{
+				{nil, oapierror.NewError(http.StatusForbidden, "")},
+			},
+			wantErr:  true,
+			wantResp: false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.desc, func(t *testing.T) {
+			apiClient := &apiClientMocked{
+				listProjectsResponses: tt.listProjectsResponses,
+			}
+
+			rmApiClient := &resourceManagerClientMocked{
+				getProjectResponses: tt.getProjectResponses,
+			}
+
+			var wantRes *iaas.ProjectListResponse
+			if tt.wantResp {
+				wantRes = tt.listProjectsResponses[len(tt.listProjectsResponses)-1].resp
+			}
+
+			handler := ReadyForNetworkAreaDeletionWaitHandler(context.Background(), apiClient, rmApiClient, "oid", "aid")
+			gotRes, err := handler.SetTimeout(200 * time.Millisecond).SetThrottle(5 * 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)
+			}
+		})
+	}
+}