Skip to content

Feature/stackit git wait #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions services/git/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ module github.com/stackitcloud/stackit-sdk-go/services/git
go 1.21

require (
github.com/google/go-cmp v0.7.0
github.com/google/uuid v1.6.0
github.com/stackitcloud/stackit-sdk-go/core v0.17.1
)
Expand Down
57 changes: 57 additions & 0 deletions services/git/wait/wait.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
package wait

import (
"context"
"fmt"
"time"

"github.com/stackitcloud/stackit-sdk-go/core/wait"
"github.com/stackitcloud/stackit-sdk-go/services/git"
)

const (
CreateSuccess = "Ready"
Creating = "Creating"
CreateFail = "Error"
)

// APIClientInterface Interfaces needed for tests
type APIClientInterface interface {
GetGitExecute(ctx context.Context, projectId string, instanceId string) (*git.Instance, error)
}

func CreateGitInstanceWaitHandler(ctx context.Context, a APIClientInterface, projectId, instanceId string) *wait.AsyncActionHandler[git.Instance] {
handler := wait.New(func() (waitFinished bool, response *git.Instance, err error) {
instance, err := a.GetGitExecute(ctx, projectId, instanceId)
if err != nil {
return false, nil, err
}
if *instance.Id == "" || *instance.State == "" {
return false, nil, fmt.Errorf("could not get Instance id or State from response for project %s and instanceId %s", projectId, instanceId)
}
if *instance.Id == instanceId && *instance.State == CreateSuccess {
return true, instance, nil
}
if *instance.Id == instanceId && *instance.State == CreateFail {
return true, instance, fmt.Errorf("create failed for Instance with id %s", instanceId)
}
return false, nil, nil
})
handler.SetTimeout(10 * time.Minute)
return handler
}

func DeleteGitInstanceWaitHandler(ctx context.Context, a APIClientInterface, projectId, instanceId string) *wait.AsyncActionHandler[git.Instance] {
handler := wait.New(func() (waitFinished bool, response *git.Instance, err error) {
instance, err := a.GetGitExecute(ctx, projectId, instanceId)
if err != nil {
return true, nil, err
}
if instance != nil {
return true, instance, nil
}
return true, nil, nil
})
handler.SetTimeout(10 * time.Minute)
return handler
}
241 changes: 241 additions & 0 deletions services/git/wait/wait_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,241 @@
package wait

import (
"context"
"net/http"
"testing"
"time"

"github.com/google/go-cmp/cmp"
"github.com/google/uuid"
"github.com/stackitcloud/stackit-sdk-go/core/oapierror"
"github.com/stackitcloud/stackit-sdk-go/core/utils"
"github.com/stackitcloud/stackit-sdk-go/services/git"
)

type apiClientMocked struct {
desc string
getFails bool
returnInstance bool
wantErr bool
created time.Time
id string
projectId string
name string
state string
url string
version string
}

func (a *apiClientMocked) GetGitExecute(_ context.Context, _, _ string) (*git.Instance, error) {
if a.getFails {
return nil, &oapierror.GenericOpenAPIError{
StatusCode: http.StatusInternalServerError,
}
}
if !a.returnInstance {
return nil, nil
}
return &git.Instance{
Created: utils.Ptr(a.created),
Id: utils.Ptr(a.id),
Name: utils.Ptr(a.name),
State: utils.Ptr(a.state),
Url: utils.Ptr(a.url),
Version: utils.Ptr(a.version),
}, nil
}

func TestCreateGitInstanceWaitHandler(t *testing.T) {
tests := []struct {
desc string
getFails bool
wantErr bool
wantResp bool
created time.Time
id string
projectId string
name string
state string
url string
version string
returnInstance bool
}{
{
desc: "Creation of an instance succeeded",
getFails: false,
wantErr: false,
wantResp: true,
created: time.Now(),
id: uuid.New().String(),
projectId: uuid.New().String(),
name: "instance-test",
state: CreateSuccess,
url: "https://testing.git.onstackit.cloud",
version: "v1.6.0",
returnInstance: true,
},
{
desc: "Creation of an instance Failed With Error",
getFails: true,
wantErr: true,
wantResp: false,
created: time.Now(),
id: uuid.New().String(),
projectId: uuid.New().String(),
name: "instance-test",
state: CreateFail,
url: "https://testing.git.onstackit.cloud",
version: "v1.6.0",
returnInstance: true,
},
{
desc: "Creation of an instance with response failed and without error",
getFails: false,
wantErr: true,
wantResp: true,
created: time.Now(),
id: uuid.New().String(),
projectId: uuid.New().String(),
name: "instance-test",
state: CreateFail,
url: "https://testing.git.onstackit.cloud",
version: "v1.6.0",
returnInstance: true,
},
{
desc: "Creation of an instance failed without id on the response",
getFails: false,
wantErr: true,
wantResp: false,
created: time.Now(),
projectId: uuid.New().String(),
name: "instance-test",
state: CreateFail,
url: "https://testing.git.onstackit.cloud",
version: "v1.6.0",
returnInstance: true,
},

{
desc: "Creation of an instance without state on the response",
getFails: false,
wantErr: true,
wantResp: false,
created: time.Now(),
id: uuid.New().String(),
projectId: uuid.New().String(),
name: "instance-test",
url: "https://testing.git.onstackit.cloud",
version: "v1.6.0",
returnInstance: true,
},
}
for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) {
apiClient := &apiClientMocked{
desc: tt.desc,
getFails: tt.getFails,
wantErr: tt.wantErr,
created: tt.created,
id: tt.id,
projectId: tt.projectId,
name: tt.name,
state: tt.state,
url: tt.url,
version: tt.version,
returnInstance: tt.returnInstance,
}
var instanceWanted *git.Instance
if tt.wantResp {
instanceWanted = &git.Instance{
Created: utils.Ptr(tt.created),
Id: utils.Ptr(tt.id),
Name: utils.Ptr(tt.name),
State: utils.Ptr(tt.state),
Url: utils.Ptr(tt.url),
Version: utils.Ptr(tt.version),
}
}

handler := CreateGitInstanceWaitHandler(context.Background(), apiClient, apiClient.projectId, apiClient.id)

response, 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(response, instanceWanted) {
t.Fatalf("handler gotRes = %v, want %v", response, instanceWanted)
}
})
}
}

func TestDeleteGitInstanceWaitHandler(t *testing.T) {
tests := []struct {
desc string
wantErr bool
wantReturnedInstance bool
getFails bool
returnInstance bool
created time.Time
id string
name string
state string
url string
version string
}{
{
desc: "Instance deletion failed with error",
wantErr: true,
getFails: true,
},
{
desc: "Instance deletion failed returning existing instance",
wantErr: false,
getFails: false,
wantReturnedInstance: true,
created: time.Now(),
id: uuid.New().String(),
name: "instance-test",
state: CreateSuccess,
returnInstance: true,
url: "https://testing.git.onstackit.cloud",
version: "v1.6.0",
},
{
desc: "Instance deletion succesfull",
wantErr: false,
getFails: false,
wantReturnedInstance: false,
returnInstance: false,
},
}
for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) {
apiClient := &apiClientMocked{

projectId: uuid.New().String(),
getFails: tt.getFails,
created: tt.created,
id: tt.id,
name: tt.name,
state: tt.state,
url: tt.url,
version: tt.version,
returnInstance: tt.returnInstance,
}

handler := DeleteGitInstanceWaitHandler(context.Background(), apiClient, apiClient.projectId, apiClient.id)
response, 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 (response != nil) != tt.wantReturnedInstance {
t.Fatalf("handler gotRes = %v, want nil", response)
}
})
}
}