servicediscoveryiface

Documentation

Overview

Package servicediscoveryiface provides an interface to enable mocking the Amazon Route 53 Auto Naming 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 ServiceDiscoveryAPI

Types

type ServiceDiscoveryAPI

type ServiceDiscoveryAPI interface {
	CreatePrivateDnsNamespaceRequest(*servicediscovery.CreatePrivateDnsNamespaceInput) servicediscovery.CreatePrivateDnsNamespaceRequest

	CreatePublicDnsNamespaceRequest(*servicediscovery.CreatePublicDnsNamespaceInput) servicediscovery.CreatePublicDnsNamespaceRequest

	CreateServiceRequest(*servicediscovery.CreateServiceInput) servicediscovery.CreateServiceRequest

	DeleteNamespaceRequest(*servicediscovery.DeleteNamespaceInput) servicediscovery.DeleteNamespaceRequest

	DeleteServiceRequest(*servicediscovery.DeleteServiceInput) servicediscovery.DeleteServiceRequest

	DeregisterInstanceRequest(*servicediscovery.DeregisterInstanceInput) servicediscovery.DeregisterInstanceRequest

	GetInstanceRequest(*servicediscovery.GetInstanceInput) servicediscovery.GetInstanceRequest

	GetInstancesHealthStatusRequest(*servicediscovery.GetInstancesHealthStatusInput) servicediscovery.GetInstancesHealthStatusRequest

	GetInstancesHealthStatusPages(*servicediscovery.GetInstancesHealthStatusInput, func(*servicediscovery.GetInstancesHealthStatusOutput, bool) bool) error
	GetInstancesHealthStatusPagesWithContext(aws.Context, *servicediscovery.GetInstancesHealthStatusInput, func(*servicediscovery.GetInstancesHealthStatusOutput, bool) bool, ...aws.Option) error

	GetNamespaceRequest(*servicediscovery.GetNamespaceInput) servicediscovery.GetNamespaceRequest

	GetOperationRequest(*servicediscovery.GetOperationInput) servicediscovery.GetOperationRequest

	GetServiceRequest(*servicediscovery.GetServiceInput) servicediscovery.GetServiceRequest

	ListInstancesRequest(*servicediscovery.ListInstancesInput) servicediscovery.ListInstancesRequest

	ListInstancesPages(*servicediscovery.ListInstancesInput, func(*servicediscovery.ListInstancesOutput, bool) bool) error
	ListInstancesPagesWithContext(aws.Context, *servicediscovery.ListInstancesInput, func(*servicediscovery.ListInstancesOutput, bool) bool, ...aws.Option) error

	ListNamespacesRequest(*servicediscovery.ListNamespacesInput) servicediscovery.ListNamespacesRequest

	ListNamespacesPages(*servicediscovery.ListNamespacesInput, func(*servicediscovery.ListNamespacesOutput, bool) bool) error
	ListNamespacesPagesWithContext(aws.Context, *servicediscovery.ListNamespacesInput, func(*servicediscovery.ListNamespacesOutput, bool) bool, ...aws.Option) error

	ListOperationsRequest(*servicediscovery.ListOperationsInput) servicediscovery.ListOperationsRequest

	ListOperationsPages(*servicediscovery.ListOperationsInput, func(*servicediscovery.ListOperationsOutput, bool) bool) error
	ListOperationsPagesWithContext(aws.Context, *servicediscovery.ListOperationsInput, func(*servicediscovery.ListOperationsOutput, bool) bool, ...aws.Option) error

	ListServicesRequest(*servicediscovery.ListServicesInput) servicediscovery.ListServicesRequest

	ListServicesPages(*servicediscovery.ListServicesInput, func(*servicediscovery.ListServicesOutput, bool) bool) error
	ListServicesPagesWithContext(aws.Context, *servicediscovery.ListServicesInput, func(*servicediscovery.ListServicesOutput, bool) bool, ...aws.Option) error

	RegisterInstanceRequest(*servicediscovery.RegisterInstanceInput) servicediscovery.RegisterInstanceRequest

	UpdateServiceRequest(*servicediscovery.UpdateServiceInput) servicediscovery.UpdateServiceRequest
}

ServiceDiscoveryAPI provides an interface to enable mocking the servicediscovery.ServiceDiscovery 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 Route 53 Auto Naming.
func myFunc(svc servicediscoveryiface.ServiceDiscoveryAPI) bool {
    // Make svc.CreatePrivateDnsNamespace request
}

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

    svc := servicediscovery.New(cfg)

    myFunc(svc)
}

In your _test.go file:

// Define a mock struct to be used in your unit tests of myFunc.
type mockServiceDiscoveryClient struct {
    servicediscoveryiface.ServiceDiscoveryAPI
}
func (m *mockServiceDiscoveryClient) CreatePrivateDnsNamespace(input *servicediscovery.CreatePrivateDnsNamespaceInput) (*servicediscovery.CreatePrivateDnsNamespaceOutput, error) {
    // mock response/functionality
}

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

    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.