sfniface

Documentation

Overview

Package sfniface provides an interface to enable mocking the AWS Step Functions service client for testing your code.

It is important to note that this interface will have breaking changes when the service model is updated and adds new API operations, paginators, and waiters.

Index

• type SFNAPI

Types

type SFNAPI

type SFNAPI interface {
	CreateActivityRequest(*sfn.CreateActivityInput) sfn.CreateActivityRequest

	CreateStateMachineRequest(*sfn.CreateStateMachineInput) sfn.CreateStateMachineRequest

	DeleteActivityRequest(*sfn.DeleteActivityInput) sfn.DeleteActivityRequest

	DeleteStateMachineRequest(*sfn.DeleteStateMachineInput) sfn.DeleteStateMachineRequest

	DescribeActivityRequest(*sfn.DescribeActivityInput) sfn.DescribeActivityRequest

	DescribeExecutionRequest(*sfn.DescribeExecutionInput) sfn.DescribeExecutionRequest

	DescribeStateMachineRequest(*sfn.DescribeStateMachineInput) sfn.DescribeStateMachineRequest

	GetActivityTaskRequest(*sfn.GetActivityTaskInput) sfn.GetActivityTaskRequest

	GetExecutionHistoryRequest(*sfn.GetExecutionHistoryInput) sfn.GetExecutionHistoryRequest

	GetExecutionHistoryPages(*sfn.GetExecutionHistoryInput, func(*sfn.GetExecutionHistoryOutput, bool) bool) error
	GetExecutionHistoryPagesWithContext(aws.Context, *sfn.GetExecutionHistoryInput, func(*sfn.GetExecutionHistoryOutput, bool) bool, ...aws.Option) error

	ListActivitiesRequest(*sfn.ListActivitiesInput) sfn.ListActivitiesRequest

	ListActivitiesPages(*sfn.ListActivitiesInput, func(*sfn.ListActivitiesOutput, bool) bool) error
	ListActivitiesPagesWithContext(aws.Context, *sfn.ListActivitiesInput, func(*sfn.ListActivitiesOutput, bool) bool, ...aws.Option) error

	ListExecutionsRequest(*sfn.ListExecutionsInput) sfn.ListExecutionsRequest

	ListExecutionsPages(*sfn.ListExecutionsInput, func(*sfn.ListExecutionsOutput, bool) bool) error
	ListExecutionsPagesWithContext(aws.Context, *sfn.ListExecutionsInput, func(*sfn.ListExecutionsOutput, bool) bool, ...aws.Option) error

	ListStateMachinesRequest(*sfn.ListStateMachinesInput) sfn.ListStateMachinesRequest

	ListStateMachinesPages(*sfn.ListStateMachinesInput, func(*sfn.ListStateMachinesOutput, bool) bool) error
	ListStateMachinesPagesWithContext(aws.Context, *sfn.ListStateMachinesInput, func(*sfn.ListStateMachinesOutput, bool) bool, ...aws.Option) error

	SendTaskFailureRequest(*sfn.SendTaskFailureInput) sfn.SendTaskFailureRequest

	SendTaskHeartbeatRequest(*sfn.SendTaskHeartbeatInput) sfn.SendTaskHeartbeatRequest

	SendTaskSuccessRequest(*sfn.SendTaskSuccessInput) sfn.SendTaskSuccessRequest

	StartExecutionRequest(*sfn.StartExecutionInput) sfn.StartExecutionRequest

	StopExecutionRequest(*sfn.StopExecutionInput) sfn.StopExecutionRequest
}

SFNAPI provides an interface to enable mocking the sfn.SFN service client's API operation, paginators, and waiters. This make unit testing your code that calls out to the SDK's service client's calls easier.

The best way to use this interface is so the SDK's service client's calls can be stubbed out for unit testing your code with the SDK without needing to inject custom request handlers into the SDK's request pipeline.

// myFunc uses an SDK service client to make a request to
// AWS Step Functions.
func myFunc(svc sfniface.SFNAPI) bool {
    // Make svc.CreateActivity request
}

func main() {
    cfg, err := external.LoadDefaultAWSConfig()
    if err != nil {
        panic("failed to load config, " + err.Error())
    }

    svc := sfn.New(cfg)

    myFunc(svc)
}

In your _test.go file:

// Define a mock struct to be used in your unit tests of myFunc.
type mockSFNClient struct {
    sfniface.SFNAPI
}
func (m *mockSFNClient) CreateActivity(input *sfn.CreateActivityInput) (*sfn.CreateActivityOutput, error) {
    // mock response/functionality
}

func TestMyFunc(t *testing.T) {
    // Setup Test
    mockSvc := &mockSFNClient{}

    myfunc(mockSvc)

    // Verify myFunc's functionality
}

It is important to note that this interface will have breaking changes when the service model is updated and adds new API operations, paginators, and waiters. Its suggested to use the pattern above for testing, or using tooling to generate mocks to satisfy the interfaces.