mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-20 20:08:46 +00:00
feat(group): add user groups query-side and projection implementation (#10758)
# Which Problems Are Solved This is the second PR related to the backend implementation of GroupService to manage user groups. The first [PR](https://github.com/zitadel/zitadel/pull/10455) implements the Command-side. This PR implements the query side. # How the Problems Are Solved * Query-side implementation to search/list groups by * a list of Group IDs * by the Group name * by the Organization ID # Additional Changes N/A # Additional Context - Follow-up for PR #10455 --------- Co-authored-by: Livio Spring <[email protected]>
This commit is contained in:
co-authored by
Livio Spring
parent
e25b21a6a4
commit
8e766132b0
@@ -0,0 +1,269 @@
|
||||
package group
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/muhlemmer/gu"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"google.golang.org/protobuf/types/known/timestamppb"
|
||||
|
||||
"github.com/zitadel/zitadel/internal/config/systemdefaults"
|
||||
"github.com/zitadel/zitadel/internal/domain"
|
||||
"github.com/zitadel/zitadel/internal/query"
|
||||
"github.com/zitadel/zitadel/internal/zerrors"
|
||||
"github.com/zitadel/zitadel/pkg/grpc/filter/v2"
|
||||
group_v2 "github.com/zitadel/zitadel/pkg/grpc/group/v2"
|
||||
)
|
||||
|
||||
func Test_ListGroupsRequestToModel(t *testing.T) {
|
||||
|
||||
groupIDsSearchQuery, err := query.NewGroupIDsSearchQuery([]string{"group1", "group2"})
|
||||
require.NoError(t, err)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
maxQueryLimit uint64
|
||||
req *group_v2.ListGroupsRequest
|
||||
wantResp *query.GroupSearchQuery
|
||||
wantErr error
|
||||
}{
|
||||
{
|
||||
name: "max query limit exceeded",
|
||||
maxQueryLimit: 1,
|
||||
req: &group_v2.ListGroupsRequest{
|
||||
Pagination: &filter.PaginationRequest{
|
||||
Limit: 5,
|
||||
},
|
||||
Filters: []*group_v2.GroupsSearchFilter{
|
||||
{
|
||||
Filter: &group_v2.GroupsSearchFilter_GroupIds{
|
||||
GroupIds: &filter.InIDsFilter{
|
||||
Ids: []string{"group1", "group2"},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
wantErr: zerrors.ThrowInvalidArgumentf(errors.New("given: 5, allowed: 1"), "QUERY-4M0fs", "Errors.Query.LimitExceeded"),
|
||||
},
|
||||
{
|
||||
name: "valid request, list of group IDs, ok",
|
||||
req: &group_v2.ListGroupsRequest{
|
||||
Filters: []*group_v2.GroupsSearchFilter{
|
||||
{
|
||||
Filter: &group_v2.GroupsSearchFilter_GroupIds{
|
||||
GroupIds: &filter.InIDsFilter{
|
||||
Ids: []string{"group1", "group2"},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
wantResp: &query.GroupSearchQuery{
|
||||
SearchRequest: query.SearchRequest{
|
||||
Offset: 0,
|
||||
Limit: 0,
|
||||
SortingColumn: query.GroupColumnCreationDate,
|
||||
},
|
||||
Queries: []query.SearchQuery{groupIDsSearchQuery},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
sysDefaults := systemdefaults.SystemDefaults{MaxQueryLimit: tt.maxQueryLimit}
|
||||
got, err := listGroupsRequestToModel(tt.req, sysDefaults)
|
||||
if tt.wantErr != nil {
|
||||
assert.Equal(t, tt.wantErr, err)
|
||||
return
|
||||
}
|
||||
for _, q := range got.Queries {
|
||||
fmt.Printf("%+v", q)
|
||||
}
|
||||
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, tt.wantResp, got)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func Test_GroupSearchFiltersToQuery(t *testing.T) {
|
||||
groupIDsSearchQuery, err := query.NewGroupIDsSearchQuery([]string{"group1", "group2"})
|
||||
require.NoError(t, err)
|
||||
groupNameSearchQuery, err := query.NewGroupNameSearchQuery("mygroup", query.TextStartsWith)
|
||||
require.NoError(t, err)
|
||||
groupOrgIDSearchQuery, err := query.NewGroupOrganizationIdSearchQuery("org1")
|
||||
require.NoError(t, err)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
filters []*group_v2.GroupsSearchFilter
|
||||
want []query.SearchQuery
|
||||
wantErr error
|
||||
}{
|
||||
{
|
||||
name: "empty",
|
||||
filters: []*group_v2.GroupsSearchFilter{},
|
||||
want: []query.SearchQuery{},
|
||||
},
|
||||
{
|
||||
name: "all filters",
|
||||
filters: []*group_v2.GroupsSearchFilter{
|
||||
{
|
||||
Filter: &group_v2.GroupsSearchFilter_GroupIds{
|
||||
GroupIds: &filter.InIDsFilter{
|
||||
Ids: []string{"group1", "group2"},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Filter: &group_v2.GroupsSearchFilter_NameFilter{
|
||||
NameFilter: &group_v2.GroupNameFilter{
|
||||
Name: "mygroup",
|
||||
Method: filter.TextFilterMethod_TEXT_FILTER_METHOD_STARTS_WITH,
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Filter: &group_v2.GroupsSearchFilter_OrganizationId{
|
||||
OrganizationId: &filter.IDFilter{
|
||||
Id: "org1",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
want: []query.SearchQuery{
|
||||
groupIDsSearchQuery,
|
||||
groupNameSearchQuery,
|
||||
groupOrgIDSearchQuery,
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := groupSearchFiltersToQuery(tt.filters)
|
||||
if tt.wantErr != nil {
|
||||
assert.Equal(t, tt.wantErr, err)
|
||||
return
|
||||
}
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, tt.want, got)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func Test_GroupFieldNameToSortingColumn(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
field *group_v2.FieldName
|
||||
want query.Column
|
||||
}{
|
||||
{
|
||||
name: "nil",
|
||||
field: nil,
|
||||
want: query.GroupColumnCreationDate,
|
||||
},
|
||||
{
|
||||
name: "creation date",
|
||||
field: gu.Ptr(group_v2.FieldName_FIELD_NAME_CREATION_DATE),
|
||||
want: query.GroupColumnCreationDate,
|
||||
},
|
||||
{
|
||||
name: "unspecified",
|
||||
field: gu.Ptr(group_v2.FieldName_FIELD_NAME_UNSPECIFIED),
|
||||
want: query.GroupColumnCreationDate,
|
||||
},
|
||||
{
|
||||
name: "id",
|
||||
field: gu.Ptr(group_v2.FieldName_FIELD_NAME_ID),
|
||||
want: query.GroupColumnID,
|
||||
},
|
||||
{
|
||||
name: "name",
|
||||
field: gu.Ptr(group_v2.FieldName_FIELD_NAME_NAME),
|
||||
want: query.GroupColumnName,
|
||||
},
|
||||
{
|
||||
name: "change date",
|
||||
field: gu.Ptr(group_v2.FieldName_FIELD_NAME_CHANGE_DATE),
|
||||
want: query.GroupColumnChangeDate,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got := groupFieldNameToSortingColumn(tt.field)
|
||||
assert.Equal(t, tt.want, got)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func Test_GroupsToPb(t *testing.T) {
|
||||
timeNow := time.Now().UTC()
|
||||
tests := []struct {
|
||||
name string
|
||||
groups []*query.Group
|
||||
want []*group_v2.Group
|
||||
}{
|
||||
{
|
||||
name: "empty",
|
||||
groups: []*query.Group{},
|
||||
want: []*group_v2.Group{},
|
||||
},
|
||||
{
|
||||
name: "with groups, ok",
|
||||
groups: []*query.Group{
|
||||
{
|
||||
ID: "group1",
|
||||
Name: "mygroup",
|
||||
Description: "my first group",
|
||||
CreationDate: timeNow,
|
||||
ChangeDate: timeNow,
|
||||
ResourceOwner: "org1",
|
||||
InstanceID: "instance1",
|
||||
State: domain.GroupStateActive,
|
||||
Sequence: 1,
|
||||
},
|
||||
{
|
||||
ID: "group2",
|
||||
Name: "mygroup2",
|
||||
Description: "my second group",
|
||||
CreationDate: timeNow,
|
||||
ChangeDate: timeNow,
|
||||
ResourceOwner: "org1",
|
||||
InstanceID: "instance1",
|
||||
State: domain.GroupStateActive,
|
||||
Sequence: 1,
|
||||
},
|
||||
},
|
||||
want: []*group_v2.Group{
|
||||
{
|
||||
Id: "group1",
|
||||
Name: "mygroup",
|
||||
Description: "my first group",
|
||||
OrganizationId: "org1",
|
||||
ChangeDate: timestamppb.New(timeNow),
|
||||
CreationDate: timestamppb.New(timeNow),
|
||||
},
|
||||
{
|
||||
Id: "group2",
|
||||
Name: "mygroup2",
|
||||
Description: "my second group",
|
||||
OrganizationId: "org1",
|
||||
ChangeDate: timestamppb.New(timeNow),
|
||||
CreationDate: timestamppb.New(timeNow),
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got := groupsToPb(tt.groups)
|
||||
assert.Equal(t, tt.want, got)
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user