framework

Documentation

Index

• Variables
• func GitReleaseSegments(m *Metadata) (org, repo, tag string, err error)
• func HasPlatform(m Metadata, platform string) bool
• func PlatformNames(platforms []Platform) []string
• type ExactStrategy
  • func (s ExactStrategy) Find(ctx context.Context, svc MetadataService, frameworkName string, ...) (Metadata, error)
• type Framework
• type Metadata
• type MetadataSearchStrategy
  • func NewSearchStrategy(version string, rootDir string) MetadataSearchStrategy
• type MetadataService
• type PackageStrategy
  • func (s PackageStrategy) Find(ctx context.Context, svc MetadataService, frameworkName string, ...) (Metadata, error)
• type Platform
• type SearchOptions
• type UnavailableError
  • func (e *UnavailableError) Error() string

Variables

var (
	PackageFromFile = node.PackageFromFile
	NewConstraint   = semver.NewConstraint
)

Monkey patch functions to allow mocking during unit testing

Functions

func GitReleaseSegments

func GitReleaseSegments(m *Metadata) (org, repo, tag string, err error)

GitReleaseSegments segments GitRelease into separate parts of org, repo and tag. Returns an error if GitRelease is malformed. The expected GitRelease format is "org/repo:tag".

func HasPlatform

func HasPlatform(m Metadata, platform string) bool

HasPlatform returns true if the provided Metadata has a matching platform.

func PlatformNames

func PlatformNames(platforms []Platform) []string

PlatformNames extracts platform names from the given platforms and returns them.

Types

type ExactStrategy

type ExactStrategy struct {
}

ExactStrategy searches for the metadata of a framework by its exact version

func (ExactStrategy) Find

func (s ExactStrategy) Find(ctx context.Context, svc MetadataService, frameworkName string, frameworkVersion string) (Metadata, error)

type Framework

type Framework struct {
	Name    string
	Version string
}

Framework represents a test framework (e.g. cypress).

type Metadata

type Metadata struct {
	FrameworkName      string
	FrameworkVersion   string
	Deprecated         bool
	DockerImage        string
	GitRelease         string
	Platforms          []Platform
	CloudRunnerVersion string
	BrowserDefaults    map[string]string
}

Metadata represents test runner metadata.

type MetadataSearchStrategy

type MetadataSearchStrategy interface {
	Find(ctx context.Context, svc MetadataService, frameworkName string, searchValue string) (Metadata, error)
}

MetadataSearchStrategy is a generic strategy for determining if the requested framework version is supported

func NewSearchStrategy

func NewSearchStrategy(version string, rootDir string) MetadataSearchStrategy

NewSearchStrategy returns a concrete MetadataSearchStrategy

type MetadataService

type MetadataService interface {
	Search(ctx context.Context, opts SearchOptions) (Metadata, error)

	Frameworks(ctx context.Context) ([]Framework, error)
	Versions(ctx context.Context, frameworkName string) ([]Metadata, error)
}

MetadataService represents an interface for retrieving framework metadata.

type PackageStrategy

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

PackageStrategy searches for metadata of a framework from a package.json file. If the requested version is a range (e.g. ~9.0.0), it matches the most recent version that satisfies the constraint.

func (PackageStrategy) Find

func (s PackageStrategy) Find(ctx context.Context, svc MetadataService, frameworkName string, frameworkVersion string) (Metadata, error)

type Platform

type Platform struct {
	PlatformName string
	BrowserNames []string
}

Platform represent a supported platform.

type SearchOptions

type SearchOptions struct {
	Name             string
	FrameworkVersion string
}

SearchOptions represents read query options for MetadataService.Search().

type UnavailableError

type UnavailableError struct {
	Name    string
	Version string
}

UnavailableError is an error type returned if the requested framework version is unavailable.

func (*UnavailableError) Error

func (e *UnavailableError) Error() string

Error returns the error string