mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-15 12:27:59 +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>
298 lines
7.0 KiB
Go
298 lines
7.0 KiB
Go
package middleware
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"reflect"
|
|
"testing"
|
|
"time"
|
|
|
|
"golang.org/x/text/language"
|
|
"google.golang.org/grpc"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/authz"
|
|
http_util "github.com/zitadel/zitadel/internal/api/http"
|
|
"github.com/zitadel/zitadel/internal/feature"
|
|
object_v3 "github.com/zitadel/zitadel/pkg/grpc/object/v3alpha"
|
|
)
|
|
|
|
func Test_setInstance(t *testing.T) {
|
|
type args struct {
|
|
ctx context.Context
|
|
req interface{}
|
|
info *grpc.UnaryServerInfo
|
|
handler grpc.UnaryHandler
|
|
verifier authz.InstanceVerifier
|
|
}
|
|
type res struct {
|
|
want interface{}
|
|
err bool
|
|
}
|
|
tests := []struct {
|
|
name string
|
|
args args
|
|
res res
|
|
}{
|
|
{
|
|
"hostname not found, error",
|
|
args{
|
|
ctx: context.Background(),
|
|
},
|
|
res{
|
|
want: nil,
|
|
err: true,
|
|
},
|
|
},
|
|
{
|
|
"invalid host, error",
|
|
args{
|
|
ctx: http_util.WithDomainContext(context.Background(), &http_util.DomainCtx{InstanceHost: "host2"}),
|
|
req: &mockRequest{},
|
|
verifier: &mockInstanceVerifier{instanceHost: "host"},
|
|
},
|
|
res{
|
|
want: nil,
|
|
err: true,
|
|
},
|
|
},
|
|
{
|
|
"valid host",
|
|
args{
|
|
ctx: http_util.WithDomainContext(context.Background(), &http_util.DomainCtx{InstanceHost: "host"}),
|
|
req: &mockRequest{},
|
|
verifier: &mockInstanceVerifier{instanceHost: "host"},
|
|
handler: func(ctx context.Context, req interface{}) (interface{}, error) {
|
|
return req, nil
|
|
},
|
|
},
|
|
res{
|
|
want: &mockRequest{},
|
|
err: false,
|
|
},
|
|
},
|
|
{
|
|
"explicit instance unset, hostname not found, error",
|
|
args{
|
|
ctx: http_util.WithDomainContext(context.Background(), &http_util.DomainCtx{InstanceHost: "host2"}),
|
|
req: &mockRequestWithExplicitInstance{},
|
|
verifier: &mockInstanceVerifier{instanceHost: "host"},
|
|
},
|
|
res{
|
|
want: nil,
|
|
err: true,
|
|
},
|
|
},
|
|
{
|
|
"explicit instance unset, invalid host, error",
|
|
args{
|
|
ctx: http_util.WithDomainContext(context.Background(), &http_util.DomainCtx{InstanceHost: "host2"}),
|
|
req: &mockRequestWithExplicitInstance{},
|
|
verifier: &mockInstanceVerifier{instanceHost: "host"},
|
|
},
|
|
res{
|
|
want: nil,
|
|
err: true,
|
|
},
|
|
},
|
|
{
|
|
"explicit instance unset, valid host",
|
|
args{
|
|
ctx: http_util.WithDomainContext(context.Background(), &http_util.DomainCtx{InstanceHost: "host"}),
|
|
req: &mockRequestWithExplicitInstance{},
|
|
verifier: &mockInstanceVerifier{instanceHost: "host"},
|
|
handler: func(ctx context.Context, req interface{}) (interface{}, error) {
|
|
return req, nil
|
|
},
|
|
},
|
|
res{
|
|
want: &mockRequestWithExplicitInstance{},
|
|
err: false,
|
|
},
|
|
},
|
|
{
|
|
name: "explicit instance set, id not found, error",
|
|
args: args{
|
|
ctx: context.Background(),
|
|
req: &mockRequestWithExplicitInstance{
|
|
instance: object_v3.Instance{
|
|
Property: &object_v3.Instance_Id{
|
|
Id: "not existing instance id",
|
|
},
|
|
},
|
|
},
|
|
verifier: &mockInstanceVerifier{id: "existing instance id"},
|
|
},
|
|
res: res{
|
|
want: nil,
|
|
err: true,
|
|
},
|
|
},
|
|
{
|
|
name: "explicit instance set, id found, ok",
|
|
args: args{
|
|
ctx: context.Background(),
|
|
req: &mockRequestWithExplicitInstance{
|
|
instance: object_v3.Instance{
|
|
Property: &object_v3.Instance_Id{
|
|
Id: "existing instance id",
|
|
},
|
|
},
|
|
},
|
|
verifier: &mockInstanceVerifier{id: "existing instance id"},
|
|
handler: func(ctx context.Context, req interface{}) (interface{}, error) {
|
|
return req, nil
|
|
},
|
|
},
|
|
res: res{
|
|
want: &mockRequestWithExplicitInstance{
|
|
instance: object_v3.Instance{
|
|
Property: &object_v3.Instance_Id{
|
|
Id: "existing instance id",
|
|
},
|
|
},
|
|
},
|
|
err: false,
|
|
},
|
|
},
|
|
{
|
|
name: "explicit instance set, domain not found, error",
|
|
args: args{
|
|
ctx: context.Background(),
|
|
req: &mockRequestWithExplicitInstance{
|
|
instance: object_v3.Instance{
|
|
Property: &object_v3.Instance_Domain{
|
|
Domain: "not existing instance domain",
|
|
},
|
|
},
|
|
},
|
|
verifier: &mockInstanceVerifier{instanceHost: "existing instance domain"},
|
|
},
|
|
res: res{
|
|
want: nil,
|
|
err: true,
|
|
},
|
|
},
|
|
{
|
|
name: "explicit instance set, domain found, ok",
|
|
args: args{
|
|
ctx: context.Background(),
|
|
req: &mockRequestWithExplicitInstance{
|
|
instance: object_v3.Instance{
|
|
Property: &object_v3.Instance_Domain{
|
|
Domain: "existing instance domain",
|
|
},
|
|
},
|
|
},
|
|
verifier: &mockInstanceVerifier{instanceHost: "existing instance domain"},
|
|
handler: func(ctx context.Context, req interface{}) (interface{}, error) {
|
|
return req, nil
|
|
},
|
|
},
|
|
res: res{
|
|
want: &mockRequestWithExplicitInstance{
|
|
instance: object_v3.Instance{
|
|
Property: &object_v3.Instance_Domain{
|
|
Domain: "existing instance domain",
|
|
},
|
|
},
|
|
},
|
|
err: false,
|
|
},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got, err := setInstance(tt.args.ctx, tt.args.req, tt.args.info, tt.args.handler, tt.args.verifier, "", nil)
|
|
if (err != nil) != tt.res.err {
|
|
t.Errorf("setInstance() error = %v, wantErr %v", err, tt.res.err)
|
|
return
|
|
}
|
|
if !reflect.DeepEqual(got, tt.res.want) {
|
|
t.Errorf("setInstance() got = %v, want %v", got, tt.res.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
type mockRequest struct{}
|
|
|
|
type mockRequestWithExplicitInstance struct {
|
|
instance object_v3.Instance
|
|
}
|
|
|
|
func (m *mockRequestWithExplicitInstance) GetInstance() *object_v3.Instance {
|
|
return &m.instance
|
|
}
|
|
|
|
type mockInstanceVerifier struct {
|
|
id string
|
|
instanceHost string
|
|
publicHost string
|
|
}
|
|
|
|
func (m *mockInstanceVerifier) InstanceByHost(_ context.Context, instanceHost, publicHost string) (authz.Instance, error) {
|
|
if instanceHost != m.instanceHost {
|
|
return nil, fmt.Errorf("invalid host")
|
|
}
|
|
if publicHost == "" {
|
|
return &mockInstance{}, nil
|
|
}
|
|
if publicHost != instanceHost && publicHost != m.publicHost {
|
|
return nil, fmt.Errorf("invalid host")
|
|
}
|
|
return &mockInstance{}, nil
|
|
}
|
|
|
|
func (m *mockInstanceVerifier) InstanceByID(_ context.Context, id string) (authz.Instance, error) {
|
|
if id != m.id {
|
|
return nil, fmt.Errorf("not found")
|
|
}
|
|
return &mockInstance{}, nil
|
|
}
|
|
|
|
type mockInstance struct{}
|
|
|
|
func (m *mockInstance) Block() *bool {
|
|
panic("shouldn't be called here")
|
|
}
|
|
|
|
func (m *mockInstance) AuditLogRetention() *time.Duration {
|
|
panic("shouldn't be called here")
|
|
}
|
|
|
|
func (m *mockInstance) InstanceID() string {
|
|
return "instanceID"
|
|
}
|
|
|
|
func (m *mockInstance) ProjectID() string {
|
|
return "projectID"
|
|
}
|
|
|
|
func (m *mockInstance) ConsoleClientID() string {
|
|
return "consoleClientID"
|
|
}
|
|
|
|
func (m *mockInstance) ConsoleApplicationID() string {
|
|
return "consoleApplicationID"
|
|
}
|
|
|
|
func (m *mockInstance) DefaultLanguage() language.Tag {
|
|
return language.English
|
|
}
|
|
|
|
func (m *mockInstance) DefaultOrganisationID() string {
|
|
return "orgID"
|
|
}
|
|
|
|
func (m *mockInstance) SecurityPolicyAllowedOrigins() []string {
|
|
return nil
|
|
}
|
|
|
|
func (m *mockInstance) EnableImpersonation() bool {
|
|
return false
|
|
}
|
|
|
|
func (m *mockInstance) Features() feature.Features {
|
|
return feature.Features{}
|
|
}
|