tests

Documentation

Overview

Package tests contains supporting code for running tests.

Index

• Constants
• Variables
• func Context() context.Context
• func IntPointer(i int) *int
• func NewUnit(t *testing.T) (*log.Logger, *sqlx.DB, func())
• func StringPointer(s string) *string
• type Container
• type Test
  • func NewIntegration(t *testing.T) *Test
  • func (test *Test) Teardown()
  • func (test *Test) Token(kid string, email, pass string) string

Constants

const (
	Success = "\u2713"
	Failed  = "\u2717"
)

Success and failure markers

Variables

var (
	AdminID = "5cf37266-3473-4006-984f-9325122678b7"
	UserID  = "45b5fbd3-755f-4379-8f07-a58d4a30fa2f"
)

Configuration for running tests.

Functions

func Context

func Context() context.Context

Context returns an app level context for testing.

func IntPointer

func IntPointer(i int) *int

IntPointer is a helper to get a *int from a int. It is in the tests package because we normally don't want to deal with pointers to basic types but it's useful in some tests.

func NewUnit

func NewUnit(t *testing.T) (*log.Logger, *sqlx.DB, func())

NewUnit creates a test database inside a Docker container. It creates the required table structure but the database is otherwise empty. It returns the database to use as well as a a function to call at the end of the test.

func StringPointer

func StringPointer(s string) *string

StringPointer is a helper to get a *string from a string. It is in the tests package because we normally don't want to deal with pointers to basic types but it's useful in some tests.

Types

type Container

type Container struct {
	ID   string
	Host string
}

Container tracks information about the docker container started for tests.

type Test

type Test struct {
	TraceID string
	DB      *sqlx.DB
	Log     *log.Logger
	Auth    *auth.Auth
	KID     string
	// contains filtered or unexported fields
}

Test owns state for running and shutting down tests.

func NewIntegration

func NewIntegration(t *testing.T) *Test

NewIntegration creates a database, seeds it, constructs an authenticator.

func (*Test) Teardown

func (test *Test) Teardown()

Teardown releases any resources used for the test.

func (*Test) Token

func (test *Test) Token(kid string, email, pass string) string

Token generates an authenticated token for a user.