aboutsummaryrefslogtreecommitdiffstats
path: root/tests/phpunit/unit/includes/Rest/RequestDataTest.php
blob: cb9211c974a30613a80aa984c43a1e223285c6b9 (plain) (blame)
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
<?php

namespace MediaWiki\Tests\Rest;

use GuzzleHttp\Psr7\Uri;
use MediaWiki\Rest\RequestData;
use MediaWiki\Rest\StringStream;

/**
 * @covers \MediaWiki\Rest\RequestData
 */
class RequestDataTest extends \MediaWikiUnitTestCase {
	use RestTestTrait;

	public function testDefaultMethodIsGet() {
		$request = new RequestData( [] );
		$this->assertSame( 'GET', $request->getMethod() );
	}

	public function testGetMethod() {
		$request = new RequestData( [
			'method' => 'HEAD'
		] );
		$this->assertSame( 'HEAD', $request->getMethod() );
	}

	public function testDefaultProtocolVersion() {
		$request = new RequestData( [] );
		$this->assertSame( '1.1', $request->getProtocolVersion() );
	}

	public function testGetProtocolVersion() {
		$request = new RequestData( [
			'protocolVersion' => '3.0'
		] );
		$this->assertSame( '3.0', $request->getProtocolVersion() );
	}

	public function testDefaultServerParams() {
		$request = new RequestData( [] );
		$this->assertSame( [], $request->getServerParams() );
	}

	public function testGetServerParams() {
		$request = new RequestData( [
			'serverParams' => [ 'serverFoo' => 'serverBar' ]
		] );
		$this->assertSame( [ 'serverFoo' => 'serverBar' ], $request->getServerParams() );
	}

	public function testDefaultCookieParams() {
		$request = new RequestData( [] );
		$this->assertSame( [], $request->getCookieParams() );
	}

	public function testGetCookieParams() {
		$request = new RequestData( [
			'cookieParams' => 'cookieData'
		] );
		$this->assertSame( 'cookieData', $request->getCookieParams() );
	}

	public function testDefaultQueryParams() {
		$request = new RequestData( [] );
		$this->assertSame( [], $request->getQueryParams() );
	}

	public function testGetQueryParams() {
		$request = new RequestData( [
			'queryParams' => 'queryData'
		] );
		$this->assertSame( 'queryData', $request->getQueryParams() );
	}

	public function testDefaultHeaders() {
		$request = new RequestData( [] );
		$this->assertSame( [], $request->getHeaders() );
	}

	public function testGetHeaders() {
		$request = new RequestData( [
			'headers' => [ 'headersData' ]
		] );
		$this->assertSame( [ [ 'headersData' ] ], $request->getHeaders() );
	}

	public function testSetHeaders() {
		$request = new RequestData( [] );
		$request->setHeaders( [ 'Content-type' => 'application/json' ] );
		$this->assertSame( [ 'application/json' ], $request->getHeaders()[ 'Content-type' ] );
	}

	public function testDefaultUri() {
		$request = new RequestData( [] );
		$this->assertInstanceOf( Uri::class, $request->getUri() );
	}

	public function testGetUri() {
		$request = new RequestData( [
			'uri' => new Uri( '/rest/mock/RouterTest/hello' ),
		] );
		$this->assertInstanceOf( Uri::class, $request->getUri() );
		$this->assertSame( '/rest/mock/RouterTest/hello', $request->getUri()->__toString() );
	}

	public function testDefaultBody() {
		$request = new RequestData( [] );
		$this->assertInstanceOf( StringStream::class, $request->getBody() );
		$this->assertSame( "", $request->getBody()->getContents() );
	}

	public function testGetBody() {
		$request = new RequestData( [
			'bodyContents' => 'bodyContents',
		] );
		$this->assertInstanceOf( StringStream::class, $request->getBody() );
		$this->assertSame( "bodyContents", $request->getBody()->getContents() );
	}

	// Testing RequestBase functions
	public function testDefaultCookiePrefix() {
		$request = new RequestData( [] );
		$this->assertSame( '', $request->getCookiePrefix() );
	}

	public function testGetCookiePrefix() {
		$request = new RequestData( [
			'cookiePrefix' => 'cookiePrefixData'
		] );
		$this->assertSame( 'cookiePrefixData', $request->getCookiePrefix() );
	}

	public function testGetNullCookie() {
		$request = new RequestData( [] );
		$this->assertNull( $request->getCookie( 'nonExistingCookie' ) );
	}

	public function testGetCookie() {
		$request = new RequestData( [
			'cookieParams' => [ 'cookie1' => 'value1' ]
		] );
		$this->assertSame( 'value1', $request->getCookie( 'cookie1' ) );
	}

	public function testDefaultPathParams() {
		$request = new RequestData( [] );
		$this->assertSame( [], $request->getPathParams() );
	}

	public function testSetPathParams() {
		$request = new RequestData( [] );
		$request->setPathParams( [ 'foo' => 'bar' ] );
		$this->assertSame( [ 'foo' => 'bar' ], $request->getPathParams() );
	}

	public function testNullPathParam() {
		$request = new RequestData( [] );
		$this->assertNull( $request->getPathParam( 'Non-existing' ) );
	}

	public function testGetPathParam() {
		$request = new RequestData( [
			'pathParams' => [ 'foo' => 'bar' ]
		] );
		$this->assertSame( 'bar', $request->getPathParam( 'foo' ) );
	}

	public function testDefaultParsedBody() {
		$request = new RequestData( [] );
		$this->assertNull( $request->getParsedBody() );
	}

	public function testSetParsedBody() {
		$request = new RequestData( [] );
		$request->setParsedBody( [ 'bodyData' ] );
		$this->assertEquals( [ 'bodyData' ], $request->getParsedBody() );
	}

	public function testGetParsedBody() {
		$request = new RequestData( [
			'parsedBody' => [ 'bodyData' ]
		] );
		$this->assertEquals( [ 'bodyData' ], $request->getParsedBody() );
	}

	public static function provideBodyTypeBasedOnHeader() {
		return [
			'application/json' => [
				[ 'Content-Type' => 'application/json' ],
				'application/json'
			],
			'application/json with charset' => [
				[ 'Content-Type' => 'application/json; charset=utf-8' ],
				'application/json'
			],
			'application/form-urlencoded' => [
				[ 'Content-Type' => 'application/x-www-form-urlencoded' ],
				'application/x-www-form-urlencoded'
			],
			'multipart/form-data' => [
				[ 'Content-Type' => 'multipart/form-data' ],
				'multipart/form-data'
			],
			'no header' => [
				[],
				null
			],
			'empty header' => [
				'headers' => [ 'Content-Type' => '' ],
				null
			],

		];
	}

	/** @dataProvider provideBodyTypeBasedOnHeader */
	public function testBodyTypeBasedOnHeader( $headers, $expectedResult ) {
		$request = new RequestData( [
			'headers' => $headers
		] );
		$this->assertSame( $expectedResult, $request->getBodyType() );
	}

	public static function provideHasBody() {
		yield 'nothing'
		=> [ [], false ];

		yield 'content-length: 1'
		=> [ [ 'content-length' => '1' ], true ];

		yield 'content-length: 0'
		=> [ [ 'content-length' => '0' ], true ];

		yield 'content-length empty'
		=> [ [ 'content-length' => '' ], false ];

		yield 'transfer-encoding: chunked'
		=> [ [ 'transfer-encoding' => 'chunked' ], true ];

		yield 'transfer-encoding empty'
		=> [ [ 'transfer-encoding' => '' ], false ];
	}

	/**
	 * @dataProvider provideHasBody
	 */
	public function testHasBodyBasedOnHeader( $headers, $expected ) {
		$request = new RequestData( [
			'headers' => $headers
		] );
		$this->assertSame( $expected, $request->hasBody() );
	}

	public function testHasBodyWithContent() {
		$request = new RequestData( [
			'bodyContents' => 'test test test'
		] );
		$this->assertTrue( $request->hasBody() );
	}

	public function testHasBodyWithParsedBody() {
		$request = new RequestData( [
			'parsedBody' => [ 'foo' => 'bar' ]
		] );
		$this->assertTrue( $request->hasBody() );
	}
}