mock

README

A package for mocking interactions with AWS services

Introduction

• Mock interactions with AWS services
• Make unit testing quicker and easier

Example

package mock_test

import (
    "github.com/gofor-little/aws-sdk-mock"
)

func TestMockExample(t *testing.T) {
    client := mock.S3client{}

    output, err := client.GetObjectWithContext(context.Background(), &s3.GetObjectInput{})
    if err != nil {
        t.Fatal(err)
    }

    // Check output is correct...
}

Documentation

Index

• type CognitoClient
  • func (c *CognitoClient) ConfirmSignUpWithContext(ctx aws.Context, input *cognitoidentityprovider.ConfirmSignUpInput, ...) (*cognitoidentityprovider.ConfirmSignUpOutput, error)
  • func (c *CognitoClient) GlobalSignOutWithContext(ctx aws.Context, input *cognitoidentityprovider.GlobalSignOutInput, ...) (*cognitoidentityprovider.GlobalSignOutOutput, error)
  • func (c *CognitoClient) InitiateAuthWithContext(ctx aws.Context, input *cognitoidentityprovider.InitiateAuthInput, ...) (*cognitoidentityprovider.InitiateAuthOutput, error)
  • func (c *CognitoClient) SignUpWithContext(ctx aws.Context, input *cognitoidentityprovider.SignUpInput, ...) (*cognitoidentityprovider.SignUpOutput, error)
• type S3Client
  • func (s *S3Client) GetObjectWithContext(ctx aws.Context, input *s3.GetObjectInput, options ...request.Option) (*s3.GetObjectOutput, error)
• type SESClient
  • func (s *SESClient) SendRawEmailWithContext(ctx aws.Context, input *ses.SendRawEmailInput, options ...request.Option) (*ses.SendRawEmailOutput, error)
• type SFNClient
  • func (s *SFNClient) StartExecutionWithContext(ctx aws.Context, input *sfn.StartExecutionInput, options ...request.Option) (*sfn.StartExecutionOutput, error)
• type SNSClient
  • func (s *SNSClient) PublishWithContext(ctx aws.Context, input *sns.PublishInput, options ...request.Option) (*sns.PublishOutput, error)
• type SQSClient
  • func (s *SQSClient) SendMessageWithContext(ctx aws.Context, input *sqs.SendMessageInput, options ...request.Option) (*sqs.SendMessageOutput, error)
• type SecretsManagerClient
  • func (s *SecretsManagerClient) GetSecretValueWithContext(ctx aws.Context, input *secretsmanager.GetSecretValueInput, ...) (*secretsmanager.GetSecretValueOutput, error)

Types

type CognitoClient

type CognitoClient struct {
	cognitoidentityprovideriface.CognitoIdentityProviderAPI
}

CognitoClient is a mock client for Cognito to help with unit tests.

func (*CognitoClient) ConfirmSignUpWithContext

func (c *CognitoClient) ConfirmSignUpWithContext(ctx aws.Context, input *cognitoidentityprovider.ConfirmSignUpInput, options ...request.Option) (*cognitoidentityprovider.ConfirmSignUpOutput, error)

ConfirmSignUpWithContext confirms a newly signed up Cognito user.

func (*CognitoClient) GlobalSignOutWithContext

func (c *CognitoClient) GlobalSignOutWithContext(ctx aws.Context, input *cognitoidentityprovider.GlobalSignOutInput, options ...request.Option) (*cognitoidentityprovider.GlobalSignOutOutput, error)

GlobalSignOutWithContext signs a Cognito user out of all their devices.

func (*CognitoClient) InitiateAuthWithContext

func (c *CognitoClient) InitiateAuthWithContext(ctx aws.Context, input *cognitoidentityprovider.InitiateAuthInput, options ...request.Option) (*cognitoidentityprovider.InitiateAuthOutput, error)

InitiateAuthWithContext signs a Cognito user in.

func (*CognitoClient) SignUpWithContext

func (c *CognitoClient) SignUpWithContext(ctx aws.Context, input *cognitoidentityprovider.SignUpInput, options ...request.Option) (*cognitoidentityprovider.SignUpOutput, error)

SignUpWithContext creates a new Cognito user.

type S3Client

type S3Client struct {
	s3iface.S3API
}

S3Client is a mock client for S3 to help with unit tests.

func (*S3Client) GetObjectWithContext

func (s *S3Client) GetObjectWithContext(ctx aws.Context, input *s3.GetObjectInput, options ...request.Option) (*s3.GetObjectOutput, error)

GetObjectWithContext fetches an object from a bucket.

type SESClient

type SESClient struct {
	sesiface.SESAPI
}

SESClient is a mock client for SES to help with unit tests.

func (*SESClient) SendRawEmailWithContext

func (s *SESClient) SendRawEmailWithContext(ctx aws.Context, input *ses.SendRawEmailInput, options ...request.Option) (*ses.SendRawEmailOutput, error)

SendRawEmailWithContext sends an email via SES.

type SFNClient

type SFNClient struct {
	sfniface.SFNAPI
}

SFNClient is a mock client for StepFunctions to help with unit tests.

func (*SFNClient) StartExecutionWithContext

func (s *SFNClient) StartExecutionWithContext(ctx aws.Context, input *sfn.StartExecutionInput, options ...request.Option) (*sfn.StartExecutionOutput, error)

StartExecutionWithContext starts execution of a StepFunctions state machine.

type SNSClient

type SNSClient struct {
	snsiface.SNSAPI
}

SNSClient is a mock client for SNS to help with unit tests.

func (*SNSClient) PublishWithContext

func (s *SNSClient) PublishWithContext(ctx aws.Context, input *sns.PublishInput, options ...request.Option) (*sns.PublishOutput, error)

PublishWithContext publishes an SNS notification.

type SQSClient

type SQSClient struct {
	sqsiface.SQSAPI
}

SQSClient is a mock client for SQS to help with unit tests.

func (*SQSClient) SendMessageWithContext

func (s *SQSClient) SendMessageWithContext(ctx aws.Context, input *sqs.SendMessageInput, options ...request.Option) (*sqs.SendMessageOutput, error)

SendMessageWithContext sends a message to an SQS queue.

type SecretsManagerClient

type SecretsManagerClient struct {
	secretsmanageriface.SecretsManagerAPI
}

SecretsManagerClient is a mock client for secrets manager to help with unit tests.

func (*SecretsManagerClient) GetSecretValueWithContext

func (s *SecretsManagerClient) GetSecretValueWithContext(ctx aws.Context, input *secretsmanager.GetSecretValueInput, options ...request.Option) (*secretsmanager.GetSecretValueOutput, error)

GetSecretValueWithContext fetches a secret value.