Getting Started

Installation

Install Testo via Composer:

composer require --dev testo/testo

Configuration

By default, if no configuration file is provided, Testo will run tests from the tests folder.

To customize the configuration, create a testo.php file in the root of your project:

<?php

declare(strict_types=1);

use Testo\Config\ApplicationConfig;
use Testo\Config\SuiteConfig;
use Testo\Config\FinderConfig;

return new ApplicationConfig(
    suites: [
        new SuiteConfig(
            name: 'Unit',
            location: new FinderConfig(
                include: ['tests/Unit'],
            ),
        ),
    ],
);

Writing Your First Test

Create a test class in the configured test directory (e.g., tests/CalculatorTest.php):

<?php

declare(strict_types=1);

namespace Tests;

use Testo\Assert;
use Testo\Attribute\Test;
use Testo\Attribute\RetryPolicy;
use Testo\Attribute\ExpectException;

final class CalculatorTest
{
    #[Test]
    public function dividesNumbers(): void
    {
        $result = 10 / 2;

        Assert::same(5.0, $result);
        Assert::notSame(5, $result); // Types matter!
    }

    #[Test]
    #[RetryPolicy(maxAttempts: 3)]
    public function flakyApiCall(): void
    {
        // Retries up to 3 times if test fails
        $response = $this->makeExternalApiCall();

        Assert::same(200, $response->status);
    }

    #[Test]
    #[ExpectException(\RuntimeException::class)]
    public function throwsException(): void
    {
        throw new \RuntimeException('Expected error');
    }
}

Key Points

• The #[Test] attribute is used to mark test methods.
• Test classes don't need to inherit from a base class.
• Use the Assert facade for assertions and Expect for expectations.
• Testo provides multiple attributes to extend testing capabilities (retry policies, exception handling, and more).

Running Tests

To run your tests, execute:

vendor/bin/testo

You should see output showing the test results with detailed information about passed and failed tests.

IDE Support

Testo comes with an official IDEA plugin for PhpStorm and IntelliJ IDEA.

The plugin provides:

• Running tests directly from the IDE
• Navigation between test and implementation code
• Test result visualization
• Debugging support