personalizeiface

Documentation

Overview

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

Types

type ClientAPI

type ClientAPI interface {
	CreateCampaignRequest(*personalize.CreateCampaignInput) personalize.CreateCampaignRequest

	CreateDatasetRequest(*personalize.CreateDatasetInput) personalize.CreateDatasetRequest

	CreateDatasetGroupRequest(*personalize.CreateDatasetGroupInput) personalize.CreateDatasetGroupRequest

	CreateDatasetImportJobRequest(*personalize.CreateDatasetImportJobInput) personalize.CreateDatasetImportJobRequest

	CreateEventTrackerRequest(*personalize.CreateEventTrackerInput) personalize.CreateEventTrackerRequest

	CreateSchemaRequest(*personalize.CreateSchemaInput) personalize.CreateSchemaRequest

	CreateSolutionRequest(*personalize.CreateSolutionInput) personalize.CreateSolutionRequest

	CreateSolutionVersionRequest(*personalize.CreateSolutionVersionInput) personalize.CreateSolutionVersionRequest

	DeleteCampaignRequest(*personalize.DeleteCampaignInput) personalize.DeleteCampaignRequest

	DeleteDatasetRequest(*personalize.DeleteDatasetInput) personalize.DeleteDatasetRequest

	DeleteDatasetGroupRequest(*personalize.DeleteDatasetGroupInput) personalize.DeleteDatasetGroupRequest

	DeleteEventTrackerRequest(*personalize.DeleteEventTrackerInput) personalize.DeleteEventTrackerRequest

	DeleteSchemaRequest(*personalize.DeleteSchemaInput) personalize.DeleteSchemaRequest

	DeleteSolutionRequest(*personalize.DeleteSolutionInput) personalize.DeleteSolutionRequest

	DescribeAlgorithmRequest(*personalize.DescribeAlgorithmInput) personalize.DescribeAlgorithmRequest

	DescribeCampaignRequest(*personalize.DescribeCampaignInput) personalize.DescribeCampaignRequest

	DescribeDatasetRequest(*personalize.DescribeDatasetInput) personalize.DescribeDatasetRequest

	DescribeDatasetGroupRequest(*personalize.DescribeDatasetGroupInput) personalize.DescribeDatasetGroupRequest

	DescribeDatasetImportJobRequest(*personalize.DescribeDatasetImportJobInput) personalize.DescribeDatasetImportJobRequest

	DescribeEventTrackerRequest(*personalize.DescribeEventTrackerInput) personalize.DescribeEventTrackerRequest

	DescribeFeatureTransformationRequest(*personalize.DescribeFeatureTransformationInput) personalize.DescribeFeatureTransformationRequest

	DescribeRecipeRequest(*personalize.DescribeRecipeInput) personalize.DescribeRecipeRequest

	DescribeSchemaRequest(*personalize.DescribeSchemaInput) personalize.DescribeSchemaRequest

	DescribeSolutionRequest(*personalize.DescribeSolutionInput) personalize.DescribeSolutionRequest

	DescribeSolutionVersionRequest(*personalize.DescribeSolutionVersionInput) personalize.DescribeSolutionVersionRequest

	GetSolutionMetricsRequest(*personalize.GetSolutionMetricsInput) personalize.GetSolutionMetricsRequest

	ListCampaignsRequest(*personalize.ListCampaignsInput) personalize.ListCampaignsRequest

	ListDatasetGroupsRequest(*personalize.ListDatasetGroupsInput) personalize.ListDatasetGroupsRequest

	ListDatasetImportJobsRequest(*personalize.ListDatasetImportJobsInput) personalize.ListDatasetImportJobsRequest

	ListDatasetsRequest(*personalize.ListDatasetsInput) personalize.ListDatasetsRequest

	ListEventTrackersRequest(*personalize.ListEventTrackersInput) personalize.ListEventTrackersRequest

	ListRecipesRequest(*personalize.ListRecipesInput) personalize.ListRecipesRequest

	ListSchemasRequest(*personalize.ListSchemasInput) personalize.ListSchemasRequest

	ListSolutionVersionsRequest(*personalize.ListSolutionVersionsInput) personalize.ListSolutionVersionsRequest

	ListSolutionsRequest(*personalize.ListSolutionsInput) personalize.ListSolutionsRequest

	UpdateCampaignRequest(*personalize.UpdateCampaignInput) personalize.UpdateCampaignRequest
}

ClientAPI provides an interface to enable mocking the personalize.Client methods. 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.
func myFunc(svc personalizeiface.ClientAPI) bool {
    // Make svc.CreateCampaign request
}

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

    svc := personalize.New(cfg)

    myFunc(svc)
}

In your _test.go file:

// Define a mock struct to be used in your unit tests of myFunc.
type mockClientClient struct {
    personalizeiface.ClientPI
}
func (m *mockClientClient) CreateCampaign(input *personalize.CreateCampaignInput) (*personalize.CreateCampaignOutput, error) {
    // mock response/functionality
}

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

    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.