testdb

Overview ¶

Package testdb is a test convenience that creates test databases, migrates schema and tears down cleanly.

Ideal for projects that use https://github.com/upper/db.

Migrations are backed by https://github.com/golang-migrate/migrate

The simplest way to use testdb in testing:

  package main
  import (
    "github.com/tnsimon/testdb"
  )
  func setup() {
	migrationPath := "/path/to/migrations.sql"

	cfg := testdb.Config{
		Host:     "localhost",
		Port:     5432,
		User:     "username",
		Password: "password",
		Database: "database",
		Options: map[string]string{
			"sslmode": "require",
		},
	}
	testDB, err := testdb.New(cfg,
		testdb.WithMigrate(migrationPath)
	)
  }

  func cleanup() {
	  testDB.Teardown()
  }