TestBroker Class
Contains methods that simulate the successful delivery or failed
publishing of platform event or change event messages in an Apex test.
Namespace
TestBroker Methods
The following are methods for TestBroker.
deliver()
Delivers platform event messages to the test event bus. Use this
method to deliver test event messages multiple times and verify that event subscribers have
processed the test events each step of the way.
Signature
public void deliver()
Return Value
Type: void
Usage
Enclose Test.getEventBus().deliver() within the Test.startTest() and Test.stopTest() statement block.
Test.startTest();
// Create test events
// ...
// Publish test events with EventBus.publish()
// ...
// Deliver test events
Test.getEventBus().deliver();
// Perform validation
// ...
Test.stopTest();
fail()
Causes the publishing of platform event messages to fail in the test event bus. Use
this method to test Apex publish callbacks.
Signature
public void fail()
Return Value
Type: void
Usage
// Create test events
// ...
// Publish test events with EventBus.publish()
// ...
// Fail publishing of test events
Test.getEventBus().fail();
// Perform validation
// ...
For more information, see <link>Get the Result of Asynchronous Platform Event Publishing with Apex Publish Callbacks<link/> in the Platform Events Developer Guide.