mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 13:52:51 +00:00
# Which Problems Are Solved This PR implements the endpoints listed in #10445 using relational tables. - [x] UpdateOrganization - [x] ListOrganizations - [x] DeleteOrganization - [x] DeactivateOrganization - [x] ActivateOrganization # How the Problems Are Solved - **UpdateOrganization:** Implemented logic for `Validate()`, `Execute()` and `Events()`. On CQRS side, updating an organization emits events related to the organization and its domains. Separate commanders have been made for the domain events so that their logic is run accordingly and we keep separation of concerns. Implementation of the domains is left to its own ticket. Because some domain-related data is changed during the organization update, its original values are saved as pointers inside [UpdateOrgCommand](https://github.com/zitadel/zitadel/blob/4f87cd8d0cfd75f290aa13c342e4939cecebef73/backend/v3/domain/org_update.go#L20). These variables will be then used as input for the domain commanders (that will run after the update organization one). - **ListOrganizations:** Implemented logic for `Validate()`, `Execute()`. Utility methods have been made to parse the input queries. This commander is used both by the v2 and v2beta endpoint, so a translation layer has been put in place to translate all v2beta requests into v2. The commander strictly handles v2 request only. The translation layer between v2beta and v2 APIs was made so to make it simple to remove it once the v2beta APIs will be removed (a simple deletion should suffice). A `converter` package [is shipped](https://github.com/zitadel/zitadel/blob/4f87cd8d0cfd75f290aa13c342e4939cecebef73/backend/v3/api/org/v2/convert/README.md#L5) as well with instruction for removal. TODOs have been put in place all over the code to indicate that the related piece of code needs to be removed once v2beta -> v2 transition is complete. - **DeleteOrganization:** Implemented logic for `Validate()`, `Execute()` and `Events()`. The `Events()` method is mostly incomplete as it requires a lot of data that is currently not retrievable due to the lack of their relational tables. - **DeactivateOrganization** and **ActivateOrganization**: Implemented logic for `Validate()`, `Execute()` and `Events()`. No notable remarks. 👉 All endpoints return matching errors to the CQRS counterpart: this way allows re-using the integration tests and 👉 All endpoints have been unit-tested through DB mocking 👉 A bunch of TODOs have been put in place for future reworks that are needed (e.g. `Update()` method on repository should also return a timestamp) # Additional Changes - A test utility method to allow mocking query options have been made. This was necessary because `database.QueryOption` is a function and the only comparison possible with functions is `nil` check. So, to mock this, `database.QueryOption` is converted first to `database.QueryOpts`. See 2276742adaef1998ea4844e1f0dca2079e45ccfb - A `BaseCommand` has been created with the idea to collect methods that are going to be needed by other commands. For the moment, it only offers a method to convert query text operations from gRPC to `domain` model. See bb85456dd101282fa76d2e2ad165eed4c8ef61b9 - SQL operations have been reworked to allow for queries using `ContainsIgnoreCase`, `EndsWithIgnoreCase` and other `IgnoreCase` operations. This change is pending approval and might be reworked. See https://github.com/zitadel/zitadel/pull/10704#discussion_r2392886177 # Additional Context `UpdateOrganization` is partially working because the logic for handling domain updates is not done (there is only a draft of the commanders to showcase the call chain). See https://github.com/zitadel/zitadel/pull/10704#discussion_r2356143178 Permissions are not implemented as they are missing. See https://github.com/zitadel/zitadel/pull/10771 - Closes: #10445 --------- Co-authored-by: Silvan <[email protected]>
197 lines
6.0 KiB
Go
197 lines
6.0 KiB
Go
// Code generated by MockGen. DO NOT EDIT.
|
|
// Source: github.com/zitadel/zitadel/backend/v3/domain (interfaces: Commander)
|
|
//
|
|
// Generated by this command:
|
|
//
|
|
// mockgen -typed -package domainmock -destination ./mock/commander.mock.go . Commander
|
|
//
|
|
|
|
// Package domainmock is a generated GoMock package.
|
|
package domainmock
|
|
|
|
import (
|
|
context "context"
|
|
reflect "reflect"
|
|
|
|
domain "github.com/zitadel/zitadel/backend/v3/domain"
|
|
eventstore "github.com/zitadel/zitadel/internal/eventstore"
|
|
gomock "go.uber.org/mock/gomock"
|
|
)
|
|
|
|
// MockCommander is a mock of Commander interface.
|
|
type MockCommander struct {
|
|
ctrl *gomock.Controller
|
|
recorder *MockCommanderMockRecorder
|
|
isgomock struct{}
|
|
}
|
|
|
|
// MockCommanderMockRecorder is the mock recorder for MockCommander.
|
|
type MockCommanderMockRecorder struct {
|
|
mock *MockCommander
|
|
}
|
|
|
|
// NewMockCommander creates a new mock instance.
|
|
func NewMockCommander(ctrl *gomock.Controller) *MockCommander {
|
|
mock := &MockCommander{ctrl: ctrl}
|
|
mock.recorder = &MockCommanderMockRecorder{mock}
|
|
return mock
|
|
}
|
|
|
|
// EXPECT returns an object that allows the caller to indicate expected use.
|
|
func (m *MockCommander) EXPECT() *MockCommanderMockRecorder {
|
|
return m.recorder
|
|
}
|
|
|
|
// Events mocks base method.
|
|
func (m *MockCommander) Events(ctx context.Context, opts *domain.InvokeOpts) ([]eventstore.Command, error) {
|
|
m.ctrl.T.Helper()
|
|
ret := m.ctrl.Call(m, "Events", ctx, opts)
|
|
ret0, _ := ret[0].([]eventstore.Command)
|
|
ret1, _ := ret[1].(error)
|
|
return ret0, ret1
|
|
}
|
|
|
|
// Events indicates an expected call of Events.
|
|
func (mr *MockCommanderMockRecorder) Events(ctx, opts any) *MockCommanderEventsCall {
|
|
mr.mock.ctrl.T.Helper()
|
|
call := mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Events", reflect.TypeOf((*MockCommander)(nil).Events), ctx, opts)
|
|
return &MockCommanderEventsCall{Call: call}
|
|
}
|
|
|
|
// MockCommanderEventsCall wrap *gomock.Call
|
|
type MockCommanderEventsCall struct {
|
|
*gomock.Call
|
|
}
|
|
|
|
// Return rewrite *gomock.Call.Return
|
|
func (c *MockCommanderEventsCall) Return(arg0 []eventstore.Command, arg1 error) *MockCommanderEventsCall {
|
|
c.Call = c.Call.Return(arg0, arg1)
|
|
return c
|
|
}
|
|
|
|
// Do rewrite *gomock.Call.Do
|
|
func (c *MockCommanderEventsCall) Do(f func(context.Context, *domain.InvokeOpts) ([]eventstore.Command, error)) *MockCommanderEventsCall {
|
|
c.Call = c.Call.Do(f)
|
|
return c
|
|
}
|
|
|
|
// DoAndReturn rewrite *gomock.Call.DoAndReturn
|
|
func (c *MockCommanderEventsCall) DoAndReturn(f func(context.Context, *domain.InvokeOpts) ([]eventstore.Command, error)) *MockCommanderEventsCall {
|
|
c.Call = c.Call.DoAndReturn(f)
|
|
return c
|
|
}
|
|
|
|
// Execute mocks base method.
|
|
func (m *MockCommander) Execute(ctx context.Context, opts *domain.InvokeOpts) error {
|
|
m.ctrl.T.Helper()
|
|
ret := m.ctrl.Call(m, "Execute", ctx, opts)
|
|
ret0, _ := ret[0].(error)
|
|
return ret0
|
|
}
|
|
|
|
// Execute indicates an expected call of Execute.
|
|
func (mr *MockCommanderMockRecorder) Execute(ctx, opts any) *MockCommanderExecuteCall {
|
|
mr.mock.ctrl.T.Helper()
|
|
call := mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Execute", reflect.TypeOf((*MockCommander)(nil).Execute), ctx, opts)
|
|
return &MockCommanderExecuteCall{Call: call}
|
|
}
|
|
|
|
// MockCommanderExecuteCall wrap *gomock.Call
|
|
type MockCommanderExecuteCall struct {
|
|
*gomock.Call
|
|
}
|
|
|
|
// Return rewrite *gomock.Call.Return
|
|
func (c *MockCommanderExecuteCall) Return(err error) *MockCommanderExecuteCall {
|
|
c.Call = c.Call.Return(err)
|
|
return c
|
|
}
|
|
|
|
// Do rewrite *gomock.Call.Do
|
|
func (c *MockCommanderExecuteCall) Do(f func(context.Context, *domain.InvokeOpts) error) *MockCommanderExecuteCall {
|
|
c.Call = c.Call.Do(f)
|
|
return c
|
|
}
|
|
|
|
// DoAndReturn rewrite *gomock.Call.DoAndReturn
|
|
func (c *MockCommanderExecuteCall) DoAndReturn(f func(context.Context, *domain.InvokeOpts) error) *MockCommanderExecuteCall {
|
|
c.Call = c.Call.DoAndReturn(f)
|
|
return c
|
|
}
|
|
|
|
// String mocks base method.
|
|
func (m *MockCommander) String() string {
|
|
m.ctrl.T.Helper()
|
|
ret := m.ctrl.Call(m, "String")
|
|
ret0, _ := ret[0].(string)
|
|
return ret0
|
|
}
|
|
|
|
// String indicates an expected call of String.
|
|
func (mr *MockCommanderMockRecorder) String() *MockCommanderStringCall {
|
|
mr.mock.ctrl.T.Helper()
|
|
call := mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "String", reflect.TypeOf((*MockCommander)(nil).String))
|
|
return &MockCommanderStringCall{Call: call}
|
|
}
|
|
|
|
// MockCommanderStringCall wrap *gomock.Call
|
|
type MockCommanderStringCall struct {
|
|
*gomock.Call
|
|
}
|
|
|
|
// Return rewrite *gomock.Call.Return
|
|
func (c *MockCommanderStringCall) Return(arg0 string) *MockCommanderStringCall {
|
|
c.Call = c.Call.Return(arg0)
|
|
return c
|
|
}
|
|
|
|
// Do rewrite *gomock.Call.Do
|
|
func (c *MockCommanderStringCall) Do(f func() string) *MockCommanderStringCall {
|
|
c.Call = c.Call.Do(f)
|
|
return c
|
|
}
|
|
|
|
// DoAndReturn rewrite *gomock.Call.DoAndReturn
|
|
func (c *MockCommanderStringCall) DoAndReturn(f func() string) *MockCommanderStringCall {
|
|
c.Call = c.Call.DoAndReturn(f)
|
|
return c
|
|
}
|
|
|
|
// Validate mocks base method.
|
|
func (m *MockCommander) Validate(ctx context.Context, opts *domain.InvokeOpts) error {
|
|
m.ctrl.T.Helper()
|
|
ret := m.ctrl.Call(m, "Validate", ctx, opts)
|
|
ret0, _ := ret[0].(error)
|
|
return ret0
|
|
}
|
|
|
|
// Validate indicates an expected call of Validate.
|
|
func (mr *MockCommanderMockRecorder) Validate(ctx, opts any) *MockCommanderValidateCall {
|
|
mr.mock.ctrl.T.Helper()
|
|
call := mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Validate", reflect.TypeOf((*MockCommander)(nil).Validate), ctx, opts)
|
|
return &MockCommanderValidateCall{Call: call}
|
|
}
|
|
|
|
// MockCommanderValidateCall wrap *gomock.Call
|
|
type MockCommanderValidateCall struct {
|
|
*gomock.Call
|
|
}
|
|
|
|
// Return rewrite *gomock.Call.Return
|
|
func (c *MockCommanderValidateCall) Return(err error) *MockCommanderValidateCall {
|
|
c.Call = c.Call.Return(err)
|
|
return c
|
|
}
|
|
|
|
// Do rewrite *gomock.Call.Do
|
|
func (c *MockCommanderValidateCall) Do(f func(context.Context, *domain.InvokeOpts) error) *MockCommanderValidateCall {
|
|
c.Call = c.Call.Do(f)
|
|
return c
|
|
}
|
|
|
|
// DoAndReturn rewrite *gomock.Call.DoAndReturn
|
|
func (c *MockCommanderValidateCall) DoAndReturn(f func(context.Context, *domain.InvokeOpts) error) *MockCommanderValidateCall {
|
|
c.Call = c.Call.DoAndReturn(f)
|
|
return c
|
|
}
|