internal

Documentation

Overview

Package internal implements the uptest runtime for running automated tests using resource example manifests using chainsaw.

Index

• type Preparer
  • func NewPreparer(testFilePaths []string, opts ...PreparerOption) *Preparer
  • func (p *Preparer) PrepareManifests() ([]config.Manifest, error)
• type PreparerOption
  • func WithDataSource(path string) PreparerOption
  • func WithTestDirectory(path string) PreparerOption
• type Tester
  • func NewTester(ms []config.Manifest, opts *config.AutomatedTest) *Tester
  • func (t *Tester) ExecuteTests() error

Types

type Preparer

type Preparer struct {
	// contains filtered or unexported fields
}

Preparer represents a structure used to prepare testing environments or configurations.

func NewPreparer

func NewPreparer(testFilePaths []string, opts ...PreparerOption) *Preparer

NewPreparer creates a new Preparer instance with the provided test file paths and optional configurations. It applies any provided PreparerOption functions to customize the Preparer.

func (*Preparer) PrepareManifests

func (p *Preparer) PrepareManifests() ([]config.Manifest, error)

PrepareManifests prepares and processes manifests from test files. It performs the following steps: 1. Cleans and recreates the case directory. 2. Injects variables into test files. 3. Decodes, processes, and validates each manifest file, skipping any that require manual intervention. 4. Returns the processed manifests or an error if any step fails.

type PreparerOption

type PreparerOption func(*Preparer)

PreparerOption is a functional option type for configuring a Preparer.

func WithDataSource

func WithDataSource(path string) PreparerOption

WithDataSource is a functional option that sets the data source path for the Preparer.

func WithTestDirectory

func WithTestDirectory(path string) PreparerOption

WithTestDirectory is a functional option that sets the test directory for the Preparer.

type Tester

type Tester struct {
	// contains filtered or unexported fields
}

Tester is responsible preparing and storing the test data&configurations, and executing the tests.

func NewTester

func NewTester(ms []config.Manifest, opts *config.AutomatedTest) *Tester

NewTester returns a Tester object.

func (*Tester) ExecuteTests

func (t *Tester) ExecuteTests() error

ExecuteTests execute tests via chainsaw.