ExamplesTest.php

<?php

namespace M6WebExamplesTests\Tornado;

use PHPUnit\Framework\TestCase;

class ExamplesTest extends TestCase
{
    private const EXAMPLES_DIR = __DIR__.'/../';

    public function examplesProvider()
    {
        $iterator = new \FilesystemIterator(
            self::EXAMPLES_DIR,
            \FilesystemIterator::CURRENT_AS_FILEINFO | \FilesystemIterator::KEY_AS_FILENAME | \FilesystemIterator::SKIP_DOTS
        );

        foreach ($iterator as $name => $fileinfo) {
            if ($fileinfo->isDir()) {
                continue;
            }

            foreach ($this->extractExampleCode($fileinfo->getRealPath()) as $eventloopName => $code) {
                yield "$name $eventloopName" => [$fileinfo->getRealPath(), $eventloopName, $code];
            }
        }
    }

    /**
     * @dataProvider examplesProvider
     */
    public function testExampleShouldRun(string $exampleFile, string $eventloopName, string $exampleCode): void
    {
        // Sanitize loop name to create a relevant temporary filename
        $eventLoopFileId = preg_replace('/[^a-z0-9]+/', '', strtolower($eventloopName));
        $tmpFilePath = tempnam(self::EXAMPLES_DIR, basename($exampleFile, '.php')."-$eventLoopFileId-");

        try {
            file_put_contents($tmpFilePath, $exampleCode);

            $output = [];
            $code = null;
            exec("php $tmpFilePath", $output, $code);

            $this->assertSame(0, $code);
            $this->assertStringStartsWith("Let's start!", reset($output));
            $this->assertStringEndsWith('Finished!', end($output));
        } finally {
            unlink($tmpFilePath);
        }
    }

    private function extractExampleCode(string $exampleFile): iterable
    {
        $originalContent = file($exampleFile);

        foreach ($this->selectEventLoop($originalContent) as $nameEL => $contentEL) {
            $exampleUseHttpClient = false;

            foreach ($this->selectHttpClient($contentEL) as $nameHC => $contentELHC) {
                $exampleUseHttpClient = true;
                yield "$nameEL - $nameHC" => implode('', $contentELHC);
            }

            if (!$exampleUseHttpClient) {
                yield $nameEL => implode('', $contentEL);
            }
        }
    }

    /**
     * Very naive approach to iterate over various eventLoop implementations.
     */
    private function selectEventLoop(array $originalContent): iterable
    {
        foreach ($originalContent as &$line) {
            if (false === strpos($line, '$eventLoop = new ')) {
                continue;
            }

            // Extract relevant name
            $name = strstr(strstr($line, '(', true), 'Adapter\\');

            // Enable current eventLoop
            $line = ltrim($line, '/');

            yield $name => $originalContent;

            // Disable this eventLoop
            $line = "//$line";
        }
    }

    /**
     * Very naive approach to iterate over various httpClient implementations.
     */
    private function selectHttpClient(array $originalContent): iterable
    {
        foreach ($originalContent as &$line) {
            if (false === strpos($line, '$httpClient = new ')) {
                continue;
            }

            // Extract relevant name
            $name = strstr(strstr($line, '(', true), 'Adapter\\');

            // Enable current eventLoop
            $line = ltrim($line, '/');

            yield $name => $originalContent;

            // Disable this eventLoop
            $line = "//$line";
        }
    }
}