gg-big-org / phpat Goto Github PK

Easy to use architecture testing tool for PHP

ℹ️ PHPat has been converted into a PHPStan extension. Read the UPGRADE notes!
The standalone version (v0.9) will still be available and receive critical bugfixes if needed.

Introduction 📜

PHP Architecture Tester is a static analysis tool to verify architectural requirements.

It provides a natural language abstraction to define your own architectural rules and test them against your software.

Check out the section WHAT TO TEST to see some examples of typical use cases.

Installation 💽

Require PHPat with Composer:

composer require --dev phpat/phpat

If you also install phpstan/extension-installer then you're all set!

# phpstan.neon
includes:
    - vendor/phpat/phpat/extension.neon

Configuration 🔧

You will need to register your test classes in your PHPStan configuration:

# phpstan.neon
services:
    -
        class: Tests\Architecture\MyFirstTest
        tags:
            - phpat.test
    -
        class: Tests\Architecture\MySecondTest
        tags:
            - phpat.test

⚠️ Your architecture tests folder should be included in the PHPStan analysed paths. See PHPat's own PHPat configuration as an example.

You can also configure some PHPat options, for instance:

# phpstan.neon
parameters:
    phpat:
        ignore_doc_comments: true

Test definition 📓

There are different Selectors to choose which classes will intervene in a rule and a wide range of Assertions.

This could be a test with a couple of rules:

<?php

use PHPat\Selector\Selector;
use PHPat\Test\Builder\Rule;
use PHPat\Test\PHPat;
use App\Domain\SuperForbiddenClass;

class MyFirstTest
{
    public function test_domain_does_not_depend_on_other_layers(): Rule
    {
        return PHPat::rule()
            ->classes(Selector::namespace('App\Domain'))
            ->shouldNotDependOn()
            ->classes(
                Selector::namespace('App\Application'),
                Selector::namespace('App\Infrastructure'),
                Selector::classname(SuperForbiddenClass::class),
                Selector::classname('/^SomeVendor\\\.*\\\ForbiddenSubfolder\\\.*/', true)
            );
    }
}

Usage 🚀

Run PHPStan as usual:

php vendor/bin/phpstan analyse -c phpstan.neon

⚠ Launching early stage releases (0.x.x) could break the API according to Semantic Versioning 2.0. We are using minor for breaking changes. This will change with the release of the stable 1.0.0 version.

PHP Architecture Tester is open source, contributions are welcome. Please have a look to the Contribution docs.