mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-19 11:45:12 +00:00
feat(domain): Instance APIs with relational tables (#10953)
# Which Problems Are Solved This PR implements the endpoints listed in https://github.com/zitadel/zitadel/issues/10443 . # How the Problems Are Solved The implementation follows the same pattern as the Organization one. There are no peculiarities to this PR. The `Update`, `Delete` are implementing the `Commander` interface, while `Get` and `List` instance(s) endpoints are implementing the `Querier` interace. # Additional Context - Closes #10443 - Depends on #10445
This commit is contained in:
@@ -0,0 +1,300 @@
|
||||
package domain_test
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"go.uber.org/mock/gomock"
|
||||
|
||||
"github.com/zitadel/zitadel/backend/v3/domain"
|
||||
domainmock "github.com/zitadel/zitadel/backend/v3/domain/mock"
|
||||
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
||||
"github.com/zitadel/zitadel/backend/v3/storage/database/dbmock"
|
||||
noopdb "github.com/zitadel/zitadel/backend/v3/storage/database/dialect/noop"
|
||||
"github.com/zitadel/zitadel/internal/api/authz"
|
||||
"github.com/zitadel/zitadel/internal/repository/instance"
|
||||
"github.com/zitadel/zitadel/internal/zerrors"
|
||||
)
|
||||
|
||||
func TestUpdateInstanceCommand_Validate(t *testing.T) {
|
||||
t.Parallel()
|
||||
getErr := errors.New("get error")
|
||||
permissionErr := errors.New("permission error")
|
||||
|
||||
tt := []struct {
|
||||
testName string
|
||||
instanceRepo func(ctrl *gomock.Controller) domain.InstanceRepository
|
||||
permissionChecker func(ctrl *gomock.Controller) domain.PermissionChecker
|
||||
inputInstanceID string
|
||||
inputInstanceName string
|
||||
expectedError error
|
||||
}{
|
||||
{
|
||||
testName: "when no ID should return invalid argument error",
|
||||
inputInstanceID: "",
|
||||
inputInstanceName: "test-name",
|
||||
expectedError: zerrors.ThrowInvalidArgument(nil, "DOM-wSs6kG", "invalid instance ID"),
|
||||
},
|
||||
{
|
||||
testName: "when no name shuld return invalid argument error",
|
||||
inputInstanceID: "test-id",
|
||||
inputInstanceName: "",
|
||||
expectedError: zerrors.ThrowInvalidArgument(nil, "DOM-FPJcLC", "invalid instance name"),
|
||||
},
|
||||
{
|
||||
testName: "when user is missing permission should return permission denied",
|
||||
permissionChecker: func(ctrl *gomock.Controller) domain.PermissionChecker {
|
||||
permChecker := domainmock.NewMockPermissionChecker(ctrl)
|
||||
|
||||
permChecker.EXPECT().
|
||||
CheckInstancePermission(gomock.Any(), domain.InstanceWritePermission).
|
||||
Times(1).
|
||||
Return(permissionErr)
|
||||
|
||||
return permChecker
|
||||
},
|
||||
inputInstanceID: "instance-1",
|
||||
inputInstanceName: "test instance update",
|
||||
expectedError: zerrors.ThrowPermissionDenied(permissionErr, "DOM-M5ObLP", "permission denied"),
|
||||
},
|
||||
{
|
||||
testName: "when retrieving instance fails should return error",
|
||||
permissionChecker: func(ctrl *gomock.Controller) domain.PermissionChecker {
|
||||
permChecker := domainmock.NewMockPermissionChecker(ctrl)
|
||||
|
||||
permChecker.EXPECT().
|
||||
CheckInstancePermission(gomock.Any(), domain.InstanceWritePermission).
|
||||
Times(1).
|
||||
Return(nil)
|
||||
|
||||
return permChecker
|
||||
},
|
||||
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
|
||||
repo := domainmock.NewInstanceRepo(ctrl)
|
||||
repo.EXPECT().
|
||||
Get(gomock.Any(), gomock.Any(), dbmock.QueryOptions(
|
||||
database.WithCondition(
|
||||
repo.IDCondition("instance-1"),
|
||||
),
|
||||
)).
|
||||
Times(1).
|
||||
Return(nil, getErr)
|
||||
return repo
|
||||
},
|
||||
inputInstanceID: "instance-1",
|
||||
inputInstanceName: "test instance update",
|
||||
expectedError: getErr,
|
||||
},
|
||||
{
|
||||
testName: "when instance name is not changed should return name not changed error",
|
||||
permissionChecker: func(ctrl *gomock.Controller) domain.PermissionChecker {
|
||||
permChecker := domainmock.NewMockPermissionChecker(ctrl)
|
||||
|
||||
permChecker.EXPECT().
|
||||
CheckInstancePermission(gomock.Any(), domain.InstanceWritePermission).
|
||||
Times(1).
|
||||
Return(nil)
|
||||
|
||||
return permChecker
|
||||
},
|
||||
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
|
||||
repo := domainmock.NewInstanceRepo(ctrl)
|
||||
repo.EXPECT().
|
||||
Get(gomock.Any(), gomock.Any(), dbmock.QueryOptions(database.WithCondition(
|
||||
repo.IDCondition("instance-1"),
|
||||
))).
|
||||
Times(1).
|
||||
Return(&domain.Instance{
|
||||
ID: "instance-1",
|
||||
Name: "test instance update",
|
||||
}, nil)
|
||||
return repo
|
||||
},
|
||||
inputInstanceID: "instance-1",
|
||||
inputInstanceName: "test instance update",
|
||||
expectedError: zerrors.ThrowPreconditionFailed(nil, "DOM-5MrT21", "Errors.Instance.NotChanged"),
|
||||
},
|
||||
{
|
||||
testName: "when instance name is changed should validate successfully and return no error",
|
||||
permissionChecker: func(ctrl *gomock.Controller) domain.PermissionChecker {
|
||||
permChecker := domainmock.NewMockPermissionChecker(ctrl)
|
||||
|
||||
permChecker.EXPECT().
|
||||
CheckInstancePermission(gomock.Any(), domain.InstanceWritePermission).
|
||||
Times(1).
|
||||
Return(nil)
|
||||
|
||||
return permChecker
|
||||
},
|
||||
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
|
||||
repo := domainmock.NewInstanceRepo(ctrl)
|
||||
repo.EXPECT().
|
||||
Get(gomock.Any(), gomock.Any(), dbmock.QueryOptions(database.WithCondition(
|
||||
repo.IDCondition("instance-1"),
|
||||
))).
|
||||
Times(1).
|
||||
Return(&domain.Instance{
|
||||
ID: "instance-1",
|
||||
Name: "old instance name",
|
||||
}, nil)
|
||||
return repo
|
||||
},
|
||||
inputInstanceID: "instance-1",
|
||||
inputInstanceName: "test instance update",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range tt {
|
||||
t.Run(tc.testName, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
// Given
|
||||
ctx := authz.NewMockContext("instance-1", "", "")
|
||||
ctrl := gomock.NewController(t)
|
||||
cmd := domain.NewUpdateInstanceCommand(tc.inputInstanceID, tc.inputInstanceName)
|
||||
|
||||
opts := &domain.InvokeOpts{
|
||||
Invoker: domain.NewTransactionInvoker(nil),
|
||||
}
|
||||
domain.WithQueryExecutor(new(noopdb.Pool))(opts)
|
||||
if tc.instanceRepo != nil {
|
||||
domain.WithInstanceRepo(tc.instanceRepo(ctrl))(opts)
|
||||
}
|
||||
if tc.permissionChecker != nil {
|
||||
opts.Permissions = tc.permissionChecker(ctrl)
|
||||
}
|
||||
|
||||
err := cmd.Validate(ctx, opts)
|
||||
assert.Equal(t, tc.expectedError, err)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestUpdateInstanceCommand_Execute(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
updateErr := errors.New("update error")
|
||||
|
||||
tt := []struct {
|
||||
testName string
|
||||
|
||||
instanceRepo func(ctrl *gomock.Controller) domain.InstanceRepository
|
||||
|
||||
inputID string
|
||||
inputName string
|
||||
|
||||
expectedError error
|
||||
}{
|
||||
{
|
||||
testName: "when instance update fails should return error",
|
||||
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
|
||||
repo := domainmock.NewInstanceRepo(ctrl)
|
||||
repo.EXPECT().
|
||||
Update(gomock.Any(), gomock.Any(),
|
||||
"instance-1",
|
||||
repo.SetName("test instance update"),
|
||||
).
|
||||
Times(1).
|
||||
Return(int64(0), updateErr)
|
||||
return repo
|
||||
},
|
||||
inputID: "instance-1",
|
||||
inputName: "test instance update",
|
||||
expectedError: updateErr,
|
||||
},
|
||||
{
|
||||
testName: "when instance update returns 0 rows updated should return not found error",
|
||||
inputID: "instance-1",
|
||||
inputName: "test instance update",
|
||||
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
|
||||
repo := domainmock.NewInstanceRepo(ctrl)
|
||||
repo.EXPECT().
|
||||
Update(gomock.Any(), gomock.Any(),
|
||||
"instance-1",
|
||||
repo.SetName("test instance update"),
|
||||
).
|
||||
Times(1).
|
||||
Return(int64(0), nil)
|
||||
return repo
|
||||
},
|
||||
expectedError: zerrors.ThrowNotFound(nil, "DOM-ghfov1", "Errors.Instance.NotFound"),
|
||||
},
|
||||
{
|
||||
testName: "when instance update returns more than 1 row updated should return internal error",
|
||||
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
|
||||
repo := domainmock.NewInstanceRepo(ctrl)
|
||||
repo.EXPECT().
|
||||
Update(gomock.Any(), gomock.Any(),
|
||||
"instance-1",
|
||||
repo.SetName("test instance update"),
|
||||
).
|
||||
Times(1).
|
||||
Return(int64(2), nil)
|
||||
return repo
|
||||
},
|
||||
inputID: "instance-1",
|
||||
inputName: "test instance update",
|
||||
expectedError: zerrors.ThrowInternal(domain.NewMultipleObjectsUpdatedError(1, 2), "DOM-HlrNmD", "unexpected number of rows updated"),
|
||||
},
|
||||
{
|
||||
testName: "when instance update returns 1 row updated should return no error and set non-primary verified domain",
|
||||
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
|
||||
repo := domainmock.NewInstanceRepo(ctrl)
|
||||
|
||||
repo.EXPECT().
|
||||
Update(gomock.Any(), gomock.Any(),
|
||||
"instance-1",
|
||||
repo.SetName("test instance update"),
|
||||
).
|
||||
Times(1).
|
||||
Return(int64(1), nil)
|
||||
return repo
|
||||
},
|
||||
inputID: "instance-1",
|
||||
inputName: "test instance update",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range tt {
|
||||
t.Run(tc.testName, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
// Given
|
||||
ctx := authz.NewMockContext("instance-1", "", "")
|
||||
ctrl := gomock.NewController(t)
|
||||
cmd := domain.NewUpdateInstanceCommand(tc.inputID, tc.inputName)
|
||||
|
||||
opts := &domain.InvokeOpts{
|
||||
Invoker: domain.NewTransactionInvoker(nil),
|
||||
}
|
||||
domain.WithQueryExecutor(new(noopdb.Pool))(opts)
|
||||
if tc.instanceRepo != nil {
|
||||
domain.WithInstanceRepo(tc.instanceRepo(ctrl))(opts)
|
||||
}
|
||||
|
||||
// Test
|
||||
err := cmd.Execute(ctx, opts)
|
||||
|
||||
// Verify
|
||||
assert.Equal(t, tc.expectedError, err)
|
||||
})
|
||||
}
|
||||
}
|
||||
func TestUpdateInstanceCommand_Events(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// Given
|
||||
ctx := authz.NewMockContext("instance-1", "", "")
|
||||
cmd := domain.NewUpdateInstanceCommand("instance-1", "test-name")
|
||||
|
||||
// Test
|
||||
events, err := cmd.Events(ctx, &domain.InvokeOpts{})
|
||||
|
||||
// Verify
|
||||
assert.NoError(t, err)
|
||||
require.Len(t, events, 1)
|
||||
|
||||
event := events[0].(*instance.InstanceChangedEvent)
|
||||
assert.Equal(t, "instance-1", event.Aggregate().ID)
|
||||
assert.Equal(t, "test-name", event.Name)
|
||||
}
|
||||
Reference in New Issue
Block a user