-
Notifications
You must be signed in to change notification settings - Fork 21
/
MessageTrait.php
293 lines (243 loc) · 10.6 KB
/
MessageTrait.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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<?php
namespace Http\Psr7Test;
use InvalidArgumentException;
use PHPUnit\Framework\AssertionFailedError;
use Psr\Http\Message\MessageInterface;
use Throwable;
use TypeError;
/**
* Test MessageInterface.
*
* @author Tobias Nyholm <tobias.nyholm@gmail.com>
*/
trait MessageTrait
{
/**
* @return MessageInterface
*/
abstract protected function getMessage();
public function testProtocolVersion()
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
$initialMessage = $this->getMessage();
$original = clone $initialMessage;
$message = $initialMessage->withProtocolVersion('1.0');
$this->assertNotSameObject($initialMessage, $message);
$this->assertEquals($initialMessage, $original, 'Message object MUST not be mutated');
$this->assertSame('1.0', $message->getProtocolVersion());
}
public function testGetHeaders()
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
$initialMessage = $this->getMessage();
$original = clone $initialMessage;
$message = $initialMessage
->withAddedHeader('content-type', 'text/html')
->withAddedHeader('content-type', 'text/plain');
$this->assertEquals($initialMessage, $original, 'Message object MUST not be mutated');
$headers = $message->getHeaders();
$this->assertTrue(isset($headers['content-type']));
$this->assertCount(2, $headers['content-type']);
$this->assertContains('text/html', $headers['content-type']);
$this->assertContains('text/plain', $headers['content-type']);
}
public function testHasHeader()
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
$message = $this->getMessage()->withAddedHeader('content-type', 'text/html');
$this->assertTrue($message->hasHeader('content-type'));
$this->assertTrue($message->hasHeader('Content-Type'));
$this->assertTrue($message->hasHeader('ConTent-Type'));
}
public function testGetHeader()
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
$message = $this->getMessage()->withAddedHeader('content-type', 'text/html');
$message = $message->withAddedHeader('content-type', 'text/plain');
$this->assertCount(2, $message->getHeader('content-type'));
$this->assertCount(2, $message->getHeader('Content-Type'));
$this->assertCount(2, $message->getHeader('CONTENT-TYPE'));
$emptyHeader = $message->getHeader('Bar');
$this->assertCount(0, $emptyHeader);
$this->assertIsArray($emptyHeader);
}
public function testGetHeaderLine()
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
$message = $this->getMessage()->withAddedHeader('content-type', 'text/html');
$message = $message->withAddedHeader('content-type', 'text/plain');
$this->assertMatchesRegexp('|text/html, ?text/plain|', $message->getHeaderLine('content-type'));
$this->assertMatchesRegexp('|text/html, ?text/plain|', $message->getHeaderLine('Content-Type'));
$this->assertMatchesRegexp('|text/html, ?text/plain|', $message->getHeaderLine('CONTENT-TYPE'));
$this->assertSame('', $message->getHeaderLine('Bar'));
}
public function testWithHeader()
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
$initialMessage = $this->getMessage();
$original = clone $initialMessage;
$message = $initialMessage->withHeader('content-type', 'text/html');
$this->assertNotSameObject($initialMessage, $message);
$this->assertEquals($initialMessage, $original, 'Message object MUST not be mutated');
$this->assertEquals('text/html', $message->getHeaderLine('content-type'));
$message = $initialMessage->withHeader('content-type', 'text/plain');
$this->assertEquals('text/plain', $message->getHeaderLine('content-type'));
$message = $initialMessage->withHeader('Content-TYPE', 'text/script');
$this->assertEquals('text/script', $message->getHeaderLine('content-type'));
$message = $initialMessage->withHeader('x-foo', ['bar', 'baz']);
$this->assertMatchesRegexp('|bar, ?baz|', $message->getHeaderLine('x-foo'));
$message = $initialMessage->withHeader('Bar', '');
$this->assertTrue($message->hasHeader('Bar'));
$this->assertSame([''], $message->getHeader('Bar'));
}
/**
* @dataProvider getInvalidHeaderArguments
*/
public function testWithHeaderInvalidArguments($name, $value)
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
try {
$initialMessage = $this->getMessage();
$initialMessage->withHeader($name, $value);
$this->fail('withHeader() should have raised exception on invalid argument');
} catch (AssertionFailedError $e) {
// invalid argument not caught
throw $e;
} catch (TypeError|InvalidArgumentException $e) {
// valid
$this->assertTrue($e instanceof Throwable);
} catch (Throwable $e) {
// invalid
$this->fail(sprintf(
'Unexpected exception (%s) thrown from withHeader(); expected TypeError or InvalidArgumentException',
gettype($e)
));
}
}
public static function getInvalidHeaderArguments()
{
return [
[[], 'foo'],
['foo', []],
['', ''],
['foo', false],
[false, 'foo'],
['foo', new \stdClass()],
[new \stdClass(), 'foo'],
];
}
public function testWithAddedHeader()
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
$message = $this->getMessage()->withAddedHeader('content-type', 'text/html');
$message = $message->withAddedHeader('CONTENT-type', 'text/plain');
$this->assertMatchesRegexp('|text/html, ?text/plain|', $message->getHeaderLine('content-type'));
$this->assertMatchesRegexp('|text/html, ?text/plain|', $message->getHeaderLine('Content-Type'));
}
/**
* @dataProvider getInvalidHeaderArguments
*/
public function testWithAddedHeaderInvalidArguments($name, $value)
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
try {
$initialMessage = $this->getMessage();
$initialMessage->withAddedHeader($name, $value);
$this->fail('withAddedHeader() should have raised exception on invalid argument');
} catch (AssertionFailedError $e) {
// invalid argument not caught
throw $e;
} catch (TypeError|InvalidArgumentException $e) {
// valid
$this->assertTrue($e instanceof Throwable);
} catch (Throwable $e) {
// invalid
$this->fail(sprintf(
'Unexpected exception (%s) thrown from withAddedHeader(); expected TypeError or InvalidArgumentException',
gettype($e)
));
}
}
/**
* Make sure we maintain headers when we add array values.
*/
public function testWithAddedHeaderArrayValue()
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
$message = $this->getMessage()->withAddedHeader('content-type', 'text/html');
$message = $message->withAddedHeader('content-type', ['text/plain', 'application/json']);
$headerLine = $message->getHeaderLine('content-type');
$this->assertMatchesRegexp('|text/html|', $headerLine);
$this->assertMatchesRegexp('|text/plain|', $headerLine);
$this->assertMatchesRegexp('|application/json|', $headerLine);
}
/**
* Make sure we maintain headers when we add array values with keys.
*/
public function testWithAddedHeaderArrayValueAndKeys()
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
$message = $this->getMessage()->withAddedHeader('content-type', ['foo' => 'text/html']);
$message = $message->withAddedHeader('content-type', ['foo' => 'text/plain', 'bar' => 'application/json']);
$headerLine = $message->getHeaderLine('content-type');
$this->assertMatchesRegexp('|text/html|', $headerLine);
$this->assertMatchesRegexp('|text/plain|', $headerLine);
$this->assertMatchesRegexp('|application/json|', $headerLine);
}
public function testWithoutHeader()
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
$message = $this->getMessage()->withAddedHeader('content-type', 'text/html');
$message = $message->withAddedHeader('Age', '0');
$message = $message->withAddedHeader('X-Foo', 'bar');
$headers = $message->getHeaders();
$headerCount = count($headers);
$this->assertTrue(isset($headers['Age']));
// Remove a header
$message = $message->withoutHeader('age');
$headers = $message->getHeaders();
$this->assertCount($headerCount - 1, $headers);
$this->assertFalse(isset($headers['Age']));
}
public function testBody()
{
if (isset($this->skippedTests[__FUNCTION__])) {
$this->markTestSkipped($this->skippedTests[__FUNCTION__]);
}
$initialMessage = $this->getMessage();
$original = clone $initialMessage;
$stream = $this->buildStream('foo');
$message = $initialMessage->withBody($stream);
$this->assertNotSameObject($initialMessage, $message);
$this->assertEquals($initialMessage, $original, 'Message object MUST not be mutated');
$this->assertEquals($stream, $message->getBody());
}
private function assertMatchesRegexp(string $pattern, string $string, string $message = ''): void
{
$this->assertMatchesRegularExpression($pattern, $string, $message);
}
}