summaryrefslogtreecommitdiffstats
path: root/sqlr_test.go
blob: f2ebfbff38a76ba0c43ad0d5efc2df4f7f8b3941 (plain) (blame)
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
package sqlr_test

import (
	"context"
	"database/sql"
	"fmt"
	"reflect"
	"testing"

	"github.com/google/go-cmp/cmp"
	_ "github.com/mattn/go-sqlite3"
	"gitlab.com/rhogenson/sqlr"
)

func TestScan(t *testing.T) {
	ctx := context.Background()

	for _, tc := range []struct {
		desc  string
		db    string
		query string
		want  any
	}{{
		desc: "match field names",
		db: `
			CREATE TABLE Tbl (ColA, ColB);
			INSERT INTO Tbl VALUES (100, "test")`,
		query: "SELECT ColA, ColB FROM Tbl",
		want: &struct {
			ColA int
			ColB string
		}{100, "test"},
	}, {
		desc: "select star",
		db: `
			CREATE TABLE Tbl (ColA, ColB);
			INSERT INTO Tbl VALUES (100, "test")`,
		query: "SELECT * FROM Tbl",
		want: &struct {
			ColA int
			ColB string
		}{100, "test"},
	}, {
		desc: "ignored field",
		db: `
			CREATE TABLE Tbl (Col);
			INSERT INTO Tbl VALUES (100)`,
		query: "SELECT Col FROM Tbl",
		want:  &struct{ Col, OtherField int }{Col: 100},
	}, {
		desc: "tag",
		db: `
			CREATE TABLE Tbl (col_a, col_b);
			INSERT INTO Tbl VALUES (100, "test")`,
		query: "SELECT col_a, col_b FROM Tbl",
		want: &struct {
			ColA int    `sql:"col_a"`
			ColB string `sql:"col_b"`
		}{100, "test"},
	}, {
		desc: "embedded struct",
		db: `
			CREATE TABLE Tbl (Col);
			INSERT INTO Tbl VALUES (100)`,
		query: "SELECT Col FROM Tbl",
		want: func() any {
			type Inner struct{ Col int }
			type outer struct{ Inner }
			return &outer{Inner{100}}
		}(),
	}} {
		t.Run(tc.desc, func(t *testing.T) {
			db, err := sql.Open("sqlite3", ":memory:")
			if err != nil {
				t.Fatalf("Failed to create in-memory database: %s", err)
			}
			defer db.Close()
			if _, err := db.ExecContext(ctx, tc.db); err != nil {
				t.Fatalf("Failed to initialize test database: %s", err)
			}

			rows, err := db.QueryContext(ctx, tc.query)
			if err != nil {
				t.Fatalf("Failed to query test database: %s", err)
			}
			if !rows.Next() {
				t.Fatalf("No data")
			}

			got := reflect.New(reflect.TypeOf(tc.want).Elem()).Interface()
			if err := sqlr.Scan(rows, got); err != nil {
				t.Fatalf("Scan failed: %s", err)
			}
			if err := rows.Close(); err != nil {
				t.Fatalf("Close rows: %s", err)
			}
			if err := rows.Err(); err != nil {
				t.Fatalf("Database read error: %s", err)
			}

			if diff := cmp.Diff(tc.want, got); diff != "" {
				t.Errorf("Scan returned unexpected diff (-want +got):\n%s", diff)
			}
		})
	}
}

func TestScan_Errors(t *testing.T) {
	ctx := context.Background()

	for _, tc := range []struct {
		desc  string
		db    string
		query string
		out   any
	}{{
		desc: "wrong type",
		db: `
			CREATE TABLE Tbl (Col);
			INSERT INTO Tbl VALUES (100)`,
		query: "SELECT Col FROM Tbl",
		out:   5,
	}, {
		desc: "nil pointer",
		db: `
			CREATE TABLE Tbl (Col);
			INSERT INTO Tbl VALUES (100)`,
		query: "SELECT Col FROM Tbl",
		out:   nil,
	}, {
		desc: "no field",
		db: `
			CREATE TABLE Tbl (ColA, ColB);
			INSERT INTO Tbl VALUES (100, "test")`,
		query: "SELECT ColA, ColB FROM Tbl",
		out:   new(struct{ ColA int }),
	}, {
		desc: "ignored field",
		db: `
			CREATE TABLE Tbl (Col);
			INSERT INTO Tbl VALUES (100)`,
		query: "SELECT Col FROM Tbl",
		out: new(struct {
			Col int `sql:"-"`
		}),
	}, {
		desc: "unexported field",
		db: `
			CREATE TABLE Tbl (col);
			INSERT INTO Tbl VALUES (100)`,
		query: "SELECT col FROM Tbl",
		out:   new(struct{ col int }),
	}} {
		t.Run(tc.desc, func(t *testing.T) {
			db, err := sql.Open("sqlite3", ":memory:")
			if err != nil {
				t.Fatalf("Failed to create in-memory database: %s", err)
			}
			defer db.Close()
			if _, err := db.ExecContext(ctx, tc.db); err != nil {
				t.Fatalf("Failed to initialize test database: %s", err)
			}

			rows, err := db.QueryContext(ctx, tc.query)
			if err != nil {
				t.Fatalf("Failed to query test database: %s", err)
			}
			defer rows.Close()
			if !rows.Next() {
				t.Fatalf("No data")
			}

			err = sqlr.Scan(rows, tc.out)
			if err == nil {
				t.Errorf("Scan returned nil, want error")
			}
		})
	}
}

func TestQuery(t *testing.T) {
	ctx := context.Background()
	db, err := sql.Open("sqlite3", ":memory:")
	if err != nil {
		t.Fatalf("Failed to create in-memory database: %s", err)
	}
	defer db.Close()
	if _, err := db.ExecContext(ctx, `
		CREATE TABLE Tbl (Name, HighScore);
		INSERT INTO Tbl VALUES ("rose", 100)
	`); err != nil {
		t.Fatalf("Failed to initialize test database: %s", err)
	}

	type row struct {
		Name      string
		HighScore int
	}
	const query = "SELECT Name, HighScore FROM Tbl"
	var got []row
	for row, err := range sqlr.Query[row](ctx, db, query) {
		if err != nil {
			t.Fatalf("Query(%q) failed: %s", query, err)
		}
		got = append(got, row)
	}
	want := []row{{
		Name:      "rose",
		HighScore: 100,
	}}
	if diff := cmp.Diff(want, got); diff != "" {
		t.Errorf("Query(%q) returned unexpected diff (-want +got):\n%s", query, diff)
	}
}

func ExampleQuery() {
	ctx := context.Background()
	db, err := sql.Open("sqlite3", ":memory:")
	if err != nil {
		panic(err)
	}
	defer db.Close()
	if _, err := db.ExecContext(ctx, `
		CREATE TABLE Tbl (Name, HighScore);
		INSERT INTO Tbl VALUES ("rose", 100)
	`); err != nil {
		panic(err)
	}

	type row struct {
		Name      string
		HighScore int
	}
	for row, err := range sqlr.Query[row](ctx, db, "SELECT Name, HighScore FROM Tbl") {
		if err != nil {
			panic(err)
		}
		fmt.Printf("%s %d\n", row.Name, row.HighScore)
	}
	// Output: rose 100
}