shieldiface

Documentation

Overview

Package shieldiface provides an interface to enable mocking the AWS Shield 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 ShieldAPI

Types

type ShieldAPI

type ShieldAPI interface {
	AssociateDRTLogBucketRequest(*shield.AssociateDRTLogBucketInput) shield.AssociateDRTLogBucketRequest

	AssociateDRTRoleRequest(*shield.AssociateDRTRoleInput) shield.AssociateDRTRoleRequest

	CreateProtectionRequest(*shield.CreateProtectionInput) shield.CreateProtectionRequest

	CreateSubscriptionRequest(*shield.CreateSubscriptionInput) shield.CreateSubscriptionRequest

	DeleteProtectionRequest(*shield.DeleteProtectionInput) shield.DeleteProtectionRequest

	DeleteSubscriptionRequest(*shield.DeleteSubscriptionInput) shield.DeleteSubscriptionRequest

	DescribeAttackRequest(*shield.DescribeAttackInput) shield.DescribeAttackRequest

	DescribeDRTAccessRequest(*shield.DescribeDRTAccessInput) shield.DescribeDRTAccessRequest

	DescribeEmergencyContactSettingsRequest(*shield.DescribeEmergencyContactSettingsInput) shield.DescribeEmergencyContactSettingsRequest

	DescribeProtectionRequest(*shield.DescribeProtectionInput) shield.DescribeProtectionRequest

	DescribeSubscriptionRequest(*shield.DescribeSubscriptionInput) shield.DescribeSubscriptionRequest

	DisassociateDRTLogBucketRequest(*shield.DisassociateDRTLogBucketInput) shield.DisassociateDRTLogBucketRequest

	DisassociateDRTRoleRequest(*shield.DisassociateDRTRoleInput) shield.DisassociateDRTRoleRequest

	GetSubscriptionStateRequest(*shield.GetSubscriptionStateInput) shield.GetSubscriptionStateRequest

	ListAttacksRequest(*shield.ListAttacksInput) shield.ListAttacksRequest

	ListProtectionsRequest(*shield.ListProtectionsInput) shield.ListProtectionsRequest

	UpdateEmergencyContactSettingsRequest(*shield.UpdateEmergencyContactSettingsInput) shield.UpdateEmergencyContactSettingsRequest

	UpdateSubscriptionRequest(*shield.UpdateSubscriptionInput) shield.UpdateSubscriptionRequest
}

ShieldAPI provides an interface to enable mocking the shield.Shield 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 Shield.
func myFunc(svc shieldiface.ShieldAPI) bool {
    // Make svc.AssociateDRTLogBucket request
}

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

    svc := shield.New(cfg)

    myFunc(svc)
}

In your _test.go file:

// Define a mock struct to be used in your unit tests of myFunc.
type mockShieldClient struct {
    shieldiface.ShieldAPI
}
func (m *mockShieldClient) AssociateDRTLogBucket(input *shield.AssociateDRTLogBucketInput) (*shield.AssociateDRTLogBucketOutput, error) {
    // mock response/functionality
}

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

    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.