README

Extension to use built-in PHP server on Behat tests

Instalation

composer require libresign/behat-builtin-extension
vendor/bin/behat --init

Configuration

Add the extension to your behat.php (Behat 4 and PHP 8.2 or later):

<?php

use Behat\Config\Config;
use Behat\Config\Extension;
use Behat\Config\Profile;
use PhpBuiltin\Server;

return (new Config())
    ->withProfile((new Profile('default'))
        ->withExtension(new Extension(Server::class, [
            'verbose' => false,
            'rootDir' => '/var/www/html',
            'host' => 'localhost',
        ])));

Config values

You can also use -v option to enable verbose mode. Example

vendor/bin/behat -v

The verbose mode will show:

• The rootDir, host, runAs and workers used
• When the PHP built-in server starts: PID, host, port, worker count and log path
• PHP built-in server stdout/stderr captured for the suite
• Process exit status when the server terminates
• A clear message when teardown finds that the server process is already gone (instead of only kill: No such process)

Usage example

<?php

use Behat\Behat\Context\Context;
use PhpBuiltin\RunServerListener;

/**
 * Defines application features from the specific context.
 */
class FeatureContext implements Context
{
    private string $baseUrl;
    public function __construct()
    {
        $this->baseUrl = RunServerListener::getServerRoot();
    }

    public function sendRequest(string $verb, string $url, ?array $body = null, array $headers = []): void
    {
        $client = new Client();

        $fullUrl = $this->baseUrl . ltrim($url, '/');

        $options['headers'] = $headers;

        if (is_array($body)) {
            $options['form_params'] = $body;
        }

        try {
            $this->response = $client->{$verb}($fullUrl, $options);
        } catch (ClientException $e) {
            $this->response = $e->getResponse();
        } catch (ServerException $e) {
            $this->response = $e->getResponse();
        }
    }
}