package
0.0.0-20230226003218-1dd1f65bfa42
Repository: https://github.com/c4-project/c4t.git
Documentation: pkg.go.dev
# Packages
Package pathset contains the various path-sets for the director.
# Functions
ConfigFromGlobal extracts the parts of a global config file relevant to a director, and builds a config from them.
CycleErrorMessage constructs a CycleError message with cycle c and error err.
CycleFinishMessage constructs a CycleFinish message with cycle c.
CycleStartMessage constructs a CycleStart message with cycle c.
FilterMachines filters the director's machine set with glob.
Filters adds fs to the set of filters to use for any analyses this director runs.
FiltersFromFile loads a filter set from path, if it is non-blank.
FuzzerConfig sets the fuzzer configuration to cfg.
InstanceClosedMessage constructs an InstanceMessage stating that the instance has closed.
InstanceMutantMessage constructs an InstanceMessage stating that the instance has changed mutant to m.
LowerToAnalyser lowers a slice of instance observers to a slice of analyser observers.
LowerToBuilder lowers a slice of instance observers to a slice of builder observers.
LowerToCopy lowers a slice of instance observers to a slice of copy observers.
LowerToMach lowers a slice of director observers to a slice of machine node observers.
LowerToMachine lowers a slice of director observers to a slice of machine observers.
LowerToPerturber lowers a slice of instance observers to a slice of perturber observers.
LowerToPlanner lowers a slice of director observers to a slice of planner observers.
LowerToPrepare lowers a slice of director observers to a slice of prepare observers.
LowerToSaver lowers a slice of instance observers to a slice of saver observers.
New creates a new Director with driver set e, input paths files, machines ms, and options opt.
ObserveWith adds obs to the director's observer pool.
OnCycle sends a cycle message to every instance observer in obs.
OnInstance sends OnInstance to each observer in obs.
OnPrepare sends OnPrepare to every observer in obs.
Options bundles the separate options ops into a single option.
OutDir sets the director's paths relative to dir.
OverrideQuantities overrides the director's quantities with qs.
PrepareInstancesMessage creates a PrepareMessage with kind PrepareInstances and instance count ninst.
PreparePathsMessage creates a PrepareMessage with kind PreparePaths and path set ps.
PrepareQuantitiesMessage creates a PrepareMessage with kind PrepareQuantities and quantity set qs.
PrepareStartMessage creates a PrepareMessage with kind PrepareStart and start time dl.
PrepareTimeoutMessage creates a PrepareMessage with kind PrepareTimeout and experiment deadline dl.
SSH sets the director's SSH config to s.
# Constants
CycleError denotes a message carrying an error from a cycle (replacing CycleFinish).
CycleFinish denotes the successful completion of a cycle.
CycleStart denotes the start of a cycle.
KindInstanceClosed means that the instance has closed.
KindInstanceMutant means that the instance has changed to a new mutant (in Mutant).
PrepareInstances states that the director is preparing its instance set; NumInstances is set.
PreparePaths states that the director is about to make its top-level paths; Paths is set.
PrepareQuantities states the director's quantity set; Quantities is set.
PrepareStart states that the director has started experiments; Time is set.
PrepareTimeout states that the director has a global timeout; Time is set.
# Variables
ErrNoMachines occurs when we try to build a director without defining any machines defined.
ErrNoOutDir occurs when we try to build a director with no output directory specified in the config.
ErrObserverNil occurs when we try to pass a nil observer as an option.
# Structs
Cycle contains information about a particular test cycle.
CycleAnalysis contains an analysis as well as the cycle that produced it.
CycleMessage is the type of observer messages pertaining to the control flow of a specific cycle.
Director contains the main state and configuration for the test director.
Env groups together the bits of configuration that pertain to dealing with the environment.
Instance contains the state necessary to run a single loop of a director.
InstanceMessage is the type of observer messages pertaining to the control flow of an instance.
Machine contains the state for a particular machine attached to an instance.
PrepareMessage is a message from the director stating some aspect of its pre-experiment preparation.
# Interfaces
CycleObserver is an interface for types that observe cycles.
InstanceObserver is an interface for types that observe a director instance.
Observer is an interface for types that implement multi-machine test progress observation.
PrepareObserver is an interface for types that observer director preparations.
# Type aliases
CycleMessageKind is the enumeration of kinds of cycle message.
InstanceMessageKind is the enumeration of kinds of instance message.
Option is the type of options for the director.
PrepareKind is the enumeration of kinds of PrepareMessage.