README

Kgabryel/TestTools to biblioteka pomocnicza dla PHPUnit, która ułatwia tworzenie i konfigurację mocków.
Kluczową funkcjonalnością jest kontrola listy dozwolonych metod – w mockach można wywołać tylko te metody, które określimy, dzięki czemu przypadkowe wywołania nie powodują fałszywego sukcesu testu.

Spis treści

• Instalacja
• Przykład wykorzystania
• Dodawanie własnej metody z handlerem
• Struktura repozytorium
• Praca z repozytorium
• Skrypty developerskie
• Skrypty pomocnicze

Instalacja

Przez Composer:

composer require --dev kgabryel/test-tools

Przykład wykorzystania

    class MyTest extends BaseTestCase
    {
        public function testExample(): void
        {
            $mock = $this->getMock(
                DummyClass::class,
                new AllowedMethodsList(),
                new ReturnsValueMethod('return1', null, 42),
                new VoidMethod('withException', null),
            );
        
            $this->assertSame(42, $mock->return1());
            $mock->withException();
        }
    }

Dodawanie własnej metody z handlerem

1. Utwórz klasę metody z atrybutem #[Handler] wskazującym handler:

    #[Handler(MyCustomHandler::class)]
    class MyCustomMethod extends BaseMethod
    {
        // konstruktor, parametry, itp.
    }

1. Stwórz handler dziedziczący po BaseHandler:

    class MyCustomHandler extends BaseHandler
    {
        protected function applyBehavior(InvocationStubber $mock): void
        {
            // dodatkowa konfiguracja
        }
    }

1. Użycie w teście:

    class MyTest extends BaseTestCase
    {
        public function testExample(): void
        {
            $mock = $this->getMock(
                DummyClass::class,
                new AllowedMethodsList(),
                new MyCustomMethod('return1', null, 42),
            );
        }
    }

Handler automatycznie zostanie przypisany do metody dzięki atrybutowi #[Handler].

Struktura repozytorium

• src/ – kod źródłowy biblioteki
• tests/ – testy jednostkowe
• tools/ – narzędzie i skrypty developerskie

Praca z repozytorium

git clone <repo-url> && cd <repo-folder> && composer install

Aby móc używać narzędzi developerskich:

cd tools && composer install

Skrypty developerskie

Skrypty w katalogu tools/ są przygotowane do uruchamiania w Dockerze, korzystają z kontenera PHP określonego w config.sh (domyślnie php).
Aby z nich korzystać:

1. Stwórz plik konfiguracyjny tools/config.sh, bazując na tools/config.example.sh

# Nazwa kontenera PHP w Dockerze
PHP_CONTAINER="php"

# Ścieżka do katalogu projektu wewnątrz kontenera
PROJECT_DIR="/var/www/html/test-tools"
TOOLS_DIR="${PROJECT_DIR}/tools"

1. Uruchamiaj skrypty z lokalnej konsoli, np.: ./tools/phpunit.sh

Skrypty pomocnicze

• code-coverage.sh – generowanie raportu pokrycia testami - wygenerowany raport: tools/var/infection.txt & tools/var/code-coverage/index.html
• cs-fixer.sh – dodatkowy fixer kodu PHP-CS-Fixer
• infection.sh – mutacje testów Infection - wygenerowany raport: tools/var/infection.txt & tools/var/infection.html
• phpcbf.sh – automatyczna poprawa kodu PHP_CodeSniffer
• phpcs.sh – sprawdza standardy kodu PHP_CodeSniffer
• phpmd.sh – analiza kodu źródłowego PHP Mess Detector - wygenerowany raport: tools/var/phpmd.html
• phpmd-tests.sh – analiza kodu testów PHP Mess Detector - wygenerowany raport: tools/var/phpmd-tests.html
• phpstan.sh – analiza statyczna kodu PHPStan
• phpunit.sh – uruchamia testy jednostkowe, integracyjne i funkcjonalne PHPUnit