服务注册与分布式协调 / 系统课时
Mock Activity 与外部依赖
Mock Activity 与外部依赖
Workflow 单元测试的重点不是验证数据库、HTTP 或消息系统是否可用,而是验证编排逻辑在不同 Activity 结果下是否走对分支。本节用 Temporal Go SDK 的测试环境替换 Activity 返回值与错误,覆盖成功、重试耗尽和补偿路径,并保证测试不访问真实外部依赖。
学习目标
- 使用
TestWorkflowEnvironment.OnActivity为 Activity 注入可控返回值或错误。 - 验证 Activity 重试次数、补偿调用和 Workflow 最终结果。
- 判断哪些依赖应该 Mock,哪些行为应留给 Activity 集成测试。
把外部依赖截在 Activity 边界
Temporal Workflow 应保持确定性,数据库查询、HTTP 请求和消息发送等非确定性 I/O 应放在 Activity 中。因此测试 Workflow 时,最稳定的切入点不是 Mock 数据库驱动,而是直接替换 Activity。这样既保留 ExecuteActivity、重试策略和补偿分支,又不会真的连接外部系统。

OnActivity 可以按 Activity 函数和参数匹配调用,并通过 Return 指定结果。对同一个失败 Mock 使用 Times(3),还能把“最多尝试三次”变成可验证行为,而不是只检查最终错误字符串。
用一个测试覆盖成功与补偿分支
下面的示例把支付 Activity 设为最多尝试 3 次。成功用例直接返回收据;失败用例让支付连续失败 3 次,随后验证 Workflow 执行退款补偿。两个 Activity 的函数体只是保护性占位,测试中的 Mock 会拦截它们,因此不会访问任何真实支付系统。
package orchestration
import (
"context"
"errors"
"testing"
"time"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
"go.temporal.io/sdk/temporal"
"go.temporal.io/sdk/testsuite"
"go.temporal.io/sdk/workflow"
)
func ChargeActivity(context.Context, string) (string, error) {
return "", errors.New("real payment dependency is not configured")
}
func RefundActivity(context.Context, string) (string, error) {
return "", errors.New("real payment dependency is not configured")
}
func OrderWorkflow(ctx workflow.Context, orderID string) (string, error) {
ctx = workflow.WithActivityOptions(ctx, workflow.ActivityOptions{
StartToCloseTimeout: time.Minute,
RetryPolicy: &temporal.RetryPolicy{
InitialInterval: time.Second,
BackoffCoefficient: 1,
MaximumAttempts: 3,
},
})
var receipt string
if err := workflow.ExecuteActivity(ctx, ChargeActivity, orderID).Get(ctx, &receipt); err == nil {
return "charged:" + receipt, nil
}
// 补偿使用独立策略,避免示例中的退款再次进入多次重试。
compensationCtx := workflow.WithActivityOptions(ctx, workflow.ActivityOptions{
StartToCloseTimeout: time.Minute,
RetryPolicy: &temporal.RetryPolicy{
MaximumAttempts: 1,
},
})
var refundID string
if err := workflow.ExecuteActivity(
compensationCtx, RefundActivity, orderID,
).Get(compensationCtx, &refundID); err != nil {
return "", err
}
return "compensated:" + refundID, nil
}
func TestOrderWorkflowSuccess(t *testing.T) {
var suite testsuite.WorkflowTestSuite
env := suite.NewTestWorkflowEnvironment()
env.OnActivity(
ChargeActivity, mock.Anything, "order-42",
).Return("receipt-42", nil).Once()
env.ExecuteWorkflow(OrderWorkflow, "order-42")
require.NoError(t, env.GetWorkflowError())
var result string
require.NoError(t, env.GetWorkflowResult(&result))
require.Equal(t, "charged:receipt-42", result)
require.True(t, env.AssertExpectations(t))
}
func TestOrderWorkflowRetriesThenCompensates(t *testing.T) {
var suite testsuite.WorkflowTestSuite
env := suite.NewTestWorkflowEnvironment()
env.OnActivity(
ChargeActivity, mock.Anything, "order-42",
).Return("", errors.New("gateway unavailable")).Times(3)
env.OnActivity(
RefundActivity, mock.Anything, "order-42",
).Return("refund-42", nil).Once()
env.ExecuteWorkflow(OrderWorkflow, "order-42")
require.NoError(t, env.GetWorkflowError())
var result string
require.NoError(t, env.GetWorkflowResult(&result))
require.Equal(t, "compensated:refund-42", result)
require.True(t, env.AssertExpectations(t))
}保存为包内的 workflow_test.go,安装 Temporal Go SDK 与 testify 依赖后运行:
go test ./...预期输出:
ok <PATH> <TIME><PATH> 与 <TIME> 取决于本地包路径和测试耗时。这里真正有价值的断言不仅是最终返回值,还包括 Mock 的调用次数:如果重试策略被误改成 2 次或补偿没有执行,AssertExpectations 会让测试失败。
用错误类型控制要覆盖的分支
默认可重试错误适合验证 RetryPolicy。若业务错误本来就不应重试,例如订单参数非法,可以让 Activity Mock 返回不可重试的 Application Error,再断言补偿或失败分支是否立即发生。测试的目标是模拟 Activity 对 Workflow 可见的契约,而不是复制外部服务内部实现。
Mock 到哪一层才合适
如果你要验证“支付失败后是否重试三次并退款”,Mock Activity 最合适;如果要验证 HTTP 状态码如何映射成业务错误,则应单独测试真实 Activity 实现,并把 HTTP 客户端或测试服务器作为 Activity 层依赖。两类测试分开后,Workflow 测试负责状态与分支,Activity 测试负责 I/O 与协议,定位问题会明显更直接。
当补偿链较长时,也应为每个关键 Activity 设置明确的调用期望,并只构造触发该路径所需的最少输入。这样既能覆盖重试、补偿和异常分支,又不会把测试写成一份难维护的外部系统模拟器。