| Q | A |
|---|
| Branch? | 4.4 |
| Bug fix? | no |
| New feature? | yes |
| Deprecations? | no |
| Tickets | - |
| License | MIT |
| Doc PR | - |
As same as theMockResponse class hasgetRequestOptions() when doing a request; I've added:
getRequestUrl() - returns the URL used when doing the requestgetRequestMethod() - returns the HTTP method used when doing the request
With these two getters, we would be able to assert that the method and URL passed to theHttpClient were well generated. I've tried to assert the URL generated in a unit test of a class with aSymfonyHttpClient injected and it wasn't possible. Calling$mock->getInfo('url') returnsnull.
Example, if we have a class withHttpClientInterface injected like this:
finalclass SymfonyHttpUserClient{privateHttpClientInterface$httpClient;privatestring$baseUri;publicfunction__construct(HttpClientInterface$httpClient,string$baseUri ) {$this->httpClient =$httpClient;$this->baseUri =$baseUri; }publicfunctiongetById(string$userId):void {$this->httpClient->request('GET',$this->baseUri .$customerId ); }}And if we want to do a unit test ofSymfonyHttpUserClient right now we are not able to check if the URL of the request was well-formed passing aMockResponse. Also, we weren't able to assert the HTTP method (maybe this piece is not so critical to assert in the unit test).
class SymfonyHttpUserClientTestsextends TestCase{publicfunctiontestGetById():void {$baseUri ='https://user-api.test/api/v1/users/';$mockResponse =newMockResponse();$symfonyHttpUserClient =newSymfonyHttpUserClient(newMockHttpClient( [$mockResponse],$baseUri ),$baseUri );// test get by id:$symfonyHttpUserClient->getById('some-user-id');// cannot be asserted right now:$this->assertSame($mockResponse->getInfo('url'),$baseUri .'some-user-id');// fail$this->assertSame($mockResponse->getInfo('http_method'),'GET');// fail// it could be with the new getters:$this->assertSame($mockResponse->getRequestUrl(),$baseUri .'some-user-id');$this->assertSame($mockResponse->getRequestMethod(),'GET'); }}This only happens if the class has injected the HttpClient and if it is used inside void methods with no being able to return the response. If the class returns the response,url andhttp_method are available with$response->getInfo() call. But this response object is a new one, is not the mock passed by argument when you instance the MockHttpClient.
Var dumps ofgetInfo array:
$response->getInfo() from MockClient:..array(10) { ["start_time"]=> float(1587109014.7985) ["user_data"]=> NULL ["http_code"]=> int(200) ["response_headers"]=> array(0) { } ["error"]=> NULL ["canceled"]=> bool(false) ["redirect_count"]=> int(0) ["redirect_url"]=> NULL ["http_method"]=> string(3) "GET" ["url"]=> string(47) "https://user-api.test/api/v1/users/some-user-id"}$mock->getInfo()array(4) { ["http_code"]=> int(200) ["response_headers"]=> array(0) { } ["error"]=> NULL ["canceled"]=> bool(false)}
This is a minor change, I opened the PR with4.4 as base branch; but not sure if it should be opened with5.0 as base branch or evenmaster taking account is a feature (add two new getters in MockResponse class). Let me know if I didn't follow right the instructions (first PR on Symfony project 😃)
Thanks!
nicolas-grekas left a comment•
Uh oh!
There was an error while loading.Please reload this page.
As same as the
MockResponseclass hasgetRequestOptions()when doing a request; I've added:getRequestUrl()- returns the URL used when doing the requestgetRequestMethod()- returns the HTTP method used when doing the requestWith these two getters, we would be able to assert that the method and URL passed to the
HttpClientwere well generated. I've tried to assert the URL generated in a unit test of a class with aSymfonyHttpClientinjected and it wasn't possible. Calling$mock->getInfo('url')returnsnull.Example, if we have a class with
HttpClientInterfaceinjected like this:And if we want to do a unit test of
SymfonyHttpUserClientright now we are not able to check if the URL of the request was well-formed passing aMockResponse. Also, we weren't able to assert the HTTP method (maybe this piece is not so critical to assert in the unit test).This only happens if the class has injected the HttpClient and if it is used inside void methods with no being able to return the response. If the class returns the response,
urlandhttp_methodare available with$response->getInfo()call. But this response object is a new one, is not the mock passed by argument when you instance the MockHttpClient.Var dumps of
getInfoarray:This is a minor change, I opened the PR with
4.4as base branch; but not sure if it should be opened with5.0as base branch or evenmastertaking account is a feature (add two new getters in MockResponse class). Let me know if I didn't follow right the instructions (first PR on Symfony project 😃)Thanks!