client_test.go

// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package dosa_test

import (
	"context"
	"fmt"
	"io/ioutil"
	"os"
	"path/filepath"
	"testing"
	"time"

	"github.com/golang/mock/gomock"
	"github.com/pkg/errors"
	"github.com/stretchr/testify/assert"
	dosaRenamed "github.com/uber-go/dosa"
	"github.com/uber-go/dosa/connectors/devnull"
	"github.com/uber-go/dosa/mocks"
	"github.com/uber-go/dosa/testutil"
)

type ClientTestEntity1 struct {
	dosaRenamed.Entity `dosa:"primaryKey=(ID)"`
	dosaRenamed.Index  `dosa:"key=Name, name=username"`
	ID                 int64
	Name               string
	Email              string
}

type ClientTestEntity2 struct {
	dosaRenamed.Entity `dosa:"primaryKey=(UUID,Color)"`
	SearchByColor      dosaRenamed.Index `dosa:"key=Color"`
	UUID               string
	Color              string
	IsActive           bool
	ignoreme           int32
}

var (
	cte1                                = &ClientTestEntity1{ID: int64(1), Name: "foo", Email: "foo@uber.com"}
	cte2                                = &ClientTestEntity2{UUID: "b1f23fa3-f453-45b4-a5d5-6d73078ac3bd", Color: "blue", IsActive: true}
	ctx                                 = context.TODO()
	scope                               = "test"
	namePrefix                          = "team.service"
	nullConnector dosaRenamed.Connector = devnull.NewConnector()
)

// ExampleNewClient initializes a client using the devnull connector, which discards all
// the data you send it and always returns no rows. It's only useful for testing dosa.
func ExampleNewClient() {
	// initialize registrar
	reg, err := dosaRenamed.NewRegistrar("test", "myteam.myservice", cte1)
	if err != nil {
		// registration will fail if the object is tagged incorrectly
		fmt.Printf("NewRegistrar error: %s", err)
		return
	}

	// use a devnull connector for example purposes
	conn := devnull.NewConnector()

	// create the client using the registrar and connector
	client := dosaRenamed.NewClient(reg, conn)

	err = client.Initialize(context.Background())
	if err != nil {
		fmt.Printf("Initialize error: %s", err)
		return
	}
}

func testAssert(t *testing.T) testutil.TestAssertFn {
	return func(a, b interface{}) {
		assert.Equal(t, a, b)
	}
}

func TestNewClient(t *testing.T) {
	// initialize registrar
	reg, err := dosaRenamed.NewRegistrar("test", "myteam.myservice", cte1)
	assert.NoError(t, err)
	assert.NotNil(t, reg)

	// initialize a pseudo-connected client
	client := dosaRenamed.NewClient(reg, nullConnector)
	err = client.Initialize(ctx)
	assert.NoError(t, err)
}

func TestClient_Initialize(t *testing.T) {
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	emptyReg, _ := dosaRenamed.NewRegistrar("test", "team.service")
	reg, _ := dosaRenamed.NewRegistrar("test", "team.service", cte1)

	// find error
	c1 := dosaRenamed.NewClient(emptyReg, nullConnector)
	assert.Error(t, c1.Initialize(ctx))

	// CheckSchema error
	errConn := mocks.NewMockConnector(ctrl)
	errConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(-1), errors.New("CheckSchema error")).AnyTimes()
	c2 := dosaRenamed.NewClient(reg, errConn)
	assert.Error(t, c2.Initialize(ctx))

	// happy path
	c3 := dosaRenamed.NewClient(reg, nullConnector)
	assert.NoError(t, c3.Initialize(ctx))

	// already initialized
	assert.NoError(t, c3.Initialize(ctx))
}

func TestClient_Read(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1)
	reg2, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1, cte2)
	fieldsToRead := []string{"ID", "Email"}
	results := map[string]dosaRenamed.FieldValue{
		"id":    int64(2),
		"name":  "bar",
		"email": "bar@email.com",
	}

	// uninitialized
	c1 := dosaRenamed.NewClient(reg1, nullConnector)
	assert.Error(t, c1.Read(ctx, fieldsToRead, cte1))

	// unregistered object
	c1.Initialize(ctx)
	err := c1.Read(ctx, dosaRenamed.All(), cte2)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "ClientTestEntity2")

	// happy path, mock connector
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().Read(ctx, gomock.Any(), gomock.Any(), gomock.Any()).
		Do(func(_ context.Context, _ *dosaRenamed.EntityInfo, columnValues map[string]dosaRenamed.FieldValue, columnsToRead []string) {
			assert.Equal(t, columnValues["id"], cte1.ID)
			assert.Equal(t, columnsToRead, []string{"id", "email"})

		}).Return(results, nil).MinTimes(1)
	c3 := dosaRenamed.NewClient(reg2, mockConn)
	assert.NoError(t, c3.Initialize(ctx))
	assert.NoError(t, c3.Read(ctx, fieldsToRead, cte1))
	assert.Equal(t, cte1.ID, results["id"])
	assert.NotEqual(t, cte1.Name, results["name"])
	assert.Equal(t, cte1.Email, results["email"])
}

func TestClient_Read_pointer_result(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1)
	reg2, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1, cte2)
	fieldsToRead := []string{"ID", "Email"}
	results := map[string]dosaRenamed.FieldValue{
		"id":    testutil.TestInt64Ptr(int64(2)),
		"name":  testutil.TestStringPtr("bar"),
		"email": testutil.TestStringPtr("bar@email.com"),
	}

	// uninitialized
	c1 := dosaRenamed.NewClient(reg1, nullConnector)
	assert.Error(t, c1.Read(ctx, fieldsToRead, cte1))

	// unregistered object
	c1.Initialize(ctx)
	err := c1.Read(ctx, dosaRenamed.All(), cte2)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "ClientTestEntity2")

	// happy path, mock connector
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().Read(ctx, gomock.Any(), gomock.Any(), gomock.Any()).
		Do(func(_ context.Context, _ *dosaRenamed.EntityInfo, columnValues map[string]dosaRenamed.FieldValue, columnsToRead []string) {
			assert.Equal(t, columnValues["id"], cte1.ID)
			assert.Equal(t, columnsToRead, []string{"id", "email"})

		}).Return(results, nil).MinTimes(1)
	c3 := dosaRenamed.NewClient(reg2, mockConn)
	assert.NoError(t, c3.Initialize(ctx))
	assert.NoError(t, c3.Read(ctx, fieldsToRead, cte1))
	testutil.AssertEqForPointer(testAssert(t), cte1.ID, results["id"])
	assert.NotEqual(t, cte1.Name, results["name"])
	testutil.AssertEqForPointer(testAssert(t), cte1.Email, results["email"])
}

type AllFieldTypes struct {
	dosaRenamed.Entity `dosa:"primaryKey=ID"`
	ID                 int64
	BoolType           bool
	Int32Type          int32
	Int64Type          int64
	DoubleType         float64
	StringType         string
	BlobType           []byte
	TimeType           time.Time
	UUIDType           dosaRenamed.UUID
	NullBoolType       *bool
	NullInt32Type      *int32
	NullInt64Type      *int64
	NullDoubleType     *float64
	NullStringType     *string
	NullTimeType       *time.Time
	NullUUIDType       *dosaRenamed.UUID
}

func TestClient_Read_pointer(t *testing.T) {
	allTypes := &AllFieldTypes{ID: int64(3212)}
	reg1, err := dosaRenamed.NewRegistrar(scope, namePrefix, allTypes)
	assert.NoError(t, err)
	results := map[string]dosaRenamed.FieldValue{
		"id":             int64(3212),
		"booltype":       true,
		"int32type":      int32(1),
		"int64type":      int64(2),
		"doubletype":     float64(8.9),
		"stringtype":     "faa@email.com",
		"blobtype":       []byte("hello world"),
		"timetype":       time.Now(),
		"uuidtype":       dosaRenamed.NewUUID(),
		"nullbooltype":   testutil.TestBoolPtr(true),
		"nullint32type":  testutil.TestInt32Ptr(int32(123)),
		"nullint64type":  testutil.TestInt64Ptr(int64(2)),
		"nulldoubletype": testutil.TestFloat64Ptr(float64(8.9)),
		"nullstringtype": testutil.TestStringPtr("bar@email.com"),
		"nulltimetype":   testutil.TestTimePtr(time.Now()),
		"nulluuidtype":   testutil.TestUUIDPtr(dosaRenamed.NewUUID()),
	}

	// uninitialized
	c1 := dosaRenamed.NewClient(reg1, nullConnector)
	assert.Error(t, c1.Read(ctx, dosaRenamed.All(), allTypes))

	// happy path, mock connector
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().Read(ctx, gomock.Any(), gomock.Any(), gomock.Any()).
		Do(func(_ context.Context, _ *dosaRenamed.EntityInfo, columnValues map[string]dosaRenamed.FieldValue, columnsToRead []string) {
			assert.Equal(t, columnValues["id"], allTypes.ID)
		}).Return(results, nil).MinTimes(1)
	c3 := dosaRenamed.NewClient(reg1, mockConn)
	assert.NoError(t, c3.Initialize(ctx))
	assert.NoError(t, c3.Read(ctx, dosaRenamed.All(), allTypes))
	assert.Equal(t, allTypes.ID, results["id"])
	assert.Equal(t, allTypes.BoolType, results["booltype"])
	assert.Equal(t, allTypes.Int32Type, results["int32type"])
	assert.Equal(t, allTypes.Int64Type, results["int64type"])
	assert.Equal(t, allTypes.DoubleType, results["doubletype"])
	assert.Equal(t, allTypes.StringType, results["stringtype"])
	assert.Equal(t, allTypes.BlobType, results["blobtype"])
	assert.Equal(t, allTypes.TimeType, results["timetype"])
	assert.Equal(t, allTypes.UUIDType, results["uuidtype"])
	testutil.AssertEqForPointer(testAssert(t), *allTypes.NullBoolType, results["nullbooltype"])
	testutil.AssertEqForPointer(testAssert(t), *allTypes.NullInt32Type, results["nullint32type"])
	testutil.AssertEqForPointer(testAssert(t), *allTypes.NullInt64Type, results["nullint64type"])
	testutil.AssertEqForPointer(testAssert(t), *allTypes.NullDoubleType, results["nulldoubletype"])
	testutil.AssertEqForPointer(testAssert(t), *allTypes.NullStringType, results["nullstringtype"])
	testutil.AssertEqForPointer(testAssert(t), *allTypes.NullTimeType, results["nulltimetype"])
	testutil.AssertEqForPointer(testAssert(t), *allTypes.NullUUIDType, results["nulluuidtype"])
}

