apitest

package

v0.0.0-...-99a89de Latest Latest Go to latest Published: May 19, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package apitest contains supporting code for running app layer tests.

This section is empty.

This section is empty.

func CmpAppErrors(got any, exp any) string

CmpAppErrors compares two encore error values. If they are not equal, the reason is returned.

func Token(db *dbtest.Database, ath *auth.Auth, email string) string

Token generates an authenticated token for a user.

type AuthHandler func(ctx context.Context, ap *AuthParams) (eauth.UID, *auth.Claims, error)

AuthHandler represents a function that can perform authentication.

type AuthParams struct {
	Authorization string `header:"Authorization"`
}

AuthParams provides access to the authorization header.

type KeyStore struct{}

KeyStore represents a mock keystore with a hardcoded key.

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

PrivateKey implements the auth interface.

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

PublicKey implements the auth interface.

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

SeedData represents users for app tests.

type Table struct {
	Name    string
	Token   string
	ExpResp any
	ExcFunc func(ctx context.Context) any
	CmpFunc func(got any, exp any) string
}

Table represent fields needed for running an app 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(db *dbtest.Database, ath *auth.Auth, handler AuthHandler) *Test

New constructs a Test value for running api tests.

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

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

type User struct {
	userbus.User
	Products []productbus.Product
	Homes    []homebus.Home
	Token    string
}

User extends the dbtest user for app test support.