/* Copyright 2021 The Dapr Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package dynamodb import ( "fmt" "strconv" "testing" "time" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/service/dynamodb" "github.com/aws/aws-sdk-go/service/dynamodb/dynamodbattribute" "github.com/aws/aws-sdk-go/service/dynamodb/dynamodbiface" "github.com/stretchr/testify/assert" "github.com/dapr/components-contrib/state" ) type mockedDynamoDB struct { GetItemFn func(input *dynamodb.GetItemInput) (*dynamodb.GetItemOutput, error) PutItemFn func(input *dynamodb.PutItemInput) (*dynamodb.PutItemOutput, error) DeleteItemFn func(input *dynamodb.DeleteItemInput) (*dynamodb.DeleteItemOutput, error) BatchWriteItemFn func(input *dynamodb.BatchWriteItemInput) (*dynamodb.BatchWriteItemOutput, error) dynamodbiface.DynamoDBAPI } type DynamoDBItem struct { Key string `json:"key"` Value string `json:"value"` TestAttributeName int64 `json:"testAttributeName"` } func (m *mockedDynamoDB) GetItem(input *dynamodb.GetItemInput) (*dynamodb.GetItemOutput, error) { return m.GetItemFn(input) } func (m *mockedDynamoDB) PutItem(input *dynamodb.PutItemInput) (*dynamodb.PutItemOutput, error) { return m.PutItemFn(input) } func (m *mockedDynamoDB) DeleteItem(input *dynamodb.DeleteItemInput) (*dynamodb.DeleteItemOutput, error) { return m.DeleteItemFn(input) } func (m *mockedDynamoDB) BatchWriteItem(input *dynamodb.BatchWriteItemInput) (*dynamodb.BatchWriteItemOutput, error) { return m.BatchWriteItemFn(input) } func TestInit(t *testing.T) { m := state.Metadata{} s := NewDynamoDBStateStore() t.Run("Init with valid metadata", func(t *testing.T) { m.Properties = map[string]string{ "AccessKey": "a", "Region": "eu-west-1", "SecretKey": "a", "SessionToken": "a", "Table": "a", "TtlAttributeName": "a", } err := s.Init(m) assert.Nil(t, err) }) t.Run("Init with missing table", func(t *testing.T) { m.Properties = map[string]string{ "Dummy": "a", } err := s.Init(m) assert.NotNil(t, err) assert.Equal(t, err, fmt.Errorf("missing dynamodb table name")) }) t.Run("Init with valid table", func(t *testing.T) { m.Properties = map[string]string{ "Table": "a", "Region": "eu-west-1", } err := s.Init(m) assert.Nil(t, err) }) } func TestGet(t *testing.T) { t.Run("Successfully retrieve item", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ GetItemFn: func(input *dynamodb.GetItemInput) (output *dynamodb.GetItemOutput, err error) { return &dynamodb.GetItemOutput{ Item: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("someKey"), }, "value": { S: aws.String("some value"), }, }, }, nil }, }, } req := &state.GetRequest{ Key: "someKey", Metadata: nil, Options: state.GetStateOption{ Consistency: "strong", }, } out, err := ss.Get(req) assert.Nil(t, err) assert.Equal(t, []byte("some value"), out.Data) }) t.Run("Successfully retrieve item (with unexpired ttl)", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ GetItemFn: func(input *dynamodb.GetItemInput) (output *dynamodb.GetItemOutput, err error) { return &dynamodb.GetItemOutput{ Item: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("someKey"), }, "value": { S: aws.String("some value"), }, "testAttributeName": { N: aws.String("4074862051"), }, }, }, nil }, }, ttlAttributeName: "testAttributeName", } req := &state.GetRequest{ Key: "someKey", Metadata: nil, Options: state.GetStateOption{ Consistency: "strong", }, } out, err := ss.Get(req) assert.Nil(t, err) assert.Equal(t, []byte("some value"), out.Data) }) t.Run("Successfully retrieve item (with expired ttl)", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ GetItemFn: func(input *dynamodb.GetItemInput) (output *dynamodb.GetItemOutput, err error) { return &dynamodb.GetItemOutput{ Item: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("someKey"), }, "value": { S: aws.String("some value"), }, "testAttributeName": { N: aws.String("35489251"), }, }, }, nil }, }, ttlAttributeName: "testAttributeName", } req := &state.GetRequest{ Key: "someKey", Metadata: nil, Options: state.GetStateOption{ Consistency: "strong", }, } out, err := ss.Get(req) assert.Nil(t, err) assert.Nil(t, out.Data) }) t.Run("Unsuccessfully get item", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ GetItemFn: func(input *dynamodb.GetItemInput) (output *dynamodb.GetItemOutput, err error) { return nil, fmt.Errorf("failed to retrieve data") }, }, } req := &state.GetRequest{ Key: "key", Metadata: nil, Options: state.GetStateOption{ Consistency: "strong", }, } out, err := ss.Get(req) assert.NotNil(t, err) assert.Nil(t, out) }) t.Run("Unsuccessfully with empty response", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ GetItemFn: func(input *dynamodb.GetItemInput) (output *dynamodb.GetItemOutput, err error) { return &dynamodb.GetItemOutput{ Item: map[string]*dynamodb.AttributeValue{}, }, nil }, }, } req := &state.GetRequest{ Key: "key", Metadata: nil, Options: state.GetStateOption{ Consistency: "strong", }, } out, err := ss.Get(req) assert.Nil(t, err) assert.Nil(t, out.Data) }) t.Run("Unsuccessfully with no required key", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ GetItemFn: func(input *dynamodb.GetItemInput) (output *dynamodb.GetItemOutput, err error) { return &dynamodb.GetItemOutput{ Item: map[string]*dynamodb.AttributeValue{ "value2": { S: aws.String("value"), }, }, }, nil }, }, } req := &state.GetRequest{ Key: "key", Metadata: nil, Options: state.GetStateOption{ Consistency: "strong", }, } out, err := ss.Get(req) assert.Nil(t, err) assert.Empty(t, out.Data) }) } func TestSet(t *testing.T) { type value struct { Value string } t.Run("Successfully set item", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ PutItemFn: func(input *dynamodb.PutItemInput) (output *dynamodb.PutItemOutput, err error) { assert.Equal(t, map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("key"), }, "value": { S: aws.String(`{"Value":"value"}`), }, }, input.Item) assert.Equal(t, len(input.Item), 2) return &dynamodb.PutItemOutput{ Attributes: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("value"), }, }, }, nil }, }, } req := &state.SetRequest{ Key: "key", Value: value{ Value: "value", }, } err := ss.Set(req) assert.Nil(t, err) }) t.Run("Successfully set item with ttl = -1", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ PutItemFn: func(input *dynamodb.PutItemInput) (output *dynamodb.PutItemOutput, err error) { assert.Equal(t, len(input.Item), 3) result := DynamoDBItem{} dynamodbattribute.UnmarshalMap(input.Item, &result) assert.Equal(t, result.Key, "someKey") assert.Equal(t, result.Value, "{\"Value\":\"someValue\"}") assert.Greater(t, result.TestAttributeName, time.Now().Unix()-2) assert.Less(t, result.TestAttributeName, time.Now().Unix()) return &dynamodb.PutItemOutput{ Attributes: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("value"), }, }, }, nil }, }, ttlAttributeName: "testAttributeName", } req := &state.SetRequest{ Key: "someKey", Value: value{ Value: "someValue", }, Metadata: map[string]string{ "ttlInSeconds": "-1", }, } err := ss.Set(req) assert.Nil(t, err) }) t.Run("Successfully set item with 'correct' ttl", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ PutItemFn: func(input *dynamodb.PutItemInput) (output *dynamodb.PutItemOutput, err error) { assert.Equal(t, len(input.Item), 3) result := DynamoDBItem{} dynamodbattribute.UnmarshalMap(input.Item, &result) assert.Equal(t, result.Key, "someKey") assert.Equal(t, result.Value, "{\"Value\":\"someValue\"}") assert.Greater(t, result.TestAttributeName, time.Now().Unix()+180-1) assert.Less(t, result.TestAttributeName, time.Now().Unix()+180+1) return &dynamodb.PutItemOutput{ Attributes: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("value"), }, }, }, nil }, }, ttlAttributeName: "testAttributeName", } req := &state.SetRequest{ Key: "someKey", Value: value{ Value: "someValue", }, Metadata: map[string]string{ "ttlInSeconds": "180", }, } err := ss.Set(req) assert.Nil(t, err) }) t.Run("Unsuccessfully set item", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ PutItemFn: func(input *dynamodb.PutItemInput) (output *dynamodb.PutItemOutput, err error) { return nil, fmt.Errorf("unable to put item") }, }, } req := &state.SetRequest{ Key: "key", Value: value{ Value: "value", }, } err := ss.Set(req) assert.NotNil(t, err) }) t.Run("Successfully set item with correct ttl but without component metadata", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ PutItemFn: func(input *dynamodb.PutItemInput) (output *dynamodb.PutItemOutput, err error) { assert.Equal(t, map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("someKey"), }, "value": { S: aws.String(`{"Value":"someValue"}`), }, }, input.Item) assert.Equal(t, len(input.Item), 2) return &dynamodb.PutItemOutput{ Attributes: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("value"), }, }, }, nil }, }, } req := &state.SetRequest{ Key: "someKey", Value: value{ Value: "someValue", }, Metadata: map[string]string{ "ttlInSeconds": "180", }, } err := ss.Set(req) assert.Nil(t, err) }) t.Run("Unsuccessfully set item with ttl (invalid value)", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ PutItemFn: func(input *dynamodb.PutItemInput) (output *dynamodb.PutItemOutput, err error) { assert.Equal(t, map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("somekey"), }, "value": { S: aws.String(`{"Value":"somevalue"}`), }, "ttlInSeconds": { N: aws.String("180"), }, }, input.Item) return &dynamodb.PutItemOutput{ Attributes: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("value"), }, }, }, nil }, }, ttlAttributeName: "testAttributeName", } req := &state.SetRequest{ Key: "somekey", Value: value{ Value: "somevalue", }, Metadata: map[string]string{ "ttlInSeconds": "invalidvalue", }, } err := ss.Set(req) assert.NotNil(t, err) assert.Equal(t, "dynamodb error: failed to parse ttlInSeconds: strconv.ParseInt: parsing \"invalidvalue\": invalid syntax", err.Error()) }) } func TestBulkSet(t *testing.T) { type value struct { Value string } t.Run("Successfully set items", func(t *testing.T) { tableName := "table_name" ss := StateStore{ client: &mockedDynamoDB{ BatchWriteItemFn: func(input *dynamodb.BatchWriteItemInput) (output *dynamodb.BatchWriteItemOutput, err error) { expected := map[string][]*dynamodb.WriteRequest{} expected[tableName] = []*dynamodb.WriteRequest{ { PutRequest: &dynamodb.PutRequest{ Item: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("key1"), }, "value": { S: aws.String(`{"Value":"value1"}`), }, }, }, }, { PutRequest: &dynamodb.PutRequest{ Item: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("key2"), }, "value": { S: aws.String(`{"Value":"value2"}`), }, }, }, }, } assert.Equal(t, expected, input.RequestItems) return &dynamodb.BatchWriteItemOutput{ UnprocessedItems: map[string][]*dynamodb.WriteRequest{}, }, nil }, }, table: tableName, } req := []state.SetRequest{ { Key: "key1", Value: value{ Value: "value1", }, }, { Key: "key2", Value: value{ Value: "value2", }, }, } err := ss.BulkSet(req) assert.Nil(t, err) }) t.Run("Successfully set items with ttl = -1", func(t *testing.T) { tableName := "table_name" ss := StateStore{ client: &mockedDynamoDB{ BatchWriteItemFn: func(input *dynamodb.BatchWriteItemInput) (output *dynamodb.BatchWriteItemOutput, err error) { expected := map[string][]*dynamodb.WriteRequest{} expected[tableName] = []*dynamodb.WriteRequest{ { PutRequest: &dynamodb.PutRequest{ Item: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("key1"), }, "value": { S: aws.String(`{"Value":"value1"}`), }, "testAttributeName": { N: aws.String(strconv.FormatInt(time.Now().Unix()-1, 10)), }, }, }, }, { PutRequest: &dynamodb.PutRequest{ Item: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("key2"), }, "value": { S: aws.String(`{"Value":"value2"}`), }, }, }, }, } assert.Equal(t, expected, input.RequestItems) return &dynamodb.BatchWriteItemOutput{ UnprocessedItems: map[string][]*dynamodb.WriteRequest{}, }, nil }, }, table: tableName, ttlAttributeName: "testAttributeName", } req := []state.SetRequest{ { Key: "key1", Value: value{ Value: "value1", }, Metadata: map[string]string{ "ttlInSeconds": "-1", }, }, { Key: "key2", Value: value{ Value: "value2", }, }, } err := ss.BulkSet(req) assert.Nil(t, err) }) t.Run("Successfully set items with ttl", func(t *testing.T) { tableName := "table_name" ss := StateStore{ client: &mockedDynamoDB{ BatchWriteItemFn: func(input *dynamodb.BatchWriteItemInput) (output *dynamodb.BatchWriteItemOutput, err error) { expected := map[string][]*dynamodb.WriteRequest{} // This might fail occasionally due to timestamp precision. timestamp := time.Now().Unix() + 90 expected[tableName] = []*dynamodb.WriteRequest{ { PutRequest: &dynamodb.PutRequest{ Item: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("key1"), }, "value": { S: aws.String(`{"Value":"value1"}`), }, "testAttributeName": { N: aws.String(strconv.FormatInt(timestamp, 10)), }, }, }, }, { PutRequest: &dynamodb.PutRequest{ Item: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("key2"), }, "value": { S: aws.String(`{"Value":"value2"}`), }, }, }, }, } assert.Equal(t, expected, input.RequestItems) return &dynamodb.BatchWriteItemOutput{ UnprocessedItems: map[string][]*dynamodb.WriteRequest{}, }, nil }, }, table: tableName, ttlAttributeName: "testAttributeName", } req := []state.SetRequest{ { Key: "key1", Value: value{ Value: "value1", }, Metadata: map[string]string{ "ttlInSeconds": "90", }, }, { Key: "key2", Value: value{ Value: "value2", }, }, } err := ss.BulkSet(req) assert.Nil(t, err) }) t.Run("Unsuccessfully set items", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ BatchWriteItemFn: func(input *dynamodb.BatchWriteItemInput) (output *dynamodb.BatchWriteItemOutput, err error) { return nil, fmt.Errorf("unable to bulk write items") }, }, } req := []state.SetRequest{ { Key: "key", Value: value{ Value: "value", }, }, } err := ss.BulkSet(req) assert.NotNil(t, err) }) } func TestDelete(t *testing.T) { t.Run("Successfully delete item", func(t *testing.T) { req := &state.DeleteRequest{ Key: "key", } ss := StateStore{ client: &mockedDynamoDB{ DeleteItemFn: func(input *dynamodb.DeleteItemInput) (output *dynamodb.DeleteItemOutput, err error) { assert.Equal(t, map[string]*dynamodb.AttributeValue{ "key": { S: aws.String(req.Key), }, }, input.Key) return nil, nil }, }, } err := ss.Delete(req) assert.Nil(t, err) }) t.Run("Unsuccessfully delete item", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ DeleteItemFn: func(input *dynamodb.DeleteItemInput) (output *dynamodb.DeleteItemOutput, err error) { return nil, fmt.Errorf("unable to delete item") }, }, } req := &state.DeleteRequest{ Key: "key", } err := ss.Delete(req) assert.NotNil(t, err) }) } func TestBulkDelete(t *testing.T) { t.Run("Successfully delete items", func(t *testing.T) { tableName := "table_name" ss := StateStore{ client: &mockedDynamoDB{ BatchWriteItemFn: func(input *dynamodb.BatchWriteItemInput) (output *dynamodb.BatchWriteItemOutput, err error) { expected := map[string][]*dynamodb.WriteRequest{} expected[tableName] = []*dynamodb.WriteRequest{ { DeleteRequest: &dynamodb.DeleteRequest{ Key: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("key1"), }, }, }, }, { DeleteRequest: &dynamodb.DeleteRequest{ Key: map[string]*dynamodb.AttributeValue{ "key": { S: aws.String("key2"), }, }, }, }, } assert.Equal(t, expected, input.RequestItems) return &dynamodb.BatchWriteItemOutput{ UnprocessedItems: map[string][]*dynamodb.WriteRequest{}, }, nil }, }, table: tableName, } req := []state.DeleteRequest{ { Key: "key1", }, { Key: "key2", }, } err := ss.BulkDelete(req) assert.Nil(t, err) }) t.Run("Unsuccessfully delete items", func(t *testing.T) { ss := StateStore{ client: &mockedDynamoDB{ BatchWriteItemFn: func(input *dynamodb.BatchWriteItemInput) (output *dynamodb.BatchWriteItemOutput, err error) { return nil, fmt.Errorf("unable to bulk write items") }, }, } req := []state.DeleteRequest{ { Key: "key", }, } err := ss.BulkDelete(req) assert.NotNil(t, err) }) }