func TestClient_Read_Errors(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1)
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	readError := errors.New("oops")
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().Read(ctx, gomock.Any(), gomock.Any(), gomock.Any()).
		Do(func(_ context.Context, _ *dosaRenamed.EntityInfo, columnValues map[string]dosaRenamed.FieldValue, columnsToRead []string) {
			assert.Equal(t, columnValues["id"], cte1.ID)
			assert.NotEmpty(t, columnsToRead)
		}).Return(nil, readError)

	c1 := dosaRenamed.NewClient(reg1, mockConn)
	assert.NoError(t, c1.Initialize(ctx))
	err := c1.Read(ctx, dosaRenamed.All(), cte1)
	assert.Error(t, err)
	assert.Equal(t, err, readError)
	err = c1.Read(ctx, []string{"badcol"}, cte1)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "badcol")
}

func TestClient_Upsert(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar("test", "team.service", cte1)
	reg2, _ := dosaRenamed.NewRegistrar("test", "team.service", cte1, cte2)
	fieldsToUpdate := []string{"Email"}
	updatedEmail := "bar@email.com"

	// uninitialized
	c1 := dosaRenamed.NewClient(reg1, nullConnector)
	assert.Error(t, c1.Upsert(ctx, fieldsToUpdate, cte1))

	// unregistered object error
	c2 := dosaRenamed.NewClient(reg1, nullConnector)
	c2.Initialize(ctx)
	assert.Error(t, c2.Upsert(ctx, fieldsToUpdate, cte2))

	// happy path, mock connector
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().Upsert(ctx, gomock.Any(), gomock.Any()).
		Do(func(_ context.Context, _ *dosaRenamed.EntityInfo, columnValues map[string]dosaRenamed.FieldValue) {
			assert.Equal(t, columnValues["id"], cte1.ID)
			assert.Equal(t, columnValues["email"], cte1.Email)
			cte1.Email = updatedEmail
		}).
		Return(nil).MinTimes(1)
	c3 := dosaRenamed.NewClient(reg2, mockConn)
	assert.NoError(t, c3.Initialize(ctx))
	assert.NoError(t, c3.Upsert(ctx, fieldsToUpdate, cte1))
	assert.Equal(t, cte1.Email, updatedEmail)
}

func TestClient_Upsert_DynTTL(t *testing.T) {
	cte3 := &ClientTestEntity1{}
	reg1, _ := dosaRenamed.NewRegistrar("test", "team.service", cte3)

	// valid cases
	idx := 0
	ttls := []time.Duration{
		time.Duration(-1),
		30 * time.Minute,
		1 * time.Minute,
		time.Duration(0),
	}
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().Upsert(ctx, gomock.Any(), gomock.Any()).
		Do(func(_ context.Context, ei *dosaRenamed.EntityInfo, _ map[string]dosaRenamed.FieldValue) {
			assert.Equal(t, ttls[idx], *ei.TTL)
			idx++
		}).
		Return(nil).MinTimes(1)
	c1 := dosaRenamed.NewClient(reg1, mockConn)
	assert.NoError(t, c1.Initialize(ctx))
	for _, ttl := range ttls {
		if ttl != dosaRenamed.NoTTL() {
			cte3.TTL(&ttl)
		}
		assert.NoError(t, c1.Upsert(ctx, []string{}, cte3))
	}

	// invalid case
	c2 := dosaRenamed.NewClient(reg1, nullConnector)
	invalidTTL := 998 * time.Millisecond
	cte3.TTL(&invalidTTL)
	assert.Error(t, c2.Upsert(ctx, []string{}, cte3))
}

func TestClient_CreateIfNotExists(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar("test", "team.service", cte1)
	reg2, _ := dosaRenamed.NewRegistrar("test", "team.service", cte1, cte2)
	updatedEmail := "bar@email.com"

	// uninitialized
	c1 := dosaRenamed.NewClient(reg1, nullConnector)
	assert.Error(t, c1.CreateIfNotExists(ctx, cte1))

	// unregistered object error
	c2 := dosaRenamed.NewClient(reg1, nullConnector)
	c2.Initialize(ctx)
	assert.Error(t, c2.CreateIfNotExists(ctx, cte2))

	// happy path, mock connector
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().CreateIfNotExists(ctx, gomock.Any(), gomock.Any()).
		Do(func(_ context.Context, _ *dosaRenamed.EntityInfo, columnValues map[string]dosaRenamed.FieldValue) {
			assert.Equal(t, columnValues["id"], cte1.ID)
			assert.Equal(t, columnValues["email"], cte1.Email)
			cte1.Email = updatedEmail
		}).
		Return(nil).MinTimes(1)
	c3 := dosaRenamed.NewClient(reg2, mockConn)
	assert.NoError(t, c3.Initialize(ctx))
	assert.NoError(t, c3.CreateIfNotExists(ctx, cte1))
	assert.Equal(t, cte1.Email, updatedEmail)
}

