Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F4059944
GuzzleHttpRequestTest.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
7 KB
Referenced Files
None
Subscribers
None
GuzzleHttpRequestTest.php
View Options
<?php
use
GuzzleHttp\Handler\MockHandler
;
use
GuzzleHttp\HandlerStack
;
use
GuzzleHttp\Middleware
;
use
GuzzleHttp\Psr7\Request
;
use
GuzzleHttp\Psr7\Response
;
/**
* class for tests of GuzzleHttpRequest
*
* No actual requests are made herein - all external communications are mocked
*
* @covers \GuzzleHttpRequest
* @covers \MWHttpRequest
*/
class
GuzzleHttpRequestTest
extends
MediaWikiIntegrationTestCase
{
/** @var int[] */
private
$timeoutOptions
=
[
'timeout'
=>
1
,
'connectTimeout'
=>
1
];
/**
* Placeholder url to use for various tests. This is never contacted, but we must use
* a url of valid format to avoid validation errors.
* @var string
*/
protected
$exampleUrl
=
'http://www.example.test'
;
/**
* Minimal example body text
* @var string
*/
protected
$exampleBodyText
=
'x'
;
/**
* For accumulating callback data for testing
* @var string
*/
protected
$bodyTextReceived
=
''
;
/**
* Callback: process a chunk of the result of a HTTP request
*
* @param mixed $req
* @param string $buffer
* @return int Number of bytes handled
*/
public
function
processHttpDataChunk
(
$req
,
$buffer
)
{
$this
->
bodyTextReceived
.=
$buffer
;
return
strlen
(
$buffer
);
}
public
function
testSuccess
()
{
$handler
=
HandlerStack
::
create
(
new
MockHandler
(
[
new
Response
(
200
,
[
'status'
=>
200
,
],
$this
->
exampleBodyText
)
]
)
);
$r
=
new
GuzzleHttpRequest
(
$this
->
exampleUrl
,
[
'handler'
=>
$handler
]
+
$this
->
timeoutOptions
);
$r
->
execute
();
$this
->
assertEquals
(
200
,
$r
->
getStatus
()
);
$this
->
assertEquals
(
$this
->
exampleBodyText
,
$r
->
getContent
()
);
}
public
function
testSuccessConstructorCallback
()
{
$this
->
bodyTextReceived
=
''
;
$handler
=
HandlerStack
::
create
(
new
MockHandler
(
[
new
Response
(
200
,
[
'status'
=>
200
,
],
$this
->
exampleBodyText
)
]
)
);
$r
=
new
GuzzleHttpRequest
(
$this
->
exampleUrl
,
[
'callback'
=>
[
$this
,
'processHttpDataChunk'
],
'handler'
=>
$handler
,
]
+
$this
->
timeoutOptions
);
$r
->
execute
();
$this
->
assertEquals
(
200
,
$r
->
getStatus
()
);
$this
->
assertEquals
(
$this
->
exampleBodyText
,
$this
->
bodyTextReceived
);
}
public
function
testSuccessSetCallback
()
{
$this
->
bodyTextReceived
=
''
;
$handler
=
HandlerStack
::
create
(
new
MockHandler
(
[
new
Response
(
200
,
[
'status'
=>
200
,
],
$this
->
exampleBodyText
)
]
)
);
$r
=
new
GuzzleHttpRequest
(
$this
->
exampleUrl
,
[
'handler'
=>
$handler
,
]
+
$this
->
timeoutOptions
);
$r
->
setCallback
(
[
$this
,
'processHttpDataChunk'
]
);
$r
->
execute
();
$this
->
assertEquals
(
200
,
$r
->
getStatus
()
);
$this
->
assertEquals
(
$this
->
exampleBodyText
,
$this
->
bodyTextReceived
);
}
/**
* use a callback stream to pipe the mocked response data to our callback function
*/
public
function
testSuccessSink
()
{
$this
->
bodyTextReceived
=
''
;
$handler
=
HandlerStack
::
create
(
new
MockHandler
(
[
new
Response
(
200
,
[
'status'
=>
200
,
],
$this
->
exampleBodyText
)
]
)
);
$r
=
new
GuzzleHttpRequest
(
$this
->
exampleUrl
,
[
'handler'
=>
$handler
,
'sink'
=>
new
MWCallbackStream
(
[
$this
,
'processHttpDataChunk'
]
),
]
+
$this
->
timeoutOptions
);
$r
->
execute
();
$this
->
assertEquals
(
200
,
$r
->
getStatus
()
);
$this
->
assertEquals
(
$this
->
exampleBodyText
,
$this
->
bodyTextReceived
);
}
public
function
testBadUrl
()
{
$r
=
new
GuzzleHttpRequest
(
''
,
$this
->
timeoutOptions
);
$s
=
$r
->
execute
();
$this
->
assertSame
(
0
,
$r
->
getStatus
()
);
$this
->
assertStatusMessage
(
'http-invalid-url'
,
$s
);
}
public
function
testConnectException
()
{
$handler
=
HandlerStack
::
create
(
new
MockHandler
(
[
new
GuzzleHttp\Exception\ConnectException
(
'Mock Connection Exception'
,
new
Request
(
'GET'
,
$this
->
exampleUrl
)
)
]
)
);
$r
=
new
GuzzleHttpRequest
(
$this
->
exampleUrl
,
[
'handler'
=>
$handler
]
+
$this
->
timeoutOptions
);
$s
=
$r
->
execute
();
$this
->
assertSame
(
0
,
$r
->
getStatus
()
);
$this
->
assertStatusMessage
(
'http-request-error'
,
$s
);
}
public
function
testTimeout
()
{
$handler
=
HandlerStack
::
create
(
new
MockHandler
(
[
new
GuzzleHttp\Exception\RequestException
(
'Connection timed out'
,
new
Request
(
'GET'
,
$this
->
exampleUrl
)
)
]
)
);
$r
=
new
GuzzleHttpRequest
(
$this
->
exampleUrl
,
[
'handler'
=>
$handler
]
+
$this
->
timeoutOptions
);
$s
=
$r
->
execute
();
$this
->
assertSame
(
0
,
$r
->
getStatus
()
);
$this
->
assertStatusMessage
(
'http-timed-out'
,
$s
);
}
public
function
testNotFound
()
{
$handler
=
HandlerStack
::
create
(
new
MockHandler
(
[
new
Response
(
404
,
[
'status'
=>
'404'
,
]
)
]
)
);
$r
=
new
GuzzleHttpRequest
(
$this
->
exampleUrl
,
[
'handler'
=>
$handler
]
+
$this
->
timeoutOptions
);
$s
=
$r
->
execute
();
$this
->
assertEquals
(
404
,
$r
->
getStatus
()
);
$this
->
assertStatusMessage
(
'http-bad-status'
,
$s
);
}
/*
* Test of POST requests header
*/
public
function
testPostBody
()
{
$container
=
[];
$history
=
Middleware
::
history
(
$container
);
$stack
=
HandlerStack
::
create
(
new
MockHandler
(
[
new
Response
()
]
)
);
$stack
->
push
(
$history
);
$client
=
new
GuzzleHttpRequest
(
$this
->
exampleUrl
,
[
'method'
=>
'POST'
,
'handler'
=>
$stack
,
'post'
=>
'key=value'
,
]
+
$this
->
timeoutOptions
);
$client
->
execute
();
$request
=
$container
[
0
][
'request'
];
$this
->
assertEquals
(
'POST'
,
$request
->
getMethod
()
);
$this
->
assertEquals
(
'application/x-www-form-urlencoded'
,
$request
->
getHeader
(
'Content-Type'
)[
0
]
);
}
/**
* Test POSTed multipart request body with custom content type
*/
public
function
testPostBodyContentType
()
{
$container
=
[];
$history
=
Middleware
::
history
(
$container
);
$stack
=
HandlerStack
::
create
(
new
MockHandler
(
[
new
Response
()
]
)
);
$stack
->
push
(
$history
);
$client
=
new
GuzzleHttpRequest
(
$this
->
exampleUrl
,
[
'method'
=>
'POST'
,
'handler'
=>
$stack
,
'postData'
=>
new
\GuzzleHttp\Psr7\MultipartStream
(
[
[
'name'
=>
'a'
,
'contents'
=>
'b'
]
]
),
]
+
$this
->
timeoutOptions
);
$client
->
setHeader
(
'Content-Type'
,
'text/mwtest'
);
$client
->
execute
();
$request
=
$container
[
0
][
'request'
];
$this
->
assertEquals
(
'text/mwtest'
,
$request
->
getHeader
(
'Content-Type'
)[
0
]
);
}
/*
* Test that cookies from CookieJar were sent in the outgoing request.
*/
public
function
testCookieSent
()
{
$domain
=
parse_url
(
$this
->
exampleUrl
,
PHP_URL_HOST
);
$expectedCookies
=
[
'cookie1'
=>
'value1'
,
'anothercookie'
=>
'secondvalue'
];
$jar
=
new
CookieJar
;
foreach
(
$expectedCookies
as
$key
=>
$val
)
{
$jar
->
setCookie
(
$key
,
$val
,
[
'domain'
=>
$domain
]
);
}
$container
=
[];
$history
=
Middleware
::
history
(
$container
);
$stack
=
HandlerStack
::
create
(
new
MockHandler
(
[
new
Response
()
]
)
);
$stack
->
push
(
$history
);
$client
=
new
GuzzleHttpRequest
(
$this
->
exampleUrl
,
[
'method'
=>
'POST'
,
'handler'
=>
$stack
,
'post'
=>
'key=value'
,
]
+
$this
->
timeoutOptions
);
$client
->
setCookieJar
(
$jar
);
$client
->
execute
();
$request
=
$container
[
0
][
'request'
];
$this
->
assertEquals
(
[
'cookie1=value1; anothercookie=secondvalue'
],
$request
->
getHeader
(
'Cookie'
)
);
}
/*
* Test that cookies returned by HTTP response were added back into the CookieJar.
*/
public
function
testCookieReceived
()
{
$handler
=
HandlerStack
::
create
(
new
MockHandler
(
[
new
Response
(
200
,
[
'status'
=>
200
,
'Set-Cookie'
=>
[
'cookie1=value1'
,
'anothercookie=secondvalue'
]
]
)
]
)
);
$r
=
new
GuzzleHttpRequest
(
$this
->
exampleUrl
,
[
'handler'
=>
$handler
]
+
$this
->
timeoutOptions
);
$r
->
execute
();
$domain
=
parse_url
(
$this
->
exampleUrl
,
PHP_URL_HOST
);
$this
->
assertEquals
(
'cookie1=value1; anothercookie=secondvalue'
,
$r
->
getCookieJar
()->
serializeToHttpRequest
(
'/'
,
$domain
)
);
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Aug 16 2026, 06:19 (13 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
c2/e3/8a31f3837f25b8a6136b7699ea90
Default Alt Text
GuzzleHttpRequestTest.php (7 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment