psql_container_test.go

package psqldocker_test

import (
	"errors"
	"strings"
	"testing"

	"github.com/adrianbrad/psqldocker"
	"github.com/jackc/pgx/v5/pgconn"
	_ "github.com/jackc/pgx/v5/stdlib"
	"github.com/matryer/is"
	"github.com/ory/dockertest/v3"
	"github.com/ory/dockertest/v3/docker"
)

func TestNewContainer(t *testing.T) {
	t.Parallel()

	const (
		user     = "user"
		password = "pass"
		dbName   = "test"
	)

	t.Run("AllOptions", func(t *testing.T) {
		t.Parallel()

		i := is.New(t)

		p, err := dockertest.NewPool("")
		i.NoErr(err)

		c, err := psqldocker.NewContainer(
			user,
			password,
			dbName,
			psqldocker.WithContainerName(containerNameFromTest(t)),
			psqldocker.WithDBPort("5432"),
			psqldocker.WithPool(p),
			psqldocker.WithImageTag("alpine"),
			psqldocker.WithPoolEndpoint(""),
			psqldocker.WithSQL(
				"CREATE TABLE users(user_id UUID PRIMARY KEY);",
			),
			psqldocker.WithPingRetryTimeout(20),
			psqldocker.WithExpiration(20),
		)
		i.NoErr(err)

		t.Logf("container started on port: %s", c.Port())

		err = c.Close()
		i.NoErr(err)
	})

	t.Run("NoOptions", func(t *testing.T) {
		t.Parallel()

		i := is.New(t)

		c, err := psqldocker.NewContainer(
			user,
			password,
			dbName,
			psqldocker.WithContainerName(containerNameFromTest(t)),
		)
		i.NoErr(err)

		err = c.Close()
		i.NoErr(err)
	})

	t.Run("WithTimescaleDBOption", func(t *testing.T) {
		t.Parallel()

		i := is.New(t)

		c, err := psqldocker.NewContainer(
			user,
			password,
			dbName,
			psqldocker.WithTimescaleDB(),
			psqldocker.WithContainerName(containerNameFromTest(t)),
		)
		i.NoErr(err)

		err = c.Close()
		i.NoErr(err)
	})

	t.Run("WithTimescaleDBOptionAndCustomTag", func(t *testing.T) {
		t.Parallel()

		i := is.New(t)

		c, err := psqldocker.NewContainer(
			user,
			password,
			dbName,
			psqldocker.WithImageTag("latest-pg14"),
			psqldocker.WithTimescaleDB(),
			psqldocker.WithContainerName(containerNameFromTest(t)),
		)
		i.NoErr(err)

		err = c.Close()
		i.NoErr(err)
	})

	t.Run("InvalidTagFormat", func(t *testing.T) {
		t.Parallel()

		i := is.New(t)

		_, err := psqldocker.NewContainer(
			user,
			password,
			dbName,
			psqldocker.WithImageTag("error:latest"),
		)

		var dockerErr *docker.Error

		i.True(errors.As(err, &dockerErr))
		i.Equal(
			"invalid tag format",
			dockerErr.Message,
		)
	})

	t.Run("InvalidSQL", func(t *testing.T) {
		t.Parallel()

		i := is.New(t)

		_, err := psqldocker.NewContainer(
			user,
			password,
			dbName,
			psqldocker.WithContainerName(containerNameFromTest(t)),
			psqldocker.WithSQL("error"),
		)

		var pgErr *pgconn.PgError

		if errors.As(err, &pgErr) {
			i.Equal("syntax error at or near \"error\"", pgErr.Message)
			return
		}

		t.Errorf("expected error to be of type *pgconn.PgError, got %T", err)
	})

	t.Run("ProvideWithPoolAndWithPoolEndpoint", func(t *testing.T) {
		t.Parallel()

		i := is.New(t)

		_, err := psqldocker.NewContainer(
			user,
			password,
			dbName,
			psqldocker.WithPool(new(dockertest.Pool)),
			psqldocker.WithPoolEndpoint("endpoint"),
		)
		i.True(errors.Is(
			err,
			psqldocker.ErrWithPoolAndWithPoolEndpoint,
		))
	})

	t.Run("InvalidPoolEndpointURL", func(t *testing.T) {
		t.Parallel()

		i := is.New(t)

		_, err := psqldocker.NewContainer(
			user,
			password,
			dbName,
			psqldocker.WithPoolEndpoint("://endpoint"),
		)
		i.Equal(
			"start container: get pool: dockertest new pool: invalid endpoint",
			err.Error(),
		)
	})

	t.Run("PingFail", func(t *testing.T) {
		t.Parallel()

		i := is.New(t)

		_, err := psqldocker.NewContainer(
			user,
			password,
			dbName,
			psqldocker.WithContainerName(containerNameFromTest(t)),
			psqldocker.WithPingRetryTimeout(1),
		)
		i.True(
			strings.Contains(
				err.Error(),
				"ping db: reached retry deadline: "+
					"ping: failed to connect to `host=localhost user=user database=test`",
			),
		)
	})
}

func containerNameFromTest(t *testing.T) string {
	t.Helper()

	containerName := strings.Split(t.Name(), "/")

	return containerName[len(containerName)-1]
}