runner

Documentation

Index

• func Screenshot(targetFile string) chromedp.Action
• func SetTestContext(ctx context.Context, testContext TestContext) context.Context
• func Suites(url string, suites TestSuites, opts Options)
• type Options
• type PostProcessingOptions
• type ScreenshotOptions
• type TestCase
• type TestContext
  • func MustGetTestContext(ctx context.Context) TestContext
• type TestSuite
• type TestSuites
• type Title

Functions

func Screenshot

func Screenshot(targetFile string) chromedp.Action

Screenshot captures a screenshot and saves it to the given filename.

func SetTestContext

func SetTestContext(ctx context.Context, testContext TestContext) context.Context

func Suites

func Suites(url string, suites TestSuites, opts Options)

Suites runs the given suites.

Types

type Options

type Options struct {
	SortSuites bool
	SortTests  bool
	Screenshot ScreenshotOptions
}

Options enabled to configure the run.

type PostProcessingOptions

type PostProcessingOptions struct {
	OutDir       string
	RemoveImages bool
	CreateGIF    bool
}

type ScreenshotOptions

type ScreenshotOptions struct {
	OutDir         string
	OnFailure      bool
	BeforeTestCase bool
	AfterTestCase  bool
	BeforeGroup    bool
	AfterGroup     bool
	BeforeAction   bool
	AfterAction    bool
	PostProcessing PostProcessingOptions
}

ScreenshotOptions controls screenshot behavior.

type TestCase

type TestCase func(ctx context.Context, url string) error

TestCase defines a function that runs a test.

type TestContext

type TestContext struct {
	ID                int
	SuiteName         string
	TestName          string
	GroupName         string
	ActionName        string
	TestStep          int
	ScreenshotOptions ScreenshotOptions
}

func MustGetTestContext

func MustGetTestContext(ctx context.Context) TestContext

type TestSuite

type TestSuite map[string]TestCase

TestSuite is a dictionary of TestCase where the key is the test case name.

type TestSuites

type TestSuites map[string]TestSuite

TestSuites is a dictionary of TestSuite where the key is the test runSuite name.

type Title

type Title struct {
	SuiteName  string
	CaseName   string
	GroupName  string
	ActionName string
	Step       int
}