testhelpers

Documentation

Index

• type ContainerManager
  • func Init(ctx context.Context, searchPath string) *ContainerManager
  • func (db *ContainerManager) Restore(ctx context.Context)
  • func (db *ContainerManager) Seeder(ctx context.Context, t *testing.T) *Seeder
  • func (db *ContainerManager) TearDown(ctx context.Context)
• type DateHelper
  • func (t DateHelper) Add(years int, months int, days int) DateHelper
  • func (t DateHelper) Date() time.Time
  • func (t DateHelper) DatePtr() *time.Time
  • func (t DateHelper) FinancialYear() string
  • func (t DateHelper) String() string
  • func (t DateHelper) StringPtr() *string
  • func (t DateHelper) Sub(years int, months int, days int) DateHelper
• type FeeRange
• type Seeder
  • func (s *Seeder) AddFeeRanges(ctx context.Context, invoiceId int, ranges []FeeRange)
  • func (s *Seeder) ApproveAdjustment(ctx context.Context, clientID int, adjustmentId int)
  • func (s *Seeder) Begin(ctx context.Context) (pgx.Tx, error)
  • func (s *Seeder) CreateAdjustment(ctx context.Context, clientID int, invoiceId int, ...) int
  • func (s *Seeder) CreateClient(ctx context.Context, firstName string, surname string, courtRef string, ...) int
  • func (s *Seeder) CreateDeputy(ctx context.Context, clientId int, firstName string, surname string, ...) int
  • func (s *Seeder) CreateFeeReduction(ctx context.Context, clientId int, feeType shared.FeeReductionType, ...)
  • func (s *Seeder) CreateInvoice(ctx context.Context, clientID int, invoiceType shared.InvoiceType, ...) (int, string)
  • func (s *Seeder) CreateOrder(ctx context.Context, clientId int, status string)
  • func (s *Seeder) CreatePayment(ctx context.Context, amount int, bankDate time.Time, courtRef string, ...)
  • func (s *Seeder) CreateTestAssignee(ctx context.Context)
  • func (s *Seeder) Exec(ctx context.Context, str string, i ...interface{}) (pgconn.CommandTag, error)
  • func (s *Seeder) Query(ctx context.Context, str string, i ...interface{}) (pgx.Rows, error)
  • func (s *Seeder) QueryRow(ctx context.Context, str string, i ...interface{}) pgx.Row
  • func (s *Seeder) SeedData(data ...string)
  • func (s *Seeder) Today() DateHelper
  • func (s *Seeder) WithService(service Service) *Seeder
• type Service

Types

type ContainerManager

type ContainerManager struct {
	Address   string
	Container *postgres.PostgresContainer
}

ContainerManager is a test utility containing a fully-migrated Postgres instance. To use this, run Init within a TestMain function and use the DbInstance to interact with the database as needed (e.g. to insert data prior to testing). Ensure to run TearDown at the end of the tests to clean up.

func Init

func Init(ctx context.Context, searchPath string) *ContainerManager

func (*ContainerManager) Restore

func (db *ContainerManager) Restore(ctx context.Context)

Restore restores the DB to the snapshot backup and re-establishes the connection

func (*ContainerManager) Seeder

func (db *ContainerManager) Seeder(ctx context.Context, t *testing.T) *Seeder

func (*ContainerManager) TearDown

func (db *ContainerManager) TearDown(ctx context.Context)

type DateHelper

type DateHelper struct {
	// contains filtered or unexported fields
}

func (DateHelper) Add

func (t DateHelper) Add(years int, months int, days int) DateHelper

func (DateHelper) Date

func (t DateHelper) Date() time.Time

func (DateHelper) DatePtr

func (t DateHelper) DatePtr() *time.Time

func (DateHelper) FinancialYear

func (t DateHelper) FinancialYear() string

func (DateHelper) String

func (t DateHelper) String() string

func (DateHelper) StringPtr

func (t DateHelper) StringPtr() *string

func (DateHelper) Sub

func (t DateHelper) Sub(years int, months int, days int) DateHelper

type FeeRange

type FeeRange struct {
	FromDate         time.Time
	ToDate           time.Time
	SupervisionLevel string
	Amount           int
}

type Seeder

type Seeder struct {
	Conn    *pgxpool.Pool
	Service Service
	// contains filtered or unexported fields
}

Seeder contains a test database connection pool and HTTP server for API calls

func (*Seeder) AddFeeRanges

func (s *Seeder) AddFeeRanges(ctx context.Context, invoiceId int, ranges []FeeRange)

func (*Seeder) ApproveAdjustment

func (s *Seeder) ApproveAdjustment(ctx context.Context, clientID int, adjustmentId int)

func (*Seeder) Begin

func (s *Seeder) Begin(ctx context.Context) (pgx.Tx, error)

func (*Seeder) CreateAdjustment

func (s *Seeder) CreateAdjustment(ctx context.Context, clientID int, invoiceId int, adjustmentType shared.AdjustmentType, amount int, notes string) int

func (*Seeder) CreateClient

func (s *Seeder) CreateClient(ctx context.Context, firstName string, surname string, courtRef string, sopNumber string) int

func (*Seeder) CreateDeputy

func (s *Seeder) CreateDeputy(ctx context.Context, clientId int, firstName string, surname string, deputyType string) int

func (*Seeder) CreateFeeReduction

func (s *Seeder) CreateFeeReduction(ctx context.Context, clientId int, feeType shared.FeeReductionType, startYear string, length int, notes string, createdAt time.Time)

func (*Seeder) CreateInvoice

func (s *Seeder) CreateInvoice(ctx context.Context, clientID int, invoiceType shared.InvoiceType, amount *string, raisedDate *string, startDate *string, endDate *string, supervisionLevel *string) (int, string)

func (*Seeder) CreateOrder

func (s *Seeder) CreateOrder(ctx context.Context, clientId int, status string)

func (*Seeder) CreatePayment

func (s *Seeder) CreatePayment(ctx context.Context, amount int, bankDate time.Time, courtRef string, ledgerType shared.TransactionType, uploadDate time.Time)

func (*Seeder) CreateTestAssignee

func (s *Seeder) CreateTestAssignee(ctx context.Context)

func (*Seeder) Exec

func (s *Seeder) Exec(ctx context.Context, str string, i ...interface{}) (pgconn.CommandTag, error)

func (*Seeder) Query

func (s *Seeder) Query(ctx context.Context, str string, i ...interface{}) (pgx.Rows, error)

func (*Seeder) QueryRow

func (s *Seeder) QueryRow(ctx context.Context, str string, i ...interface{}) pgx.Row

func (*Seeder) SeedData

func (s *Seeder) SeedData(data ...string)

func (*Seeder) Today

func (s *Seeder) Today() DateHelper

func (*Seeder) WithService

func (s *Seeder) WithService(service Service) *Seeder

type Service

type Service interface {
	AddManualInvoice(ctx context.Context, clientID int, invoice shared.AddManualInvoice) error
	AddInvoiceAdjustment(ctx context.Context, clientID int, invoiceId int, adjustment *shared.AddInvoiceAdjustmentRequest) (*shared.InvoiceReference, error)
	UpdatePendingInvoiceAdjustment(ctx context.Context, clientID int, adjustmentId int, status shared.AdjustmentStatus) error
	AddFeeReduction(ctx context.Context, clientId int, reduction shared.AddFeeReduction) error
	ProcessPaymentsUploadLine(ctx context.Context, tx *store.Tx, details shared.PaymentDetails, index int, failedLines *map[int]string) error
	BeginStoreTx(ctx context.Context) (*store.Tx, error)
}