dynamock

package module
v0.0.0-...-6d83a24 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 16, 2023 License: MIT Imports: 7 Imported by: 0

README

go-dynamock

Amazon Dynamo DB Mock Driver for Golang to Test Database Interactions.

Originally forked from https://github.com/gusaul/go-dynamock and added more functionalities with examples:

  • QueryInput expectation.
  • WithContext expectation to support QueryWithContext.

Install

go get github.com/alext234/go-dynamock

Examples Usage

See the examples directory.

DynamoDB configuration

First of all, change the dynamodb configuration to use the dynamodb interface. see code below:

package main

import (
    "github.com/aws/aws-sdk-go/aws"
    "github.com/aws/aws-sdk-go/aws/session"
    "github.com/aws/aws-sdk-go/service/dynamodb"
    "github.com/aws/aws-sdk-go/service/dynamodb/dynamodbiface"
)

type MyDynamo struct {
    Db dynamodbiface.DynamoDBAPI
}

var Dyna *MyDynamo

func ConfigureDynamoDB() {
	Dyna = new(MyDynamo)
	awsSession, _ := session.NewSession(&aws.Config{Region: aws.String("ap-southeast-2")})
	svc := dynamodb.New(awsSession)
	Dyna.Db = dynamodbiface.DynamoDBAPI(svc)
}

the purpose of code above is to make your dynamoDB object can be mocked by dynamock through the dynamodbiface.

Something you may wanna test
package main

import (
    "github.com/aws/aws-sdk-go/aws"
    "github.com/aws/aws-sdk-go/service/dynamodb"
)

func GetName(id string) (*string, error) {
	parameter := &dynamodb.GetItemInput{
		Key: map[string]*dynamodb.AttributeValue{
			"id": {
				N: aws.String(id),
			},
		},
		TableName: aws.String("employee"),
	}

	response, err := Dyna.Db.GetItem(parameter)
	if err != nil {
		return nil, err
	}

	name := response.Item["name"].S
	return name, nil
}
Test with DynaMock
package examples

import (
	"testing"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/dynamodb"
	dynamock "github.com/alext234/go-dynamock"
)

var mock *dynamock.DynaMock

func init() {
	Dyna = new(MyDynamo)
	Dyna.Db, mock = dynamock.New()
}

func TestGetName(t *testing.T) {
	expectKey := map[string]*dynamodb.AttributeValue{
		"id": {
			N: aws.String("1"),
		},
	}

	expectedResult := aws.String("jaka")
	result := dynamodb.GetItemOutput{
		Item: map[string]*dynamodb.AttributeValue{
			"name": {
				S: expectedResult,
			},
		},
	}

	//lets start dynamock in action
	mock.ExpectGetItem().ToTable("employee").WithKeys(expectKey).WillReturns(result)

	actualResult, _ := GetName("1")
	if actualResult != expectedResult {
		t.Errorf("Test Fail")
	}
}

if you just wanna expect the table

mock.ExpectGetItem().ToTable("employee").WillReturns(result)

or maybe you didn't care with any arguments, you just need to determine the result

mock.ExpectGetItem().WillReturns(result)

and you can do multiple expectations at once, then the expectation will be executed sequentially.

mock.ExpectGetItem().WillReturns(resultOne)
mock.ExpectUpdateItem().WillReturns(resultTwo)
mock.ExpectGetItem().WillReturns(resultThree)

/* Result
the first call of GetItem will return resultOne
the second call of GetItem will return resultThree
and the only call of UpdateItem will return resultTwo */

License

The MIT License

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchGetItemExpectation 

type BatchGetItemExpectation struct {
	// contains filtered or unexported fields
}

BatchGetItemExpectation struct hold expectation field, err, and result

func (*BatchGetItemExpectation) WillReturns 

func (e *BatchGetItemExpectation) WillReturns(res dynamodb.BatchGetItemOutput) *BatchGetItemExpectation

WillReturns - method for set desired result

func (*BatchGetItemExpectation) WithRequest 

func (e *BatchGetItemExpectation) WithRequest(input map[string]*dynamodb.KeysAndAttributes) *BatchGetItemExpectation

WithRequest - method for set Request expectation

