asmblah/fast-cgi

v0.1.2 2024-04-08 17:28 UTC

Requires

• php: >=8.1
• ext-pcntl: *
• hollodotme/fast-cgi-client: ^3.1

Requires (Dev)

• mockery/mockery: ^1.6
• phpstan/phpstan: ^1.10
• phpstan/phpstan-mockery: ^1.1
• phpunit/phpunit: ^10.2

MIT

README

Simplifies management of a real php-cgi worker process or php-fpm worker pool.

Leverages the excellent hollodotme/fast-cgi-client for a FastCGI API.

Why?

Easy testing of a FastCGI application's behaviour across requests: for example, ensuring that opcache is cleared correctly when expected.

Usage

$ composer install --dev asmblah/fast-cgi

Launching a php-cgi instance and making a GET request to it:

Use PhpCgiLauncher for php-cgi.

test.php

<?php

declare(strict_types=1);

use Asmblah\FastCgi\FastCgi;
use Asmblah\FastCgi\Launcher\PhpCgiLauncher;

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

$baseDir = __DIR__;
$wwwDir = 'www'; // Relative to $baseDir.
$phpCgiBinaryPath = dirname(PHP_BINARY) . '/php-cgi';

$dataDir = $baseDir . '/var/test';
@mkdir($dataDir, 0700, true);
$socketPath = $dataDir . '/php-cgi.test.sock';

$fastCgi = new FastCgi(
    baseDir: $baseDir,
    wwwDir: $wwwDir,
    socketPath: $socketPath,
    launcher: new PhpCgiLauncher($phpCgiBinaryPath)
);
$session = $fastCgi->start();

$response = $session->sendGetRequest(
    'my_script.php',
    '/path/to/my-page',
    [
        'greeting' => 'Hello',
    ]
);

// Will print "Hello from my front controller!".
print $response->getBody() . PHP_EOL;

$session->quit();

www/my_script.php

<?php

declare(strict_types=1);

print ($_GET['greeting'] ?? '(none)') . ' from my front controller!';

Run

$ php test.php
Hello from my front controller!

Launching a php-fpm instance and making a GET request to it:

Use PhpFpmLauncher for php-fpm.

test.php

<?php

declare(strict_types=1);

use Asmblah\FastCgi\FastCgi;
use Asmblah\FastCgi\Launcher\PhpFpmLauncher;

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

$baseDir = __DIR__;
$wwwDir = 'www'; // Relative to $baseDir.
$phpFpmBinaryPath = dirname(PHP_BINARY, 2) . '/sbin/php-fpm';

$dataDir = $baseDir . '/var/test';
@mkdir($dataDir, 0700, true);
$socketPath = $dataDir . '/php-fpm.test.sock';
$logFilePath = $dataDir . '/php-fpm.log';

$configFilePath = $dataDir . '/php-fpm.conf';
file_put_contents($configFilePath, <<<CONFIG
[global]
error_log = $logFilePath

[www]
listen = $socketPath
pm = static
pm.max_children = 1

CONFIG
);

$fastCgi = new FastCgi(
    baseDir: $baseDir,
    wwwDir: $wwwDir,
    socketPath: $socketPath,
    launcher: new PhpFpmLauncher(
        $phpFpmBinaryPath,
        $configFilePath
    )
);
$session = $fastCgi->start();

$response = $session->sendGetRequest(
    'my_script.php',
    '/path/to/my-page',
    [
        'greeting' => 'Hello',
    ]
);

// Will print "Hello from my front controller!".
print $response->getBody() . PHP_EOL;

$session->quit();

www/my_script.php

<?php

declare(strict_types=1);

print ($_GET['greeting'] ?? '(none)') . ' from my front controller!';

Run

$ php test.php
Hello from my front controller!

See also

• FastCGI
• hollodotme/fast-cgi-client