func_test.go

// Copyright (c) 2018 David Crawshaw <david@zentus.com>
// Copyright (c) 2021 Roxy Light <roxy@zombiezen.com>
//
// Permission to use, copy, modify, and distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
//
// SPDX-License-Identifier: ISC

package sqlite

import (
	"fmt"
	"strings"
	"testing"
	"unsafe"

	"github.com/google/go-cmp/cmp"
	"modernc.org/libc"
)

func TestFunc(t *testing.T) {
	c, err := OpenConn(":memory:", 0)
	if err != nil {
		t.Fatal(err)
	}
	defer func() {
		if err := c.Close(); err != nil {
			t.Error(err)
		}
	}()

	err = c.CreateFunction("addints", &FunctionImpl{
		NArgs:         2,
		Deterministic: true,
		Scalar: func(ctx Context, args []Value) (Value, error) {
			if got := ctx.Conn(); got != c {
				t.Errorf("ctx.Conn() = %p; want %p", got, c)
			}
			return IntegerValue(args[0].Int64() + args[1].Int64()), nil
		},
	})
	if err != nil {
		t.Fatal(err)
	}

	stmt, _, err := c.PrepareTransient("SELECT addints(2, 3);")
	if err != nil {
		t.Fatal(err)
	}
	if _, err := stmt.Step(); err != nil {
		t.Fatal(err)
	}
	if got, want := stmt.ColumnInt(0), 5; got != want {
		t.Errorf("addints(2, 3)=%d, want %d", got, want)
	}
	stmt.Finalize()
}

func TestAggFunc(t *testing.T) {
	c, err := OpenConn(":memory:", 0)
	if err != nil {
		t.Fatal(err)
	}
	defer func() {
		if err := c.Close(); err != nil {
			t.Error(err)
		}
	}()

	stmt, _, err := c.PrepareTransient("CREATE TABLE t (c integer);")
	if err != nil {
		t.Fatal(err)
	}
	if _, err := stmt.Step(); err != nil {
		t.Fatal(err)
	}
	if err := stmt.Finalize(); err != nil {
		t.Error(err)
	}

	cVals := []int{3, 5, 7}
	want := 3 + 5 + 7

	stmt, err = c.Prepare("INSERT INTO t (c) VALUES ($c);")
	if err != nil {
		t.Fatal(err)
	}
	defer stmt.Finalize()
	for _, val := range cVals {
		stmt.SetInt64("$c", int64(val))
		if _, err = stmt.Step(); err != nil {
			t.Errorf("INSERT %q: %v", val, err)
		}
		if err = stmt.Reset(); err != nil {
			t.Errorf("INSERT reset %q: %v", val, err)
		}
	}

	finalCalled := false
	err = c.CreateFunction("sumints", &FunctionImpl{
		NArgs:         1,
		Deterministic: true,
		AllowIndirect: true,
		MakeAggregate: func(ctx Context) (AggregateFunction, error) {
			return &sumintsFunction{finalCalled: &finalCalled}, nil
		},
	})
	if err != nil {
		t.Fatal(err)
	}

	stmt, _, err = c.PrepareTransient("SELECT sumints(c) FROM t;")
	if err != nil {
		t.Fatal(err)
	}
	defer stmt.Finalize()
	if _, err := stmt.Step(); err != nil {
		t.Fatal(err)
	}
	if got := stmt.ColumnInt(0); got != want {
		t.Errorf("sum(c)=%d, want %d", got, want)
	}
	if !finalCalled {
		t.Error("xFinal not called")
	}
}

