Refactor drivers into separate packages (#179)

`dbmate` package was starting to get a bit polluted. This PR migrates each driver into a separate package, with clean separation between each.

In addition:

* Drivers are now initialized with a URL, avoiding the need to pass `*url.URL` to every method
* Sqlite supports a cleaner syntax for relative paths
* Driver tests now load their test URL from environment variables

Public API of `dbmate` package has not changed (no changes to `main` package).
This commit is contained in:
Adrian Macneil 2020-11-19 15:04:42 +13:00 committed by GitHub
parent c907c3f5c6
commit 61771e386d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 1195 additions and 1078 deletions

View file

@ -0,0 +1,382 @@
package postgres
import (
"bytes"
"database/sql"
"fmt"
"net/url"
"strings"
"github.com/amacneil/dbmate/pkg/dbmate"
"github.com/amacneil/dbmate/pkg/dbutil"
"github.com/lib/pq"
)
func init() {
dbmate.RegisterDriver(NewDriver, "postgres")
dbmate.RegisterDriver(NewDriver, "postgresql")
}
// Driver provides top level database functions
type Driver struct {
migrationsTableName string
databaseURL *url.URL
}
// NewDriver initializes the driver
func NewDriver(config dbmate.DriverConfig) dbmate.Driver {
return &Driver{
migrationsTableName: config.MigrationsTableName,
databaseURL: config.DatabaseURL,
}
}
func connectionString(u *url.URL) string {
hostname := u.Hostname()
port := u.Port()
query := u.Query()
// support socket parameter for consistency with mysql
if query.Get("socket") != "" {
query.Set("host", query.Get("socket"))
query.Del("socket")
}
// default hostname
if hostname == "" {
hostname = "localhost"
}
// host param overrides url hostname
if query.Get("host") != "" {
hostname = ""
}
// always specify a port
if query.Get("port") != "" {
port = query.Get("port")
query.Del("port")
}
if port == "" {
port = "5432"
}
// generate output URL
out, _ := url.Parse(u.String())
out.Host = fmt.Sprintf("%s:%s", hostname, port)
out.RawQuery = query.Encode()
return out.String()
}
func connectionArgsForDump(u *url.URL) []string {
u = dbutil.MustParseURL(connectionString(u))
// find schemas from search_path
query := u.Query()
schemas := strings.Split(query.Get("search_path"), ",")
query.Del("search_path")
u.RawQuery = query.Encode()
out := []string{}
for _, schema := range schemas {
schema = strings.TrimSpace(schema)
if schema != "" {
out = append(out, "--schema", schema)
}
}
out = append(out, u.String())
return out
}
// Open creates a new database connection
func (drv *Driver) Open() (*sql.DB, error) {
return sql.Open("postgres", connectionString(drv.databaseURL))
}
func (drv *Driver) openPostgresDB() (*sql.DB, error) {
// clone databaseURL
postgresURL, err := url.Parse(connectionString(drv.databaseURL))
if err != nil {
return nil, err
}
// connect to postgres database
postgresURL.Path = "postgres"
return sql.Open("postgres", postgresURL.String())
}
// CreateDatabase creates the specified database
func (drv *Driver) CreateDatabase() error {
name := dbutil.DatabaseName(drv.databaseURL)
fmt.Printf("Creating: %s\n", name)
db, err := drv.openPostgresDB()
if err != nil {
return err
}
defer dbutil.MustClose(db)
_, err = db.Exec(fmt.Sprintf("create database %s",
pq.QuoteIdentifier(name)))
return err
}
// DropDatabase drops the specified database (if it exists)
func (drv *Driver) DropDatabase() error {
name := dbutil.DatabaseName(drv.databaseURL)
fmt.Printf("Dropping: %s\n", name)
db, err := drv.openPostgresDB()
if err != nil {
return err
}
defer dbutil.MustClose(db)
_, err = db.Exec(fmt.Sprintf("drop database if exists %s",
pq.QuoteIdentifier(name)))
return err
}
func (drv *Driver) schemaMigrationsDump(db *sql.DB) ([]byte, error) {
migrationsTable, err := drv.quotedMigrationsTableName(db)
if err != nil {
return nil, err
}
// load applied migrations
migrations, err := dbutil.QueryColumn(db,
"select quote_literal(version) from "+migrationsTable+" order by version asc")
if err != nil {
return nil, err
}
// build migrations table data
var buf bytes.Buffer
buf.WriteString("\n--\n-- Dbmate schema migrations\n--\n\n")
if len(migrations) > 0 {
buf.WriteString("INSERT INTO " + migrationsTable + " (version) VALUES\n (" +
strings.Join(migrations, "),\n (") +
");\n")
}
return buf.Bytes(), nil
}
// DumpSchema returns the current database schema
func (drv *Driver) DumpSchema(db *sql.DB) ([]byte, error) {
// load schema
args := append([]string{"--format=plain", "--encoding=UTF8", "--schema-only",
"--no-privileges", "--no-owner"}, connectionArgsForDump(drv.databaseURL)...)
schema, err := dbutil.RunCommand("pg_dump", args...)
if err != nil {
return nil, err
}
migrations, err := drv.schemaMigrationsDump(db)
if err != nil {
return nil, err
}
schema = append(schema, migrations...)
return dbutil.TrimLeadingSQLComments(schema)
}
// DatabaseExists determines whether the database exists
func (drv *Driver) DatabaseExists() (bool, error) {
name := dbutil.DatabaseName(drv.databaseURL)
db, err := drv.openPostgresDB()
if err != nil {
return false, err
}
defer dbutil.MustClose(db)
exists := false
err = db.QueryRow("select true from pg_database where datname = $1", name).
Scan(&exists)
if err == sql.ErrNoRows {
return false, nil
}
return exists, err
}
// CreateMigrationsTable creates the schema_migrations table
func (drv *Driver) CreateMigrationsTable(db *sql.DB) error {
schema, migrationsTable, err := drv.quotedMigrationsTableNameParts(db)
if err != nil {
return err
}
// first attempt at creating migrations table
createTableStmt := fmt.Sprintf("create table if not exists %s.%s", schema, migrationsTable) +
" (version varchar(255) primary key)"
_, err = db.Exec(createTableStmt)
if err == nil {
// table exists or created successfully
return nil
}
// catch 'schema does not exist' error
pqErr, ok := err.(*pq.Error)
if !ok || pqErr.Code != "3F000" {
// unknown error
return err
}
// in theory we could attempt to create the schema every time, but we avoid that
// in case the user doesn't have permissions to create schemas
fmt.Printf("Creating schema: %s\n", schema)
_, err = db.Exec(fmt.Sprintf("create schema if not exists %s", schema))
if err != nil {
return err
}
// second and final attempt at creating migrations table
_, err = db.Exec(createTableStmt)
return err
}
// SelectMigrations returns a list of applied migrations
// with an optional limit (in descending order)
func (drv *Driver) SelectMigrations(db *sql.DB, limit int) (map[string]bool, error) {
migrationsTable, err := drv.quotedMigrationsTableName(db)
if err != nil {
return nil, err
}
query := "select version from " + migrationsTable + " order by version desc"
if limit >= 0 {
query = fmt.Sprintf("%s limit %d", query, limit)
}
rows, err := db.Query(query)
if err != nil {
return nil, err
}
defer dbutil.MustClose(rows)
migrations := map[string]bool{}
for rows.Next() {
var version string
if err := rows.Scan(&version); err != nil {
return nil, err
}
migrations[version] = true
}
if err = rows.Err(); err != nil {
return nil, err
}
return migrations, nil
}
// InsertMigration adds a new migration record
func (drv *Driver) InsertMigration(db dbutil.Transaction, version string) error {
migrationsTable, err := drv.quotedMigrationsTableName(db)
if err != nil {
return err
}
_, err = db.Exec("insert into "+migrationsTable+" (version) values ($1)", version)
return err
}
// DeleteMigration removes a migration record
func (drv *Driver) DeleteMigration(db dbutil.Transaction, version string) error {
migrationsTable, err := drv.quotedMigrationsTableName(db)
if err != nil {
return err
}
_, err = db.Exec("delete from "+migrationsTable+" where version = $1", version)
return err
}
// Ping verifies a connection to the database server. It does not verify whether the
// specified database exists.
func (drv *Driver) Ping() error {
// attempt connection to primary database, not "postgres" database
// to support servers with no "postgres" database
// (see https://github.com/amacneil/dbmate/issues/78)
db, err := drv.Open()
if err != nil {
return err
}
defer dbutil.MustClose(db)
err = db.Ping()
if err == nil {
return nil
}
// ignore 'database does not exist' error
pqErr, ok := err.(*pq.Error)
if ok && pqErr.Code == "3D000" {
return nil
}
return err
}
func (drv *Driver) quotedMigrationsTableName(db dbutil.Transaction) (string, error) {
schema, name, err := drv.quotedMigrationsTableNameParts(db)
if err != nil {
return "", err
}
return schema + "." + name, nil
}
func (drv *Driver) quotedMigrationsTableNameParts(db dbutil.Transaction) (string, string, error) {
schema := ""
tableNameParts := strings.Split(drv.migrationsTableName, ".")
if len(tableNameParts) > 1 {
// schema specified as part of table name
schema, tableNameParts = tableNameParts[0], tableNameParts[1:]
}
if schema == "" {
// no schema specified with table name, try URL search path if available
searchPath := strings.Split(drv.databaseURL.Query().Get("search_path"), ",")
schema = strings.TrimSpace(searchPath[0])
}
var err error
if schema == "" {
// if no URL available, use current schema
// this is a hack because we don't always have the URL context available
schema, err = dbutil.QueryValue(db, "select current_schema()")
if err != nil {
return "", "", err
}
}
// fall back to public schema as last resort
if schema == "" {
schema = "public"
}
// quote all parts
// use server rather than client to do this to avoid unnecessary quotes
// (which would change schema.sql diff)
tableNameParts = append([]string{schema}, tableNameParts...)
quotedNameParts, err := dbutil.QueryColumn(db, "select quote_ident(unnest($1::text[]))", pq.Array(tableNameParts))
if err != nil {
return "", "", err
}
// if more than one part, we already have a schema
return quotedNameParts[0], strings.Join(quotedNameParts[1:], "."), nil
}

View file

@ -0,0 +1,569 @@
package postgres
import (
"database/sql"
"net/url"
"os"
"testing"
"github.com/amacneil/dbmate/pkg/dbmate"
"github.com/amacneil/dbmate/pkg/dbutil"
"github.com/stretchr/testify/require"
)
func testPostgresDriver(t *testing.T) *Driver {
u := dbutil.MustParseURL(os.Getenv("POSTGRES_TEST_URL"))
drv, err := dbmate.New(u).GetDriver()
require.NoError(t, err)
return drv.(*Driver)
}
func prepTestPostgresDB(t *testing.T) *sql.DB {
drv := testPostgresDriver(t)
// drop any existing database
err := drv.DropDatabase()
require.NoError(t, err)
// create database
err = drv.CreateDatabase()
require.NoError(t, err)
// connect database
db, err := sql.Open("postgres", drv.databaseURL.String())
require.NoError(t, err)
return db
}
func TestGetDriver(t *testing.T) {
db := dbmate.New(dbutil.MustParseURL("postgres://"))
drvInterface, err := db.GetDriver()
require.NoError(t, err)
// driver should have URL and default migrations table set
drv, ok := drvInterface.(*Driver)
require.True(t, ok)
require.Equal(t, db.DatabaseURL.String(), drv.databaseURL.String())
require.Equal(t, "schema_migrations", drv.migrationsTableName)
}
func TestConnectionString(t *testing.T) {
cases := []struct {
input string
expected string
}{
// defaults
{"postgres:///foo", "postgres://localhost:5432/foo"},
// support custom url params
{"postgres://bob:secret@myhost:1234/foo?bar=baz", "postgres://bob:secret@myhost:1234/foo?bar=baz"},
// support `host` and `port` via url params
{"postgres://bob:secret@myhost:1234/foo?host=new&port=9999", "postgres://bob:secret@:9999/foo?host=new"},
{"postgres://bob:secret@myhost:1234/foo?port=9999&bar=baz", "postgres://bob:secret@myhost:9999/foo?bar=baz"},
// support unix sockets via `host` or `socket` param
{"postgres://bob:secret@myhost:1234/foo?host=/var/run/postgresql", "postgres://bob:secret@:1234/foo?host=%2Fvar%2Frun%2Fpostgresql"},
{"postgres://bob:secret@localhost/foo?socket=/var/run/postgresql", "postgres://bob:secret@:5432/foo?host=%2Fvar%2Frun%2Fpostgresql"},
{"postgres:///foo?socket=/var/run/postgresql", "postgres://:5432/foo?host=%2Fvar%2Frun%2Fpostgresql"},
}
for _, c := range cases {
t.Run(c.input, func(t *testing.T) {
u, err := url.Parse(c.input)
require.NoError(t, err)
actual := connectionString(u)
require.Equal(t, c.expected, actual)
})
}
}
func TestConnectionArgsForDump(t *testing.T) {
cases := []struct {
input string
expected []string
}{
// defaults
{"postgres:///foo", []string{"postgres://localhost:5432/foo"}},
// support single schema
{"postgres:///foo?search_path=foo", []string{"--schema", "foo", "postgres://localhost:5432/foo"}},
// support multiple schemas
{"postgres:///foo?search_path=foo,public", []string{"--schema", "foo", "--schema", "public", "postgres://localhost:5432/foo"}},
}
for _, c := range cases {
t.Run(c.input, func(t *testing.T) {
u, err := url.Parse(c.input)
require.NoError(t, err)
actual := connectionArgsForDump(u)
require.Equal(t, c.expected, actual)
})
}
}
func TestPostgresCreateDropDatabase(t *testing.T) {
drv := testPostgresDriver(t)
// drop any existing database
err := drv.DropDatabase()
require.NoError(t, err)
// create database
err = drv.CreateDatabase()
require.NoError(t, err)
// check that database exists and we can connect to it
func() {
db, err := sql.Open("postgres", drv.databaseURL.String())
require.NoError(t, err)
defer dbutil.MustClose(db)
err = db.Ping()
require.NoError(t, err)
}()
// drop the database
err = drv.DropDatabase()
require.NoError(t, err)
// check that database no longer exists
func() {
db, err := sql.Open("postgres", drv.databaseURL.String())
require.NoError(t, err)
defer dbutil.MustClose(db)
err = db.Ping()
require.Error(t, err)
require.Equal(t, "pq: database \"dbmate_test\" does not exist", err.Error())
}()
}
func TestPostgresDumpSchema(t *testing.T) {
t.Run("default migrations table", func(t *testing.T) {
drv := testPostgresDriver(t)
// prepare database
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
err := drv.CreateMigrationsTable(db)
require.NoError(t, err)
// insert migration
err = drv.InsertMigration(db, "abc1")
require.NoError(t, err)
err = drv.InsertMigration(db, "abc2")
require.NoError(t, err)
// DumpSchema should return schema
schema, err := drv.DumpSchema(db)
require.NoError(t, err)
require.Contains(t, string(schema), "CREATE TABLE public.schema_migrations")
require.Contains(t, string(schema), "\n--\n"+
"-- PostgreSQL database dump complete\n"+
"--\n\n\n"+
"--\n"+
"-- Dbmate schema migrations\n"+
"--\n\n"+
"INSERT INTO public.schema_migrations (version) VALUES\n"+
" ('abc1'),\n"+
" ('abc2');\n")
// DumpSchema should return error if command fails
drv.databaseURL.Path = "/fakedb"
schema, err = drv.DumpSchema(db)
require.Nil(t, schema)
require.EqualError(t, err, "pg_dump: [archiver (db)] connection to database "+
"\"fakedb\" failed: FATAL: database \"fakedb\" does not exist")
})
t.Run("custom migrations table with schema", func(t *testing.T) {
drv := testPostgresDriver(t)
drv.migrationsTableName = "camelSchema.testMigrations"
// prepare database
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
err := drv.CreateMigrationsTable(db)
require.NoError(t, err)
// insert migration
err = drv.InsertMigration(db, "abc1")
require.NoError(t, err)
err = drv.InsertMigration(db, "abc2")
require.NoError(t, err)
// DumpSchema should return schema
schema, err := drv.DumpSchema(db)
require.NoError(t, err)
require.Contains(t, string(schema), "CREATE TABLE \"camelSchema\".\"testMigrations\"")
require.Contains(t, string(schema), "\n--\n"+
"-- PostgreSQL database dump complete\n"+
"--\n\n\n"+
"--\n"+
"-- Dbmate schema migrations\n"+
"--\n\n"+
"INSERT INTO \"camelSchema\".\"testMigrations\" (version) VALUES\n"+
" ('abc1'),\n"+
" ('abc2');\n")
})
}
func TestPostgresDatabaseExists(t *testing.T) {
drv := testPostgresDriver(t)
// drop any existing database
err := drv.DropDatabase()
require.NoError(t, err)
// DatabaseExists should return false
exists, err := drv.DatabaseExists()
require.NoError(t, err)
require.Equal(t, false, exists)
// create database
err = drv.CreateDatabase()
require.NoError(t, err)
// DatabaseExists should return true
exists, err = drv.DatabaseExists()
require.NoError(t, err)
require.Equal(t, true, exists)
}
func TestPostgresDatabaseExists_Error(t *testing.T) {
drv := testPostgresDriver(t)
drv.databaseURL.User = url.User("invalid")
exists, err := drv.DatabaseExists()
require.Error(t, err)
require.Equal(t, "pq: password authentication failed for user \"invalid\"", err.Error())
require.Equal(t, false, exists)
}
func TestPostgresCreateMigrationsTable(t *testing.T) {
t.Run("default schema", func(t *testing.T) {
drv := testPostgresDriver(t)
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
// migrations table should not exist
count := 0
err := db.QueryRow("select count(*) from public.schema_migrations").Scan(&count)
require.Error(t, err)
require.Equal(t, "pq: relation \"public.schema_migrations\" does not exist", err.Error())
// create table
err = drv.CreateMigrationsTable(db)
require.NoError(t, err)
// migrations table should exist
err = db.QueryRow("select count(*) from public.schema_migrations").Scan(&count)
require.NoError(t, err)
// create table should be idempotent
err = drv.CreateMigrationsTable(db)
require.NoError(t, err)
})
t.Run("custom search path", func(t *testing.T) {
drv := testPostgresDriver(t)
drv.migrationsTableName = "testMigrations"
u, err := url.Parse(drv.databaseURL.String() + "&search_path=camelFoo")
require.NoError(t, err)
drv.databaseURL = u
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
// delete schema
_, err = db.Exec("drop schema if exists \"camelFoo\"")
require.NoError(t, err)
// drop any testMigrations table in public schema
_, err = db.Exec("drop table if exists public.\"testMigrations\"")
require.NoError(t, err)
// migrations table should not exist in either schema
count := 0
err = db.QueryRow("select count(*) from \"camelFoo\".\"testMigrations\"").Scan(&count)
require.Error(t, err)
require.Equal(t, "pq: relation \"camelFoo.testMigrations\" does not exist", err.Error())
err = db.QueryRow("select count(*) from public.\"testMigrations\"").Scan(&count)
require.Error(t, err)
require.Equal(t, "pq: relation \"public.testMigrations\" does not exist", err.Error())
// create table
err = drv.CreateMigrationsTable(db)
require.NoError(t, err)
// camelFoo schema should be created, and migrations table should exist only in camelFoo schema
err = db.QueryRow("select count(*) from \"camelFoo\".\"testMigrations\"").Scan(&count)
require.NoError(t, err)
err = db.QueryRow("select count(*) from public.\"testMigrations\"").Scan(&count)
require.Error(t, err)
require.Equal(t, "pq: relation \"public.testMigrations\" does not exist", err.Error())
// create table should be idempotent
err = drv.CreateMigrationsTable(db)
require.NoError(t, err)
})
t.Run("custom schema", func(t *testing.T) {
drv := testPostgresDriver(t)
drv.migrationsTableName = "camelSchema.testMigrations"
u, err := url.Parse(drv.databaseURL.String() + "&search_path=foo")
require.NoError(t, err)
drv.databaseURL = u
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
// delete schemas
_, err = db.Exec("drop schema if exists foo")
require.NoError(t, err)
_, err = db.Exec("drop schema if exists \"camelSchema\"")
require.NoError(t, err)
// migrations table should not exist
count := 0
err = db.QueryRow("select count(*) from \"camelSchema\".\"testMigrations\"").Scan(&count)
require.Error(t, err)
require.Equal(t, "pq: relation \"camelSchema.testMigrations\" does not exist", err.Error())
// create table
err = drv.CreateMigrationsTable(db)
require.NoError(t, err)
// camelSchema should be created, and testMigrations table should exist
err = db.QueryRow("select count(*) from \"camelSchema\".\"testMigrations\"").Scan(&count)
require.NoError(t, err)
// testMigrations table should not exist in foo schema because
// schema specified with migrations table name takes priority over search path
err = db.QueryRow("select count(*) from foo.\"testMigrations\"").Scan(&count)
require.Error(t, err)
require.Equal(t, "pq: relation \"foo.testMigrations\" does not exist", err.Error())
// create table should be idempotent
err = drv.CreateMigrationsTable(db)
require.NoError(t, err)
})
}
func TestPostgresSelectMigrations(t *testing.T) {
drv := testPostgresDriver(t)
drv.migrationsTableName = "test_migrations"
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
err := drv.CreateMigrationsTable(db)
require.NoError(t, err)
_, err = db.Exec(`insert into public.test_migrations (version)
values ('abc2'), ('abc1'), ('abc3')`)
require.NoError(t, err)
migrations, err := drv.SelectMigrations(db, -1)
require.NoError(t, err)
require.Equal(t, true, migrations["abc1"])
require.Equal(t, true, migrations["abc2"])
require.Equal(t, true, migrations["abc2"])
// test limit param
migrations, err = drv.SelectMigrations(db, 1)
require.NoError(t, err)
require.Equal(t, true, migrations["abc3"])
require.Equal(t, false, migrations["abc1"])
require.Equal(t, false, migrations["abc2"])
}
func TestPostgresInsertMigration(t *testing.T) {
drv := testPostgresDriver(t)
drv.migrationsTableName = "test_migrations"
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
err := drv.CreateMigrationsTable(db)
require.NoError(t, err)
count := 0
err = db.QueryRow("select count(*) from public.test_migrations").Scan(&count)
require.NoError(t, err)
require.Equal(t, 0, count)
// insert migration
err = drv.InsertMigration(db, "abc1")
require.NoError(t, err)
err = db.QueryRow("select count(*) from public.test_migrations where version = 'abc1'").
Scan(&count)
require.NoError(t, err)
require.Equal(t, 1, count)
}
func TestPostgresDeleteMigration(t *testing.T) {
drv := testPostgresDriver(t)
drv.migrationsTableName = "test_migrations"
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
err := drv.CreateMigrationsTable(db)
require.NoError(t, err)
_, err = db.Exec(`insert into public.test_migrations (version)
values ('abc1'), ('abc2')`)
require.NoError(t, err)
err = drv.DeleteMigration(db, "abc2")
require.NoError(t, err)
count := 0
err = db.QueryRow("select count(*) from public.test_migrations").Scan(&count)
require.NoError(t, err)
require.Equal(t, 1, count)
}
func TestPostgresPing(t *testing.T) {
drv := testPostgresDriver(t)
// drop any existing database
err := drv.DropDatabase()
require.NoError(t, err)
// ping database
err = drv.Ping()
require.NoError(t, err)
// ping invalid host should return error
drv.databaseURL.Host = "postgres:404"
err = drv.Ping()
require.Error(t, err)
require.Contains(t, err.Error(), "connect: connection refused")
}
func TestPostgresQuotedMigrationsTableName(t *testing.T) {
t.Run("default schema", func(t *testing.T) {
drv := testPostgresDriver(t)
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
name, err := drv.quotedMigrationsTableName(db)
require.NoError(t, err)
require.Equal(t, "public.schema_migrations", name)
})
t.Run("custom schema", func(t *testing.T) {
drv := testPostgresDriver(t)
u, err := url.Parse(drv.databaseURL.String() + "&search_path=foo,bar,public")
require.NoError(t, err)
drv.databaseURL = u
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
_, err = db.Exec("drop schema if exists foo")
require.NoError(t, err)
_, err = db.Exec("drop schema if exists bar")
require.NoError(t, err)
// should use first schema from search path
name, err := drv.quotedMigrationsTableName(db)
require.NoError(t, err)
require.Equal(t, "foo.schema_migrations", name)
})
t.Run("no schema", func(t *testing.T) {
drv := testPostgresDriver(t)
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
// this is an unlikely edge case, but if for some reason there is
// no current schema then we should default to "public"
_, err := db.Exec("select pg_catalog.set_config('search_path', '', false)")
require.NoError(t, err)
name, err := drv.quotedMigrationsTableName(db)
require.NoError(t, err)
require.Equal(t, "public.schema_migrations", name)
})
t.Run("custom table name", func(t *testing.T) {
drv := testPostgresDriver(t)
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
drv.migrationsTableName = "simple_name"
name, err := drv.quotedMigrationsTableName(db)
require.NoError(t, err)
require.Equal(t, "public.simple_name", name)
})
t.Run("custom table name quoted", func(t *testing.T) {
drv := testPostgresDriver(t)
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
// this table name will need quoting
drv.migrationsTableName = "camelCase"
name, err := drv.quotedMigrationsTableName(db)
require.NoError(t, err)
require.Equal(t, "public.\"camelCase\"", name)
})
t.Run("custom table name with custom schema", func(t *testing.T) {
drv := testPostgresDriver(t)
u, err := url.Parse(drv.databaseURL.String() + "&search_path=foo")
require.NoError(t, err)
drv.databaseURL = u
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
_, err = db.Exec("create schema if not exists foo")
require.NoError(t, err)
drv.migrationsTableName = "simple_name"
name, err := drv.quotedMigrationsTableName(db)
require.NoError(t, err)
require.Equal(t, "foo.simple_name", name)
})
t.Run("custom table name overrides schema", func(t *testing.T) {
drv := testPostgresDriver(t)
u, err := url.Parse(drv.databaseURL.String() + "&search_path=foo")
require.NoError(t, err)
drv.databaseURL = u
db := prepTestPostgresDB(t)
defer dbutil.MustClose(db)
_, err = db.Exec("create schema if not exists foo")
require.NoError(t, err)
_, err = db.Exec("create schema if not exists bar")
require.NoError(t, err)
// if schema is specified as part of table name, it should override search_path
drv.migrationsTableName = "bar.simple_name"
name, err := drv.quotedMigrationsTableName(db)
require.NoError(t, err)
require.Equal(t, "bar.simple_name", name)
// schema and table name should be quoted if necessary
drv.migrationsTableName = "barName.camelTable"
name, err = drv.quotedMigrationsTableName(db)
require.NoError(t, err)
require.Equal(t, "\"barName\".\"camelTable\"", name)
// more than 2 components is unexpected but we will quote and pass it along anyway
drv.migrationsTableName = "whyWould.i.doThis"
name, err = drv.quotedMigrationsTableName(db)
require.NoError(t, err)
require.Equal(t, "\"whyWould\".i.\"doThis\"", name)
})
}