type BatchWriteItemExpectation 

type BatchWriteItemExpectation struct {
	// contains filtered or unexported fields
}

BatchWriteItemExpectation struct hold expectation field, err, and result

func (*BatchWriteItemExpectation) WillReturns 

func (e *BatchWriteItemExpectation) WillReturns(res dynamodb.BatchWriteItemOutput) *BatchWriteItemExpectation

WillReturns - method for set desired result

func (*BatchWriteItemExpectation) WithRequest 

func (e *BatchWriteItemExpectation) WithRequest(input map[string][]*dynamodb.WriteRequest) *BatchWriteItemExpectation

WithRequest - method for set Request expectation

type CreateTableExpectation 

type CreateTableExpectation struct {
	// contains filtered or unexported fields
}

CreateTableExpectation struct hold expectation field, err, and result

func (*CreateTableExpectation) KeySchema 

func (e *CreateTableExpectation) KeySchema(keySchema []*dynamodb.KeySchemaElement) *CreateTableExpectation

KeySchema - method for set KeySchema expectation

func (*CreateTableExpectation) Name 

func (e *CreateTableExpectation) Name(table string) *CreateTableExpectation

Name - method for set Name expectation

func (*CreateTableExpectation) WillReturns 

func (e *CreateTableExpectation) WillReturns(res dynamodb.CreateTableOutput) *CreateTableExpectation

WillReturns - method for set desired result

type DeleteItemExpectation 

type DeleteItemExpectation struct {
	// contains filtered or unexported fields
}

DeleteItemExpectation struct hold expectation field, err, and result

func (*DeleteItemExpectation) ToTable 

func (e *DeleteItemExpectation) ToTable(table string) *DeleteItemExpectation

ToTable - method for set Table expectation

func (*DeleteItemExpectation) WillReturns 

func (e *DeleteItemExpectation) WillReturns(res dynamodb.DeleteItemOutput) *DeleteItemExpectation

WillReturns - method for set desired result

func (*DeleteItemExpectation) WithKeys 

func (e *DeleteItemExpectation) WithKeys(keys map[string]*dynamodb.AttributeValue) *DeleteItemExpectation

WithKeys - method for set Keys expectation

type DescribeTableExpectation 

type DescribeTableExpectation struct {
	// contains filtered or unexported fields
}

DescribeTableExpectation struct hold expectation field, err, and result

func (*DescribeTableExpectation) Table 

func (e *DescribeTableExpectation) Table(table string) *DescribeTableExpectation

Table - method for set Table expectation

func (*DescribeTableExpectation) WillReturns 

func (e *DescribeTableExpectation) WillReturns(res dynamodb.DescribeTableOutput) *DescribeTableExpectation

WillReturns - method for set desired result

type DynaMock 

type DynaMock struct {
	GetItemExpect            []GetItemExpectation
	BatchGetItemExpect       []BatchGetItemExpectation
	UpdateItemExpect         []UpdateItemExpectation
	PutItemExpect            []PutItemExpectation
	DeleteItemExpect         []DeleteItemExpectation
	BatchWriteItemExpect     []BatchWriteItemExpectation
	CreateTableExpect        []CreateTableExpectation
	DescribeTableExpect      []DescribeTableExpectation
	WaitTableExistExpect     []WaitTableExistExpectation
	ScanExpect               []ScanExpectation
	QueryExpect              []QueryExpectation
	TransactWriteItemsExpect []TransactWriteItemsExpectation
}

DynaMock mock struct hold all expectation types

func New 

func New() (dynamodbiface.DynamoDBAPI, *DynaMock)

New - constructor for mock instantiation Return : 1st => DynamoDBAPI implementation, used to inject app object 

2nd => mock object, used to set expectation and desired result

func (*DynaMock) ExpectBatchGetItem 

func (e *DynaMock) ExpectBatchGetItem() *BatchGetItemExpectation

ExpectBatchGetItem - method to start do expectation

func (*DynaMock) ExpectBatchWriteItem 

func (e *DynaMock) ExpectBatchWriteItem() *BatchWriteItemExpectation

ExpectBatchWriteItem - method to start do expectation

func (*DynaMock) ExpectCreateTable 