func TestClient_CreateIfNotExists_DynTTL(t *testing.T) {
	cte3 := &ClientTestEntity1{}
	reg1, _ := dosaRenamed.NewRegistrar("test", "team.service", cte3)

	// valid cases
	idx := 0
	ttls := []time.Duration{
		time.Duration(-1),
		30 * time.Minute,
		1 * time.Minute,
		time.Duration(0),
	}
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().CreateIfNotExists(ctx, gomock.Any(), gomock.Any()).
		Do(func(_ context.Context, ei *dosaRenamed.EntityInfo, _ map[string]dosaRenamed.FieldValue) {
			assert.Equal(t, ttls[idx], *ei.TTL)
			idx++
		}).
		Return(nil).MinTimes(1)
	c1 := dosaRenamed.NewClient(reg1, mockConn)
	assert.NoError(t, c1.Initialize(ctx))
	for _, ttl := range ttls {
		if ttl != dosaRenamed.NoTTL() {
			cte3.TTL(&ttl)
		}
		assert.NoError(t, c1.CreateIfNotExists(ctx, cte3))
	}

	// invalid case
	c2 := dosaRenamed.NewClient(reg1, nullConnector)
	invalidTTL := 998 * time.Millisecond
	cte3.TTL(&invalidTTL)
	assert.Error(t, c2.CreateIfNotExists(ctx, cte3))
}

func TestClient_Upsert_Errors(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1)
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	readError := errors.New("oops")
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()

	c1 := dosaRenamed.NewClient(reg1, mockConn)
	assert.NoError(t, c1.Initialize(ctx))
	mockConn.EXPECT().Upsert(ctx, gomock.Any(), gomock.Not(dosaRenamed.All())).Return(nil)
	err := c1.Upsert(ctx, dosaRenamed.All(), cte1)
	assert.NoError(t, err)

	mockConn.EXPECT().Upsert(ctx, gomock.Any(), map[string]dosaRenamed.FieldValue{"id": dosaRenamed.FieldValue(int64(2))}).Return(readError)
	err = c1.Upsert(ctx, []string{"ID"}, cte1)
	assert.Error(t, err)
	assert.Equal(t, err, readError)
	err = c1.Upsert(ctx, []string{"badcol"}, cte1)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "badcol")
}

func TestClient_RemoveRange(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1)

	c1 := dosaRenamed.NewClient(reg1, nullConnector)
	rop := dosaRenamed.NewRemoveRangeOp(cte1).Eq("ID", "123")
	err := c1.RemoveRange(ctx, rop)
	assert.True(t, dosaRenamed.ErrorIsNotInitialized(err))

	c1.Initialize(ctx)

	//bad entity
	rop = dosaRenamed.NewRemoveRangeOp(cte2)
	err = c1.RemoveRange(ctx, rop)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "ClientTestEntity2")

	// bad column in range
	rop = dosaRenamed.NewRemoveRangeOp(cte1).Eq("borkborkbork", int64(1))
	err = c1.RemoveRange(ctx, rop)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "ClientTestEntity1")
	assert.Contains(t, err.Error(), "borkborkbork")

	// success case
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().RemoveRange(ctx, gomock.Any(), gomock.Any()).Return(nil)
	c2 := dosaRenamed.NewClient(reg1, mockConn)
	c2.Initialize(ctx)
	rop = dosaRenamed.NewRemoveRangeOp(cte1)
	err = c2.RemoveRange(ctx, rop)
	assert.NoError(t, err)
}

func TestClient_Range(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1)
	fieldsToRead := []string{"ID", "Email"}
	resultRow := map[string]dosaRenamed.FieldValue{
		"id":    int64(2),
		"name":  "bar",
		"email": "bar@email.com",
	}

	// uninitialized
	c1 := dosaRenamed.NewClient(reg1, nullConnector)
	rop := dosaRenamed.NewRangeOp(cte1).Fields(fieldsToRead).Eq("ID", "123").Offset("tokeytoketoke")
	_, _, err := c1.Range(ctx, rop)
	assert.True(t, dosaRenamed.ErrorIsNotInitialized(err))

	c1.Initialize(ctx)

	// bad entity
	rop = dosaRenamed.NewRangeOp(cte2)
	_, _, err = c1.Range(ctx, rop)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "ClientTestEntity2")

	// bad column in range
	// we don't test other failed RangeOpConditions since those are unit tested elsewhere
	rop = dosaRenamed.NewRangeOp(cte1).Eq("borkborkbork", int64(1))
	_, _, err = c1.Range(ctx, rop)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "ClientTestEntity1")
	assert.Contains(t, err.Error(), "borkborkbork")

	// bad projected column
	rop = dosaRenamed.NewRangeOp(cte1).Fields([]string{"borkborkbork"})
	_, _, err = c1.Range(ctx, rop)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "ClientTestEntity1")
	assert.Contains(t, err.Error(), "borkborkbork")

	// success case
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().Range(ctx, gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).
		Return([]map[string]dosaRenamed.FieldValue{resultRow}, "continuation-token", nil)
	c2 := dosaRenamed.NewClient(reg1, mockConn)
	c2.Initialize(ctx)
	rop = dosaRenamed.NewRangeOp(cte1)
	rows, token, err := c2.Range(ctx, rop)
	assert.NoError(t, err)
	assert.NotNil(t, rows)
	assert.Equal(t, 1, len(rows))
	for _, obj := range rows {
		assert.Equal(t, resultRow["id"], obj.(*ClientTestEntity1).ID)
		assert.Equal(t, resultRow["name"], obj.(*ClientTestEntity1).Name)
		assert.Equal(t, resultRow["email"], obj.(*ClientTestEntity1).Email)
	}
	assert.Equal(t, "continuation-token", token)

	// no resulting rows, just use the devnull connector
	rop = dosaRenamed.NewRangeOp(cte1)
	_, _, err = c1.Range(ctx, rop)
	assert.True(t, dosaRenamed.ErrorIsNotFound(err))
}

