sq/libsq/query_test.go
Neil O'Toole 3f6157c4c4
Change logging library to slog (#175)
- Switch to slog logger.
2023-04-02 13:49:45 -06:00

119 lines
2.8 KiB
Go

package libsq_test
import (
"strings"
"testing"
"github.com/neilotoole/sq/libsq"
"golang.org/x/exp/slices"
"github.com/neilotoole/sq/libsq/source"
"github.com/stretchr/testify/require"
_ "github.com/mattn/go-sqlite3"
"github.com/neilotoole/sq/testh"
"github.com/neilotoole/sq/testh/sakila"
)
// queryTestCase is used to test libsq's rendering of SLQ into SQL.
// It is probably the most important test struct in the codebase.
type queryTestCase struct {
// name is the test name
name string
// skip indicates the test should be skipped. Useful for test cases
// that we wantSQL to implement in the future.
skip bool
// in is the SLQ input. The "@sakila" handle is replaced
// with the source's actual handle before an individual
// test cases is executed.
in string
// args contains args for the "--args a b" mechanism. Typically empty.
args map[string]string
// wantErr indicates that an error is expected
wantErr bool
// wantSQL is the wanted SQL
wantSQL string
// override allows an alternative "wantSQL" for a specific driver type.
// For example, MySQL uses backtick as the quote char, so it needs
// a separate wantSQL string.
override map[source.Type]string
// onlyFor indicates that this test should only run on sources of
// the specified types. When empty, the test is executed on all types.
onlyFor []source.Type
// skipExec indicates that the resulting query should not be executed.
// Some SLQ inputs we wantSQL to test don't actually have corresponding
// data in the Sakila datasets.
skipExec bool
// wantRecs is the number of expected records from actually executing
// the query. This is N/A if skipExec is true.
wantRecs int
}
func execQueryTestCase(t *testing.T, tc queryTestCase) {
if tc.skip {
t.Skip()
}
srcs := testh.New(t).NewSourceSet(sakila.SQLLatest()...)
for _, src := range srcs.Items() {
src := src
t.Run(string(src.Type), func(t *testing.T) {
if len(tc.onlyFor) > 0 {
if !slices.Contains(tc.onlyFor, src.Type) {
t.Skip()
}
}
in := strings.Replace(tc.in, "@sakila", src.Handle, 1)
t.Log(in)
want := tc.wantSQL
if overrideWant, ok := tc.override[src.Type]; ok {
want = overrideWant
}
_, err := srcs.SetActive(src.Handle)
require.NoError(t, err)
th := testh.New(t)
dbases := th.Databases()
qc := &libsq.QueryContext{
Sources: srcs,
DBOpener: dbases,
JoinDBOpener: dbases,
Args: tc.args,
}
gotSQL, gotErr := libsq.SLQ2SQL(th.Context, qc, in)
if tc.wantErr {
require.Error(t, gotErr)
return
}
require.NoError(t, gotErr)
require.Equal(t, want, gotSQL)
t.Log(gotSQL)
if tc.skipExec {
return
}
sink, err := th.QuerySLQ(in)
require.NoError(t, err)
require.Equal(t, tc.wantRecs, len(sink.Recs))
})
}
}