func (e *DynaMock) ExpectCreateTable() *CreateTableExpectation

ExpectCreateTable - method to start do expectation

func (*DynaMock) ExpectDeleteItem 

func (e *DynaMock) ExpectDeleteItem() *DeleteItemExpectation

ExpectDeleteItem - method to start do expectation

func (*DynaMock) ExpectDescribeTable 

func (e *DynaMock) ExpectDescribeTable() *DescribeTableExpectation

ExpectDescribeTable - method to start do expectation

func (*DynaMock) ExpectGetItem 

func (e *DynaMock) ExpectGetItem() *GetItemExpectation

ExpectGetItem - method to start do expectation

func (*DynaMock) ExpectPutItem 

func (e *DynaMock) ExpectPutItem() *PutItemExpectation

ExpectPutItem - method to start do expectation

func (*DynaMock) ExpectQuery 

func (e *DynaMock) ExpectQuery() *QueryExpectation

ExpectQuery - method to start do expectation

func (*DynaMock) ExpectScan 

func (e *DynaMock) ExpectScan() *ScanExpectation

ExpectScan - method to start do expectation

func (*DynaMock) ExpectTransactWriteItems 

func (e *DynaMock) ExpectTransactWriteItems() *TransactWriteItemsExpectation

ExpectTransactWriteItems - method to start do expectation

func (*DynaMock) ExpectUpdateItem 

func (e *DynaMock) ExpectUpdateItem() *UpdateItemExpectation

ExpectUpdateItem - method to start do expectation

func (*DynaMock) ExpectWaitTableExist 

func (e *DynaMock) ExpectWaitTableExist() *WaitTableExistExpectation

ExpectWaitTableExist - method to start do expectation

type GetItemExpectation 

type GetItemExpectation struct {
	// contains filtered or unexported fields
}

GetItemExpectation struct hold expectation field, err, and result

func (*GetItemExpectation) ToTable 

func (e *GetItemExpectation) ToTable(table string) *GetItemExpectation

ToTable - method for set Table expectation

func (*GetItemExpectation) WillReturns 

func (e *GetItemExpectation) WillReturns(res dynamodb.GetItemOutput) *GetItemExpectation

WillReturns - method for set desired result

func (*GetItemExpectation) WithKeys 

func (e *GetItemExpectation) WithKeys(keys map[string]*dynamodb.AttributeValue) *GetItemExpectation

WithKeys - method for set Keys expectation

type MockDynamoDB 

type MockDynamoDB struct {
	dynamodbiface.DynamoDBAPI
	// contains filtered or unexported fields
}

MockDynamoDB struct hold DynamoDBAPI implementation and mock object

func (*MockDynamoDB) BatchGetItem 

func (e *MockDynamoDB) BatchGetItem(input *dynamodb.BatchGetItemInput) (*dynamodb.BatchGetItemOutput, error)

BatchGetItem - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) BatchGetItemWithContext 

func (e *MockDynamoDB) BatchGetItemWithContext(ctx aws.Context, input *dynamodb.BatchGetItemInput, opt ...request.Option) (*dynamodb.BatchGetItemOutput, error)

BatchGetItemWithContext - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) BatchWriteItem 

func (e *MockDynamoDB) BatchWriteItem(input *dynamodb.BatchWriteItemInput) (*dynamodb.BatchWriteItemOutput, error)

BatchWriteItem - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) BatchWriteItemWithContext 

func (e *MockDynamoDB) BatchWriteItemWithContext(ctx aws.Context, input *dynamodb.BatchWriteItemInput, opt ...request.Option) (*dynamodb.BatchWriteItemOutput, error)

BatchWriteItemWithContext - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) CreateTable 

func (e *MockDynamoDB) CreateTable(input *dynamodb.CreateTableInput) (*dynamodb.CreateTableOutput, error)

CreateTable - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) DeleteItem 

func (e *MockDynamoDB) DeleteItem(input *dynamodb.DeleteItemInput) (*dynamodb.DeleteItemOutput, error)

DeleteItem - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) DeleteItemWithContext 

func (e *MockDynamoDB) DeleteItemWithContext(ctx aws.Context, input *dynamodb.DeleteItemInput, options ...request.Option) (*dynamodb.DeleteItemOutput, error)