func TestClient_WalkRange(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1)
	fieldsToRead := []string{"ID", "Email"}
	resultRow0 := map[string]dosaRenamed.FieldValue{
		"id":    int64(2),
		"name":  "bar",
		"email": "bar@email.com",
	}
	resultRow1 := map[string]dosaRenamed.FieldValue{
		"id":    int64(3),
		"name":  "jeff",
		"email": "jeff@email.com",
	}

	// uninitialized
	c0 := dosaRenamed.NewClient(reg1, nullConnector)
	rop := dosaRenamed.NewRangeOp(cte1).Fields(fieldsToRead).Eq("ID", "123").Offset("tokeytoketoke")
	err := c0.WalkRange(ctx, rop, func(value dosaRenamed.DomainObject) error {
		return nil
	})
	assert.True(t, dosaRenamed.ErrorIsNotInitialized(err))

	// success case
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn1 := mocks.NewMockConnector(ctrl)
	mockConn1.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn1.EXPECT().Range(ctx, gomock.Any(), gomock.Any(), gomock.Any(), "", gomock.Any()).
		Return([]map[string]dosaRenamed.FieldValue{resultRow0}, "token0", nil)
	mockConn1.EXPECT().Range(ctx, gomock.Any(), gomock.Any(), gomock.Any(), "token0", gomock.Any()).
		Return([]map[string]dosaRenamed.FieldValue{resultRow1}, "", nil)
	c1 := dosaRenamed.NewClient(reg1, mockConn1)
	c1.Initialize(ctx)
	rop = dosaRenamed.NewRangeOp(cte1)

	var fetched []*ClientTestEntity1
	err = c1.WalkRange(ctx, rop, func(value dosaRenamed.DomainObject) error {
		fetched = append(fetched, value.(*ClientTestEntity1))
		return nil
	})
	assert.NoError(t, err)
	assert.NotNil(t, fetched)
	assert.Equal(t, 2, len(fetched))
	assert.Equal(t, resultRow0["id"], fetched[0].ID)
	assert.Equal(t, resultRow0["name"], fetched[0].Name)
	assert.Equal(t, resultRow0["email"], fetched[0].Email)
	assert.Equal(t, resultRow1["id"], fetched[1].ID)
	assert.Equal(t, resultRow1["name"], fetched[1].Name)
	assert.Equal(t, resultRow1["email"], fetched[1].Email)

	// Range with closure error
	mockConn2 := mocks.NewMockConnector(ctrl)
	mockConn2.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil)
	mockConn2.EXPECT().Range(ctx, gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).
		Return([]map[string]dosaRenamed.FieldValue{resultRow0}, "", nil)
	c2 := dosaRenamed.NewClient(reg1, mockConn2)
	c2.Initialize(ctx)
	rop = dosaRenamed.NewRangeOp(cte1)
	err = c2.WalkRange(ctx, rop, func(value dosaRenamed.DomainObject) error {
		return errors.New("woops!")
	})
	assert.EqualError(t, err, "woops!")
}

