aws-sdk-go: github.com/aws/aws-sdk-go/service/personalizeevents/personalizeeventsiface Index | Files

package personalizeeventsiface

import "github.com/aws/aws-sdk-go/service/personalizeevents/personalizeeventsiface"

Package personalizeeventsiface provides an interface to enable mocking the Amazon Personalize Events 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

Package Files

interface.go

type PersonalizeEventsAPI Uses

type PersonalizeEventsAPI interface {
    PutEvents(*personalizeevents.PutEventsInput) (*personalizeevents.PutEventsOutput, error)
    PutEventsWithContext(aws.Context, *personalizeevents.PutEventsInput, ...request.Option) (*personalizeevents.PutEventsOutput, error)
    PutEventsRequest(*personalizeevents.PutEventsInput) (*request.Request, *personalizeevents.PutEventsOutput)
}

PersonalizeEventsAPI provides an interface to enable mocking the personalizeevents.PersonalizeEvents 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
// Amazon Personalize Events.
func myFunc(svc personalizeeventsiface.PersonalizeEventsAPI) bool {
    // Make svc.PutEvents request
}

func main() {
    sess := session.New()
    svc := personalizeevents.New(sess)

    myFunc(svc)
}

In your _test.go file:

// Define a mock struct to be used in your unit tests of myFunc.
type mockPersonalizeEventsClient struct {
    personalizeeventsiface.PersonalizeEventsAPI
}
func (m *mockPersonalizeEventsClient) PutEvents(input *personalizeevents.PutEventsInput) (*personalizeevents.PutEventsOutput, error) {
    // mock response/functionality
}

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

    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.

Package personalizeeventsiface imports 3 packages (graph). Updated 2019-06-10. Refresh now. Tools for package owners.