mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 21:17:32 +00:00
test(queries): suite for prepare stmt funcs (#2644)
* chore(queries): test suite for prepare stmt funcs * test(queries): prepare project funcs * refactor: add comments * test: simlify expected sql, added possibility to add args to expected queries
This commit is contained in:
Silvan
324
internal/query/prepare_test.go
Normal file
324
internal/query/prepare_test.go
Normal file
@@ -0,0 +1,324 @@
|
||||
package query
|
||||
|
||||
import (
|
||||
"database/sql"
|
||||
"database/sql/driver"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"log"
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"github.com/DATA-DOG/go-sqlmock"
|
||||
sq "github.com/Masterminds/squirrel"
|
||||
"github.com/nsf/jsondiff"
|
||||
)
|
||||
|
||||
//assertPrepare checks if the prepare func executes the correct sql query and returns the correct object
|
||||
//prepareFunc must be of type
|
||||
// func() (sq.SelectBuilder, func(*sql.Rows) (*struct, error))
|
||||
// or
|
||||
// func() (sq.SelectBuilder, func(*sql.Row) (*struct, error))
|
||||
//expectedObject represents the return value of scan
|
||||
//sqlExpectation represents the query executed on the database
|
||||
func assertPrepare(t *testing.T, prepareFunc, expectedObject interface{}, sqlExpectation sqlExpectation, isErr checkErr) bool {
|
||||
t.Helper()
|
||||
|
||||
client, mock, err := sqlmock.New()
|
||||
if err != nil {
|
||||
t.Fatalf("failed to build mock client: %v", err)
|
||||
}
|
||||
|
||||
mock = sqlExpectation(mock)
|
||||
|
||||
builder, scan, err := execPrepare(prepareFunc)
|
||||
if err != nil {
|
||||
t.Error(err)
|
||||
return false
|
||||
}
|
||||
errCheck := func(err error) (error, bool) {
|
||||
if isErr == nil {
|
||||
if err == nil {
|
||||
return nil, true
|
||||
} else {
|
||||
return fmt.Errorf("no error expected got: %w", err), false
|
||||
}
|
||||
}
|
||||
return isErr(err)
|
||||
}
|
||||
object, ok := execScan(client, builder, scan, errCheck)
|
||||
if !ok {
|
||||
t.Error(object)
|
||||
return false
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(object, expectedObject) {
|
||||
prettyPrintDiff(t, expectedObject, object)
|
||||
return false
|
||||
}
|
||||
|
||||
if err := mock.ExpectationsWereMet(); err != nil {
|
||||
t.Errorf("sql expectations not met: %v", err)
|
||||
return false
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
type checkErr func(error) (err error, ok bool)
|
||||
|
||||
type sqlExpectation func(sqlmock.Sqlmock) sqlmock.Sqlmock
|
||||
|
||||
func mockQuery(stmt string, cols []string, row []driver.Value) func(m sqlmock.Sqlmock) sqlmock.Sqlmock {
|
||||
return func(m sqlmock.Sqlmock) sqlmock.Sqlmock {
|
||||
q := m.ExpectQuery(stmt)
|
||||
result := sqlmock.NewRows(cols)
|
||||
result.AddRow(row...)
|
||||
q.WillReturnRows(result)
|
||||
return m
|
||||
}
|
||||
}
|
||||
|
||||
func mockQueries(stmt string, cols []string, rows [][]driver.Value, args ...driver.Value) func(m sqlmock.Sqlmock) sqlmock.Sqlmock {
|
||||
return func(m sqlmock.Sqlmock) sqlmock.Sqlmock {
|
||||
q := m.ExpectQuery(stmt).WithArgs(args...)
|
||||
result := sqlmock.NewRows(cols)
|
||||
count := uint64(len(rows))
|
||||
for _, row := range rows {
|
||||
row = append(row, count)
|
||||
result.AddRow(row...)
|
||||
}
|
||||
q.WillReturnRows(result)
|
||||
q.RowsWillBeClosed()
|
||||
return m
|
||||
}
|
||||
}
|
||||
|
||||
func mockQueryErr(stmt string, err error, args ...driver.Value) func(m sqlmock.Sqlmock) sqlmock.Sqlmock {
|
||||
return func(m sqlmock.Sqlmock) sqlmock.Sqlmock {
|
||||
q := m.ExpectQuery(stmt).WithArgs(args...)
|
||||
q.WillReturnError(err)
|
||||
return m
|
||||
}
|
||||
}
|
||||
|
||||
var (
|
||||
rowType = reflect.TypeOf(&sql.Row{})
|
||||
rowsType = reflect.TypeOf(&sql.Rows{})
|
||||
selectBuilderType = reflect.TypeOf(sq.SelectBuilder{})
|
||||
)
|
||||
|
||||
func execScan(client *sql.DB, builder sq.SelectBuilder, scan interface{}, errCheck checkErr) (interface{}, bool) {
|
||||
scanType := reflect.TypeOf(scan)
|
||||
err := validateScan(scanType)
|
||||
if err != nil {
|
||||
return err, false
|
||||
}
|
||||
|
||||
stmt, args, err := builder.ToSql()
|
||||
if err != nil {
|
||||
return fmt.Errorf("unexpeted error from sql builder: %w", err), false
|
||||
}
|
||||
|
||||
//resultSet represents *sql.Row or *sql.Rows,
|
||||
// depending on whats assignable to the scan function
|
||||
var resultSet interface{}
|
||||
|
||||
//execute sql stmt
|
||||
// if scan(*sql.Rows)...
|
||||
if scanType.In(0).AssignableTo(rowsType) {
|
||||
resultSet, err = client.Query(stmt, args...)
|
||||
if err != nil {
|
||||
return errCheck(err)
|
||||
}
|
||||
|
||||
// if scan(*sql.Row)...
|
||||
} else if scanType.In(0).AssignableTo(rowType) {
|
||||
row := client.QueryRow(stmt, args...)
|
||||
if row.Err() != nil {
|
||||
return errCheck(row.Err())
|
||||
}
|
||||
resultSet = row
|
||||
} else {
|
||||
return errors.New("scan: parameter must be *sql.Row or *sql.Rows"), false
|
||||
}
|
||||
|
||||
// res contains object and error
|
||||
res := reflect.ValueOf(scan).Call([]reflect.Value{reflect.ValueOf(resultSet)})
|
||||
|
||||
//check for error
|
||||
if res[1].Interface() != nil {
|
||||
if err, ok := errCheck(res[1].Interface().(error)); !ok {
|
||||
return fmt.Errorf("scan failed: %w", err), false
|
||||
}
|
||||
}
|
||||
|
||||
return res[0].Interface(), true
|
||||
}
|
||||
|
||||
func validateScan(scanType reflect.Type) error {
|
||||
if scanType.Kind() != reflect.Func {
|
||||
return errors.New("scan is not a function")
|
||||
}
|
||||
if scanType.NumIn() != 1 {
|
||||
return fmt.Errorf("scan: invalid number of inputs: want: 1 got %d", scanType.NumIn())
|
||||
}
|
||||
if scanType.NumOut() != 2 {
|
||||
return fmt.Errorf("scan: invalid number of outputs: want: 2 got %d", scanType.NumOut())
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func execPrepare(prepare interface{}) (builder sq.SelectBuilder, scan interface{}, err error) {
|
||||
prepareVal := reflect.ValueOf(prepare)
|
||||
if err := validatePrepare(prepareVal.Type()); err != nil {
|
||||
return sq.SelectBuilder{}, nil, err
|
||||
}
|
||||
res := prepareVal.Call([]reflect.Value{})
|
||||
|
||||
return res[0].Interface().(sq.SelectBuilder), res[1].Interface(), nil
|
||||
}
|
||||
|
||||
func validatePrepare(prepareType reflect.Type) error {
|
||||
if prepareType.Kind() != reflect.Func {
|
||||
return errors.New("prepare is not a function")
|
||||
}
|
||||
if prepareType.NumIn() != 0 {
|
||||
return fmt.Errorf("prepare: invalid number of inputs: want: 0 got %d", prepareType.NumIn())
|
||||
}
|
||||
if prepareType.NumOut() != 2 {
|
||||
return fmt.Errorf("prepare: invalid number of outputs: want: 2 got %d", prepareType.NumOut())
|
||||
}
|
||||
if prepareType.Out(0) != selectBuilderType {
|
||||
return fmt.Errorf("prepare: first return value must be: %s got %s", selectBuilderType, prepareType.Out(0))
|
||||
}
|
||||
if prepareType.Out(1).Kind() != reflect.Func {
|
||||
return fmt.Errorf("prepare: second return value must be: %s got %s", reflect.Func, prepareType.Out(1))
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func TestValidateScan(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
t reflect.Type
|
||||
expectErr bool
|
||||
}{
|
||||
{
|
||||
name: "not a func",
|
||||
t: reflect.TypeOf(&struct{}{}),
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
name: "wong input count",
|
||||
t: reflect.TypeOf(func() (*struct{}, error) {
|
||||
log.Fatal("should not be executed")
|
||||
return nil, nil
|
||||
}),
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
name: "wrong output count",
|
||||
t: reflect.TypeOf(func(interface{}) error {
|
||||
log.Fatal("should not be executed")
|
||||
return nil
|
||||
}),
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
name: "correct",
|
||||
t: reflect.TypeOf(func(interface{}) (*struct{}, error) {
|
||||
log.Fatal("should not be executed")
|
||||
return nil, nil
|
||||
}),
|
||||
expectErr: false,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
err := validateScan(tt.t)
|
||||
if (err != nil) != tt.expectErr {
|
||||
t.Errorf("unexpected err: %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidatePrepare(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
t reflect.Type
|
||||
expectErr bool
|
||||
}{
|
||||
{
|
||||
name: "not a func",
|
||||
t: reflect.TypeOf(&struct{}{}),
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
name: "wong input count",
|
||||
t: reflect.TypeOf(func(int) (sq.SelectBuilder, func(*sql.Rows) (interface{}, error)) {
|
||||
log.Fatal("should not be executed")
|
||||
return sq.SelectBuilder{}, nil
|
||||
}),
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
name: "wrong output count",
|
||||
t: reflect.TypeOf(func() sq.SelectBuilder {
|
||||
log.Fatal("should not be executed")
|
||||
return sq.SelectBuilder{}
|
||||
}),
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
name: "first output type wrong",
|
||||
t: reflect.TypeOf(func() (*struct{}, func(*sql.Rows) (interface{}, error)) {
|
||||
log.Fatal("should not be executed")
|
||||
return nil, nil
|
||||
}),
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
name: "second output type wrong",
|
||||
t: reflect.TypeOf(func() (sq.SelectBuilder, *struct{}) {
|
||||
log.Fatal("should not be executed")
|
||||
return sq.SelectBuilder{}, nil
|
||||
}),
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
name: "correct",
|
||||
t: reflect.TypeOf(func() (sq.SelectBuilder, func(*sql.Rows) (interface{}, error)) {
|
||||
log.Fatal("should not be executed")
|
||||
return sq.SelectBuilder{}, nil
|
||||
}),
|
||||
expectErr: false,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
err := validatePrepare(tt.t)
|
||||
if (err != nil) != tt.expectErr {
|
||||
t.Errorf("unexpected err: %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func prettyPrintDiff(t *testing.T, expected, gotten interface{}) {
|
||||
t.Helper()
|
||||
|
||||
expectedMarshalled, _ := json.Marshal(expected)
|
||||
objectMarshalled, _ := json.Marshal(gotten)
|
||||
_, diff := jsondiff.Compare(
|
||||
expectedMarshalled,
|
||||
objectMarshalled,
|
||||
&jsondiff.Options{
|
||||
SkipMatches: true,
|
||||
Indent: " ",
|
||||
ChangedSeparator: " is expected, got ",
|
||||
})
|
||||
t.Errorf("unexpected object: want %T, got %T, difference:\n%s", expected, gotten, diff)
|
||||
}
|
||||
Reference in New Issue
Block a user