func TestClient_ScanEverything(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1)
	fieldsToRead := []string{"ID", "Email"}
	resultRow := map[string]dosaRenamed.FieldValue{
		"id":          int64(2),
		"name":        "bar",
		"email":       "bar@email.com",
		"straycolumn": "this_should_be_discarded",
	}

	// uninitialized
	c1 := dosaRenamed.NewClient(reg1, nullConnector)
	sop := dosaRenamed.NewScanOp(cte1).Fields(fieldsToRead).Offset("tokeytoketoke")
	_, _, err := c1.ScanEverything(ctx, sop)
	assert.True(t, dosaRenamed.ErrorIsNotInitialized(err))

	c1.Initialize(ctx)

	// bad entity
	sop = dosaRenamed.NewScanOp(cte2)
	_, _, err = c1.ScanEverything(ctx, sop)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "ClientTestEntity2")

	// bad projected column
	sop = dosaRenamed.NewScanOp(cte1).Fields([]string{"borkborkbork"})
	_, _, err = c1.ScanEverything(ctx, sop)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "ClientTestEntity1")
	assert.Contains(t, err.Error(), "borkborkbork")

	// success case
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().Scan(ctx, gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).
		Return([]map[string]dosaRenamed.FieldValue{resultRow}, "continuation-token", nil)
	c2 := dosaRenamed.NewClient(reg1, mockConn)
	c2.Initialize(ctx)
	sop = dosaRenamed.NewScanOp(cte1)
	rows, token, err := c2.ScanEverything(ctx, sop)
	assert.NoError(t, err)
	assert.NotNil(t, rows)
	assert.Equal(t, 1, len(rows))
	for _, obj := range rows {
		assert.Equal(t, resultRow["id"], obj.(*ClientTestEntity1).ID)
		assert.Equal(t, resultRow["name"], obj.(*ClientTestEntity1).Name)
		assert.Equal(t, resultRow["email"], obj.(*ClientTestEntity1).Email)
	}
	assert.Equal(t, "continuation-token", token)

	// no resulting rows, just use the devnull connector
	sop = dosaRenamed.NewScanOp(cte1)
	_, _, err = c1.ScanEverything(ctx, sop)
	assert.True(t, dosaRenamed.ErrorIsNotFound(err))
}

func TestClient_Remove(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1)

	// uninitialized
	c1 := dosaRenamed.NewClient(reg1, nullConnector)
	err := c1.Remove(ctx, cte1)
	assert.True(t, dosaRenamed.ErrorIsNotInitialized(err))

	c1.Initialize(ctx)

	// bad entity
	err = c1.Remove(ctx, cte2)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "ClientTestEntity2")
	// success case
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().Remove(ctx, gomock.Any(), map[string]dosaRenamed.FieldValue{"id": dosaRenamed.FieldValue(int64(123))}).Return(nil)
	c2 := dosaRenamed.NewClient(reg1, mockConn)
	c2.Initialize(ctx)
	err = c2.Remove(ctx, &ClientTestEntity1{ID: int64(123)})
	assert.NoError(t, err)

}

func TestClient_MultiRead(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1)
	reg2, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1, cte2)
	fieldsToRead := []string{"ID", "Email"}
	e1 := &ClientTestEntity1{ID: int64(1)}
	e2 := &ClientTestEntity1{ID: int64(2)}
	results := []*dosaRenamed.FieldValuesOrError{
		{
			Values: map[string]dosaRenamed.FieldValue{
				"id":    testutil.TestInt64Ptr(int64(1)),
				"name":  testutil.TestStringPtr("xxx"),
				"email": testutil.TestStringPtr("xxx@gmail.com"),
			},
		},
		{
			Error: errors.New("not fonud"),
		},
	}

	// uninitialized
	c1 := dosaRenamed.NewClient(reg1, nullConnector)
	assert.Error(t, c1.Read(ctx, fieldsToRead, cte1))

	// unregistered object
	c1.Initialize(ctx)
	_, err := c1.MultiRead(ctx, dosaRenamed.All(), cte2)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "ClientTestEntity2")

	// multi read different types of object
	c1.Initialize(ctx)
	_, err = c1.MultiRead(ctx, dosaRenamed.All(), cte2, cte1)
	assert.Error(t, err)
	assert.Contains(t, err.Error(), "ClientTestEntity2")

	// happy path, mock connector
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchema(ctx, gomock.Any(), gomock.Any(), gomock.Any()).Return(int32(1), nil).AnyTimes()
	mockConn.EXPECT().MultiRead(ctx, gomock.Any(), gomock.Any(), gomock.Any()).
		Do(func(_ context.Context, _ *dosaRenamed.EntityInfo, columnValues []map[string]dosaRenamed.FieldValue, columnsToRead []string) {
			assert.Equal(t, columnValues[0]["id"], e1.ID)
			assert.Equal(t, columnValues[1]["id"], e2.ID)
			assert.Equal(t, columnsToRead, []string{"id", "email"})

		}).Return(results, nil).MinTimes(1)
	c3 := dosaRenamed.NewClient(reg2, mockConn)
	assert.NoError(t, c3.Initialize(ctx))
	rs, err := c3.MultiRead(ctx, fieldsToRead, e1, e2)
	assert.NoError(t, err)
	assert.Equal(t, int64(1), e1.ID)
	assert.Empty(t, e1.Name)
	assert.Equal(t, "xxx@gmail.com", e1.Email)
	assert.Equal(t, rs[e2].Error(), "not fonud")
}

/* TODO: Coming in v2.1
func TestClient_Unimplemented(t *testing.T) {
	reg1, _ := dosaRenamed.NewRegistrar(scope, namePrefix, cte1)

	c := dosaRenamed.NewClient(reg1, nullConnector)
	assert.Panics(t, func() {
		c.MultiUpsert(ctx, dosaRenamed.All(), &ClientTestEntity1{})
	})
	assert.Panics(t, func() {
		c.MultiRemove(ctx, &ClientTestEntity1{})
	})
}
*/

func TestAdminClient_CreateScope(t *testing.T) {
	c := dosaRenamed.NewAdminClient(nullConnector)
	assert.NotNil(t, c)

	err := c.CreateScope(context.TODO(), &dosaRenamed.ScopeMetadata{Name: scope})
	assert.NoError(t, err)
}

