Skip to content

feat(ske): add wait handlers for trigger endpoints #3379

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 2 commits into from
Jul 28, 2025
Merged

feat(ske): add wait handlers for trigger endpoints #3379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f352488
feat(ske): add wait handlers for trigger endpoints
rubenhoenle Jul 28, 2025
4399d81
add changelog entries
rubenhoenle Jul 28, 2025
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@
- `serviceenablement`: [v1.2.2](services/serviceenablement/CHANGELOG.md#v122)
- **Dependencies:** Bump `github.com/golang-jwt/jwt/v5` from `v5.2.2` to `v5.2.3`
- `ske`:
- [v1.3.0](services/ske/CHANGELOG.md#v130)
- **Feature:** Add new wait handlers: `TriggerClusterHibernationWaitHandler`, `TriggerClusterMaintenanceWaitHandler`, `TriggerClusterReconciliationWaitHandler`, `TriggerClusterWakeupWaitHandler`
- [v1.2.0](services/ske/CHANGELOG.md#v120)
- **Feature:** Add new method `TriggerWakeup`
- [v1.1.1](services/ske/CHANGELOG.md#v111)
Expand Down
7 changes: 5 additions & 2 deletions services/ske/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
## v1.3.0
- **Feature:** Add new wait handlers: `TriggerClusterHibernationWaitHandler`, `TriggerClusterMaintenanceWaitHandler`, `TriggerClusterReconciliationWaitHandler`, `TriggerClusterWakeupWaitHandler`

## v1.2.0
- **Feature:** Add new method `TriggerWakeup`
- **Feature:** Add new method `TriggerWakeup`

## v1.1.1
- **Dependencies:** Bump `github.com/golang-jwt/jwt/v5` from `v5.2.2` to `v5.2.3`
- **Dependencies:** Bump `github.com/golang-jwt/jwt/v5` from `v5.2.2` to `v5.2.3`

## v1.1.0
- **Breaking Change:** `ClusterError.Code` field is now a string type instead of an enum. The field no longer validates against predefined enum values and accepts any string value.
Expand Down
2 changes: 1 addition & 1 deletion services/ske/VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v1.2.0
v1.3.0
72 changes: 72 additions & 0 deletions services/ske/wait/wait.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,78 @@ func DeleteClusterWaitHandler(ctx context.Context, a APIClientClusterInterface,
return handler
}

func TriggerClusterHibernationWaitHandler(ctx context.Context, a APIClientClusterInterface, projectId, region, clusterName string) *wait.AsyncActionHandler[ske.Cluster] {
handler := wait.New(func() (waitFinished bool, response *ske.Cluster, err error) {
cluster, err := a.GetClusterExecute(ctx, projectId, region, clusterName)
if err != nil {
return false, nil, err
}
state := *cluster.Status.Aggregated

if state == ske.CLUSTERSTATUSSTATE_HIBERNATING {
return false, nil, nil
}

return true, cluster, nil
})
handler.SetTimeout(45 * time.Minute)
return handler
}

func TriggerClusterMaintenanceWaitHandler(ctx context.Context, a APIClientClusterInterface, projectId, region, clusterName string) *wait.AsyncActionHandler[ske.Cluster] {
handler := wait.New(func() (waitFinished bool, response *ske.Cluster, err error) {
cluster, err := a.GetClusterExecute(ctx, projectId, region, clusterName)
if err != nil {
return false, nil, err
}
state := *cluster.Status.Aggregated

if state == ske.CLUSTERSTATUSSTATE_RECONCILING {
return false, nil, nil
}

return true, cluster, nil
})
handler.SetTimeout(45 * time.Minute)
return handler
}

func TriggerClusterReconciliationWaitHandler(ctx context.Context, a APIClientClusterInterface, projectId, region, clusterName string) *wait.AsyncActionHandler[ske.Cluster] {
handler := wait.New(func() (waitFinished bool, response *ske.Cluster, err error) {
cluster, err := a.GetClusterExecute(ctx, projectId, region, clusterName)
if err != nil {
return false, nil, err
}
state := *cluster.Status.Aggregated

if state == ske.CLUSTERSTATUSSTATE_RECONCILING {
return false, nil, nil
}

return true, cluster, nil
})
handler.SetTimeout(45 * time.Minute)
return handler
}

func TriggerClusterWakeupWaitHandler(ctx context.Context, a APIClientClusterInterface, projectId, region, clusterName string) *wait.AsyncActionHandler[ske.Cluster] {
handler := wait.New(func() (waitFinished bool, response *ske.Cluster, err error) {
cluster, err := a.GetClusterExecute(ctx, projectId, region, clusterName)
if err != nil {
return false, nil, err
}
state := *cluster.Status.Aggregated

if state == ske.CLUSTERSTATUSSTATE_WAKINGUP {
return false, nil, nil
}

return true, cluster, nil
})
handler.SetTimeout(45 * time.Minute)
return handler
}

// RotateCredentialsWaitHandler will wait for credentials rotation
func RotateCredentialsWaitHandler(ctx context.Context, a APIClientClusterInterface, projectId, region, clusterName string) *wait.AsyncActionHandler[ske.Cluster] {
handler := wait.New(func() (waitFinished bool, response *ske.Cluster, err error) {
Expand Down
276 changes: 276 additions & 0 deletions services/ske/wait/wait_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,282 @@ func TestCreateOrUpdateClusterWaitHandler(t *testing.T) {
}
}

func TestTriggerClusterHibernationWaitHandler(t *testing.T) {
tests := []struct {
description string
getFails bool
resourceState ske.ClusterStatusState
wantErr bool
wantResp bool
}{
{
description: "hibernation ongoing (timeout)",
getFails: false,
resourceState: ske.CLUSTERSTATUSSTATE_HIBERNATING,
wantErr: true,
wantResp: false,
},
{
description: "hibernation succeeded",
getFails: false,
resourceState: ske.CLUSTERSTATUSSTATE_HIBERNATED,
wantErr: false,
wantResp: true,
},
{
description: "unexpected status",
getFails: false,
resourceState: ske.CLUSTERSTATUSSTATE_HEALTHY,
wantErr: false,
wantResp: true,
},
{
description: "get_fails",
getFails: true,
wantErr: true,
wantResp: false,
},
}
for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
name := "cluster"

apiClient := &apiClientClusterMocked{
getFails: tt.getFails,
name: name,
resourceState: tt.resourceState,
}
var wantRes *ske.Cluster
if tt.wantResp {
wantRes = &ske.Cluster{
Name: &name,
Status: &ske.ClusterStatus{
Aggregated: utils.Ptr(tt.resourceState),
},
}
}

handler := TriggerClusterHibernationWaitHandler(context.Background(), apiClient, "", testRegion, name)

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 TestTriggerClusterMaintenanceWaitHandler(t *testing.T) {
tests := []struct {
description string
getFails bool
resourceState ske.ClusterStatusState
wantErr bool
wantResp bool
}{
{
description: "maintenance ongoing (timeout)",
getFails: false,
resourceState: ske.CLUSTERSTATUSSTATE_RECONCILING,
wantErr: true,
wantResp: false,
},
{
description: "maintenance succeeded",
getFails: false,
resourceState: ske.CLUSTERSTATUSSTATE_HEALTHY,
wantErr: false,
wantResp: true,
},
{
description: "unexpected status",
getFails: false,
resourceState: ske.CLUSTERSTATUSSTATE_HIBERNATED,
wantErr: false,
wantResp: true,
},
{
description: "get_fails",
getFails: true,
wantErr: true,
wantResp: false,
},
}
for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
name := "cluster"

apiClient := &apiClientClusterMocked{
getFails: tt.getFails,
name: name,
resourceState: tt.resourceState,
}
var wantRes *ske.Cluster
if tt.wantResp {
wantRes = &ske.Cluster{
Name: &name,
Status: &ske.ClusterStatus{
Aggregated: utils.Ptr(tt.resourceState),
},
}
}

handler := TriggerClusterMaintenanceWaitHandler(context.Background(), apiClient, "", testRegion, name)

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 TestTriggerClusterWakeupWaitHandler(t *testing.T) {
tests := []struct {
description string
getFails bool
resourceState ske.ClusterStatusState
wantErr bool
wantResp bool
}{
{
description: "wakeup ongoing (timeout)",
getFails: false,
resourceState: ske.CLUSTERSTATUSSTATE_WAKINGUP,
wantErr: true,
wantResp: false,
},
{
description: "wakeup succeeded",
getFails: false,
resourceState: ske.CLUSTERSTATUSSTATE_HEALTHY,
wantErr: false,
wantResp: true,
},
{
description: "unexpected status",
getFails: false,
resourceState: ske.CLUSTERSTATUSSTATE_DELETING,
wantErr: false,
wantResp: true,
},
{
description: "get_fails",
getFails: true,
wantErr: true,
wantResp: false,
},
}
for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
name := "cluster"

apiClient := &apiClientClusterMocked{
getFails: tt.getFails,
name: name,
resourceState: tt.resourceState,
}
var wantRes *ske.Cluster
if tt.wantResp {
wantRes = &ske.Cluster{
Name: &name,
Status: &ske.ClusterStatus{
Aggregated: utils.Ptr(tt.resourceState),
},
}
}

handler := TriggerClusterWakeupWaitHandler(context.Background(), apiClient, "", testRegion, name)

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 TestTriggerClusterReconciliationWaitHandler(t *testing.T) {
tests := []struct {
description string
getFails bool
resourceState ske.ClusterStatusState
wantErr bool
wantResp bool
}{
{
description: "reconciliation ongoing (timeout)",
getFails: false,
resourceState: ske.CLUSTERSTATUSSTATE_RECONCILING,
wantErr: true,
wantResp: false,
},
{
description: "reconciliation succeeded",
getFails: false,
resourceState: ske.CLUSTERSTATUSSTATE_HEALTHY,
wantErr: false,
wantResp: true,
},
{
description: "unexpected status",
getFails: false,
resourceState: ske.CLUSTERSTATUSSTATE_CREATING,
wantErr: false,
wantResp: true,
},
{
description: "get_fails",
getFails: true,
wantErr: true,
wantResp: false,
},
}
for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
name := "cluster"

apiClient := &apiClientClusterMocked{
getFails: tt.getFails,
name: name,
resourceState: tt.resourceState,
}
var wantRes *ske.Cluster
if tt.wantResp {
wantRes = &ske.Cluster{
Name: &name,
Status: &ske.ClusterStatus{
Aggregated: utils.Ptr(tt.resourceState),
},
}
}

handler := TriggerClusterReconciliationWaitHandler(context.Background(), apiClient, "", testRegion, name)

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 TestRotateCredentialsWaitHandler(t *testing.T) {
tests := []struct {
desc string
Expand Down
Loading