Files
zitadel/backend/v3/domain/instance_delete_test.go
T
Marco A.andGitHub 2793abf1e3 chore(domain): Assert errors using ErrorIS for instance and organization tests (#11789)
# Which Problems Are Solved

This is a small refactoring for tests in `backend/v3/domain` package to
use `assert.ErrorIs` instead of `assert.Equal` for error assertion.

# How the Problems Are Solved

  - Add custom `Is()` function to `MultipleObjectsUpdatedError` error
- Substitute `assert.Equal` with `assert.ErrorIs` in instance and
organization tests

# Additional Context

This was part of #11035
2026-03-06 19:20:54 +01:00

407 lines
11 KiB
Go

package domain_test
import (
"context"
"errors"
"testing"
"github.com/brianvoe/gofakeit/v6"
"github.com/stretchr/testify/assert"
"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/eventstore"
"github.com/zitadel/zitadel/internal/repository/instance"
"github.com/zitadel/zitadel/internal/repository/milestone"
"github.com/zitadel/zitadel/internal/zerrors"
)
func TestDeleteInstanceCommand_Validate(t *testing.T) {
t.Parallel()
permissionErr := errors.New("permission error")
tt := []struct {
name string
permissionChecker func(ctrl *gomock.Controller) domain.PermissionChecker
inputID string
expectedError error
}{
{
name: "empty id",
inputID: "",
expectedError: zerrors.ThrowInvalidArgument(nil, "DOM-VpQ9lF", "Errors.Invalid.Argument"),
},
{
name: "whitespace id",
inputID: " ",
expectedError: zerrors.ThrowInvalidArgument(nil, "DOM-VpQ9lF", "Errors.Invalid.Argument"),
},
{
name: "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
},
expectedError: zerrors.ThrowPermissionDenied(permissionErr, "DOM-Yz8f1X", "Errors.PermissionDenied"),
inputID: "instance-1",
},
{
name: "valid id",
permissionChecker: func(ctrl *gomock.Controller) domain.PermissionChecker {
permChecker := domainmock.NewMockPermissionChecker(ctrl)
permChecker.EXPECT().
CheckInstancePermission(gomock.Any(), domain.InstanceWritePermission).
Times(1).
Return(nil)
return permChecker
},
inputID: "instance-1",
},
}
for _, tc := range tt {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
// Given
d := &domain.DeleteInstanceCommand{ID: tc.inputID}
cmdOpts := &domain.InvokeOpts{}
if tc.permissionChecker != nil {
ctrl := gomock.NewController(t)
cmdOpts.Permissions = tc.permissionChecker(ctrl)
}
// Test
err := d.Validate(context.Background(), cmdOpts)
// Verify
assert.ErrorIs(t, err, tc.expectedError)
})
}
}
func TestDeleteInstanceCommand_Events(t *testing.T) {
t.Parallel()
// Given
cmd := domain.NewDeleteInstanceCommand("instance-1")
expectedEvents := []eventstore.Command{
instance.NewInstanceRemovedEvent(context.Background(), &instance.NewAggregate("instance-1").Aggregate, "instance-1", []string{}),
milestone.NewReachedEvent(context.Background(), milestone.NewInstanceAggregate("instance-1"), milestone.InstanceDeleted),
}
// Test
events, err := cmd.Events(context.Background(), nil)
// Verify
assert.NoError(t, err)
assert.Len(t, events, len(expectedEvents))
assert.IsType(t, &instance.InstanceRemovedEvent{}, events[0])
assert.IsType(t, &milestone.ReachedEvent{}, events[1])
}
func TestDeleteInstanceCommand_Execute(t *testing.T) {
t.Parallel()
ctx := authz.NewMockContext("inst-1", "org-1", gofakeit.UUID())
deleteErr := errors.New("delete error")
getErr := errors.New("get error")
noRowFoundErr := database.NewNoRowFoundError(nil)
tests := []struct {
testName string
instanceRepo func(ctrl *gomock.Controller) domain.InstanceRepository
inputInstanceID string
expectedError error
expectedInstanceName string
expectedInstanceDomains []string
expectsDeleteTime bool
}{
{
testName: "when retrieving instance fails should return error",
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
instanceRepo := domainmock.NewInstanceRepo(ctrl)
instanceRepo.EXPECT().
LoadDomains().
Times(1).
Return(instanceRepo)
instanceRepo.EXPECT().
Get(
gomock.Any(),
gomock.Any(),
dbmock.QueryOptions(database.WithCondition(
instanceRepo.IDCondition("instance-1"),
)),
).
Times(1).
Return(nil, noRowFoundErr)
return instanceRepo
},
inputInstanceID: "instance-1",
},
{
testName: "when retrieving instance fails with no row found should return no error",
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
instanceRepo := domainmock.NewInstanceRepo(ctrl)
instanceRepo.EXPECT().
LoadDomains().
Times(1).
Return(instanceRepo)
instanceRepo.EXPECT().
Get(
gomock.Any(),
gomock.Any(),
dbmock.QueryOptions(database.WithCondition(
instanceRepo.IDCondition("instance-1"),
)),
).
Times(1).
Return(nil, getErr)
return instanceRepo
},
inputInstanceID: "instance-1",
expectedError: getErr,
},
{
testName: "when delete instance fails should return error",
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
instanceRepo := domainmock.NewInstanceRepo(ctrl)
instanceRepo.EXPECT().
LoadDomains().
Times(1).
Return(instanceRepo)
instanceRepo.EXPECT().
Get(
gomock.Any(),
gomock.Any(),
dbmock.QueryOptions(database.WithCondition(
instanceRepo.IDCondition("instance-1"),
)),
).
Times(1).
Return(&domain.Instance{
ID: "instance-1",
Name: "My instance 1",
Domains: []*domain.InstanceDomain{
{Domain: "d1.example.com"},
{Domain: "d2.example.com"},
{Domain: "d3.example.com"},
},
}, nil)
instanceRepo.EXPECT().
Delete(gomock.Any(), gomock.Any(), "instance-1").
Times(1).
Return(int64(0), deleteErr)
return instanceRepo
},
inputInstanceID: "instance-1",
expectedError: zerrors.ThrowInternal(deleteErr, "DOM-caF4Vs", "Errors.Instance.Delete"),
expectedInstanceName: "My instance 1",
expectedInstanceDomains: []string{"d1.example.com", "d2.example.com", "d3.example.com"},
},
{
testName: "when delete instance fails with no row found should return no error",
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
instanceRepo := domainmock.NewInstanceRepo(ctrl)
instanceRepo.EXPECT().
LoadDomains().
Times(1).
Return(instanceRepo)
instanceRepo.EXPECT().
Get(
gomock.Any(),
gomock.Any(),
dbmock.QueryOptions(database.WithCondition(
instanceRepo.IDCondition("instance-1"),
)),
).
Times(1).
Return(&domain.Instance{
ID: "instance-1",
Name: "My instance 1",
Domains: []*domain.InstanceDomain{
{Domain: "d1.example.com"},
{Domain: "d2.example.com"},
{Domain: "d3.example.com"},
},
}, nil)
instanceRepo.EXPECT().
Delete(gomock.Any(), gomock.Any(), "instance-1").
Times(1).
Return(int64(0), database.NewNoRowFoundError(nil))
return instanceRepo
},
inputInstanceID: "instance-1",
expectedInstanceName: "My instance 1",
expectedInstanceDomains: []string{"d1.example.com", "d2.example.com", "d3.example.com"},
},
{
testName: "when more than one row deleted should return internal error",
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
instanceRepo := domainmock.NewInstanceRepo(ctrl)
instanceRepo.EXPECT().
LoadDomains().
Times(1).
Return(instanceRepo)
instanceRepo.EXPECT().
Get(
gomock.Any(),
gomock.Any(),
dbmock.QueryOptions(database.WithCondition(
instanceRepo.IDCondition("instance-1"),
)),
).
Times(1).
Return(&domain.Instance{
ID: "instance-1",
Name: "My instance 1",
Domains: []*domain.InstanceDomain{
{Domain: "d1.example.com"},
{Domain: "d2.example.com"},
{Domain: "d3.example.com"},
},
}, nil)
instanceRepo.EXPECT().
Delete(gomock.Any(), gomock.Any(), "instance-1").
Times(1).
Return(int64(2), nil)
return instanceRepo
},
inputInstanceID: "instance-1",
expectedError: zerrors.ThrowInternal(nil, "DOM-Od04Jx", "Errors.Instsance.DeleteMismatch"),
expectedInstanceName: "My instance 1",
expectedInstanceDomains: []string{"d1.example.com", "d2.example.com", "d3.example.com"},
},
{
testName: "when no rows deleted should return no error",
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
instanceRepo := domainmock.NewInstanceRepo(ctrl)
instanceRepo.EXPECT().
LoadDomains().
Times(1).
Return(instanceRepo)
instanceRepo.EXPECT().
Get(
gomock.Any(),
gomock.Any(),
dbmock.QueryOptions(database.WithCondition(
instanceRepo.IDCondition("instance-1"),
)),
).
Times(1).
Return(&domain.Instance{
ID: "instance-1",
Name: "My instance 1",
Domains: []*domain.InstanceDomain{
{Domain: "d1.example.com"},
{Domain: "d2.example.com"},
{Domain: "d3.example.com"},
},
}, nil)
instanceRepo.EXPECT().
Delete(gomock.Any(), gomock.Any(), "instance-1").
Times(1).
Return(int64(0), nil)
return instanceRepo
},
inputInstanceID: "instance-1",
expectedInstanceName: "My instance 1",
expectedInstanceDomains: []string{"d1.example.com", "d2.example.com", "d3.example.com"},
},
{
testName: "when one row deleted should execute successfully",
instanceRepo: func(ctrl *gomock.Controller) domain.InstanceRepository {
instanceRepo := domainmock.NewInstanceRepo(ctrl)
instanceRepo.EXPECT().
LoadDomains().
Times(1).
Return(instanceRepo)
instanceRepo.EXPECT().
Get(
gomock.Any(),
gomock.Any(),
dbmock.QueryOptions(database.WithCondition(
instanceRepo.IDCondition("instance-1"),
)),
).
Times(1).
Return(&domain.Instance{
ID: "instance-1",
Name: "My instance 1",
Domains: []*domain.InstanceDomain{
{Domain: "d1.example.com"},
{Domain: "d2.example.com"},
{Domain: "d3.example.com"},
},
}, nil)
instanceRepo.EXPECT().
Delete(gomock.Any(), gomock.Any(), "instance-1").
Times(1).
Return(int64(1), nil)
return instanceRepo
},
inputInstanceID: "instance-1",
expectedInstanceName: "My instance 1",
expectedInstanceDomains: []string{"d1.example.com", "d2.example.com", "d3.example.com"},
expectsDeleteTime: true,
},
}
for _, tc := range tests {
t.Run(tc.testName, func(t *testing.T) {
t.Parallel()
// Given
d := domain.NewDeleteInstanceCommand(tc.inputInstanceID)
ctrl := gomock.NewController(t)
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 := d.Execute(ctx, opts)
// Verify
assert.ErrorIs(t, err, tc.expectedError)
assert.Equal(t, tc.expectedInstanceName, d.InstanceName)
assert.ElementsMatch(t, tc.expectedInstanceDomains, d.InstanceDomains)
assert.Equal(t, tc.expectsDeleteTime, d.DeleteTime != nil && !d.DeleteTime.IsZero())
})
}
}