// Equivalent of https://www.sqlite.org/windowfunctions.html#user_defined_aggregate_window_functions
func TestWindowFunc(t *testing.T) {
	c, err := OpenConn(":memory:", 0)
	if err != nil {
		t.Fatal(err)
	}
	defer func() {
		if err := c.Close(); err != nil {
			t.Error(err)
		}
	}()

	stmt, _, err := c.PrepareTransient("CREATE TABLE t3 (x, y);")
	if err != nil {
		t.Fatal(err)
	}
	if _, err := stmt.Step(); err != nil {
		t.Fatal(err)
	}
	if err := stmt.Finalize(); err != nil {
		t.Error(err)
	}

	stmt, err = c.Prepare("INSERT INTO t3 VALUES ('a', 4), " +
		"('b', 5), " +
		"('c', 3), " +
		"('d', 8), " +
		"('e', 1);")
	if err != nil {
		t.Fatal(err)
	}
	defer stmt.Finalize()
	if _, err := stmt.Step(); err != nil {
		t.Errorf("INSERT: %v", err)
	}

	finalCalled := false
	err = c.CreateFunction("sumint", &FunctionImpl{
		NArgs:         1,
		Deterministic: true,
		AllowIndirect: true,
		MakeAggregate: func(ctx Context) (AggregateFunction, error) {
			return &sumintsFunction{finalCalled: &finalCalled}, nil
		},
	})
	if err != nil {
		t.Fatal(err)
	}

	stmt, _, err = c.PrepareTransient("SELECT x, sumint(y) OVER (" +
		"ORDER BY x ROWS BETWEEN 1 PRECEDING AND 1 FOLLOWING" +
		") AS sum_y " +
		"FROM t3 ORDER BY x;")
	if err != nil {
		t.Fatal(err)
	}
	defer stmt.Finalize()
	type row struct {
		x    string
		sumY int64
	}
	var got []row
	for {
		hasData, err := stmt.Step()
		if err != nil {
			t.Error("SELECT:", err)
			break
		}
		if !hasData {
			break
		}
		got = append(got, row{
			stmt.ColumnText(0),
			stmt.ColumnInt64(1),
		})
	}
	want := []row{
		{"a", 9},
		{"b", 12},
		{"c", 16},
		{"d", 12},
		{"e", 9},
	}
	if diff := cmp.Diff(want, got, cmp.AllowUnexported(row{})); diff != "" {
		t.Errorf("-want +got:\n%s", diff)
	}
	if !finalCalled {
		t.Error("xFinal not called")
	}
}

type sumintsFunction struct {
	sum         int64
	finalCalled *bool
}

func (f *sumintsFunction) Step(ctx Context, args []Value) error {
	if args[0].Type() != TypeInteger {
		return fmt.Errorf("invalid argument")
	}
	f.sum += args[0].Int64()
	return nil
}

func (f *sumintsFunction) WindowInverse(ctx Context, args []Value) error {
	f.sum -= args[0].Int64()
	return nil
}

func (f *sumintsFunction) WindowValue(ctx Context) (Value, error) {
	return IntegerValue(f.sum), nil
}

func (f *sumintsFunction) Finalize(ctx Context) {
	*f.finalCalled = true
}

func TestCastTextToInteger(t *testing.T) {
	tests := []struct {
		text string
		want int64
	}{
		{
			text: "abc",
			want: 0,
		},
		{
			text: "123",
			want: 123,
		},
		{
			text: " 123 ",
			want: 123,
		},
		{
			text: "+123",
			want: 123,
		},
		{
			text: "-123",
			want: -123,
		},
		{
			text: "123e+5",
			want: 123,
		},
		{
			text: "0x123",
			want: 0,
		},
		{
			text: "9223372036854775808",
			want: 9223372036854775807,
		},
		{
			text: "-9223372036854775809",
			want: -9223372036854775808,
		},
	}
	for _, test := range tests {
		if got := castTextToInteger(test.text); got != test.want {
			t.Errorf("castTextToInteger(%q) = %d; want %d", test.text, got, test.want)
		}
	}
}

func TestCastTextToReal(t *testing.T) {
	tests := []struct {
		text string
		want float64
	}{
		{
			text: "abc",
			want: 0,
		},
		{
			text: "123",
			want: 123,
		},
		{
			text: "123.45",
			want: 123.45,
		},
		{
			text: " 123.45 ",
			want: 123.45,
		},
		{
			text: "+123",
			want: 123,
		},
		{
			text: "-123",
			want: -123,
		},
		{
			text: "123e+5",
			want: 123e+5,
		},
		{
			text: "123.45xxx",
			want: 123.45,
		},
		{
			text: "0x123",
			want: 0,
		},
		{
			text: "9223372036854775808",
			want: 9223372036854775808,
		},
		{
			text: "-9223372036854775809",
			want: -9223372036854775809,
		},
	}
	for _, test := range tests {
		if got := castTextToReal(test.text); got != test.want {
			t.Errorf("castTextToReal(%q) = %g; want %g", test.text, got, test.want)
		}
	}
}

