README

Rapira SDK

An SDK for building PHP applications and tooling on top of Rapira. It collects the shared building blocks that frameworks and their Rapira bridges keep re-implementing — PSR-7 request factories, reusable wrappers and helpers, API clients, and testing utilities.

This repository is a development monorepo: it is not published itself. Each building block ships as its own package under packages/*, split out to a dedicated repository and installed on its own:

Package	Namespace	What it provides
`rapira/http`	`Rapira\Sdk\Http`	PSR-7 server-request factories for every Rapira run mode (SAPI and dispatcher).
`rapira/testing`	`Rapira\Sdk\Testing`	Provisions the `rapira` binary for a suite and runs a live `rapira serve` process around your test cases, so tests exercise the app over a real socket. Ships a Testo adapter.

Installation

Install whichever package you need, e.g. the testing utilities:

composer require --dev rapira/testing

The rapira binary itself is downloaded on demand via dload the first time a suite that needs it runs. Your project must have a dload.xml describing where to fetch it from (see the dload-fetch-tool skill or the dload documentation for how to register a software alias).

Usage with Testo

1. Provision the binary for a suite

Attach RunRapiraPlugin to the suite in testo.php. It downloads the rapira binary (once, if missing) and binds the application directory the server will run from.

use Rapira\Sdk\Testing\Testo\RunRapiraPlugin;
use Testo\Application\Config\ApplicationConfig;
use Testo\Application\Config\Plugin\SuitePlugins;
use Testo\Application\Config\SuiteConfig;

return new ApplicationConfig(
    src: ['src'],
    suites: [
        new SuiteConfig(
            name: 'Integration',
            location: ['tests/Integration'],
            plugins: SuitePlugins::with(new RunRapiraPlugin(
                binary: __DIR__ . '/runtime/bin/rapira',
                workingDirectory: __DIR__ . '/tests/Integration/App',
                projectRoot: __DIR__,
            )),
        ),
    ],
);

2. Run the server around a test case

Annotate a test case with #[RunRapira]. Testo starts rapira serve before the case's tests and stops it afterwards.

use Rapira\Sdk\Common\Mode;
use Rapira\Sdk\Testing\Testo\Attribute\RunRapira;
use Testo\Attribute\Test;

#[RunRapira(mode: Mode::Worker, worker: 'worker.php', address: '127.0.0.1:8080')]
final class WorkerTest
{
    #[Test]
    public function respondsToRequests(): void
    {
        $response = file_get_contents('http://127.0.0.1:8080/');

        // ...assertions on $response
    }
}

RunRapira options:

Option	Default	Description
`mode`	`Mode::Worker`	Run mode passed as `--mode` (`classic`, `worker`, or `dispatcher`).
`worker`	`'worker.php'`	Entrypoint script, absolute or relative to the working directory.
`address`	`'127.0.0.1:8080'`	Listen address (`host:port`, `:port`, or `unix:<path>`).
`readyTimeout`	`5.0`	Seconds to wait for the server to accept connections.

rapira / sdk

Maintainers

Package info

Fund package maintenance!

Statistics

Security