resourcegroupsiface

Documentation

Overview

Package resourcegroupsiface provides an interface to enable mocking the AWS Resource Groups 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 ResourceGroupsAPI

Types

type ResourceGroupsAPI

type ResourceGroupsAPI interface {
	CreateGroupRequest(*resourcegroups.CreateGroupInput) resourcegroups.CreateGroupRequest

	DeleteGroupRequest(*resourcegroups.DeleteGroupInput) resourcegroups.DeleteGroupRequest

	GetGroupRequest(*resourcegroups.GetGroupInput) resourcegroups.GetGroupRequest

	GetGroupQueryRequest(*resourcegroups.GetGroupQueryInput) resourcegroups.GetGroupQueryRequest

	GetTagsRequest(*resourcegroups.GetTagsInput) resourcegroups.GetTagsRequest

	ListGroupResourcesRequest(*resourcegroups.ListGroupResourcesInput) resourcegroups.ListGroupResourcesRequest

	ListGroupResourcesPages(*resourcegroups.ListGroupResourcesInput, func(*resourcegroups.ListGroupResourcesOutput, bool) bool) error
	ListGroupResourcesPagesWithContext(aws.Context, *resourcegroups.ListGroupResourcesInput, func(*resourcegroups.ListGroupResourcesOutput, bool) bool, ...aws.Option) error

	ListGroupsRequest(*resourcegroups.ListGroupsInput) resourcegroups.ListGroupsRequest

	ListGroupsPages(*resourcegroups.ListGroupsInput, func(*resourcegroups.ListGroupsOutput, bool) bool) error
	ListGroupsPagesWithContext(aws.Context, *resourcegroups.ListGroupsInput, func(*resourcegroups.ListGroupsOutput, bool) bool, ...aws.Option) error

	SearchResourcesRequest(*resourcegroups.SearchResourcesInput) resourcegroups.SearchResourcesRequest

	SearchResourcesPages(*resourcegroups.SearchResourcesInput, func(*resourcegroups.SearchResourcesOutput, bool) bool) error
	SearchResourcesPagesWithContext(aws.Context, *resourcegroups.SearchResourcesInput, func(*resourcegroups.SearchResourcesOutput, bool) bool, ...aws.Option) error

	TagRequest(*resourcegroups.TagInput) resourcegroups.TagRequest

	UntagRequest(*resourcegroups.UntagInput) resourcegroups.UntagRequest

	UpdateGroupRequest(*resourcegroups.UpdateGroupInput) resourcegroups.UpdateGroupRequest

	UpdateGroupQueryRequest(*resourcegroups.UpdateGroupQueryInput) resourcegroups.UpdateGroupQueryRequest
}

ResourceGroupsAPI provides an interface to enable mocking the resourcegroups.ResourceGroups 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 Resource Groups.
func myFunc(svc resourcegroupsiface.ResourceGroupsAPI) bool {
    // Make svc.CreateGroup request
}

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

    svc := resourcegroups.New(cfg)

    myFunc(svc)
}

In your _test.go file:

// Define a mock struct to be used in your unit tests of myFunc.
type mockResourceGroupsClient struct {
    resourcegroupsiface.ResourceGroupsAPI
}
func (m *mockResourceGroupsClient) CreateGroup(input *resourcegroups.CreateGroupInput) (*resourcegroups.CreateGroupOutput, error) {
    // mock response/functionality
}

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

    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.