package
2.23.0
Repository: https://github.com/onsi/ginkgo.git
Documentation: pkg.go.dev

# Functions

BuildBuildCommandFlagSet builds the FlagSet for the `ginkgo build` command.
BuildRunCommandFlagSet builds the FlagSet for the `ginkgo run` command.
BuildTestSuiteFlagSet attaches to the CommandLine flagset and provides flags for the Ginkgo test process.
BuildWatchCommandFlagSet builds the FlagSet for the `ginkgo watch` command.
given a set of GinkgoFlags and bindings, generate flag arguments suitable to be passed to an application with that set of flags configured.
GenerateGinkgoTestRunArgs is used by the Ginkgo CLI to generate command line arguments to pass to the compiled Ginkgo test binary.
GenerateGoTestCompileArgs is used by the Ginkgo CLI to generate command line arguments to pass to the go test -c command when compiling the test.
GenerateGoTestRunArgs is used by the Ginkgo CLI to generate command line arguments to pass to the compiled non-Ginkgo test binary.
MarkAsHelper is used by GinkgoHelper to mark the caller (appropriately offset by skip)as a helper.
Call NewGinkgoFlagSet to create GinkgoFlagSet that extends an existing *flag.FlagSet.
Call NewGinkgoFlagSet to create GinkgoFlagSet that creates and binds to it's own *flag.FlagSet.
PruneStack removes references to functions that are internal to Ginkgo and the Go runtime from a stack string and a certain number of stack entries at the beginning of the stack.
VetAndInitializeCLIAndGoConfig validates that the Ginkgo CLI's configuration is sound It returns a potentially mutated copy of the config that rationalizes the configuration to ensure consistency for downstream consumers.
VetConfig validates that the Ginkgo test process' configuration is sound.

# Constants

# Variables

Flags sections used by both the CLI and the Ginkgo test process.
GinkgoCLIRunAndWatchFlags provides flags shared by the Ginkgo CLI's build and watch commands (but not run).
GinkgoCLIRunFlags provides flags for Ginkgo CLI's run command that aren't shared by any other commands.
GinkgoCLISharedFlags provides flags shared by the Ginkgo CLI's build, watch, and run commands.
GinkgoCLIRunFlags provides flags for Ginkgo CLI's watch command that aren't shared by any other commands.
GoBuildFlags provides flags for the Ginkgo CLI build, run, and watch commands that capture go's build-time flags.
GoRunFlags provides flags for the Ginkgo CLI run, and watch commands that capture go's run-time flags.
ParallelConfigFlags provides flags for the Ginkgo test process (not the CLI).
ReporterConfigFlags provides flags for the Ginkgo test process, and CLI.
SuiteConfigFlags provides flags for the Ginkgo test process, and CLI.

# Structs

AdditionalFailure capturs any additional failures that occur after the initial failure of a psec these typically occur in clean up nodes after the spec has failed.
Configuration for the Ginkgo CLI.
Failure captures failure information for an individual test.
Configuration for the Ginkgo CLI capturing available go flags A subset of Go flags are exposed by Ginkgo.
PreRunStats contains a set of stats captured before the test run begins.
ProgressReport captures the progress of the current spec.
Report captures information about a Ginkgo test run.
ReportEntry captures information attached to `SpecReport` via `AddReportEntry`.
ReportEntryValue wraps a report entry's value ensuring it can be encoded and decoded safely into reports and across the network connection when running in parallel.
Configuration for Ginkgo's reporter.
SpecEvent captures a vareity of events that can occur when specs run.
SpecReport captures information about a Ginkgo spec.
Configuration controlling how an individual test suite is run.
TimelineLocation captures the location of an event in the spec's timeline.

# Interfaces

ColorableStringer is an interface that ReportEntry values can satisfy.
TimelineEvent represent an event on the timeline consumers of Timeline will need to check the concrete type of each entry to determine how to handle it.

# Type aliases

FailureNodeContext captures the location context for the node containing the failing line of code.
NodeType captures the type of a given Ginkgo Node.
ReportEntryVisibility governs the visibility of ReportEntries in Ginkgo's console reporter.
SpecState captures the state of a spec To determine if a given `state` represents a failure state, use `state.Is(SpecStateFailureStates)`.