serverlessapplicationrepositoryiface

Documentation

Overview

Package serverlessapplicationrepositoryiface provides an interface to enable mocking the AWSServerlessApplicationRepository 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 ServerlessApplicationRepositoryAPI

Types

type ServerlessApplicationRepositoryAPI

type ServerlessApplicationRepositoryAPI interface {
	CreateApplicationRequest(*serverlessapplicationrepository.CreateApplicationInput) serverlessapplicationrepository.CreateApplicationRequest

	CreateApplicationVersionRequest(*serverlessapplicationrepository.CreateApplicationVersionInput) serverlessapplicationrepository.CreateApplicationVersionRequest

	CreateCloudFormationChangeSetRequest(*serverlessapplicationrepository.CreateCloudFormationChangeSetInput) serverlessapplicationrepository.CreateCloudFormationChangeSetRequest

	GetApplicationRequest(*serverlessapplicationrepository.GetApplicationInput) serverlessapplicationrepository.GetApplicationRequest

	GetApplicationPolicyRequest(*serverlessapplicationrepository.GetApplicationPolicyInput) serverlessapplicationrepository.GetApplicationPolicyRequest

	ListApplicationVersionsRequest(*serverlessapplicationrepository.ListApplicationVersionsInput) serverlessapplicationrepository.ListApplicationVersionsRequest

	ListApplicationsRequest(*serverlessapplicationrepository.ListApplicationsInput) serverlessapplicationrepository.ListApplicationsRequest

	PutApplicationPolicyRequest(*serverlessapplicationrepository.PutApplicationPolicyInput) serverlessapplicationrepository.PutApplicationPolicyRequest

	UpdateApplicationRequest(*serverlessapplicationrepository.UpdateApplicationInput) serverlessapplicationrepository.UpdateApplicationRequest
}

ServerlessApplicationRepositoryAPI provides an interface to enable mocking the serverlessapplicationrepository.ServerlessApplicationRepository 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
// AWSServerlessApplicationRepository.
func myFunc(svc serverlessapplicationrepositoryiface.ServerlessApplicationRepositoryAPI) bool {
    // Make svc.CreateApplication request
}

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

    svc := serverlessapplicationrepository.New(cfg)

    myFunc(svc)
}

In your _test.go file:

// Define a mock struct to be used in your unit tests of myFunc.
type mockServerlessApplicationRepositoryClient struct {
    serverlessapplicationrepositoryiface.ServerlessApplicationRepositoryAPI
}
func (m *mockServerlessApplicationRepositoryClient) CreateApplication(input *serverlessapplicationrepository.CreateApplicationInput) (*serverlessapplicationrepository.CreateApplicationOutput, error) {
    // mock response/functionality
}

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

    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.