 |
VOOZH | about |
|
VOOZH | about |
This document explains how to test code that pushes jobs to queues without actually executing them. The Queue::fake() method replaces the real queue manager with a test double that records all pushed jobs and provides assertion methods for verifying queue interactions.
For general testing patterns and concepts, see Testing Overview. For testing other facades, see Event Testing and HTTP Client Testing.
The queue testing infrastructure allows you to verify that your application pushes the correct jobs to queues without actually dispatching them to queue workers. This enables fast, isolated unit tests that validate queue interaction logic.
Sources: src/Facades/Queue.php1-114
The Queue::fake() method replaces the queue manager with a test double that intercepts all queue operations:
The fake is implemented in src/Facades/Queue.php91-104 which creates a QueueFake instance and swaps it into the service container using the swap() method.
You can fake only specific job types while allowing others to execute normally:
Alternatively, use the except() method to fake all jobs except specific ones:
Sources: src/Facades/Queue.php91-104 src/Facades/Queue.php58
The QueueFake provides comprehensive assertion methods for verifying queue interactions. All assertions are available as static methods on the Queue facade after calling fake().
Verifies that a specific job type was pushed to any queue:
The method signature from src/Facades/Queue.php59:
Verifies that a job was pushed to a specific queue:
Sources: src/Facades/Queue.php60
Verifies that a job was pushed with a specific chain of subsequent jobs:
Sources: src/Facades/Queue.php61
Verifies that a job was pushed without any chained jobs:
Sources: src/Facades/Queue.php62
Verifies that closure-based jobs were or were not pushed:
Sources: src/Facades/Queue.php63-64
Verifies that a specific job type was never pushed:
Sources: src/Facades/Queue.php65
Verifies the total number of jobs pushed across all queues:
Sources: src/Facades/Queue.php66
Verifies that no jobs were pushed to any queue:
Sources: src/Facades/Queue.php67
In addition to assertions, QueueFake provides methods for inspecting pushed jobs programmatically.
| Method | Purpose | Parameters |
|---|---|---|
assertPushed() | Verify job was pushed | Job class, optional callback/count |
assertPushedOn() | Verify job pushed to specific queue | Queue name, job class, optional callback |
assertPushedWithChain() | Verify job has specific chain | Job class, chain array, optional callback |
assertPushedWithoutChain() | Verify job has no chain | Job class, optional callback |
assertClosurePushed() | Verify closure job pushed | Optional callback/count |
assertClosureNotPushed() | Verify no closure jobs | Optional callback |
assertNotPushed() | Verify job not pushed | Job class, optional callback |
assertCount() | Verify total job count | Expected count |
assertNothingPushed() | Verify no jobs pushed | None |
Returns a collection of all pushed jobs of a specific type:
Sources: src/Facades/Queue.php68
Checks if any jobs of a specific type were pushed:
Sources: src/Facades/Queue.php69
Returns all pushed jobs organized by job class:
Sources: src/Facades/Queue.php71
Use serializeAndRestore() to test that jobs can be properly serialized and unserialized, mimicking the actual queue behavior:
This ensures your jobs handle serialization correctly, catching issues with closures, resources, or other non-serializable data.
Sources: src/Facades/Queue.php72
Determine if job faking should apply to a specific job instance:
Sources: src/Facades/Queue.php70
Sources: src/Facades/Queue.php91-104
The QueueFake intercepts all standard queue methods:
| Method | Description | Usage in Tests |
|---|---|---|
push() | Push job immediately | Queue::push(new Job()) |
pushOn() | Push to specific queue | Queue::pushOn('high', new Job()) |
pushRaw() | Push raw payload | Queue::pushRaw($payload) |
later() | Push with delay | Queue::later(60, new Job()) |
laterOn() | Push delayed to queue | Queue::laterOn('low', 60, new Job()) |
bulk() | Push multiple jobs | Queue::bulk([new Job1(), new Job2()]) |
All of these methods are recorded by QueueFake and can be verified with assertions.
Sources: src/Facades/Queue.php41-46
Sources: src/Facades/Queue.php41-46 src/Facades/Queue.php59-71
The QueueFake class, referenced in src/Facades/Queue.php10 implements the queue contract while recording all operations:
Hypervel\Support\Testing\Fakes\QueueFake
├── Constructor receives:
│ ├── ContainerInterface $container
│ ├── array|string $jobsToFake
│ └── QueueManager $actualQueue (for non-faked jobs)
├── Records job pushes with:
│ ├── Job instance
│ ├── Queue name
│ ├── Delay timing
│ └── Chained jobs
└── Provides assertion/inspection methods
The Queue::fake() method src/Facades/Queue.php91-104 performs the following steps:
isFake())QueueFake instance with dependenciestap() helper for fluent interfaceswap() to replace facade rootSources: src/Facades/Queue.php91-104 src/Facades/Queue.php10
For comprehensive testing of asynchronous operations:
Event::fake()Http::fake()shouldReceive()Sources: src/Facades/Queue.php1-114
Refresh this wiki