File: metadata_test.go

package info (click to toggle)
usql 0.19.19-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,652 kB
  • sloc: sql: 1,115; sh: 643; ansic: 191; makefile: 60
file content (292 lines) | stat: -rw-r--r-- 8,960 bytes parent folder | download
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
//go:build fulltest

package postgres_test

import (
	"database/sql"
	"flag"
	"fmt"
	"log"
	"os"
	"strings"
	"testing"

	dt "github.com/ory/dockertest/v3"
	dc "github.com/ory/dockertest/v3/docker"
	"github.com/xo/usql/drivers/metadata"
	"github.com/xo/usql/drivers/metadata/postgres"
	_ "github.com/xo/usql/drivers/postgres"
)

type Database struct {
	BuildArgs  []dc.BuildArg
	RunOptions *dt.RunOptions
	Exec       []string
	Driver     string
	URL        string
	DockerPort string
	Resource   *dt.Resource
	DB         *sql.DB
	Opts       []metadata.ReaderOption
	Reader     metadata.BasicReader
}

var dbName string = "postgres"

var db = Database{
	BuildArgs: []dc.BuildArg{
		{Name: "BASE_IMAGE", Value: "postgres:13"},
		{Name: "SCHEMA_URL", Value: "https://raw.githubusercontent.com/jOOQ/sakila/main/postgres-sakila-db/postgres-sakila-schema.sql"},
		{Name: "TARGET", Value: "/docker-entrypoint-initdb.d"},
		{Name: "USER", Value: "root"},
	},
	RunOptions: &dt.RunOptions{
		Name: "usql-pgsql",
		Cmd:  []string{"-c", "log_statement=all", "-c", "log_min_duration_statement=0"},
		Env:  []string{"POSTGRES_PASSWORD=pw"},
	},
	Driver:     "postgres",
	URL:        "postgres://postgres:pw@localhost:%s/postgres?sslmode=disable",
	DockerPort: "5432/tcp",
}

func TestMain(m *testing.M) {
	cleanup := true
	flag.BoolVar(&cleanup, "cleanup", true, "delete containers when finished")
	flag.Parse()
	pool, err := dt.NewPool("")
	if err != nil {
		log.Fatalf("Could not connect to docker: %s", err)
	}
	var ok bool
	db.Resource, ok = pool.ContainerByName(db.RunOptions.Name)
	if !ok {
		buildOpts := &dt.BuildOptions{
			ContextDir: "../../testdata/docker",
			BuildArgs:  db.BuildArgs,
		}
		db.Resource, err = pool.BuildAndRunWithBuildOptions(buildOpts, db.RunOptions)
		if err != nil {
			log.Fatal("Could not start resource: ", err)
		}
	}

	// exponential backoff-retry, because the application in the container might not be ready to accept connections yet
	if err := pool.Retry(func() error {
		hostPort := db.Resource.GetPort(db.DockerPort)
		var err error
		db.DB, err = sql.Open(db.Driver, fmt.Sprintf(db.URL, hostPort))
		if err != nil {
			return err
		}
		return db.DB.Ping()
	}); err != nil {
		log.Fatal("Timed out waiting for db: ", err)
	}
	db.Reader = postgres.NewReader()(db.DB).(metadata.BasicReader)

	if len(db.Exec) != 0 {
		exitCode, err := db.Resource.Exec(db.Exec, dt.ExecOptions{
			StdIn:  os.Stdin,
			StdOut: os.Stdout,
			StdErr: os.Stderr,
			TTY:    true,
		})
		if err != nil || exitCode != 0 {
			log.Fatal("Could not load schema: ", err)
		}
	}
	code := m.Run()
	// You can't defer this because os.Exit doesn't care for defer
	if cleanup {
		if err := pool.Purge(db.Resource); err != nil {
			log.Fatal("Could not purge resource: ", err)
		}
	}
	os.Exit(code)
}

func TestTriggers(t *testing.T) {
	schema := "public"
	expected := "film_fulltext_trigger, last_updated"
	parent := "film"
	r := postgres.NewReader()(db.DB).(metadata.TriggerReader)

	result, err := r.Triggers(metadata.Filter{Schema: schema, Parent: parent})
	if err != nil {
		log.Fatalf("Could not read %s triggers: %v", dbName, err)
	}

	names := []string{}
	for result.Next() {
		names = append(names, result.Get().Name)
	}
	actual := strings.Join(names, ", ")
	if actual != expected {
		t.Errorf("Wrong %s trigger names, expected:\n  %v\ngot:\n  %v", dbName, expected, names)
	}
}

