marketplaceentitlementserviceiface

package
Version: v2.0.0-preview.4+incom... Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 26, 2018 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package marketplaceentitlementserviceiface provides an interface to enable mocking the AWS Marketplace Entitlement Service 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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MarketplaceEntitlementServiceAPI

type MarketplaceEntitlementServiceAPI interface {
	GetEntitlementsRequest(*marketplaceentitlementservice.GetEntitlementsInput) marketplaceentitlementservice.GetEntitlementsRequest
}

MarketplaceEntitlementServiceAPI provides an interface to enable mocking the marketplaceentitlementservice.MarketplaceEntitlementService 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 Marketplace Entitlement Service.
func myFunc(svc marketplaceentitlementserviceiface.MarketplaceEntitlementServiceAPI) bool {
    // Make svc.GetEntitlements request
}

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

    svc := marketplaceentitlementservice.New(cfg)

    myFunc(svc)
}

In your _test.go file:

// Define a mock struct to be used in your unit tests of myFunc.
type mockMarketplaceEntitlementServiceClient struct {
    marketplaceentitlementserviceiface.MarketplaceEntitlementServiceAPI
}
func (m *mockMarketplaceEntitlementServiceClient) GetEntitlements(input *marketplaceentitlementservice.GetEntitlementsInput) (*marketplaceentitlementservice.GetEntitlementsOutput, error) {
    // mock response/functionality
}

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

    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.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL