Gleipnir/jet
4
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Add automatic query logger function with additional execution details.

Browse source
This commit is contained in:
go-jet 2022-01-12 19:03:50 +01:00
parent 7377e078cd
commit 4955bfc4b5
18 changed files with 266 additions and 59 deletions
Download patch file Download diff file Expand all files Collapse all files

26
tests/mysql/main_test.go
View file

@ -8,6 +8,7 @@ import (
"github.com/go-jet/jet/v2/tests/dbconfig"
"github.com/stretchr/testify/require"
"math/rand"
"runtime"
"time"
_ "github.com/go-sql-driver/mysql"
@ -51,11 +52,21 @@ var loggedSQL string
var loggedSQLArgs []interface{}
var loggedDebugSQL string
var queryInfo jetmysql.QueryInfo
var callerFile string
var callerLine int
var callerFunction string
func init() {
jetmysql.SetLogger(func(ctx context.Context, statement jetmysql.PrintableStatement) {
loggedSQL, loggedSQLArgs = statement.Sql()
loggedDebugSQL = statement.DebugSql()
})
jetmysql.SetQueryLoggerFunc(func(ctx context.Context, info jetmysql.QueryInfo) {
queryInfo = info
callerFile, callerLine, callerFunction = info.Caller()
})
}
func requireLogged(t *testing.T, statement postgres.Statement) {
@ -65,6 +76,21 @@ func requireLogged(t *testing.T, statement postgres.Statement) {
require.Equal(t, loggedDebugSQL, statement.DebugSql())
}
func requireQueryLogged(t *testing.T, statement postgres.Statement, rowsProcessed int64) {
query, args := statement.Sql()
queryLogged, argsLogged := queryInfo.Statement.Sql()
require.Equal(t, query, queryLogged)
require.Equal(t, args, argsLogged)
require.Equal(t, queryInfo.RowsProcessed, rowsProcessed)
pc, file, _, _ := runtime.Caller(1)
funcDetails := runtime.FuncForPC(pc)
require.Equal(t, file, callerFile)
require.NotEmpty(t, callerLine)
require.Equal(t, funcDetails.Name(), callerFunction)
}
func skipForMariaDB(t *testing.T) {
if sourceIsMariaDB() {
t.SkipNow()

6
tests/mysql/select_test.go
View file

@ -38,6 +38,7 @@ WHERE actor.actor_id = ?;
testutils.AssertDeepEqual(t, actor, actor2)
requireLogged(t, query)
requireQueryLogged(t, query, 1)
}
var actor2 = model.Actor{
@ -60,9 +61,9 @@ SELECT actor.actor_id AS "actor.actor_id",
FROM dvds.actor
ORDER BY actor.actor_id;
`)
dest := []model.Actor{}
var dest []model.Actor
err := query.Query(db, &dest)
err := query.QueryContext(context.Background(), db, &dest)
require.NoError(t, err)
@ -73,6 +74,7 @@ ORDER BY actor.actor_id;
//testutils.SaveJsonFile(dest, "mysql/testdata/all_actors.json")
testutils.AssertJSONFile(t, dest, "./testdata/results/mysql/all_actors.json")
requireLogged(t, query)
requireQueryLogged(t, query, 200)
}
func TestSelectGroupByHaving(t *testing.T) {

4
tests/postgres/chinook_db_test.go
View file

@ -35,6 +35,7 @@ ORDER BY "Album"."AlbumId" ASC;
testutils.AssertDeepEqual(t, dest[1], album2)
testutils.AssertDeepEqual(t, dest[len(dest)-1], album347)
requireLogged(t, stmt)
requireQueryLogged(t, stmt, 347)
}
func TestJoinEverything(t *testing.T) {
@ -191,12 +192,13 @@ FROM chinook."Artist"
ORDER BY "Artist"."ArtistId", "Album"."AlbumId", "Track"."TrackId", "Genre"."GenreId", "MediaType"."MediaTypeId", "Playlist"."PlaylistId", "Invoice"."InvoiceId", "Customer"."CustomerId";
`)
err := stmt.Query(db, &dest)
err := stmt.QueryContext(context.Background(), db, &dest)
require.NoError(t, err)
require.Equal(t, len(dest), 275)
testutils.AssertJSONFile(t, dest, "./testdata/results/postgres/joined_everything.json")
requireLogged(t, stmt)
requireQueryLogged(t, stmt, 9423)
}
// default column aliases from sub-CTEs are bubbled up to the main query,

9
tests/postgres/delete_test.go
View file

@ -25,7 +25,14 @@ WHERE link.name IN ('Gmail', 'Outlook');
WHERE(Link.Name.IN(String("Gmail"), String("Outlook")))
testutils.AssertDebugStatementSql(t, deleteStmt, expectedSQL, "Gmail", "Outlook")
AssertExec(t, deleteStmt, 2)
res, err := deleteStmt.ExecContext(context.Background(), db)
require.NoError(t, err)
rows, err := res.RowsAffected()
require.NoError(t, err)
require.Equal(t, rows, int64(2))
requireQueryLogged(t, deleteStmt, int64(2))
}
func TestDeleteWithWhereAndReturning(t *testing.T) {

26
tests/postgres/main_test.go
View file

@ -7,6 +7,7 @@ import (
"github.com/go-jet/jet/v2/tests/internal/utils/repo"
"math/rand"
"os"
"runtime"
"testing"
"time"
@ -59,11 +60,21 @@ var loggedSQL string
var loggedSQLArgs []interface{}
var loggedDebugSQL string
var queryInfo postgres.QueryInfo
var callerFile string
var callerLine int
var callerFunction string
func init() {
postgres.SetLogger(func(ctx context.Context, statement postgres.PrintableStatement) {
loggedSQL, loggedSQLArgs = statement.Sql()
loggedDebugSQL = statement.DebugSql()
})
postgres.SetQueryLoggerFunc(func(ctx context.Context, info postgres.QueryInfo) {
queryInfo = info
callerFile, callerLine, callerFunction = info.Caller()
})
}
func requireLogged(t *testing.T, statement postgres.Statement) {
@ -73,6 +84,21 @@ func requireLogged(t *testing.T, statement postgres.Statement) {
require.Equal(t, loggedDebugSQL, statement.DebugSql())
}
func requireQueryLogged(t *testing.T, statement postgres.Statement, rowsProcessed int64) {
query, args := statement.Sql()
queryLogged, argsLogged := queryInfo.Statement.Sql()
require.Equal(t, query, queryLogged)
require.Equal(t, args, argsLogged)
require.Equal(t, queryInfo.RowsProcessed, rowsProcessed)
pc, file, _, _ := runtime.Caller(1)
funcDetails := runtime.FuncForPC(pc)
require.Equal(t, file, callerFile)
require.NotEmpty(t, callerLine)
require.Equal(t, funcDetails.Name(), callerFunction)
}
func skipForPgxDriver(t *testing.T) {
if isPgxDriver() {
t.SkipNow()

4
tests/postgres/scan_test.go
View file

@ -62,7 +62,8 @@ func TestScanToValidDestination(t *testing.T) {
t.Run("global query function scan", func(t *testing.T) {
queryStr, args := oneInventoryQuery.Sql()
dest := []struct{}{}
err := qrm.Query(nil, db, queryStr, args, &dest)
rowProcessed, err := qrm.Query(nil, db, queryStr, args, &dest)
require.Equal(t, rowProcessed, int64(1))
require.NoError(t, err)
})
@ -782,6 +783,7 @@ func TestRowsScan(t *testing.T) {
require.NoError(t, err)
requireLogged(t, stmt)
requireQueryLogged(t, stmt, 0)
}
func TestScanNumericToFloat(t *testing.T) {

4
tests/postgres/update_test.go
View file

@ -270,7 +270,9 @@ WHERE link.id = 201::integer;
`
testutils.AssertDebugStatementSql(t, stmt, expectedSQL, int32(201), "http://www.duckduckgo.com", "DuckDuckGo", nil, int32(201))
AssertExec(t, stmt, 1)
_, err := stmt.Exec(db)
require.NoError(t, err)
requireQueryLogged(t, stmt, 1)
}
func TestUpdateWithModelDataAndPredefinedColumnList(t *testing.T) {

27
tests/sqlite/main_test.go
View file

@ -5,12 +5,14 @@ import (
"database/sql"
"fmt"
"github.com/go-jet/jet/v2/internal/utils/throw"
"github.com/go-jet/jet/v2/postgres"
"github.com/go-jet/jet/v2/sqlite"
"github.com/go-jet/jet/v2/tests/dbconfig"
"github.com/stretchr/testify/require"
"math/rand"
"os"
"os/exec"
"runtime"
"strings"
"testing"
"time"
@ -63,11 +65,36 @@ var loggedSQL string
var loggedSQLArgs []interface{}
var loggedDebugSQL string
var queryInfo sqlite.QueryInfo
var callerFile string
var callerLine int
var callerFunction string
func init() {
sqlite.SetLogger(func(ctx context.Context, statement sqlite.PrintableStatement) {
loggedSQL, loggedSQLArgs = statement.Sql()
loggedDebugSQL = statement.DebugSql()
})
sqlite.SetQueryLoggerFunc(func(ctx context.Context, info sqlite.QueryInfo) {
queryInfo = info
callerFile, callerLine, callerFunction = info.Caller()
})
}
func requireQueryLogged(t *testing.T, statement postgres.Statement, rowsProcessed int64) {
query, args := statement.Sql()
queryLogged, argsLogged := queryInfo.Statement.Sql()
require.Equal(t, query, queryLogged)
require.Equal(t, args, argsLogged)
require.Equal(t, queryInfo.RowsProcessed, rowsProcessed)
pc, file, _, _ := runtime.Caller(1)
funcDetails := runtime.FuncForPC(pc)
require.Equal(t, file, callerFile)
require.NotEmpty(t, callerLine)
require.Equal(t, funcDetails.Name(), callerFunction)
}
func requireLogged(t *testing.T, statement sqlite.Statement) {

4
tests/sqlite/select_test.go
View file

@ -39,6 +39,7 @@ WHERE actor.actor_id = ?;
testutils.AssertDeepEqual(t, actor, actor2)
requireLogged(t, query)
requireQueryLogged(t, query, 1)
}
var actor2 = model.Actor{
@ -63,7 +64,7 @@ ORDER BY actor.actor_id;
`)
dest := []model.Actor{}
err := query.Query(db, &dest)
err := query.QueryContext(context.Background(), db, &dest)
require.NoError(t, err)
@ -73,6 +74,7 @@ ORDER BY actor.actor_id;
//testutils.SaveJSONFile(dest, "./testdata/results/sqlite/all_actors.json")
testutils.AssertJSONFile(t, dest, "./testdata/results/sqlite/all_actors.json")
requireLogged(t, query)
requireQueryLogged(t, query, 200)
}
func TestSelectGroupByHaving(t *testing.T) {