test api controller that returns json response

Question

In order to test an API controller in a Symfony2 project that returns json response, I tried to generate a route of the action like here:

$client->getContainer()->get('router')->generate('/api/register/emailverification/', array('email' => 'email@gmail.com'), true)
$response= $client->getResponse();
$this->assertEquals(200, $response);`

But the response returns null. I don't know if have to do a specific test for this type of response like using guzzle...

In tests you should not "generate" routes, they must be hardcoded. — COil, Apr 04 '17 at 13:34
I tried this : $client = static::createClient(); $crawler = $client->request('GET', '/api/register/emailverification/', array('email' => 'email@gmail.com')); $response = $client->getResponse(); $this->assertEquals(200, $response->getStatusCode()); it returns 404 — Christophegonfrere, Apr 04 '17 at 13:43

COil · Accepted Answer · 2017-04-04T14:10:35.933

2

In tests one shouldn't "generate" routes paths, they must be hard-coded:

$client = $this->createClient();
$client->request('GET', '/api/register/emailverification/email@gmail.com');
$this->assertTrue($client->getResponse()->isOk());

But if you want to test json, you can do:

$this->assertJson($client->getResponse()->getContent());

You can find additional PHPunit helpers in the rest extra bundle.

edited Apr 04 '17 at 14:10

answered Apr 04 '17 at 13:44

COil

7,201
2
50
98

please how can i add a host to this request because it returns 404 (my host is 127.0.0.1:8000) – Christophegonfrere Apr 04 '17 at 13:54
But does your code working in your browser? That's the 1st step. – COil Apr 04 '17 at 13:56
copy/past your controller, if 404 it's `/api/register/emailverification/` is not correct. – COil Apr 04 '17 at 13:58
127.0.0.1:8000/api/register/emailverification/email@gmail.com it works like this in browser – Christophegonfrere Apr 04 '17 at 14:01
So it's not the same, the email is not a get parameter but part of the route. Answer updated. – COil Apr 04 '17 at 14:03
still same issue I think i have to add a host – Christophegonfrere Apr 04 '17 at 14:27
How is constructed `$client`? copy/past all the code in the question. – COil Apr 04 '17 at 14:32
Try with: $client = $this->createClient() instead. – COil Apr 04 '17 at 14:40
just one more question , when I put a wrong email just for testing ,the assert return fail – Christophegonfrere Apr 04 '17 at 18:02
Its depends on how is implemented your controller. If the email is not valid a good practice for a web service is to return a response code 422, check out: http://stackoverflow.com/questions/4781187/http-400-bad-request-for-logical-error-not-malformed-request-syntax – COil Apr 04 '17 at 18:44

score 0 · Answer 2 · answered Apr 04 '17 at 12:50

0

I believe you should try:

$controllerResponse = $client->getContainer()->get('router')->generate('_validation_email', array('email' => 'email@gmail.com'), true)
$response= $controllerResponse->getResponse();
$this->assertEquals(200, $response);

answered Apr 04 '17 at 12:50

Antonis Charalambous

952
8
11

still the same issue – Christophegonfrere Apr 04 '17 at 13:45

test api controller that returns json response

2 Answers2