func TestColumns(t *testing.T) {
	// Only testing postgres specific datatype formatting.
	// The rest of the functionality is covered by informationschema/metadata_test.go:TestColumns
	type test struct {
		typeDef string
		want    string
	}
	schema := "public"
	table := "test_dtypes"
	tests := []test{
		{typeDef: "bit", want: "bit(1)"},
		{typeDef: "bit(1)", want: "bit(1)"},
		{typeDef: "bit varying", want: "bit varying"},
		{typeDef: "bit varying(2)", want: "bit varying(2)"},
		{typeDef: "character", want: "character(1)"},
		{typeDef: "character(3)", want: "character(3)"},
		{typeDef: "character varying", want: "character varying"},
		{typeDef: "character varying(4)", want: "character varying(4)"},
		{typeDef: "numeric", want: "numeric"},
		{typeDef: "numeric(1,0)", want: "numeric(1,0)"},
		{typeDef: "time", want: "time(6) without time zone"},
		{typeDef: "time(4)", want: "time(4) without time zone"},
		{typeDef: "time(6)", want: "time(6) without time zone"},
		{typeDef: "time with time zone", want: "time(6) with time zone"},
		{typeDef: "time(3) with time zone", want: "time(3) with time zone"},
		{typeDef: "timestamp", want: "timestamp(6) without time zone"},
		{typeDef: "timestamp(2)", want: "timestamp(2) without time zone"},
		{typeDef: "timestamp with time zone", want: "timestamp(6) with time zone"},
		{typeDef: "timestamp(1) with time zone", want: "timestamp(1) with time zone"},
		{typeDef: "bigint", want: "bigint"},
		{typeDef: "bigserial", want: "bigint"},
		{typeDef: "boolean", want: "boolean"},
		{typeDef: "box", want: "box"},
		{typeDef: "bytea", want: "bytea"},
		{typeDef: "cidr", want: "cidr"},
		{typeDef: "circle", want: "circle"},
		{typeDef: "date", want: "date"},
		{typeDef: "double precision", want: "double precision"},
		{typeDef: "inet", want: "inet"},
		{typeDef: "integer", want: "integer"},
		{typeDef: "json", want: "json"},
		{typeDef: "jsonb", want: "jsonb"},
		{typeDef: "line", want: "line"},
		{typeDef: "lseg", want: "lseg"},
		{typeDef: "macaddr", want: "macaddr"},
		{typeDef: "macaddr8", want: "macaddr8"},
		{typeDef: "money", want: "money"},
		{typeDef: "path", want: "path"},
		{typeDef: "pg_lsn", want: "pg_lsn"},
		{typeDef: "pg_snapshot", want: "pg_snapshot"},
		{typeDef: "point", want: "point"},
		{typeDef: "polygon", want: "polygon"},
		{typeDef: "real", want: "real"},
		{typeDef: "smallint", want: "smallint"},
		{typeDef: "smallserial", want: "smallint"},
		{typeDef: "serial", want: "integer"},
		{typeDef: "text", want: "text"},
		{typeDef: "tsvector", want: "tsvector"},
		{typeDef: "txid_snapshot", want: "txid_snapshot"},
		{typeDef: "uuid", want: "uuid"},
		{typeDef: "xml", want: "xml"},
	}

	// Create table
	colExpressions := []string{}
	for i, test := range tests {
		colExpressions = append(colExpressions, fmt.Sprintf("column_%d %s", i, test.typeDef))
	}
	query := fmt.Sprintf("CREATE TABLE %s.%s (%s)", schema, table, strings.Join(colExpressions, ", "))
	db.DB.Exec(query)
	defer db.DB.Exec(fmt.Sprintf("DROP TABLE %s.%s", schema, table))

	// Read data types
	r := postgres.NewReader()(db.DB).(metadata.ColumnReader)
	result, err := r.Columns(metadata.Filter{Schema: schema, Parent: table})
	if err != nil {
		log.Fatalf("Could not read %s columns: %v", dbName, err)
	}
	actualTypes := []string{}
	for result.Next() {
		actualTypes = append(actualTypes, result.Get().DataType)
	}

	// Compare
	for i, test := range tests {
		if actualTypes[i] != test.want {
			t.Errorf("Wrong %s column data type, expected:\n  %s, got:\n  %s", dbName, test.want, actualTypes[i])
		}
	}
}

func TestIndexes(t *testing.T) {
	schema := "public"
	table := "tmp_table"

	tests := []struct {
		indexType string
		want      string
	}{
		{
			indexType: "btree",
			want:      "btree",
		},
		{
			indexType: "hash",
			want:      "hash",
		},
	}

	columns := []string{}
	for _, v := range tests {
		columns = append(columns, fmt.Sprintf("column_%s integer", v.indexType))
	}
	indexes := []string{}
	for _, v := range tests {
		indexes = append(indexes, fmt.Sprintf("CREATE INDEX %s_index ON %s.%s USING %[1]s (column_%[1]s)", v.indexType, schema, table))
	}
	query := `
		CREATE TABLE %s.%s (%s);
		-- Indexes creation sql
		%s
	`
	db.DB.Exec(fmt.Sprintf(query, schema, table, strings.Join(columns, ", "), strings.Join(indexes, ";")))
	defer db.DB.Exec(fmt.Sprintf("DROP TABLE %s.%s", schema, table))

	r := postgres.NewReader()(db.DB).(metadata.IndexReader)

	t.Run("Get info about access method for specyfic index.", func(t *testing.T) {
		accessMethods := []string{}
		for _, v := range tests {
			result, err := r.Indexes(metadata.Filter{Name: fmt.Sprintf("%s_index", v.indexType)})
			if err != nil {
				log.Fatalf("Could not get Index informatin: %s", err)
			}
			for result.Next() {
				accessMethods = append(accessMethods, result.Get().Type)
			}
		}

		for i, test := range tests {
			if accessMethods[i] != test.want {
				t.Errorf("Wrong %s index access method, expected:\n  %s, got:\n  %s", dbName, test.want, accessMethods[i])
			}
		}
	})

	t.Run("Get info about index access method for all table indexes.", func(t *testing.T) {
		result, err := r.Indexes(metadata.Filter{Schema: schema, Parent: table})
		if err != nil {
			log.Fatalf("Could not get Index informatin: %s", err)
		}
		accessMethods := []string{}
		for result.Next() {
			accessMethods = append(accessMethods, result.Get().Type)
		}

		for i, test := range tests {
			if accessMethods[i] != test.want {
				t.Errorf("Wrong %s index access method, expected:\n  %s, got:\n  %s", dbName, test.want, accessMethods[i])
			}
		}
	})
}