Skip to content

Improving waiters tests in git package #2

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.

Sign up for GitHub

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 1 commit into from
Apr 22, 2025
Merged

Improving waiters tests in git package #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions services/git/wait/wait.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ const (

// APIClientInterface Interfaces needed for tests
type APIClientInterface interface {
GetGitExecute(ctx context.Context, projectId string, instanceId string) (*git.Instance, error)
GetInstanceExecute(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)
instance, err := a.GetInstanceExecute(ctx, projectId, instanceId)
if err != nil {
return false, nil, err
}
Expand All @@ -43,7 +43,7 @@ func CreateGitInstanceWaitHandler(ctx context.Context, a APIClientInterface, pro

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)
instance, err := a.GetInstanceExecute(ctx, projectId, instanceId)
if err != nil {
return false, nil, err
}
Expand Down
32 changes: 7 additions & 25 deletions services/git/wait/wait_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,14 @@ import (
)

type apiClientMocked struct {
desc string
getFails bool
returnInstance bool
wantErr bool
projectId string
instanceId string
getGitResponse *git.Instance
}

func (a *apiClientMocked) GetGitExecute(_ context.Context, _, _ string) (*git.Instance, error) {
func (a *apiClientMocked) GetInstanceExecute(_ context.Context, _, _ string) (*git.Instance, error) {
if a.getFails {
return nil, &oapierror.GenericOpenAPIError{
StatusCode: http.StatusInternalServerError,
Expand All @@ -32,14 +30,7 @@ func (a *apiClientMocked) GetGitExecute(_ context.Context, _, _ string) (*git.In
if !a.returnInstance {
return nil, nil
}
return &git.Instance{
Created: a.getGitResponse.Created,
Id: a.getGitResponse.Id,
Name: a.getGitResponse.Name,
State: a.getGitResponse.State,
Url: a.getGitResponse.Url,
Version: a.getGitResponse.Version,
}, nil
return a.getGitResponse, nil
}

var PROJECT_ID = uuid.New().String()
Expand Down Expand Up @@ -74,7 +65,7 @@ func TestCreateGitInstanceWaitHandler(t *testing.T) {
},
},
{
desc: "Creation of an instance Failed With Error",
desc: "Creation of an instance failed with error",
getFails: true,
wantErr: true,
wantResp: false,
Expand All @@ -93,7 +84,7 @@ func TestCreateGitInstanceWaitHandler(t *testing.T) {
{
desc: "Creation of an instance with response failed and without error",
getFails: false,
wantErr: false,
wantErr: true,
wantResp: true,
projectId: uuid.New().String(),
instanceId: INSTANCE_ID,
Expand All @@ -102,7 +93,7 @@ func TestCreateGitInstanceWaitHandler(t *testing.T) {
Created: utils.Ptr(time.Now()),
Id: utils.Ptr(INSTANCE_ID),
Name: utils.Ptr("instance-test"),
State: utils.Ptr(InstanceStateReady),
State: utils.Ptr(InstanceStateError),
Url: utils.Ptr("https://testing.git.onstackit.cloud"),
Version: utils.Ptr("v1.6.0"),
},
Expand Down Expand Up @@ -144,24 +135,15 @@ func TestCreateGitInstanceWaitHandler(t *testing.T) {
for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) {
apiClient := &apiClientMocked{
desc: tt.desc,
getFails: tt.getFails,
wantErr: tt.wantErr,
projectId: tt.projectId,
instanceId: tt.instanceId,
getGitResponse: tt.getGitResponse,
returnInstance: tt.returnInstance,
}
var instanceWanted *git.Instance
if tt.wantResp {
instanceWanted = &git.Instance{
Created: tt.getGitResponse.Created,
Id: tt.getGitResponse.Id,
Name: tt.getGitResponse.Name,
State: tt.getGitResponse.State,
Url: tt.getGitResponse.Url,
Version: tt.getGitResponse.Version,
}
instanceWanted = tt.getGitResponse
}

handler := CreateGitInstanceWaitHandler(context.Background(), apiClient, apiClient.projectId, apiClient.instanceId)
Expand Down Expand Up @@ -208,7 +190,7 @@ func TestDeleteGitInstanceWaitHandler(t *testing.T) {
},
},
{
desc: "Instance deletion succesfull",
desc: "Instance deletion succesful",
wantErr: false,
getFails: false,
wantReturnedInstance: false,
Expand Down