repository_global_index_test.go

package djoemo_test

import (
	"errors"

	"github.com/golang/mock/gomock"

	. "github.com/adjoeio/djoemo"
	"github.com/adjoeio/djoemo/mock"
)

var _ = Describe("Global Index", func() {
	const (
		UserTableName    = "UserTable"
		ProfileTableName = "ProfileTable"
		IndexName        = "gindex"
	)

	var (
		dMock      mock.DynamoMock
		repository RepositoryInterface
	)

	BeforeEach(func() {
		mockCtrl := gomock.NewController(GinkgoT())
		dAPIMock := mock.NewMockDynamoDBAPI(mockCtrl)
		dMock = mock.NewDynamoMock(dAPIMock)
		repository = NewRepository(dAPIMock)
	})

	Describe("GetItem", func() {
		Describe("GetItem Invalid key ", func() {
			It("should fail with table name is nil", func() {
				key := Key().WithHashKeyName("UUID").WithHashKey("uuid")
				user := &User{}
				found, err := repository.GIndex(IndexName).GetItem(key, user)

				Expect(err).To(BeEqualTo(ErrInvalidTableName))
				Expect(found).To(BeFalse())
			})
			It("should fail with hash key name is nil", func() {
				key := Key().WithTableName(UserTableName).WithHashKey("uuid")
				user := &User{}
				found, err := repository.GIndex(IndexName).GetItem(key, user)

				Expect(err).To(BeEqualTo(ErrInvalidHashKeyName))
				Expect(found).To(BeFalse())
			})
			It("should fail with hash key value is nil", func() {
				key := Key().WithTableName(UserTableName).WithHashKeyName("UUID")
				user := &User{}
				found, err := repository.GIndex(IndexName).GetItem(key, user)

				Expect(err).To(BeEqualTo(ErrInvalidHashKeyValue))
				Expect(found).To(BeFalse())
			})
		})

		Describe("GetItems Invalid key ", func() {
			It("should fail with table name is nil", func() {
				key := Key().WithHashKeyName("UUID").WithHashKey("uuid")
				users := &[]User{}
				found, err := repository.GIndex(IndexName).GetItem(key, users)

				Expect(err).To(BeEqualTo(ErrInvalidTableName))
				Expect(found).To(BeFalse())
			})
			It("should fail with hash key name is nil", func() {
				key := Key().WithTableName(UserTableName).WithHashKey("uuid")
				users := &[]User{}
				found, err := repository.GIndex(IndexName).GetItem(key, users)

				Expect(err).To(BeEqualTo(ErrInvalidHashKeyName))
				Expect(found).To(BeFalse())
			})
			It("should fail with hash key value is nil", func() {
				key := Key().WithTableName(UserTableName).WithHashKeyName("UUID")
				users := &[]User{}
				found, err := repository.GIndex(IndexName).GetItem(key, users)

				Expect(err).To(BeEqualTo(ErrInvalidHashKeyValue))
				Expect(found).To(BeFalse())
			})
		})
		Describe("GetItem", func() {
			It("should get item with Hash", func() {
				key := Key().WithTableName(UserTableName).
					WithHashKeyName("UUID").
					WithHashKey("uuid")

				userDBOutput := map[string]interface{}{
					"UUID": "uuid",
				}

				dMock.Should().
					Query(
						dMock.WithTable(key.TableName()),
						dMock.WithIndex(IndexName),
						dMock.WithCondition(*key.HashKeyName(), key.HashKey(), "EQ"),
						dMock.WithQueryOutput(userDBOutput),
					).Exec()

				user := &User{}
				found, err := repository.GIndex(IndexName).GetItem(key, user)

				Expect(err).To(BeNil())
				Expect(found).To(BeTrue())
				Expect(user.UUID).To(BeEqualTo(userDBOutput["UUID"]))
			})

			It("should get item with Hash and range", func() {
				key := Key().WithTableName(ProfileTableName).
					WithHashKeyName("UUID").
					WithHashKey("uuid").
					WithRangeKeyName("Email").
					WithRangeKey("user@adjeo.io")

				profileDBOutput := map[string]interface{}{
					"UUID":  "uuid",
					"Email": "user@adjeo.io",
				}

				dMock.Should().
					Query(
						dMock.WithTable(key.TableName()),
						dMock.WithIndex(IndexName),
						dMock.WithCondition(*key.HashKeyName(), key.HashKey(), "EQ"),
						dMock.WithCondition(*key.RangeKeyName(), key.RangeKey(), "EQ"),
						dMock.WithQueryOutput(profileDBOutput),
					).Exec()

				profile := &Profile{}
				found, err := repository.GIndex(IndexName).GetItem(key, profile)

				Expect(err).To(BeNil())
				Expect(found).To(BeTrue())
				Expect(profile.UUID).To(BeEqualTo(profileDBOutput["UUID"]))
				Expect(profile.Email).To(BeEqualTo(profileDBOutput["Email"]))
			})

			It("should return false and nil if item was not found", func() {
				key := Key().WithTableName(UserTableName).
					WithHashKeyName("UUID").
					WithHashKey("uuid")

				dMock.Should().
					Query(
						dMock.WithTable(key.TableName()),
						dMock.WithIndex(IndexName),
						dMock.WithCondition(*key.HashKeyName(), key.HashKey(), "EQ"),
						dMock.WithQueryOutput(nil),
					).Exec()

				user := &User{}
				found, err := repository.GIndex(IndexName).GetItem(key, user)

				Expect(err).To(BeNil())
				Expect(found).To(BeFalse())
			})

			It("should return false and error in case of error", func() {
				key := Key().WithTableName(UserTableName).
					WithHashKeyName("UUID").
					WithHashKey("uuid")
				err := errors.New("invalid query")

				dMock.Should().
					Query(
						dMock.WithTable(key.TableName()),
						dMock.WithIndex(IndexName),
						dMock.WithCondition(*key.HashKeyName(), key.HashKey(), "EQ"),
						dMock.WithError(err),
					).Exec()

				user := &User{}
				found, err := repository.GIndex(IndexName).GetItem(key, user)

				Expect(err).To(BeEquivalentTo(err))
				Expect(found).To(BeFalse())
			})
		})
		Describe("GetItems", func() {
			It("should get items with Hash", func() {
				key := Key().WithTableName(UserTableName).
					WithHashKeyName("UUID").
					WithHashKey("uuid")

				userDBOutput := []map[string]interface{}{
					{"UUID": "uuid", "UserName": "name1"},
					{"UUID": "uuid", "UserName": "name2"},
				}

				dMock.Should().
					Query(
						dMock.WithTable(key.TableName()),
						dMock.WithIndex(IndexName),
						dMock.WithCondition(*key.HashKeyName(), key.HashKey(), "EQ"),
						dMock.WithQueryOutput(userDBOutput),
					).Exec()

				users := &[]User{}
				found, err := repository.GIndex(IndexName).GetItems(key, users)
				Expect(err).To(BeNil())
				Expect(found).To(BeTrue())
				result := *users
				Expect(len(result)).To(BeEqualTo(2))
				Expect(result[0].UUID).To(BeEqualTo(userDBOutput[0]["UUID"]))
			})

			It("should get items with Hash and ignore range", func() {
				key := Key().WithTableName(ProfileTableName).
					WithHashKeyName("UUID").
					WithHashKey("uuid")

				profileDBOutput := []map[string]interface{}{
					{"UUID": "uuid", "Email": "email1"},
					{"UUID": "uuid", "Email": "email2"},
				}

				dMock.Should().
					Query(
						dMock.WithTable(key.TableName()),
						dMock.WithIndex(IndexName),
						dMock.WithCondition(*key.HashKeyName(), key.HashKey(), "EQ"),
						dMock.WithQueryOutput(profileDBOutput),
					).Exec()

				profiles := &[]Profile{}
				found, err := repository.GIndex(IndexName).GetItems(key, profiles)
				Expect(err).To(BeNil())
				Expect(found).To(BeTrue())
				result := *profiles
				Expect(len(result)).To(BeEqualTo(2))
				Expect(result[0].UUID).To(BeEqualTo(profileDBOutput[0]["UUID"]))

			})

			It("should return false and nil if item was not found", func() {
				key := Key().WithTableName(UserTableName).
					WithHashKeyName("UUID").
					WithHashKey("uuid")

				dMock.Should().
					Query(
						dMock.WithIndex(IndexName),
						dMock.WithTable(key.TableName()),
						dMock.WithCondition(*key.HashKeyName(), key.HashKey(), "EQ"),
						dMock.WithQueryOutput(nil),
					).Exec()

				users := &[]User{}
				found, err := repository.GIndex(IndexName).GetItems(key, users)

				Expect(err).To(BeNil())
				Expect(found).To(BeFalse())
			})

			It("should return false and error in case of error", func() {
				key := Key().WithTableName(UserTableName).
					WithHashKeyName("UUID").
					WithHashKey("uuid")
				err := errors.New("invalid query")
				dMock.Should().
					Query(
						dMock.WithIndex(IndexName),
						dMock.WithTable(key.TableName()),
						dMock.WithCondition(*key.HashKeyName(), key.HashKey(), "EQ"),
						dMock.WithError(err),
					).Exec()

				users := &[]User{}
				found, err := repository.GIndex(IndexName).GetItems(key, users)

				Expect(err).To(BeEquivalentTo(err))
				Expect(found).To(BeFalse())
			})

		})
	})

	Describe("Query Items", func() {
		Describe("Query Items Invalid key ", func() {
			It("should fail with table name is nil", func() {
				query := Query().WithHashKeyName("UUID").WithHashKey("uuid")
				user := &[]User{}
				err := repository.Query(query, user)
				Expect(err).To(BeEqualTo(ErrInvalidTableName))
			})
			It("should fail with hash key name is nil", func() {
				query := Query().WithTableName(UserTableName).WithHashKey("uuid")
				user := &[]User{}
				err := repository.GIndex(IndexName).Query(query, user)
				Expect(err).To(BeEqualTo(ErrInvalidHashKeyName))
			})
			It("should fail with hash key value is nil", func() {
				query := Query().WithTableName(UserTableName).WithHashKeyName("UUID")
				user := &[]User{}
				err := repository.GIndex(IndexName).Query(query, user)
				Expect(err).To(BeEqualTo(ErrInvalidHashKeyValue))
			})
		})

		Describe("Query Items", func() {
			It("should query items with Hash", func() {
				q := Query().WithTableName(UserTableName).
					WithHashKeyName("UUID").
					WithHashKey("uuid")

				userDBOutput := map[string]interface{}{
					"UUID": "uuid",
				}

				dMock.Should().
					Query(
						dMock.WithIndex(IndexName),
						dMock.WithTable(q.TableName()),
						dMock.WithCondition(*q.HashKeyName(), q.HashKey(), string(Equal)),
						dMock.WithQueryOutput(userDBOutput),
					).Exec()

				var users []User
				err := repository.GIndex(IndexName).Query(q, &users)
				Expect(err).To(BeNil())
				Expect(users[0].UUID).To(BeEqualTo(userDBOutput["UUID"]))
			})

			It("should query items with hash and range", func() {
				q := Query().WithTableName(ProfileTableName).
					WithHashKeyName("UUID").
					WithHashKey("uuid").
					WithRangeKeyName("Email").
					WithRangeKey("user").
					WithRangeOp(BeginsWith)

				profileDBOutput := []map[string]interface{}{
					{
						"UUID":  "uuid1",
						"Email": "user1@adjeo.io",
					}, {
						"UUID":  "uuid2",
						"Email": "user2@adjeo.io",
					},
				}

				dMock.Should().
					Query(
						dMock.WithIndex(IndexName),
						dMock.WithTable(q.TableName()),
						dMock.WithCondition(*q.HashKeyName(), q.HashKey(), string(Equal)),
						dMock.WithCondition(*q.RangeKeyName(), q.RangeKey(), string(BeginsWith)),
						dMock.WithQueryOutput(profileDBOutput),
					).Exec()

				var profiles []Profile
				err := repository.GIndex(IndexName).Query(q, &profiles)

				Expect(err).To(BeNil())
				Expect(len(profiles)).To(BeEqualTo(2))
				Expect(profiles[0].UUID).To(BeEqualTo("uuid1"))
				Expect(profiles[1].UUID).To(BeEqualTo("uuid2"))
			})

			It("should query items with limit and order", func() {
				q := Query().WithTableName(UserTableName).
					WithHashKeyName("UUID").
					WithHashKey("uuid").
					WithLimit(2).
					WithDescending()

				userDBOutput := map[string]interface{}{
					"UUID": "uuid",
				}

				dMock.Should().
					Query(
						dMock.WithIndex(IndexName),
						dMock.WithTable(q.TableName()),
						dMock.WithCondition(*q.HashKeyName(), q.HashKey(), string(Equal)),
						dMock.WithQueryOutput(userDBOutput),
						dMock.WithLimit(2),
						dMock.WithDesc(true),
					).Exec()

				var users []User
				err := repository.GIndex(IndexName).Query(q, &users)
				Expect(err).To(BeNil())
				Expect(users[0].UUID).To(BeEqualTo(userDBOutput["UUID"]))
			})

			It("should return error if output is not pointer to slice ", func() {
				q := Query().WithTableName(ProfileTableName).
					WithHashKeyName("UUID").
					WithHashKey("uuid").
					WithRangeKeyName("Email").
					WithRangeKey("user").
					WithRangeOp(BeginsWith)

				var profile Profile
				err := repository.GIndex(IndexName).Query(q, &profile)

				Expect(err).To(BeEquivalentTo(ErrInvalidPointerSliceType))
			})
		})
	})
})