How do I write unit tests for a REST API built in Slim Framework?

Question

I have an API built in Slim like this:

    $app->group('/'.$endpoint, function () use ($app, $endpoint) {

        $handler = Api\Rest\Handlers\Factory::load($endpoint);

        if (is_null($handler)) {
            throw new \Exception('No REST handler found for '.$endpoint);
        }

        $app->get('(/:id)', function ($id) use ($app, $handler) {
            echo json_encode($handler->get($id));
        });

        $app->post('', function () use ($app, $handler) {
            echo json_encode($handler->post($app->request->post()));
        });

        $app->put(':id', function ($id) use ($app, $handler) {
            echo json_encode($handler->put($id, $app->request->put()));
        });

        $app->delete(':id', function ($id) use ($app, $handler) {
            echo json_encode($handler->delete($id));
        });

    });

$endpoint is a string, for example 'user';

How do I go about writing unit tests for it?

Ideally;

class RestUserTest extends PHPUnitFrameworkTestCase 
{
    public function testGet() 
    {
        $slim = ''; // my slim app
        // set route 'api/user/1' with method GET
        // invoke slim
        // ensure that what we expected to happen did
    }
}

(The REST handler class would make it trivial to mock the results that would ordinarily be backed by a DB.)

It's the nitty gritty of how to spoof the request into Slim that I don't know how to do.

score 10 · Accepted Answer · edited Apr 17 '16 at 21:35

10

You can have a try with this guidelines. It may help you. I tried it for one of my slim project.

Let me know if that helps.

Codes

<?php

require_once __DIR__ . '/../vendor/autoload.php';

use Slim\Environment;


class RoutesTest extends PHPUnit_Framework_TestCase
{

    public function request($method, $path, $options = array())
    {
        // Capture STDOUT
        ob_start();

        // Prepare a mock environment
        Environment::mock(array_merge(array(
            'REQUEST_METHOD' => $method,
            'PATH_INFO' => $path,
            'SERVER_NAME' => 'slim-test.dev',
        ), $options));

        $app = new \Slim\Slim();
        $this->app = $app;
        $this->request = $app->request();
        $this->response = $app->response();

        // Return STDOUT
        return ob_get_clean();
    }

    public function get($path, $options = array())
    {
        $this->request('GET', $path, $options);
    }

    public function testIndex()
       {
         $this->get('/');
         $this->assertEquals('200', $this->response->status());
       }
}

full code hosted in Gist . see this

edited Apr 17 '16 at 21:35

kerel

9
3

answered Jan 28 '14 at 19:05

Shaharia Azam

1,948
19
25

Wouldn't you need to add routes to `$app` to use this to test more than just an empty Slim server? Perhaps you can post some code showing how you use this to test a route? – rinogo Jul 07 '16 at 01:56
Also, shouldn't the result of `Environment::mock()` be stored so it can be used with something like `\Slim\Http\Request::createFromEnvironment($environment)`? I keep on staring at this code, and it looks good on first glance, but I just don't get how to use it... Perhaps this made sense with Slim 2, but Slim 3 requires a totally different approach? – rinogo Jul 07 '16 at 02:04
This approach seems a bit more complete and Slim 3-esque: http://stackoverflow.com/a/36111988/114558 (See the full writeup in the link on the answer for more info) – rinogo Jul 07 '16 at 02:28

How do I write unit tests for a REST API built in Slim Framework?

1 Answers1