CommandExpectations
in package
implements
CommandSubscriber
Spec test CommandStartedEvent expectations.
Interfaces, Classes, Traits and Enums
- CommandSubscriber
Table of Contents
- $actualEvents : array<string|int, mixed>
- $expectedEvents : array<string|int, mixed>
- $ignoreCommandFailed : bool
- $ignoreCommandStarted : bool
- $ignoreCommandSucceeded : bool
- $ignoredCommandNames : array<string|int, string>
- $ignoreExtraEvents : bool
- $ignoreKeyVaultListCollections : bool
- assert() : void
- Assert that the command expectations match the monitored events.
- commandFailed() : void
- Not used.
- commandStarted() : void
- Tracks outgoing commands for spec test APM assertions.
- commandSucceeded() : void
- Not used.
- fromChangeStreams() : mixed
- fromClientSideEncryption() : mixed
- fromCommandMonitoring() : mixed
- fromCrud() : mixed
- fromReadWriteConcern() : mixed
- fromRetryableReads() : mixed
- fromTransactions() : mixed
- startMonitoring() : void
- Start command monitoring.
- stopMonitoring() : void
- Stop command monitoring.
- __construct() : mixed
- isEventIgnored() : mixed
Properties
$actualEvents
private
array<string|int, mixed>
$actualEvents
= []
$expectedEvents
private
array<string|int, mixed>
$expectedEvents
= []
$ignoreCommandFailed
private
bool
$ignoreCommandFailed
= false
$ignoreCommandStarted
private
bool
$ignoreCommandStarted
= false
$ignoreCommandSucceeded
private
bool
$ignoreCommandSucceeded
= false
$ignoredCommandNames
private
array<string|int, string>
$ignoredCommandNames
= []
$ignoreExtraEvents
private
bool
$ignoreExtraEvents
= false
$ignoreKeyVaultListCollections
private
bool
$ignoreKeyVaultListCollections
= false
Methods
assert()
Assert that the command expectations match the monitored events.
public
assert(FunctionalTestCase $test, Context $context) : void
Parameters
- $test : FunctionalTestCase
-
Test instance
- $context : Context
-
Execution context
Return values
void —commandFailed()
Not used.
public
commandFailed(CommandFailedEvent $event) : void
Parameters
- $event : CommandFailedEvent
Tags
Return values
void —commandStarted()
Tracks outgoing commands for spec test APM assertions.
public
commandStarted(CommandStartedEvent $event) : void
Parameters
- $event : CommandStartedEvent
Tags
Return values
void —commandSucceeded()
Not used.
public
commandSucceeded(CommandSucceededEvent $event) : void
Parameters
- $event : CommandSucceededEvent
Tags
Return values
void —fromChangeStreams()
public
static fromChangeStreams(array<string|int, mixed> $expectedEvents) : mixed
Parameters
- $expectedEvents : array<string|int, mixed>
Return values
mixed —fromClientSideEncryption()
public
static fromClientSideEncryption(array<string|int, mixed> $expectedEvents) : mixed
Parameters
- $expectedEvents : array<string|int, mixed>
Return values
mixed —fromCommandMonitoring()
public
static fromCommandMonitoring(array<string|int, mixed> $expectedEvents) : mixed
Parameters
- $expectedEvents : array<string|int, mixed>
Return values
mixed —fromCrud()
public
static fromCrud(array<string|int, mixed> $expectedEvents) : mixed
Parameters
- $expectedEvents : array<string|int, mixed>
Return values
mixed —fromReadWriteConcern()
public
static fromReadWriteConcern(array<string|int, mixed> $expectedEvents) : mixed
Parameters
- $expectedEvents : array<string|int, mixed>
Return values
mixed —fromRetryableReads()
public
static fromRetryableReads(array<string|int, mixed> $expectedEvents) : mixed
Parameters
- $expectedEvents : array<string|int, mixed>
Return values
mixed —fromTransactions()
public
static fromTransactions(array<string|int, mixed> $expectedEvents) : mixed
Parameters
- $expectedEvents : array<string|int, mixed>
Return values
mixed —startMonitoring()
Start command monitoring.
public
startMonitoring() : void
Return values
void —stopMonitoring()
Stop command monitoring.
public
stopMonitoring() : void
Return values
void —__construct()
private
__construct(array<string|int, mixed> $events) : mixed
Parameters
- $events : array<string|int, mixed>
Return values
mixed —isEventIgnored()
private
isEventIgnored(mixed $event) : mixed
Parameters
- $event : mixed