Breaking News: Grepper is joining You.com. Read the official announcement!

aws-sdk-go-v2 - Unit-Testing - Mocking Client Operations - `mockGetObjectAPI` satisfies `S3GetObjectAPI` Interface Definition

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

answer aws-sdk-go-v2 - Unit-Testing - Mocking Client Operations - `mockGetObjectAPI` satisfies `S3GetObjectAPI` Interface Definition

aws-sdk-go-v2 - Unit-Testing - Mocking Client Operations - `mockGetObjectAPI` satisfies `S3GetObjectAPI` Interface Definition

Comment

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

// ...

type mockGetObjectAPI func(ctx context.Context, params *s3.GetObjectInput, optFns ...func(*s3.Options)) (*s3.GetObjectOutput, error)

func (m mockGetObjectAPI) GetObject(ctx context.Context, params *s3.GetObjectInput, optFns ...func(*s3.Options)) (*s3.GetObjectOutput, error) {
	return m(ctx, params, optFns...)
}

func TestGetObjectFromS3(t *testing.T) {
	cases := []struct {
		client func(t *testing.T) S3GetObjectAPI
		bucket string
		key	string
		expect []byte
	}{
		{
			client: func(t *testing.T) S3GetObjectAPI {
				return mockGetObjectAPI(func(ctx context.Context, params *s3.GetObjectInput, optFns ...func(*s3.Options)) (*s3.GetObjectOutput, error) {
					t.Helper()
					if params.Bucket == nil {
						t.Fatal("expect bucket to not be nil")
					}
					if e, a := "fooBucket", *params.Bucket; e != a {
						t.Errorf("expect %v, got %v", e, a)
					}
					if params.Key == nil {
						t.Fatal("expect key to not be nil")
					}
					if e, a := "barKey", *params.Key; e != a {
						t.Errorf("expect %v, got %v", e, a)
					}

					return &s3.GetObjectOutput{
						Body: ioutil.NopCloser(bytes.NewReader([]byte("this is the body foo bar baz"))),
					}, nil
				})
			},
			bucket: "fooBucket",
			key:	"barKey",
			expect: []byte("this is the body foo bar baz"),
		},
	}

	for i, tt := range cases {
		t.Run(strconv.Itoa(i), func(t *testing.T) {
			ctx := context.TODO()
			content, err := GetObjectFromS3(ctx, tt.client(t), tt.bucket, tt.key)
			if err != nil {
				t.Fatalf("expect no error, got %v", err)
			}
			if e, a := tt.expect, content; bytes.Compare(e, a) != 0 {
				t.Errorf("expect %v, got %v", e, a)
			}
		})
	}
}

To test the `GetObjectFromS3` function, use the `mockGetObjectAPI` to satisfy the `S3GetObjectAPI` interface definition. Then use the `mockGetObjectAPI` type to mock output and error responses returned from the service client.

Popularity 1/10 Helpfulness 1/10 Language go

Source: aws.github.io

Tags: aws-sdk-go-v2 client definition go interface mocking operations 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 - `mockGetObjectAPI` satisfies `S3GetObjectAPI` Interface Definition

Contents

More Related Answers

aws-sdk-go-v2 - Unit-Testing - Mocking Client Operations - `mockGetObjectAPI` satisfies `S3GetObjectAPI` Interface Definition

Grepper

Documentation

Social

Legal

Contact

Oops, You will need to install Grepper and log-in to perform this action.