database

Documentation

Index

• func AnyTime() sqlmock.Argument
• func CreateGormDB(logger hclog.Logger, c *config.Config) (*gorm.DB, error)
• func Migrate(databaseURL string) error
• func MockQueueJob(mock sqlmock.Sqlmock, params interface{}, job string, priority int)
• func NewGormDB(databaseURL string) (*gorm.DB, error)
• func NewMockedGormDB() (*gorm.DB, sqlmock.Sqlmock)
• func NewTestPostgresDB(migrate bool) (*dockertest.Resource, string, error)
• func Ping(ctx context.Context, db *gorm.DB) error
• type NoOpCrypter
  • func (c NoOpCrypter) Decrypt(w io.Writer, r io.Reader) error
  • func (c NoOpCrypter) Encrypt(w io.Writer, r io.Reader) error

Functions

func AnyTime

func AnyTime() sqlmock.Argument

AnyTime will return an sqlmock.Argument which can match any time.Time argument.

func CreateGormDB

func CreateGormDB(logger hclog.Logger, c *config.Config) (*gorm.DB, error)

CreateGormDB creates a configured gorm.DB

func Migrate

func Migrate(databaseURL string) error

Migrate leverages golang-migrate to perform a database migration using SQL migration files embedded within the binary.

func MockQueueJob

func MockQueueJob(mock sqlmock.Sqlmock, params interface{}, job string, priority int)

func NewGormDB

func NewGormDB(databaseURL string) (*gorm.DB, error)

NewGormDB creates a gorm.DB given a database URL.

This is a utility function only to be used for tests.

func NewMockedGormDB

func NewMockedGormDB() (*gorm.DB, sqlmock.Sqlmock)

NewMockedGormDB returns a mocked gorm.DB for use in tests.

func NewTestPostgresDB

func NewTestPostgresDB(migrate bool) (*dockertest.Resource, string, error)

NewTestPostgresDB spawns a new Docker container running PostgreSQL v14.5 and executes database migration optionally.

Use "defer resource.Close()" to ensure the container is purged when you are done with it.

func Ping

func Ping(ctx context.Context, db *gorm.DB) error

Ping pings the database to test the connection

Types

type NoOpCrypter

type NoOpCrypter struct{}

NoOpCrypter is a no-op crypter useful for testing.

func (NoOpCrypter) Decrypt

func (c NoOpCrypter) Decrypt(w io.Writer, r io.Reader) error

func (NoOpCrypter) Encrypt

func (c NoOpCrypter) Encrypt(w io.Writer, r io.Reader) error