/
generic_repo_delete_tests.go
165 lines (139 loc) · 5.39 KB
/
generic_repo_delete_tests.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
package testdb
import (
"context"
"fmt"
"reflect"
"testing"
"github.com/DATA-DOG/go-sqlmock"
"github.com/kyma-incubator/compass/components/director/pkg/apperrors"
"github.com/kyma-incubator/compass/components/director/pkg/persistence"
"github.com/pkg/errors"
"github.com/stretchr/testify/require"
)
// RepoDeleteTestSuite represents a generic test suite for repository Delete method of any global entity or entity that has externally managed tenants in m2m table/view.
type RepoDeleteTestSuite struct {
Name string
SQLQueryDetails []SQLQueryDetails
ConverterMockProvider func() Mock
RepoConstructorFunc interface{}
MethodName string
MethodArgs []interface{}
IsDeleteMany bool
IsGlobal bool
}
// Run runs the generic repo delete test suite
func (suite *RepoDeleteTestSuite) Run(t *testing.T) bool {
if len(suite.MethodName) == 0 {
suite.MethodName = "Delete"
}
return t.Run(suite.Name, func(t *testing.T) {
testErr := errors.New("test error")
t.Run("success", func(t *testing.T) {
sqlxDB, sqlMock := MockDatabase(t)
ctx := persistence.SaveToContext(context.TODO(), sqlxDB)
configureValidSQLQueries(sqlMock, suite.SQLQueryDetails)
convMock := suite.ConverterMockProvider()
pgRepository := createRepo(suite.RepoConstructorFunc, convMock)
// WHEN
err := callDelete(pgRepository, ctx, suite.MethodName, suite.MethodArgs)
// THEN
require.NoError(t, err)
sqlMock.AssertExpectations(t)
convMock.AssertExpectations(t)
})
if !suite.IsDeleteMany { // Single delete requires exactly one row to be deleted
t.Run("returns error if no entity matches criteria", func(t *testing.T) {
sqlxDB, sqlMock := MockDatabase(t)
ctx := persistence.SaveToContext(context.TODO(), sqlxDB)
configureNoEntityDeleted(sqlMock, suite.SQLQueryDetails)
convMock := suite.ConverterMockProvider()
pgRepository := createRepo(suite.RepoConstructorFunc, convMock)
// WHEN
err := callDelete(pgRepository, ctx, suite.MethodName, suite.MethodArgs)
// THEN
require.Error(t, err)
if suite.IsGlobal {
require.Equal(t, apperrors.InternalError, apperrors.ErrorCode(err))
require.Contains(t, err.Error(), "delete should remove single row, but removed 0 rows")
} else {
require.Equal(t, apperrors.Unauthorized, apperrors.ErrorCode(err))
require.Contains(t, err.Error(), apperrors.ShouldBeOwnerMsg)
}
sqlMock.AssertExpectations(t)
convMock.AssertExpectations(t)
})
t.Run("returns error if more than one entity matches criteria", func(t *testing.T) {
sqlxDB, sqlMock := MockDatabase(t)
ctx := persistence.SaveToContext(context.TODO(), sqlxDB)
configureMoreThanOneEntityDeleted(sqlMock, suite.SQLQueryDetails)
convMock := suite.ConverterMockProvider()
pgRepository := createRepo(suite.RepoConstructorFunc, convMock)
// WHEN
err := callDelete(pgRepository, ctx, suite.MethodName, suite.MethodArgs)
// THEN
require.Error(t, err)
require.Equal(t, apperrors.InternalError, apperrors.ErrorCode(err))
require.Contains(t, err.Error(), "delete should remove single row, but removed")
sqlMock.AssertExpectations(t)
convMock.AssertExpectations(t)
})
}
for i := range suite.SQLQueryDetails {
t.Run(fmt.Sprintf("error if SQL query %d fail", i), func(t *testing.T) {
sqlxDB, sqlMock := MockDatabase(t)
ctx := persistence.SaveToContext(context.TODO(), sqlxDB)
configureFailureForSQLQueryOnIndex(sqlMock, suite.SQLQueryDetails, i, testErr)
convMock := suite.ConverterMockProvider()
pgRepository := createRepo(suite.RepoConstructorFunc, convMock)
// WHEN
err := callDelete(pgRepository, ctx, suite.MethodName, suite.MethodArgs)
// THEN
require.Error(t, err)
require.Equal(t, apperrors.InternalError, apperrors.ErrorCode(err))
require.Contains(t, err.Error(), "Internal Server Error: Unexpected error while executing SQL query")
sqlMock.AssertExpectations(t)
convMock.AssertExpectations(t)
})
}
})
}
func callDelete(repo interface{}, ctx context.Context, methodName string, args []interface{}) error {
argsVals := make([]reflect.Value, 1, len(args))
argsVals[0] = reflect.ValueOf(ctx)
for _, arg := range args {
argsVals = append(argsVals, reflect.ValueOf(arg))
}
results := reflect.ValueOf(repo).MethodByName(methodName).Call(argsVals)
if len(results) != 1 {
panic("Create should return one argument")
}
result := results[0].Interface()
if result == nil {
return nil
}
err, ok := result.(error)
if !ok {
panic("Expected result to be an error")
}
return err
}
func configureMoreThanOneEntityDeleted(sqlMock DBMock, sqlQueryDetails []SQLQueryDetails) {
for _, sqlDetails := range sqlQueryDetails {
if sqlDetails.IsSelect {
sqlMock.ExpectQuery(sqlDetails.Query).WithArgs(sqlDetails.Args...).WillReturnRows(sqlDetails.ValidRowsProvider()...)
} else {
sqlMock.ExpectExec(sqlDetails.Query).WithArgs(sqlDetails.Args...).WillReturnResult(sqlDetails.InvalidResult)
break
}
}
}
func configureNoEntityDeleted(sqlMock DBMock, sqlQueryDetails []SQLQueryDetails) {
for _, sqlDetails := range sqlQueryDetails {
if sqlDetails.IsSelect {
sqlMock.ExpectQuery(sqlDetails.Query).WithArgs(sqlDetails.Args...).WillReturnRows(sqlDetails.ValidRowsProvider()...)
} else {
sqlMock.ExpectExec(sqlDetails.Query).WithArgs(sqlDetails.Args...).WillReturnResult(sqlmock.NewResult(-1, 0))
break
}
}
}