ExamplesTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

require_once("vendor/composer/vendor/autoload.php");
require_once(__DIR__ . "/../Base.php");

use ILIAS\UI\Implementation\Crawler as Crawler;
use ILIAS\DI\Container;
use ILIAS\UI\NotImplementedException;
use ILIAS\FileUpload\FileUpload;

class ExamplesTest extends ILIAS_UI_TestBase
{
    protected const MAY_NOT_HAVE_EXAMPLES = [
        \ILIAS\UI\Help\Topic::class,
        \ILIAS\UI\Component\Progress\State\Bar\State::class,
        \ILIAS\UI\Component\Input\Field\Node\Node::class,
        \ILIAS\UI\Component\Input\Field\Node\Async::class,
        \ILIAS\UI\Component\Input\Field\Node\Leaf::class,
    ];

    protected static string $path_to_base_factory = "components/ILIAS/UI/src/Factory.php";
    protected Container $dic;
    protected Crawler\ExamplesYamlParser $example_parser;

    public function setUp(): void
    {
        //This avoids various index not set warnings, which are only relevant in test context.
        $_SERVER["REQUEST_SCHEME"] = "http";
        $_SERVER["SERVER_NAME"] = "localhost";
        $_SERVER["SERVER_PORT"] = "80";
        $_SERVER["REQUEST_URI"] = "";
        $_SERVER['SCRIPT_NAME'] = "";
        $_SERVER['QUERY_STRING'] = "param=1";

        //This avoids Undefined index: ilfilehash for the moment
        $_POST["ilfilehash"] = "";
        $this->setUpMockDependencies();
        $this->example_parser = new Crawler\ExamplesYamlParser();
    }

    protected function setUpMockDependencies(): void
    {
        $this->dic = new Container();
        $this->dic["tpl"] = $this->getTemplateFactory()->getTemplate("tpl.main.html", false, false);
        $this->dic["lng"] = $this->getLanguage();
        $this->dic["refinery"] = new \ILIAS\Refinery\Factory(
            new ILIAS\Data\Factory(),
            $this->getLanguage()
        );

        (new InitUIFramework())->init($this->dic);

        $this->dic["ui.template_factory"] = $this->getTemplateFactory();

        $this->dic["ilCtrl"] = $this->getMockBuilder(\ilCtrl::class)->disableOriginalConstructor()->onlyMethods([
            "getFormActionByClass","setParameterByClass","saveParameterByClass","getLinkTargetByClass", "isAsynch"
        ])->getMock();
        $this->dic["ilCtrl"]->method("getFormActionByClass")->willReturn("Testing");
        $this->dic["ilCtrl"]->method("getLinkTargetByClass")->willReturn("2");
        $this->dic["ilCtrl"]->method("isAsynch")->willReturn(false);

        $this->dic["upload"] = $this->getMockBuilder(FileUpload::class)->getMock();

        $this->dic["tree"] = $this->getMockBuilder(ilTree::class)
                                  ->disableOriginalConstructor()
                                  ->onlyMethods(["getNodeData"])->getMock();

        $this->dic["tree"]->method("getNodeData")->willReturn([
            "ref_id" => "1",
            "title" => "mock root node",
            "type" => "crs"
        ]);

        $component_factory = $this->createMock(ilComponentFactory::class);
        $component_factory->method("getActivePluginsInSlot")->willReturn(new ArrayIterator());
        $this->dic["component.factory"] = $component_factory;

        $this->dic["help.text_retriever"] = new ILIAS\UI\Help\TextRetriever\Echoing();

        (new InitHttpServices())->init($this->dic);
    }

    public function testAllNonAbstractComponentsShowcaseExamples(): void
    {
        global $DIC;
        $DIC = $this->dic;

        foreach ($this->getEntriesFromCrawler() as $entry) {
            if (in_array(trim($entry->getNamespace(), '\\'), self::MAY_NOT_HAVE_EXAMPLES, true)) {
                continue;
            }
            if (!$entry->isAbstract()) {
                $this->assertGreaterThan(
                    0,
                    count($entry->getExamples()),
                    "Non abstract Component " . $entry->getNamespace()
                    . " does not provide any example. Please provide at least one in " . $entry->getExamplesNamespace() . " at " . $entry->getExamplesPath()
                );
            }
        }
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getFullFunctionNamesAndPathExample')]
    public function testAllExamplesRenderAString(string $example_function_name, string $example_path): void
    {
        global $DIC;
        $DIC = $this->dic;

        include_once $example_path;
        try {
            $this->assertIsString($example_function_name(), " Example $example_function_name does not render a string");
        } catch (NotImplementedException $e) {
            $this->assertTrue(true);
        }
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getFullFunctionNamesAndPathExample')]
    public function testAllExamplesHaveExpectedOutcomeInDocs(string $example_function_name, string $example_path)
    {
        $docs = $this->example_parser->parseYamlStringArrayFromFile($example_path);
        $this->assertArrayHasKey('expected output', $docs);
    }

    protected static function getEntriesFromCrawler(): Crawler\Entry\ComponentEntries
    {
        $crawler = new Crawler\FactoriesCrawler();
        return $crawler->crawlFactory(self::$path_to_base_factory);
    }

    public static function getFullFunctionNamesAndPathExample(): array
    {
        $function_names = [];
        foreach (static::getEntriesFromCrawler() as $entry) {
            foreach ($entry->getExamples() as $name => $example_path) {
                $function_names[$entry->getExamplesNamespace() . "\\" . $name] = [
                    $entry->getExamplesNamespace() . "\\" . $name,
                    $example_path
                ];
            }
        }
        return $function_names;
    }

    #[\PHPUnit\Framework\Attributes\DataProvider('getListOfFullscreenExamples')]
    public function testFullscreenModeExamples(string $example_function_name, string $example_path): void
    {
        global $DIC;
        $DIC = $this->dic;

        include_once $example_path;
        try {
            $this->assertIsString($example_function_name($DIC), " Example $example_function_name does not render a string");
        } catch (NotImplementedException $e) {
            $this->assertTrue(true);
        }
    }

    public static function getListOfFullscreenExamples(): array
    {
        return [
            ['ILIAS\UI\examples\MainControls\Footer\base', "components/ILIAS/UI/src/examples/MainControls/Footer/base.php"],
            ['ILIAS\UI\examples\MainControls\MetaBar\renderMetaBarInFullscreenMode', "components/ILIAS/UI/src/examples/MainControls/MetaBar/base_metabar.php"],
            ['ILIAS\UI\examples\Layout\Page\Standard\getUIMainbarExampleCondensed', "components/ILIAS/UI/src/examples/Layout/Page/Standard/ui_mainbar.php"],
            ['ILIAS\UI\examples\Layout\Page\Standard\getUIMainbarExampleFull', "components/ILIAS/UI/src/examples/Layout/Page/Standard/ui_mainbar.php"],
            ['ILIAS\UI\examples\Layout\Page\Standard\ui', "components/ILIAS/UI/src/examples/Layout/Page/Standard/ui.php"],
            ['ILIAS\UI\examples\MainControls\ModeInfo\renderModeInfoFullscreenMode', "components/ILIAS/UI/src/examples/MainControls/ModeInfo/modeinfo.php"]
        ];
    }
}