-
Notifications
You must be signed in to change notification settings - Fork 48
/
InteractsWithQueue.php
185 lines (159 loc) · 4.21 KB
/
InteractsWithQueue.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<?php
namespace Illuminate\Queue;
use DateTimeInterface;
use Illuminate\Contracts\Queue\Job as JobContract;
use Illuminate\Queue\Jobs\FakeJob;
use Illuminate\Support\InteractsWithTime;
use InvalidArgumentException;
use PHPUnit\Framework\Assert as PHPUnit;
use RuntimeException;
use Throwable;
trait InteractsWithQueue
{
use InteractsWithTime;
/**
* The underlying queue job instance.
*
* @var \Illuminate\Contracts\Queue\Job|null
*/
public $job;
/**
* Get the number of times the job has been attempted.
*
* @return int
*/
public function attempts()
{
return $this->job ? $this->job->attempts() : 1;
}
/**
* Delete the job from the queue.
*
* @return void
*/
public function delete()
{
if ($this->job) {
return $this->job->delete();
}
}
/**
* Fail the job from the queue.
*
* @param \Throwable|string|null $exception
* @return void
*/
public function fail($exception = null)
{
if (is_string($exception)) {
$exception = new ManuallyFailedException($exception);
}
if ($exception instanceof Throwable || is_null($exception)) {
if ($this->job) {
return $this->job->fail($exception);
}
} else {
throw new InvalidArgumentException('The fail method requires a string or an instance of Throwable.');
}
}
/**
* Release the job back into the queue after (n) seconds.
*
* @param \DateTimeInterface|\DateInterval|int $delay
* @return void
*/
public function release($delay = 0)
{
$delay = $delay instanceof DateTimeInterface
? $this->secondsUntil($delay)
: $delay;
if ($this->job) {
return $this->job->release($delay);
}
}
/**
* Indicate that queue interactions like fail, delete, and release should be faked.
*
* @return $this
*/
public function withFakeQueueInteractions()
{
$this->job = new FakeJob;
return $this;
}
/**
* Assert that the job was deleted from the queue.
*
* @return $this
*/
public function assertDeleted()
{
$this->ensureQueueInteractionsHaveBeenFaked();
PHPUnit::assertTrue(
$this->job->isDeleted(),
'Job was expected to be deleted, but was not.'
);
return $this;
}
/**
* Assert that the job was manually failed.
*
* @return $this
*/
public function assertFailed()
{
$this->ensureQueueInteractionsHaveBeenFaked();
PHPUnit::assertTrue(
$this->job->hasFailed(),
'Job was expected to be manually failed, but was not.'
);
return $this;
}
/**
* Assert that the job was released back onto the queue.
*
* @param \DateTimeInterface|\DateInterval|int $delay
* @return $this
*/
public function assertReleased($delay = null)
{
$this->ensureQueueInteractionsHaveBeenFaked();
$delay = $delay instanceof DateTimeInterface
? $this->secondsUntil($delay)
: $delay;
PHPUnit::assertTrue(
$this->job->isReleased(),
'Job was expected to be released, but was not.'
);
if (! is_null($delay)) {
PHPUnit::assertSame(
$delay,
$this->job->releaseDelay,
"Expected job to be released with delay of [{$delay}] seconds, but was released with delay of [{$this->job->releaseDelay}] seconds."
);
}
return $this;
}
/**
* Ensure that queue interactions have been faked.
*
* @return void
*/
private function ensureQueueInteractionsHaveBeenFaked()
{
if (! $this->job instanceof FakeJob) {
throw new RuntimeException('Queue interactions have not been faked.');
}
}
/**
* Set the base queue job instance.
*
* @param \Illuminate\Contracts\Queue\Job $job
* @return $this
*/
public function setJob(JobContract $job)
{
$this->job = $job;
return $this;
}
}