mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-15 20:38:00 +00:00
042c438813
# Which Problems Are Solved The current v3alpha actions APIs don't exactly adhere to the [new resources API design](https://zitadel.com/docs/apis/v3#standard-resources). # How the Problems Are Solved - **Improved ID access**: The aggregate ID is added to the resource details object, so accessing resource IDs and constructing proto messages for resources is easier - **Explicit Instances**: Optionally, the instance can be explicitly given in each request - **Pagination**: A default search limit and a max search limit are added to the defaults.yaml. They apply to the new v3 APIs (currently only actions). The search query defaults are changed to ascending by creation date, because this makes the pagination results the most deterministic. The creation date is also added to the object details. The bug with updated creation dates is fixed for executions and targets. - **Removed Sequences**: Removed Sequence from object details and ProcessedSequence from search details # Additional Changes Object details IDs are checked in unit test only if an empty ID is expected. Centralizing the details check also makes this internal object more flexible for future evolutions. # Additional Context - Closes #8169 - Depends on https://github.com/zitadel/zitadel/pull/8225 --------- Co-authored-by: Silvan <silvan.reusser@gmail.com> Co-authored-by: Stefan Benz <46600784+stebenz@users.noreply.github.com>
451 lines
12 KiB
Go
451 lines
12 KiB
Go
//go:build integration
|
|
|
|
package action_test
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
object "github.com/zitadel/zitadel/pkg/grpc/object/v3alpha"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/muhlemmer/gu"
|
|
"github.com/stretchr/testify/require"
|
|
"google.golang.org/protobuf/types/known/durationpb"
|
|
"google.golang.org/protobuf/types/known/timestamppb"
|
|
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
"github.com/zitadel/zitadel/internal/integration"
|
|
action "github.com/zitadel/zitadel/pkg/grpc/resources/action/v3alpha"
|
|
resource_object "github.com/zitadel/zitadel/pkg/grpc/resources/object/v3alpha"
|
|
)
|
|
|
|
func TestServer_CreateTarget(t *testing.T) {
|
|
_, instanceID, _, isolatedIAMOwnerCTX := Tester.UseIsolatedInstance(t, IAMOwnerCTX, SystemCTX)
|
|
ensureFeatureEnabled(t, isolatedIAMOwnerCTX)
|
|
tests := []struct {
|
|
name string
|
|
ctx context.Context
|
|
req *action.Target
|
|
want *resource_object.Details
|
|
wantErr bool
|
|
}{
|
|
{
|
|
name: "missing permission",
|
|
ctx: Tester.WithAuthorization(context.Background(), integration.OrgOwner),
|
|
req: &action.Target{
|
|
Name: fmt.Sprint(time.Now().UnixNano() + 1),
|
|
},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "empty name",
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.Target{
|
|
Name: "",
|
|
},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "empty type",
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.Target{
|
|
Name: fmt.Sprint(time.Now().UnixNano() + 1),
|
|
TargetType: nil,
|
|
},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "empty webhook url",
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.Target{
|
|
Name: fmt.Sprint(time.Now().UnixNano() + 1),
|
|
TargetType: &action.Target_RestWebhook{
|
|
RestWebhook: &action.SetRESTWebhook{},
|
|
},
|
|
},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "empty request response url",
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.Target{
|
|
Name: fmt.Sprint(time.Now().UnixNano() + 1),
|
|
TargetType: &action.Target_RestCall{
|
|
RestCall: &action.SetRESTCall{},
|
|
},
|
|
},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "empty timeout",
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.Target{
|
|
Name: fmt.Sprint(time.Now().UnixNano() + 1),
|
|
Endpoint: "https://example.com",
|
|
TargetType: &action.Target_RestWebhook{
|
|
RestWebhook: &action.SetRESTWebhook{},
|
|
},
|
|
Timeout: nil,
|
|
},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "async, ok",
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.Target{
|
|
Name: fmt.Sprint(time.Now().UnixNano() + 1),
|
|
Endpoint: "https://example.com",
|
|
TargetType: &action.Target_RestAsync{
|
|
RestAsync: &action.SetRESTAsync{},
|
|
},
|
|
Timeout: durationpb.New(10 * time.Second),
|
|
},
|
|
want: &resource_object.Details{
|
|
Changed: timestamppb.Now(),
|
|
Owner: &object.Owner{
|
|
Type: object.OwnerType_OWNER_TYPE_INSTANCE,
|
|
Id: instanceID,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "webhook, ok",
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.Target{
|
|
Name: fmt.Sprint(time.Now().UnixNano() + 1),
|
|
Endpoint: "https://example.com",
|
|
TargetType: &action.Target_RestWebhook{
|
|
RestWebhook: &action.SetRESTWebhook{
|
|
InterruptOnError: false,
|
|
},
|
|
},
|
|
Timeout: durationpb.New(10 * time.Second),
|
|
},
|
|
want: &resource_object.Details{
|
|
Changed: timestamppb.Now(),
|
|
Owner: &object.Owner{
|
|
Type: object.OwnerType_OWNER_TYPE_INSTANCE,
|
|
Id: instanceID,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "webhook, interrupt on error, ok",
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.Target{
|
|
Name: fmt.Sprint(time.Now().UnixNano() + 1),
|
|
Endpoint: "https://example.com",
|
|
TargetType: &action.Target_RestWebhook{
|
|
RestWebhook: &action.SetRESTWebhook{
|
|
InterruptOnError: true,
|
|
},
|
|
},
|
|
Timeout: durationpb.New(10 * time.Second),
|
|
},
|
|
want: &resource_object.Details{
|
|
Changed: timestamppb.Now(),
|
|
Owner: &object.Owner{
|
|
Type: object.OwnerType_OWNER_TYPE_INSTANCE,
|
|
Id: instanceID,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "call, ok",
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.Target{
|
|
Name: fmt.Sprint(time.Now().UnixNano() + 1),
|
|
Endpoint: "https://example.com",
|
|
TargetType: &action.Target_RestCall{
|
|
RestCall: &action.SetRESTCall{
|
|
InterruptOnError: false,
|
|
},
|
|
},
|
|
Timeout: durationpb.New(10 * time.Second),
|
|
},
|
|
want: &resource_object.Details{
|
|
Changed: timestamppb.Now(),
|
|
Owner: &object.Owner{
|
|
Type: object.OwnerType_OWNER_TYPE_INSTANCE,
|
|
Id: instanceID,
|
|
},
|
|
},
|
|
},
|
|
|
|
{
|
|
name: "call, interruptOnError, ok",
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.Target{
|
|
Name: fmt.Sprint(time.Now().UnixNano() + 1),
|
|
Endpoint: "https://example.com",
|
|
TargetType: &action.Target_RestCall{
|
|
RestCall: &action.SetRESTCall{
|
|
InterruptOnError: true,
|
|
},
|
|
},
|
|
Timeout: durationpb.New(10 * time.Second),
|
|
},
|
|
want: &resource_object.Details{
|
|
Changed: timestamppb.Now(),
|
|
Owner: &object.Owner{
|
|
Type: object.OwnerType_OWNER_TYPE_INSTANCE,
|
|
Id: instanceID,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got, err := Tester.Client.ActionV3.CreateTarget(tt.ctx, &action.CreateTargetRequest{Target: tt.req})
|
|
if tt.wantErr {
|
|
require.Error(t, err)
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
integration.AssertResourceDetails(t, tt.want, got.Details)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestServer_PatchTarget(t *testing.T) {
|
|
_, instanceID, _, isolatedIAMOwnerCTX := Tester.UseIsolatedInstance(t, IAMOwnerCTX, SystemCTX)
|
|
ensureFeatureEnabled(t, isolatedIAMOwnerCTX)
|
|
type args struct {
|
|
ctx context.Context
|
|
req *action.PatchTargetRequest
|
|
}
|
|
tests := []struct {
|
|
name string
|
|
prepare func(request *action.PatchTargetRequest) error
|
|
args args
|
|
want *resource_object.Details
|
|
wantErr bool
|
|
}{
|
|
{
|
|
name: "missing permission",
|
|
prepare: func(request *action.PatchTargetRequest) error {
|
|
targetID := Tester.CreateTarget(isolatedIAMOwnerCTX, t, "", "https://example.com", domain.TargetTypeWebhook, false).GetDetails().GetId()
|
|
request.Id = targetID
|
|
return nil
|
|
},
|
|
args: args{
|
|
ctx: Tester.WithAuthorization(context.Background(), integration.OrgOwner),
|
|
req: &action.PatchTargetRequest{
|
|
Target: &action.PatchTarget{
|
|
Name: gu.Ptr(fmt.Sprint(time.Now().UnixNano() + 1)),
|
|
},
|
|
},
|
|
},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "not existing",
|
|
prepare: func(request *action.PatchTargetRequest) error {
|
|
request.Id = "notexisting"
|
|
return nil
|
|
},
|
|
args: args{
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.PatchTargetRequest{
|
|
Target: &action.PatchTarget{
|
|
Name: gu.Ptr(fmt.Sprint(time.Now().UnixNano() + 1)),
|
|
},
|
|
},
|
|
},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "change name, ok",
|
|
prepare: func(request *action.PatchTargetRequest) error {
|
|
targetID := Tester.CreateTarget(isolatedIAMOwnerCTX, t, "", "https://example.com", domain.TargetTypeWebhook, false).GetDetails().GetId()
|
|
request.Id = targetID
|
|
return nil
|
|
},
|
|
args: args{
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.PatchTargetRequest{
|
|
Target: &action.PatchTarget{
|
|
Name: gu.Ptr(fmt.Sprint(time.Now().UnixNano() + 1)),
|
|
},
|
|
},
|
|
},
|
|
want: &resource_object.Details{
|
|
Changed: timestamppb.Now(),
|
|
Owner: &object.Owner{
|
|
Type: object.OwnerType_OWNER_TYPE_INSTANCE,
|
|
Id: instanceID,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "change type, ok",
|
|
prepare: func(request *action.PatchTargetRequest) error {
|
|
targetID := Tester.CreateTarget(isolatedIAMOwnerCTX, t, "", "https://example.com", domain.TargetTypeWebhook, false).GetDetails().GetId()
|
|
request.Id = targetID
|
|
return nil
|
|
},
|
|
args: args{
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.PatchTargetRequest{
|
|
Target: &action.PatchTarget{
|
|
TargetType: &action.PatchTarget_RestCall{
|
|
RestCall: &action.SetRESTCall{
|
|
InterruptOnError: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: &resource_object.Details{
|
|
Changed: timestamppb.Now(),
|
|
Owner: &object.Owner{
|
|
Type: object.OwnerType_OWNER_TYPE_INSTANCE,
|
|
Id: instanceID,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "change url, ok",
|
|
prepare: func(request *action.PatchTargetRequest) error {
|
|
targetID := Tester.CreateTarget(isolatedIAMOwnerCTX, t, "", "https://example.com", domain.TargetTypeWebhook, false).GetDetails().GetId()
|
|
request.Id = targetID
|
|
return nil
|
|
},
|
|
args: args{
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.PatchTargetRequest{
|
|
Target: &action.PatchTarget{
|
|
Endpoint: gu.Ptr("https://example.com/hooks/new"),
|
|
},
|
|
},
|
|
},
|
|
want: &resource_object.Details{
|
|
Changed: timestamppb.Now(),
|
|
Owner: &object.Owner{
|
|
Type: object.OwnerType_OWNER_TYPE_INSTANCE,
|
|
Id: instanceID,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "change timeout, ok",
|
|
prepare: func(request *action.PatchTargetRequest) error {
|
|
targetID := Tester.CreateTarget(isolatedIAMOwnerCTX, t, "", "https://example.com", domain.TargetTypeWebhook, false).GetDetails().GetId()
|
|
request.Id = targetID
|
|
return nil
|
|
},
|
|
args: args{
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.PatchTargetRequest{
|
|
Target: &action.PatchTarget{
|
|
Timeout: durationpb.New(20 * time.Second),
|
|
},
|
|
},
|
|
},
|
|
want: &resource_object.Details{
|
|
Changed: timestamppb.Now(),
|
|
Owner: &object.Owner{
|
|
Type: object.OwnerType_OWNER_TYPE_INSTANCE,
|
|
Id: instanceID,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "change type async, ok",
|
|
prepare: func(request *action.PatchTargetRequest) error {
|
|
targetID := Tester.CreateTarget(isolatedIAMOwnerCTX, t, "", "https://example.com", domain.TargetTypeAsync, false).GetDetails().GetId()
|
|
request.Id = targetID
|
|
return nil
|
|
},
|
|
args: args{
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.PatchTargetRequest{
|
|
Target: &action.PatchTarget{
|
|
TargetType: &action.PatchTarget_RestAsync{
|
|
RestAsync: &action.SetRESTAsync{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: &resource_object.Details{
|
|
Changed: timestamppb.Now(),
|
|
Owner: &object.Owner{
|
|
Type: object.OwnerType_OWNER_TYPE_INSTANCE,
|
|
Id: instanceID,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
err := tt.prepare(tt.args.req)
|
|
require.NoError(t, err)
|
|
// We want to have the same response no matter how often we call the function
|
|
Tester.Client.ActionV3.PatchTarget(tt.args.ctx, tt.args.req)
|
|
got, err := Tester.Client.ActionV3.PatchTarget(tt.args.ctx, tt.args.req)
|
|
if tt.wantErr {
|
|
require.Error(t, err)
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
integration.AssertResourceDetails(t, tt.want, got.Details)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestServer_DeleteTarget(t *testing.T) {
|
|
_, instanceID, _, isolatedIAMOwnerCTX := Tester.UseIsolatedInstance(t, IAMOwnerCTX, SystemCTX)
|
|
ensureFeatureEnabled(t, isolatedIAMOwnerCTX)
|
|
target := Tester.CreateTarget(isolatedIAMOwnerCTX, t, "", "https://example.com", domain.TargetTypeWebhook, false)
|
|
tests := []struct {
|
|
name string
|
|
ctx context.Context
|
|
req *action.DeleteTargetRequest
|
|
want *resource_object.Details
|
|
wantErr bool
|
|
}{
|
|
{
|
|
name: "missing permission",
|
|
ctx: Tester.WithAuthorization(context.Background(), integration.OrgOwner),
|
|
req: &action.DeleteTargetRequest{
|
|
Id: target.GetDetails().GetId(),
|
|
},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "empty id",
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.DeleteTargetRequest{
|
|
Id: "",
|
|
},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "delete target",
|
|
ctx: isolatedIAMOwnerCTX,
|
|
req: &action.DeleteTargetRequest{
|
|
Id: target.GetDetails().GetId(),
|
|
},
|
|
want: &resource_object.Details{
|
|
Changed: timestamppb.Now(),
|
|
Owner: &object.Owner{
|
|
Type: object.OwnerType_OWNER_TYPE_INSTANCE,
|
|
Id: instanceID,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got, err := Tester.Client.ActionV3.DeleteTarget(tt.ctx, tt.req)
|
|
if tt.wantErr {
|
|
require.Error(t, err)
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
integration.AssertResourceDetails(t, tt.want, got.Details)
|
|
})
|
|
}
|
|
}
|