testcontainerpostgres

README

Postgres testcontainer

A postgres docker testcontainer for go

Example usage:

initPath, err := filepath.Abs("./initdb")
if err != nil {
    log.Fatalf("%v", err)
}
ctx := context.Background()
postgresC, conn, err := testcontainerpostgres.New(ctx, "14.5-alpine",
    testcontainerpostgres.WithInit(initPath),
    testcontainerpostgres.WithDb("test_db"),
    testcontainerpostgres.WithAuth("postgres", "postgres"),
)
if err != nil {
    log.Fatalf("%v", err)
}
defer Terminate(ctx, postgresC)

fmt.Println(conn)
// Output: postgres://postgres:postgres@localhost:49156/test_db

Run tests

go test

Documentation

Overview

Package testcontainerpostgres provides an easy way to start a postgres testcontainer using docker

Index

• func New(ctx context.Context, tag string, opts ...Option) (testcontainers.Container, string, error)
• func Terminate(ctx context.Context, c testcontainers.Container)
• type Option
  • func WithAuth(user, pass string) Option
  • func WithDb(db string) Option
  • func WithEnv(env map[string]string) Option
  • func WithInit(init string) Option

Functions

func New

func New(ctx context.Context, tag string, opts ...Option) (testcontainers.Container, string, error)

New setup a postgres testcontainer

func Terminate

func Terminate(ctx context.Context, c testcontainers.Container)

Terminate terminates the container in a defer friendly way

Types

type Option

type Option func(testcontainers.ContainerRequest) testcontainers.ContainerRequest

func WithAuth

func WithAuth(user, pass string) Option

WithAuth adds a username and password to the container request

func WithDb

func WithDb(db string) Option

WithDb adds a database name to the container request

func WithEnv

func WithEnv(env map[string]string) Option

WithEnv replaces the environment variables of the container request

func WithInit

func WithInit(init string) Option

WithInit adds a path to a folder containing sql files to be executed on startup