func TestSetCollation(t *testing.T) {
	c, err := OpenConn(":memory:", 0)
	if err != nil {
		t.Fatal(err)
	}
	defer func() {
		if err := c.Close(); err != nil {
			t.Error(err)
		}
	}()

	err = c.SetCollation("foo", func(a, b string) int {
		return -strings.Compare(a, b)
	})
	if err != nil {
		t.Error(err)
	}
	stmt := c.Prep(`select ?1 < ?2 collate foo, ?1 = ?2 collate foo, ?1 > ?2 collate foo;`)
	defer func() {
		if err := stmt.Finalize(); err != nil {
			t.Error(err)
		}
	}()

	tests := []struct {
		name string
		a    string
		b    string
		lt   bool
		eq   bool
		gt   bool
	}{
		{"Greater", "abc", "def", false, false, true},
		{"Less", "def", "abc", true, false, false},
		{"Equal", "abc", "abc", false, true, false},
	}
	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			if err := stmt.Reset(); err != nil {
				t.Error(err)
			}
			stmt.BindText(1, test.a)
			stmt.BindText(2, test.b)
			if _, err := stmt.Step(); err != nil {
				t.Fatal(err)
			}
			lt := stmt.ColumnBool(0)
			eq := stmt.ColumnBool(1)
			gt := stmt.ColumnBool(2)
			if lt != test.lt {
				t.Errorf("%q < %q == %t; want %t", test.a, test.b, lt, test.lt)
			}
			if eq != test.eq {
				t.Errorf("(%q == %q) == %t; want %t", test.a, test.b, eq, test.eq)
			}
			if gt != test.gt {
				t.Errorf("%q > %q == %t; want %t", test.a, test.b, gt, test.gt)
			}
		})
	}
}

func TestIDGen(t *testing.T) {
	const newID = -1
	repeat := func(n int, seq ...int) []int {
		slice := make([]int, 0, len(seq)*n)
		for i := 0; i < n; i++ {
			slice = append(slice, seq...)
		}
		return slice
	}
	tests := []struct {
		name    string
		actions []int // non-negative means reclaim the ID at the given action index
	}{
		{
			name:    "Single",
			actions: []int{newID},
		},
		{
			name:    "LongSequence",
			actions: repeat(129, newID),
		},
		{
			name: "Reclaim",
			actions: []int{
				0: newID,
				1: 0,
				2: newID,
			},
		},
		{
			name: "ReclaimAfterAnother",
			actions: []int{
				0: newID,
				1: newID,
				2: 0,
				3: newID,
				4: newID,
			},
		},
		{
			name:    "LongSequenceWithMiddleReclaim",
			actions: append(repeat(129, newID), 42, newID),
		},
	}
	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			gen := new(idGen)
			got := make([]uintptr, len(test.actions))
			used := make(map[uintptr]struct{})
			for i, reclaimIdx := range test.actions {
				if reclaimIdx < 0 {
					got[i] = gen.next()
					t.Logf("gen.next() = %d", got[i])
					if _, alreadyUsed := used[got[i]]; got[i] == 0 || alreadyUsed {
						t.Fail()
					}
					used[got[i]] = struct{}{}
				} else {
					id := got[reclaimIdx]
					t.Logf("gen.reclaim(%d)", id)
					gen.reclaim(id)
					delete(used, id)
				}
			}
		})
	}
}

// TestCFuncPointer verifies that the cFuncPointer function
// is identical to taking the function address in the libc style.
func TestCFuncPointer(t *testing.T) {
	got := cFuncPointer(libc.Xfree)
	want := *(*uintptr)(unsafe.Pointer(&struct{ f func(*libc.TLS, uintptr) }{libc.Xfree}))
	if got != want {
		t.Errorf("cFuncPointer(libc.Xfree) = %#x; want %#x", got, want)
	}
}