DeleteItemWithContext - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) DescribeTable 

func (e *MockDynamoDB) DescribeTable(input *dynamodb.DescribeTableInput) (*dynamodb.DescribeTableOutput, error)

DescribeTable - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) GetItem 

func (e *MockDynamoDB) GetItem(input *dynamodb.GetItemInput) (*dynamodb.GetItemOutput, error)

GetItem - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) GetItemWithContext 

func (e *MockDynamoDB) GetItemWithContext(ctx aws.Context, input *dynamodb.GetItemInput, opt ...request.Option) (*dynamodb.GetItemOutput, error)

GetItemWithContext - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) PutItem 

func (e *MockDynamoDB) PutItem(input *dynamodb.PutItemInput) (*dynamodb.PutItemOutput, error)

PutItem - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) PutItemWithContext 

func (e *MockDynamoDB) PutItemWithContext(ctx aws.Context, input *dynamodb.PutItemInput, opt ...request.Option) (*dynamodb.PutItemOutput, error)

PutItemWithContext - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) Query 

func (e *MockDynamoDB) Query(input *dynamodb.QueryInput) (*dynamodb.QueryOutput, error)

Query - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) QueryPages 

func (e *MockDynamoDB) QueryPages(input *dynamodb.QueryInput, fn func(*dynamodb.QueryOutput, bool) bool) error

QueryPages - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) QueryPagesWithContext 

func (e *MockDynamoDB) QueryPagesWithContext(ctx aws.Context, input *dynamodb.QueryInput, fn func(*dynamodb.QueryOutput, bool) bool, options ...request.Option) error

QueryPagesWithContext - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) QueryWithContext 

func (e *MockDynamoDB) QueryWithContext(ctx aws.Context, input *dynamodb.QueryInput, options ...request.Option) (*dynamodb.QueryOutput, error)

QueryWithContext - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) Scan 

func (e *MockDynamoDB) Scan(input *dynamodb.ScanInput) (*dynamodb.ScanOutput, error)

Scan - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) ScanPages 

func (e *MockDynamoDB) ScanPages(input *dynamodb.ScanInput, fn func(*dynamodb.ScanOutput, bool) bool) error

ScanPages - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) ScanPagesWithContext 

func (e *MockDynamoDB) ScanPagesWithContext(ctx aws.Context, input *dynamodb.ScanInput, fn func(*dynamodb.ScanOutput, bool) bool, opts ...request.Option) error

ScanPagesWithContext - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) ScanWithContext 

func (e *MockDynamoDB) ScanWithContext(ctx aws.Context, input *dynamodb.ScanInput, opts ...request.Option) (*dynamodb.ScanOutput, error)

ScanWithContext - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) TransactWriteItems 

func (e *MockDynamoDB) TransactWriteItems(input *dynamodb.TransactWriteItemsInput) (*dynamodb.TransactWriteItemsOutput, error)

TransactWriteItems - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) TransactWriteItemsWithContext 

func (e *MockDynamoDB) TransactWriteItemsWithContext(ctx aws.Context, input *dynamodb.TransactWriteItemsInput, opts ...request.Option) (*dynamodb.TransactWriteItemsOutput, error)

func (*MockDynamoDB) UpdateItem 

func (e *MockDynamoDB) UpdateItem(input *dynamodb.UpdateItemInput) (*dynamodb.UpdateItemOutput, error)

UpdateItem - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) UpdateItemWithContext 

func (e *MockDynamoDB) UpdateItemWithContext(ctx aws.Context, input *dynamodb.UpdateItemInput, opt ...request.Option) (*dynamodb.UpdateItemOutput, error)

UpdateItemWithContext - this func will be invoked when test running matching expectation with actual input

func (*MockDynamoDB) WaitUntilTableExists 

func (e *MockDynamoDB) WaitUntilTableExists(input *dynamodb.DescribeTableInput) error

WaitUntilTableExists - this func will be invoked when test running matching expectation with actual input

type PutItemExpectation 

type PutItemExpectation struct {
	// contains filtered or unexported fields
}

PutItemExpectation struct hold expectation field, err, and result

func (*PutItemExpectation) ToTable 

