Event API
This reference lists the events that plugins and reporters receive during a run.
These signatures are the public API.
Event
Namespace: Greenlight\Core\Event
Add new event types only. Do not replace or remove an event type.
interface Event extends WireSerializable$occurredAt
Returns a Unix timestamp with microsecond precision.
public float $occurredAt { get; }RecycleReason
Namespace: Greenlight\Core\Event
enum RecycleReason: stringTestCount
case TestCount = 'test-count';Memory
case Memory = 'memory';Crash
case Crash = 'crash';RunFinished
Namespace: Greenlight\Core\Event
final readonly class RunFinished implements Event$runId
public string $runId;PHPDoc:
@var non-empty-string
__construct()
public function __construct(
string $runId,
public ResultSummary $summary,
public float $durationSeconds,
public float $occurredAt,
)PHPDoc:
@throws \InvalidArgumentException
toWire()
[\Override]
public function toWire(): arrayfromWire()
[\Override]
public static function fromWire(array $payload): staticRunStarted
Namespace: Greenlight\Core\Event
final readonly class RunStarted implements Event$runId
public string $runId;PHPDoc:
@var non-empty-string
$plannedTests
public int $plannedTests;PHPDoc:
@var non-negative-int
$workers
public int $workers;PHPDoc:
@var positive-int
__construct()
public function __construct(
string $runId,
int $plannedTests,
int $workers,
public float $occurredAt,
public ?string $artifactsDirectory = null,
)PHPDoc:
@throws \InvalidArgumentException
toWire()
[\Override]
public function toWire(): arrayfromWire()
[\Override]
public static function fromWire(array $payload): staticSuiteFinished
Namespace: Greenlight\Core\Event
final readonly class SuiteFinished implements Event$suite
public string $suite;PHPDoc:
@var non-empty-string
__construct()
public function __construct(string $suite, public float $occurredAt)PHPDoc:
@throws \InvalidArgumentException
toWire()
[\Override]
public function toWire(): arrayfromWire()
[\Override]
public static function fromWire(array $payload): staticSuiteStarted
Namespace: Greenlight\Core\Event
final readonly class SuiteStarted implements Event$suite
public string $suite;PHPDoc:
@var non-empty-string
__construct()
public function __construct(string $suite, public float $occurredAt)PHPDoc:
@throws \InvalidArgumentException
toWire()
[\Override]
public function toWire(): arrayfromWire()
[\Override]
public static function fromWire(array $payload): staticTestClassFinished
Namespace: Greenlight\Core\Event
final readonly class TestClassFinished implements Event$class
public string $class;PHPDoc:
@var non-empty-string
__construct()
public function __construct(
string $class,
public float $occurredAt,
public string $workerId = '',
)PHPDoc:
@param string $workerId The worker that ran the class, or an empty string from a producer without worker attribution@throws \InvalidArgumentException
toWire()
[\Override]
public function toWire(): arrayfromWire()
[\Override]
public static function fromWire(array $payload): staticTestClassStarted
Namespace: Greenlight\Core\Event
final readonly class TestClassStarted implements Event$class
public string $class;PHPDoc:
@var non-empty-string
__construct()
public function __construct(
string $class,
public float $occurredAt,
public string $workerId = '',
)PHPDoc:
@param string $workerId The worker that ran the class, or an empty string from a producer without worker attribution@throws \InvalidArgumentException
toWire()
[\Override]
public function toWire(): arrayfromWire()
[\Override]
public static function fromWire(array $payload): staticTestFinished
Namespace: Greenlight\Core\Event
final readonly class TestFinished implements Event__construct()
public function __construct(public TestResult $result, public float $occurredAt)toWire()
[\Override]
public function toWire(): arrayfromWire()
[\Override]
public static function fromWire(array $payload): staticTestStarted
Namespace: Greenlight\Core\Event
final readonly class TestStarted implements Event__construct()
public function __construct(public TestId $id, public float $occurredAt)toWire()
[\Override]
public function toWire(): arrayfromWire()
[\Override]
public static function fromWire(array $payload): staticWorkerRecycled
Namespace: Greenlight\Core\Event
final readonly class WorkerRecycled implements Event$workerId
public string $workerId;PHPDoc:
@var non-empty-string
__construct()
public function __construct(
string $workerId,
public RecycleReason $reason,
public float $occurredAt,
)PHPDoc:
@throws \InvalidArgumentException
toWire()
[\Override]
public function toWire(): arrayfromWire()
[\Override]
public static function fromWire(array $payload): staticWorkerSpawned
Namespace: Greenlight\Core\Event
final readonly class WorkerSpawned implements Event$workerId
public string $workerId;PHPDoc:
@var non-empty-string
$pid
public int $pid;PHPDoc:
@var positive-int
__construct()
public function __construct(
string $workerId,
int $pid,
public float $occurredAt,
)PHPDoc:
@throws \InvalidArgumentException
toWire()
[\Override]
public function toWire(): arrayfromWire()
[\Override]
public static function fromWire(array $payload): static