tests

Documentation

Overview

Package tests provides common helpers and mocks used in PocketBase application tests.

Index

• func MockMultipartData(data map[string]string, fileFields ...string) (*bytes.Buffer, *multipart.Writer, error)
• func MockRequestLogsData(app *TestApp) error
• func TempDirClone(dirToClone string) (string, error)
• type ApiScenario
  • func (scenario *ApiScenario) Test(t *testing.T)
• type TestApp
  • func NewTestApp(optTestDataDir ...string) (*TestApp, error)
  • func (t *TestApp) Cleanup()
  • func (t *TestApp) NewMailClient() mailer.Mailer
  • func (t *TestApp) ResetEventCalls()
• type TestMailer
  • func (m *TestMailer) Reset()
  • func (c *TestMailer) Send(m *mailer.Message) error

Functions

func MockMultipartData

func MockMultipartData(data map[string]string, fileFields ...string) (*bytes.Buffer, *multipart.Writer, error)

MockMultipartData creates a mocked multipart/form-data payload.

Example

data, mp, err := tests.MockMultipartData(
	map[string]string{"title": "new"},
	"file1",
	"file2",
	...
)

func MockRequestLogsData

func MockRequestLogsData(app *TestApp) error

func TempDirClone

func TempDirClone(dirToClone string) (string, error)

TempDirClone creates a new temporary directory copy from the provided directory path.

It is the caller's responsibility to call `os.RemoveAll(tempDir)` when the directory is no longer needed!

Types

type ApiScenario

type ApiScenario struct {
	Name           string
	Method         string
	Url            string
	Body           io.Reader
	RequestHeaders map[string]string

	// Delay adds a delay before checking the expectations usually
	// to ensure that all fired non-awaited go routines have finished
	Delay time.Duration

	// expectations
	// ---
	ExpectedStatus     int
	ExpectedContent    []string
	NotExpectedContent []string
	ExpectedEvents     map[string]int

	// test hooks
	// ---
	TestAppFactory func() (*TestApp, error)
	BeforeTestFunc func(t *testing.T, app *TestApp, e *echo.Echo)
	AfterTestFunc  func(t *testing.T, app *TestApp, e *echo.Echo)
}

ApiScenario defines a single api request test case/scenario.

func (*ApiScenario) Test

func (scenario *ApiScenario) Test(t *testing.T)

Test executes the test scenario.

type TestApp

type TestApp struct {
	*core.BaseApp

	// EventCalls defines a map to inspect which app events
	// (and how many times) were triggered.
	//
	// The following events are not counted because they execute always:
	// - OnBeforeBootstrap
	// - OnAfterBootstrap
	// - OnBeforeServe
	EventCalls map[string]int

	TestMailer *TestMailer
	// contains filtered or unexported fields
}

TestApp is a wrapper app instance used for testing.

func NewTestApp

func NewTestApp(optTestDataDir ...string) (*TestApp, error)

NewTestApp creates and initializes a test application instance.

It is the caller's responsibility to call `app.Cleanup()` when the app is no longer needed.

func (*TestApp) Cleanup

func (t *TestApp) Cleanup()

Cleanup resets the test application state and removes the test app's dataDir from the filesystem.

After this call, the app instance shouldn't be used anymore.

func (*TestApp) NewMailClient

func (t *TestApp) NewMailClient() mailer.Mailer

NewMailClient initializes test app mail client.

func (*TestApp) ResetEventCalls

func (t *TestApp) ResetEventCalls()

ResetEventCalls resets the EventCalls counter.

type TestMailer

type TestMailer struct {
	TotalSend   int
	LastMessage mailer.Message
}

TestMailer is a mock `mailer.Mailer` implementation.

func (*TestMailer) Reset

func (m *TestMailer) Reset()

Reset clears any previously test collected data.

func (*TestMailer) Send

func (c *TestMailer) Send(m *mailer.Message) error

Send implements `mailer.Mailer` interface.