func TestAdminClient_TruncateScope(t *testing.T) {
	c := dosaRenamed.NewAdminClient(nullConnector)
	assert.NotNil(t, c)

	err := c.TruncateScope(context.TODO(), scope)
	assert.NoError(t, err)
}

func TestAdminClient_DropScope(t *testing.T) {
	c := dosaRenamed.NewAdminClient(nullConnector)
	assert.NotNil(t, c)

	err := c.DropScope(context.TODO(), scope)
	assert.NoError(t, err)
}

func TestAdminClient_CanUpsertSchema(t *testing.T) {
	// write some entities to disk
	tmpdir := ".testcanupsertschema"
	os.RemoveAll(tmpdir)
	defer os.RemoveAll(tmpdir)
	content := `
package main

import "github.com/uber-go/dosa"

type TestEntityA struct {
	dosa.Entity ` + "`dosa:\"primaryKey=(ID)\"`" + `
	ID int32
}
type TestEntityB struct {
	dosa.Entity ` + "`dosa:\"primaryKey=(ID)\"`" + `
	ID int32
}
`
	assert.NoError(t, os.MkdirAll(tmpdir, 0770))
	assert.NoError(t, ioutil.WriteFile(filepath.Join(tmpdir, "f1.go"), []byte(content), 0700))

	data := []struct {
		dirs        []string
		excludes    []string
		scope       string
		namePrefix  string
		errContains string
	}{
		// cannot get schema
		{
			dirs:        []string{"/foo/bar/baz"},
			scope:       scope,
			errContains: "/foo/bar/baz",
		},
		// connector error
		{
			dirs:        []string{tmpdir},
			scope:       scope,
			namePrefix:  "error",
			errContains: "connector error",
		},
		// happy path
		{
			dirs:       []string{tmpdir},
			scope:      scope,
			namePrefix: namePrefix,
		},
	}

	// calls with "error" name prefix will fail, rest succeed
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CanUpsertSchema(ctx, scope, "error", gomock.Any()).Return(int32(-1), errors.New("connector error")).Times(1)
	mockConn.EXPECT().CanUpsertSchema(ctx, scope, namePrefix, gomock.Any()).Return(int32(1), nil).Times(1)

	for _, d := range data {
		_, err := dosaRenamed.NewAdminClient(mockConn).
			Directories(d.dirs).
			Scope(d.scope).
			CanUpsertSchema(ctx, d.namePrefix)
		if d.errContains != "" {
			assert.Contains(t, err.Error(), d.errContains)
			continue
		}
		assert.NoError(t, err)
	}
}

func TestAdminClient_CheckSchemaStatus(t *testing.T) {
	data := []struct {
		version     int32
		scope       string
		namePrefix  string
		errContains string
	}{
		{ // connector error
			version:     int32(1),
			scope:       scope,
			namePrefix:  "error",
			errContains: "connector error",
		},
		// happy path
		{
			version:    int32(1),
			scope:      scope,
			namePrefix: namePrefix,
		},
	}

	// calls with "error" name prefix will fail, rest succeed
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().CheckSchemaStatus(ctx, scope, "error", int32(1)).Return(nil, errors.New("connector error")).Times(1)
	mockConn.EXPECT().CheckSchemaStatus(ctx, scope, namePrefix, gomock.Any()).Return(&dosaRenamed.SchemaStatus{Version: int32(1)}, nil).Times(1)

	for _, d := range data {
		status, err := dosaRenamed.NewAdminClient(mockConn).
			Scope(d.scope).
			CheckSchemaStatus(ctx, d.namePrefix, d.version)
		if d.errContains != "" {
			assert.Contains(t, err.Error(), d.errContains)
			continue
		}
		assert.NoError(t, err)
		assert.Equal(t, d.version, status.Version)
	}
}

func TestAdminClient_UpsertSchema(t *testing.T) {
	// write some entities to disk
	tmpdir := ".testupsertschema"
	os.RemoveAll(tmpdir)
	defer os.RemoveAll(tmpdir)
	content := `
package main

import "github.com/uber-go/dosa"

type TestEntityA struct {
	dosa.Entity ` + "`dosa:\"primaryKey=(ID)\"`" + `
	ID int32
}
type TestEntityB struct {
	dosa.Entity ` + "`dosa:\"primaryKey=(ID)\"`" + `
	ID int32
}
`
	assert.NoError(t, os.MkdirAll(tmpdir, 0770))
	assert.NoError(t, ioutil.WriteFile(filepath.Join(tmpdir, "f1.go"), []byte(content), 0700))

	data := []struct {
		dirs        []string
		scope       string
		namePrefix  string
		errContains string
	}{
		// cannot get schema
		{
			dirs:        []string{"/foo/bar/baz"},
			scope:       scope,
			errContains: "/foo/bar/baz",
		},
		// connector error
		{
			dirs:        []string{tmpdir},
			scope:       scope,
			namePrefix:  "error",
			errContains: "connector error",
		},
		// happy path
		{
			dirs:       []string{tmpdir},
			scope:      scope,
			namePrefix: namePrefix,
		},
	}

	// calls with "error" name prefix will fail, rest succeed
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockConn := mocks.NewMockConnector(ctrl)
	mockConn.EXPECT().UpsertSchema(ctx, scope, "error", gomock.Any()).Return(nil, errors.New("connector error")).Times(1)
	mockConn.EXPECT().UpsertSchema(ctx, scope, namePrefix, gomock.Any()).Return(&dosaRenamed.SchemaStatus{Version: int32(1)}, nil).Times(1)

	for _, d := range data {
		_, err := dosaRenamed.NewAdminClient(mockConn).
			Directories(d.dirs).
			Scope(d.scope).
			UpsertSchema(ctx, d.namePrefix)
		if d.errContains != "" {
			assert.Contains(t, err.Error(), d.errContains)
			continue
		}
		assert.NoError(t, err)
	}
}

