Files
tasks/service/worker/common/interface_mock.go
Michael SnowdenandGitHub d167c90162 Implement AdminService.PurgeDLQTasks (#4972)
<!-- Describe what has changed in this PR -->
**What changed?**
This PR adds the `PurgeDLQTasks` RPC to the history service. This RPC
allows users to delete tasks from the new history task DLQ.

<!-- Tell your future self why have you made these changes -->
**Why?**
We want this so that users can delete DLQ'd tasks once they've dealt
with them (e.g. re-enqueued them, decided they're poison pills, etc.).

<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
**How did you test it?**
There's a large suite of tests that covers the following:
1. All error branches (100% test coverage)
2. When arguments are invalid, we return a non-retryable error
3. When the service returns an "Unavailable" error, the workflow returns
a retryable error
4. We validate the request parameters
5. Integration tests against the actual admin and history service

<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
**Potential risks**


<!-- Is this PR a hotfix candidate or require that a notification be
sent to the broader community? (Yes/No) -->
**Is hotfix candidate?**
2023-10-18 02:06:16 +00:00

162 lines
6.5 KiB
Go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
// Code generated by MockGen. DO NOT EDIT.
// Source: interface.go
// Package common is a generated GoMock package.
package common
import (
reflect "reflect"
gomock "github.com/golang/mock/gomock"
worker "go.temporal.io/sdk/worker"
namespace "go.temporal.io/server/common/namespace"
)
// MockWorkerComponent is a mock of WorkerComponent interface.
type MockWorkerComponent struct {
ctrl *gomock.Controller
recorder *MockWorkerComponentMockRecorder
}
// MockWorkerComponentMockRecorder is the mock recorder for MockWorkerComponent.
type MockWorkerComponentMockRecorder struct {
mock *MockWorkerComponent
}
// NewMockWorkerComponent creates a new mock instance.
func NewMockWorkerComponent(ctrl *gomock.Controller) *MockWorkerComponent {
mock := &MockWorkerComponent{ctrl: ctrl}
mock.recorder = &MockWorkerComponentMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MockWorkerComponent) EXPECT() *MockWorkerComponentMockRecorder {
return m.recorder
}
// DedicatedActivityWorkerOptions mocks base method.
func (m *MockWorkerComponent) DedicatedActivityWorkerOptions() *DedicatedWorkerOptions {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "DedicatedActivityWorkerOptions")
ret0, _ := ret[0].(*DedicatedWorkerOptions)
return ret0
}
// DedicatedActivityWorkerOptions indicates an expected call of DedicatedActivityWorkerOptions.
func (mr *MockWorkerComponentMockRecorder) DedicatedActivityWorkerOptions() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DedicatedActivityWorkerOptions", reflect.TypeOf((*MockWorkerComponent)(nil).DedicatedActivityWorkerOptions))
}
// DedicatedWorkflowWorkerOptions mocks base method.
func (m *MockWorkerComponent) DedicatedWorkflowWorkerOptions() *DedicatedWorkerOptions {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "DedicatedWorkflowWorkerOptions")
ret0, _ := ret[0].(*DedicatedWorkerOptions)
return ret0
}
// DedicatedWorkflowWorkerOptions indicates an expected call of DedicatedWorkflowWorkerOptions.
func (mr *MockWorkerComponentMockRecorder) DedicatedWorkflowWorkerOptions() *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DedicatedWorkflowWorkerOptions", reflect.TypeOf((*MockWorkerComponent)(nil).DedicatedWorkflowWorkerOptions))
}
// RegisterActivities mocks base method.
func (m *MockWorkerComponent) RegisterActivities(registry worker.Registry) {
m.ctrl.T.Helper()
m.ctrl.Call(m, "RegisterActivities", registry)
}
// RegisterActivities indicates an expected call of RegisterActivities.
func (mr *MockWorkerComponentMockRecorder) RegisterActivities(registry interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RegisterActivities", reflect.TypeOf((*MockWorkerComponent)(nil).RegisterActivities), registry)
}
// RegisterWorkflow mocks base method.
func (m *MockWorkerComponent) RegisterWorkflow(registry worker.Registry) {
m.ctrl.T.Helper()
m.ctrl.Call(m, "RegisterWorkflow", registry)
}
// RegisterWorkflow indicates an expected call of RegisterWorkflow.
func (mr *MockWorkerComponentMockRecorder) RegisterWorkflow(registry interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RegisterWorkflow", reflect.TypeOf((*MockWorkerComponent)(nil).RegisterWorkflow), registry)
}
// MockPerNSWorkerComponent is a mock of PerNSWorkerComponent interface.
type MockPerNSWorkerComponent struct {
ctrl *gomock.Controller
recorder *MockPerNSWorkerComponentMockRecorder
}
// MockPerNSWorkerComponentMockRecorder is the mock recorder for MockPerNSWorkerComponent.
type MockPerNSWorkerComponentMockRecorder struct {
mock *MockPerNSWorkerComponent
}
// NewMockPerNSWorkerComponent creates a new mock instance.
func NewMockPerNSWorkerComponent(ctrl *gomock.Controller) *MockPerNSWorkerComponent {
mock := &MockPerNSWorkerComponent{ctrl: ctrl}
mock.recorder = &MockPerNSWorkerComponentMockRecorder{mock}
return mock
}
// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MockPerNSWorkerComponent) EXPECT() *MockPerNSWorkerComponentMockRecorder {
return m.recorder
}
// DedicatedWorkerOptions mocks base method.
func (m *MockPerNSWorkerComponent) DedicatedWorkerOptions(arg0 *namespace.Namespace) *PerNSDedicatedWorkerOptions {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "DedicatedWorkerOptions", arg0)
ret0, _ := ret[0].(*PerNSDedicatedWorkerOptions)
return ret0
}
// DedicatedWorkerOptions indicates an expected call of DedicatedWorkerOptions.
func (mr *MockPerNSWorkerComponentMockRecorder) DedicatedWorkerOptions(arg0 interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DedicatedWorkerOptions", reflect.TypeOf((*MockPerNSWorkerComponent)(nil).DedicatedWorkerOptions), arg0)
}
// Register mocks base method.
func (m *MockPerNSWorkerComponent) Register(arg0 worker.Registry, arg1 *namespace.Namespace, arg2 RegistrationDetails) {
m.ctrl.T.Helper()
m.ctrl.Call(m, "Register", arg0, arg1, arg2)
}
// Register indicates an expected call of Register.
func (mr *MockPerNSWorkerComponentMockRecorder) Register(arg0, arg1, arg2 interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Register", reflect.TypeOf((*MockPerNSWorkerComponent)(nil).Register), arg0, arg1, arg2)
}