apitest

Documentation

Overview

Package apitest provides support for excuting api test logic.

Index

• func Token(userBus *userbus.Business, ath *auth.Auth, email string) string
• type KeyStore
  • func (ks *KeyStore) PrivateKey(kid string) (string, error)
  • func (ks *KeyStore) PublicKey(kid string) (string, error)
• type SeedData
• type Table
• type Test
  • func New(t *testing.T, testName string) *Test
  • func (at *Test) Run(t *testing.T, table []Table, testName string)
• type User

Functions

func Token

func Token(userBus *userbus.Business, ath *auth.Auth, email string) string

Token generates an authenticated token for a user.

Types

type KeyStore

type KeyStore struct{}

KeyStore represents a mock keystore with a hardcoded key.

func (*KeyStore) PrivateKey

func (ks *KeyStore) PrivateKey(kid string) (string, error)

PrivateKey implements the auth interface.

func (*KeyStore) PublicKey

func (ks *KeyStore) PublicKey(kid string) (string, error)

PublicKey implements the auth interface.

type SeedData

type SeedData struct {
	Users  []User
	Admins []User
}

SeedData represents users for api tests.

type Table

type Table struct {
	Name       string
	URL        string
	Token      string
	Method     string
	StatusCode int
	Input      any
	GotResp    any
	ExpResp    any
	CmpFunc    func(got any, exp any) string
}

Table represent fields needed for running an api test.

type Test

type Test struct {
	DB   *dbtest.Database
	Auth *auth.Auth
	// contains filtered or unexported fields
}

Test contains functions for executing an api test.

func New

func New(t *testing.T, testName string) *Test

New initialized the system to run a test.

func (*Test) Run

func (at *Test) Run(t *testing.T, table []Table, testName string)

Run performs the actual test logic based on the table data.

type User

type User struct {
	userbus.User
	Scrums []scrumbus.Scrum
	Token  string
}

User extends the dbtest user for api test support.