func TestAdminClient_GetSchema(t *testing.T) {
	// write some entities to disk
	tmpdir := ".testgetschema"
	os.RemoveAll(tmpdir)
	defer os.RemoveAll(tmpdir)
	path1 := filepath.Join(tmpdir, "f1.go")
	path2 := filepath.Join(tmpdir, "f2.go")
	content := `
package main

import renamed "github.com/uber-go/dosa"

type TestEntityA struct {
	renamed.Entity ` + "`dosa:\"primaryKey=(ID)\"`" + `
	ID int32
}
type TestEntityB struct {
	renamed.Entity ` + "`dosa:\"primaryKey=(ID)\"`" + `
	ID renamed.UUID
}
`
	invalid := `
package main

import "github.com/uber-go/dosa"

type TestEntityC struct {
	dosa.Entity ` + "`dosa:\"primaryKey=ID, etl=\"`" + `
	ID int32
}
`
	assert.NoError(t, os.MkdirAll(tmpdir, 0770))
	assert.NoError(t, ioutil.WriteFile(path1, []byte(content), 0700))
	assert.NoError(t, ioutil.WriteFile(path2, []byte(invalid), 0700))

	data := []struct {
		dirs        []string
		excludes    []string
		scope       string
		namePrefix  string
		errContains string
	}{
		// invalid scope
		{
			scope:       "***",
			errContains: "invalid scope name",
		},
		// invalid directory
		{
			dirs:        []string{"/foo/bar/baz"},
			scope:       scope,
			errContains: "/foo/bar/baz",
		},
		// no entities found
		{
			dirs:        []string{tmpdir},
			excludes:    []string{"f1.go", "f2.go", "f3.go"},
			scope:       scope,
			errContains: "no entities found",
		},
		// invalid struct tag
		{
			dirs:        []string{tmpdir},
			scope:       scope,
			errContains: "invalid",
		},
	}

	for _, d := range data {
		_, err := dosaRenamed.NewAdminClient(nullConnector).
			Directories(d.dirs).
			Excludes(d.excludes).
			Scope(d.scope).
			UpsertSchema(ctx, d.namePrefix)
		if d.errContains != "" {
			assert.Contains(t, err.Error(), d.errContains)
			continue
		}
		assert.NoError(t, err)
	}
}

func TestErrorIsNotFound(t *testing.T) {
	assert.False(t, dosaRenamed.ErrorIsNotFound(errors.New("not a IsNotFound error")))
	assert.False(t, dosaRenamed.ErrorIsNotFound(&dosaRenamed.ErrNotInitialized{}))
	assert.True(t, dosaRenamed.ErrorIsNotFound(&dosaRenamed.ErrNotFound{}))
	assert.True(t, dosaRenamed.ErrorIsNotFound(errors.Wrap(&dosaRenamed.ErrNotFound{}, "wrapped")))
	assert.Equal(t, (&dosaRenamed.ErrNotFound{}).Error(), "not found")
}

func TestErrNotInitialized_Error(t *testing.T) {
	assert.False(t, dosaRenamed.ErrorIsNotInitialized(errors.New("not a IsNotInitializedError")))
	assert.False(t, dosaRenamed.ErrorIsNotInitialized(&dosaRenamed.ErrNotFound{}))
	assert.True(t, dosaRenamed.ErrorIsNotInitialized(&dosaRenamed.ErrNotInitialized{}))
	assert.True(t, dosaRenamed.ErrorIsNotInitialized(errors.Wrap(&dosaRenamed.ErrNotInitialized{}, "wrapped")))
	assert.Equal(t, (&dosaRenamed.ErrNotInitialized{}).Error(), "client not initialized")

}

func TestErrorIsAlreadyExists(t *testing.T) {
	assert.False(t, dosaRenamed.ErrorIsAlreadyExists(errors.New("not an already exists error")))
	assert.False(t, dosaRenamed.ErrorIsAlreadyExists(&dosaRenamed.ErrNotInitialized{}))
	assert.False(t, dosaRenamed.ErrorIsAlreadyExists(&dosaRenamed.ErrNotFound{}))
	assert.True(t, dosaRenamed.ErrorIsAlreadyExists(errors.Wrap(&dosaRenamed.ErrAlreadyExists{}, "wrapped")))
	assert.Equal(t, "already exists", (&dosaRenamed.ErrAlreadyExists{}).Error())
}