StepState class

The state of a step during and after the run, shared with the reporters

Only the runner changes the state, the reporters read it

Constructors

StepState({required PipeStep step, required PipeStage stage, required String number, required bool isLast, StepState? parent})

Properties

children → List<StepState>
The steps of a StepGroup, empty for the other steps
final
depth → int
The number of groups the step is in
no setter
elapsed → Duration
The time the step has been running for, or took to run once it is finished
no setter
error ↔ StepError?
Set when the step has failed
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
isFinished → bool
no setter
isLast → bool
Whether the step is the last of its stage, or of its group
final
number → String
The position of the step in the run, e.g. 3 for the third step and 3.2 for the second step of its group
final
parent → StepState?
The group the step belongs to, if any
final
path → List<String>
The title of the stage, the labels of the groups the step is in, and the label of the step, e.g. [Build, Web, Cache bust]
no setter
recentOutput → List<String>
The last lines of the output of the commands run by the step, at most recentOutputLimit
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
skipReason ↔ String?
Set when the step has been skipped
getter/setter pair
stage → PipeStage
final
status ↔ StepStatus
getter/setter pair
statusText ↔ String?
What the step is doing at the moment, as reported by the step itself
getter/setter pair
step → PipeStep
final
tree → List<StepState>
The step followed by all the steps of its group, and of their groups, in the order they are shown
no setter
warningCount → int
The warnings of the step and of all the steps of its group
no setter
warnings → List<String>
final

Methods

addOutput(String line) → void
Called by the runner for each line of the output of a command
finish(StepError? error) → void
Called by the runner when the step ends, with the error if the step has failed
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
skip(String reason) → void
Called by the runner instead of start and finish when the step is not run
start() → void
Called by the runner when the step starts
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

recentOutputLimit → const int
The number of output lines kept for showing a failure