aws-sdk-go-v2 - Unit-Testing - Mocking Client Operations

CL answered on March 1, 2023 Popularity 1/10 Helpfulness 1/10

answer aws-sdk-go-v2 - Unit-Testing - Mocking Client Operations

related aws-sdk-go-v2 - Unit-Testing - Mocking Paginators

aws-sdk-go-v2 - Unit-Testing - Mocking Client Operations

Comment

import "context"
import "github.com/aws/aws-sdk-go-v2/service/s3"

// ...

type S3GetObjectAPI interface {
	GetObject(ctx context.Context, params *s3.GetObjectInput, optFns ...func(*s3.Options)) (*s3.GetObjectOutput, error)
}

func GetObjectFromS3(ctx context.Context, api S3GetObjectAPI, bucket, key string) ([]byte, error) {
	object, err := api.GetObject(ctx, &s3.GetObjectInput{
		Bucket: &bucket,
		Key:    &key,
	})
	if err != nil {
		return nil, err
	}
	defer object.Body.Close()

	return ioutil.ReadAll(object.Body)
}

In this example, `S3GetObjectAPI` is an interface that defines the set of Amazon S3 API operations required by the `GetObjectFromS3` function. `S3GetObjectAPI` is satisfied by the Amazon S3 client’s [GetObject](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.GetObject) method.

Popularity 1/10 Helpfulness 1/10 Language go

Source: aws.github.io

Tags: aws-sdk-go-v2 client go mocking operations unit-testing

Link to this answer
Share Copy Link

Contributed on Mar 01 2023

0 Answers Avg Quality 2/10

Closely Related Answers

aws-sdk-go-v2 - Unit-Testing - Mocking Paginators

Comment

import "context"
import "github.com/aws/aws-sdk-go-v2/service/s3"

// ...

type ListObjectsV2Pager interface {
	HasMorePages() bool
	NextPage(context.Context, ...func(*s3.Options)) (*s3.ListObjectsV2Output, error)
}

func CountObjects(ctx context.Context, pager ListObjectsV2Pager) (count int, err error) {
	for pager.HasMorePages() {
		var output *s3.ListObjectsV2Output
		output, err = pager.NextPage(ctx)
		if err != nil {
			return count, err
		}
		count += int(output.KeyCount)
	}
	return count, nil
}

Similar to service clients, paginators can be mocked by defining a Go interface for the paginator. That interface would be used by your application’s code. This allows the SDK’s implementation to be used when your application is running, and a mocked implementation for testing.

In the following example, `ListObjectsV2Pager` is an interface that defines the behaviors for the Amazon S3 [ListObjectsV2Paginator](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#ListObjectsV2Paginator). required by `CountObjects` function.

Popularity 1/10 Helpfulness 1/10 Language go

Source: aws.github.io

Tags: aws-sdk-go-v2 go mocking unit-testing

Link to this answer
Share Copy Link

Contributed on Mar 01 2023

0 Answers Avg Quality 2/10

aws-sdk-go-v2 - Unit-Testing - Mocking Client Operations

Contents

More Related Answers