tester

Documentation

Overview

package tester implements support for testing Serulian code.

Index

• func DecorateRunners(command *cobra.Command, vcsDevelopmentDirectories *[]string)
• func RegisterRunner(name string, runner TestRunner)
• type TestRunner

Functions

func DecorateRunners

func DecorateRunners(command *cobra.Command, vcsDevelopmentDirectories *[]string)

DecorateRunners decorates the test command with a command for each runner.

func RegisterRunner

func RegisterRunner(name string, runner TestRunner)

RegisterRunner registers a test runner with the specific name.

Types

type TestRunner

type TestRunner interface {
	// Title is a human-readable title for the test runner.
	Title() string

	// DecorateCommand decorates the cobra command for the runner with the runner-specific
	// options.
	DecorateCommand(command *cobra.Command)

	// SetupIfNecessary is run before any test runs occur to run the setup process
	// for the runner (if necessary). This method should no-op if all necessary
	// dependencies are in place.
	SetupIfNecessary(testingEnvDirectoryPath string) error

	// Run runs the test runner over the generated ES path.
	Run(testingEnvDirectoryPath string, generatedFilePath string) (bool, error)
}

TestRunner defines an interface for the test runner.