Files
Stephan BehnkeandGitHub 4d41efecb0 Rename api.WorkflowContext to api.WorkflowLease (#5386)
## What changed?
<!-- Describe what has changed in this PR -->

Renamed `api.WorkflowContext` to `api.WorkflowLease`.

## Why?

The name is confusing as there is already a `workflow.Context`. It keeps
coming up for me and makes it unnecessarily harder to read/understand
the code. The current name also doesn't _add_ anything but the entity
_is_ different from `workflow.Context`. I believe it effectively acts as
a "lease".

If that one doesn't work, I'm happy to find a better name than that
together.

## How did you test it?

Compiler.

## Potential risks

N/A

## Is hotfix candidate?

No
2024-02-05 09:41:18 -08:00

118 lines
3.8 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.
package isworkflowtaskvalid
import (
"math/rand"
"testing"
"github.com/golang/mock/gomock"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
"go.temporal.io/api/serviceerror"
"go.temporal.io/server/common"
"go.temporal.io/server/service/history/api"
"go.temporal.io/server/service/history/workflow"
)
type (
apiSuite struct {
suite.Suite
*require.Assertions
controller *gomock.Controller
workflowLease api.WorkflowLease
workflowContext *workflow.MockContext
mutableState *workflow.MockMutableState
}
)
func TestAPISuite(t *testing.T) {
s := new(apiSuite)
suite.Run(t, s)
}
func (s *apiSuite) SetupTest() {
s.Assertions = require.New(s.T())
s.controller = gomock.NewController(s.T())
s.workflowContext = workflow.NewMockContext(s.controller)
s.mutableState = workflow.NewMockMutableState(s.controller)
s.workflowLease = api.NewWorkflowLease(
s.workflowContext,
func(err error) {},
s.mutableState,
)
}
func (s *apiSuite) TeardownTest() {
s.controller.Finish()
}
func (s *apiSuite) TestWorkflowCompleted() {
s.mutableState.EXPECT().IsWorkflowExecutionRunning().Return(false)
_, err := isWorkflowTaskValid(s.workflowLease, rand.Int63())
s.Error(err)
s.IsType(&serviceerror.NotFound{}, err)
}
func (s *apiSuite) TestWorkflowRunning_WorkflowTaskNotStarted() {
s.mutableState.EXPECT().IsWorkflowExecutionRunning().Return(true)
workflowTaskScheduleEventID := rand.Int63()
s.mutableState.EXPECT().GetWorkflowTaskByID(workflowTaskScheduleEventID).Return(&workflow.WorkflowTaskInfo{
ScheduledEventID: workflowTaskScheduleEventID,
StartedEventID: common.EmptyEventID,
})
valid, err := isWorkflowTaskValid(s.workflowLease, workflowTaskScheduleEventID)
s.NoError(err)
s.True(valid)
}
func (s *apiSuite) TestWorkflowRunning_WorkflowTaskStarted() {
s.mutableState.EXPECT().IsWorkflowExecutionRunning().Return(true)
workflowTaskScheduleEventID := rand.Int63()
s.mutableState.EXPECT().GetWorkflowTaskByID(workflowTaskScheduleEventID).Return(&workflow.WorkflowTaskInfo{
ScheduledEventID: workflowTaskScheduleEventID,
StartedEventID: workflowTaskScheduleEventID + 10,
})
valid, err := isWorkflowTaskValid(s.workflowLease, workflowTaskScheduleEventID)
s.NoError(err)
s.False(valid)
}
func (s *apiSuite) TestWorkflowRunning_WorkflowTaskMissing() {
s.mutableState.EXPECT().IsWorkflowExecutionRunning().Return(true)
workflowTaskScheduleEventID := rand.Int63()
s.mutableState.EXPECT().GetWorkflowTaskByID(workflowTaskScheduleEventID).Return(nil)
valid, err := isWorkflowTaskValid(s.workflowLease, workflowTaskScheduleEventID)
s.NoError(err)
s.False(valid)
}