mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-13 19:44:21 +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>
109 lines
2.7 KiB
Go
109 lines
2.7 KiB
Go
// this is a helper file for tests
|
|
package command
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"reflect"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
"github.com/zitadel/zitadel/internal/command/preparation"
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
"github.com/zitadel/zitadel/internal/eventstore"
|
|
)
|
|
|
|
// Want represents the expected values for each step
|
|
type Want struct {
|
|
ValidationErr error
|
|
CreateErr error
|
|
Commands []eventstore.Command
|
|
}
|
|
|
|
type CommandVerifier interface {
|
|
Validate(eventstore.Command) bool
|
|
}
|
|
|
|
// AssertValidation checks if the validation works as intended
|
|
func AssertValidation(t *testing.T, ctx context.Context, validation preparation.Validation, filter preparation.FilterToQueryReducer, want Want) {
|
|
t.Helper()
|
|
|
|
creates, err := validation()
|
|
if !errors.Is(err, want.ValidationErr) {
|
|
t.Errorf("wrong validation err = (%[1]T): %[1]v, want (%[2]T): %[2]v", err, want.ValidationErr)
|
|
return
|
|
}
|
|
if err != nil {
|
|
return
|
|
}
|
|
cmds, err := creates(ctx, filter)
|
|
if !errors.Is(err, want.CreateErr) {
|
|
t.Errorf("wrong create err = (%[1]T): %[1]v, want (%[2]T): %[2]v", err, want.CreateErr)
|
|
return
|
|
}
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
if len(cmds) != len(want.Commands) {
|
|
t.Errorf("wrong length of commands = %v, want %v", eventTypes(cmds), eventTypes(want.Commands))
|
|
return
|
|
}
|
|
|
|
for i, cmd := range want.Commands {
|
|
if v, ok := cmd.(CommandVerifier); ok {
|
|
if verified := v.Validate(cmds[i]); !verified {
|
|
t.Errorf("verification failed on command: =\n%v\nwant\n%v", cmds[i], cmd)
|
|
}
|
|
continue
|
|
}
|
|
if !reflect.DeepEqual(cmd, cmds[i]) {
|
|
t.Errorf("unexpected command: = %v, want %v", cmds[i], cmd)
|
|
}
|
|
}
|
|
}
|
|
|
|
func eventTypes(cmds []eventstore.Command) []eventstore.EventType {
|
|
types := make([]eventstore.EventType, len(cmds))
|
|
for i, cmd := range cmds {
|
|
types[i] = cmd.Type()
|
|
}
|
|
return types
|
|
}
|
|
|
|
type MultiFilter struct {
|
|
count int
|
|
filters []preparation.FilterToQueryReducer
|
|
}
|
|
|
|
func NewMultiFilter() *MultiFilter {
|
|
return new(MultiFilter)
|
|
}
|
|
|
|
func (mf *MultiFilter) Append(filter preparation.FilterToQueryReducer) *MultiFilter {
|
|
mf.filters = append(mf.filters, filter)
|
|
return mf
|
|
}
|
|
|
|
func (mf *MultiFilter) Filter() preparation.FilterToQueryReducer {
|
|
return func(ctx context.Context, queryFactory *eventstore.SearchQueryBuilder) ([]eventstore.Event, error) {
|
|
mf.count++
|
|
return mf.filters[mf.count-1](ctx, queryFactory)
|
|
}
|
|
}
|
|
|
|
func assertObjectDetails(t *testing.T, want, got *domain.ObjectDetails) {
|
|
if want == nil {
|
|
assert.Nil(t, got)
|
|
return
|
|
}
|
|
assert.Equal(t, got.CreationDate, want.CreationDate)
|
|
assert.Equal(t, got.EventDate, want.EventDate)
|
|
assert.Equal(t, got.ResourceOwner, want.ResourceOwner)
|
|
assert.Equal(t, got.Sequence, want.Sequence)
|
|
if want.ID != "" {
|
|
assert.Equal(t, got.ID, want.ID)
|
|
}
|
|
}
|