func (e *PutItemExpectation) ToTable(table string) *PutItemExpectation

ToTable - method for set Table expectation

func (*PutItemExpectation) WillReturns 

func (e *PutItemExpectation) WillReturns(res dynamodb.PutItemOutput) *PutItemExpectation

WillReturns - method for set desired result

func (*PutItemExpectation) WithItems 

func (e *PutItemExpectation) WithItems(item map[string]*dynamodb.AttributeValue) *PutItemExpectation

WithItems - method for set Items expectation

type QueryExpectation 

type QueryExpectation struct {
	// contains filtered or unexported fields
}

QueryExpectation struct hold expectation field, err, and result

func (*QueryExpectation) Table 

func (e *QueryExpectation) Table(table string) *QueryExpectation

Table - method for set Table expectation

func (*QueryExpectation) WillReturns 

func (e *QueryExpectation) WillReturns(res dynamodb.QueryOutput) *QueryExpectation

WillReturns - method for set desired result

func (*QueryExpectation) WithContext 

func (e *QueryExpectation) WithContext(ctx context.Context) *QueryExpectation

WithContext set the context object

func (*QueryExpectation) WithQueryInput 

func (e *QueryExpectation) WithQueryInput(expectedQuery *dynamodb.QueryInput) *QueryExpectation

WithQueryInput set the expected query to be called

type ScanExpectation 

type ScanExpectation struct {
	// contains filtered or unexported fields
}

ScanExpectation struct hold expectation field, err, and result

func (*ScanExpectation) Table 

func (e *ScanExpectation) Table(table string) *ScanExpectation

Table - method for set Table expectation

func (*ScanExpectation) WillReturns 

func (e *ScanExpectation) WillReturns(res dynamodb.ScanOutput) *ScanExpectation

WillReturns - method for set desired result

type TransactWriteItemsExpectation 

type TransactWriteItemsExpectation struct {
	// contains filtered or unexported fields
}

TransactWriteItemsExpectation struct holds field, err, and result

func (*TransactWriteItemsExpectation) Table 

func (e *TransactWriteItemsExpectation) Table(table string) *TransactWriteItemsExpectation

Table - method for set Table expectation

func (*TransactWriteItemsExpectation) WillReturns 

func (e *TransactWriteItemsExpectation) WillReturns(res dynamodb.TransactWriteItemsOutput) *TransactWriteItemsExpectation

WillReturns - method for set desired result

func (*TransactWriteItemsExpectation) WithItems 

func (e *TransactWriteItemsExpectation) WithItems(items []*dynamodb.TransactWriteItem) *TransactWriteItemsExpectation

WithItems - method for set Items expectation

type UpdateItemExpectation 

type UpdateItemExpectation struct {
	// contains filtered or unexported fields
}

UpdateItemExpectation struct hold expectation field, err, and result

func (*UpdateItemExpectation) ToTable 

func (e *UpdateItemExpectation) ToTable(table string) *UpdateItemExpectation

ToTable - method for set Table expectation

func (*UpdateItemExpectation) Updates 

func (e *UpdateItemExpectation) Updates(attrs map[string]*dynamodb.AttributeValueUpdate) *UpdateItemExpectation

Updates - method for set Updates expectation

func (*UpdateItemExpectation) WillReturns 

func (e *UpdateItemExpectation) WillReturns(res dynamodb.UpdateItemOutput) *UpdateItemExpectation

WillReturns - method for set desired result

func (*UpdateItemExpectation) WithKeys 

func (e *UpdateItemExpectation) WithKeys(keys map[string]*dynamodb.AttributeValue) *UpdateItemExpectation

WithKeys - method for set Keys expectation

type WaitTableExistExpectation 

type WaitTableExistExpectation struct {
	// contains filtered or unexported fields
}

WaitTableExistExpectation struct hold expectation field, err, and result

func (*WaitTableExistExpectation) Table 

func (e *WaitTableExistExpectation) Table(table string) *WaitTableExistExpectation

Table - method for set Table expectation

func (*WaitTableExistExpectation) WillReturns 

func (e *WaitTableExistExpectation) WillReturns(err error) *WaitTableExistExpectation

WillReturns - method for set desired result

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.