Golang sdk

With the DBCTL Golang SDK, you can create ephemeral databases for each unit test, ensuring that each test has its own fresh database.

To begin, you’ll need DBCTL running in testing mode. In this example, we want to set up a PostgreSQL database.

Start dbctl with a Postgres db

dbctl testing -- pg

Use sdk in test:

Install the sdk:

go get github.com/mirzakhany/dbctl/clients/dbctlgo

package foo

import (
	"database/sql"

	"testing"
	"github.com/mirzakhany/dbctl/clients/dbctlgo"
	// golang postgres driver
	_ "github.com/lib/pq"
)

func TestMustCreatePostgresDB(t *testing.T) {
	uri := dbctlgo.MustCreatePostgresDB(t)
	if uri == "" {
		t.Fatal("url is empty")
	}

	t.Log("uri:", uri)

	conn, err := sql.Open("postgres", uri)
	if err != nil {
		t.Fatal(err)
	}

	if err := conn.Ping(); err != nil {
		t.Fatal(err)
	}
	defer func() {
		_ = conn.Close()
	}()

	// create a table 
	res, err := conn.Exec("create table foo(id int, name varchar(20));")
	if err != nil {
		t.Fatal(err)
	}

    ...
}

We can also apply migrations before starting the test.

func TestMustCreatePostgresDB(t *testing.T) {
	uri := dbctlgo.MustCreatePostgresDB(t, dbctlgo.WithMigrations("./test_sql/schema"), dbctlgo.WithFixtures("./test_sql/fixtures"))
	if uri == "" {
		t.Fatal("url is empty")
	}

	t.Log("uri:", uri)

    ...
}

Each time we call MustCreatePostgresDB it will create a new database, apply migrations and test file and will return connection url.

To have redis database, we can do the same by starting the redis testing db:

dbclt testing -- rs

And use MustCreateRedisDB to create redis databases.

package foo

import (
	"database/sql"

	"testing"
	"github.com/mirzakhany/dbctl/clients/dbctlgo"
	"github.com/gomodule/redigo/redis"
)

func TestRedis(t *testing.T) {
	uri := dbctlgo.MustCreateRedisDB(t)
	if uri == "" {
		t.Fatal("url is empty")
	}

	t.Log("uri:", uri)
}