Class ExamplesTest Checks if all examples are implemented and properly returning strings. More...

Inheritance diagram for ExamplesTest:

Collaboration diagram for ExamplesTest:

Public Member Functions
	setUp ()

	testAllNonAbstractComponentsShowcaseExamples ()

	testAllExamplesRenderAString (string $example_function_name, string $example_path)
	@dataProvider provideExampleFullFunctionNamesAndPath More...

	provideExampleFullFunctionNamesAndPath ()

	testFullscreenModeExamples (string $example_function_name, string $example_path)
	@dataProvider provideListOfFullscreenExamples More...

	provideListOfFullscreenExamples ()

Public Member Functions inherited from ILIAS_UI_TestBase
	setUp ()

	tearDown ()

	getUIFactory ()

	getTemplateFactory ()

	getResourceRegistry ()

	getLanguage ()

	getJavaScriptBinding ()

	getRefinery ()

	getImagePathResolver ()

	getDataFactory ()

	getDefaultRenderer (JavaScriptBinding $js_binding=null, array $with_stub_renderings=[])

	getDecoratedRenderer (Renderer $default)

	normalizeHTML (string $html)

	assertHTMLEquals (string $expected_html_as_string, string $html_as_string)

Protected Member Functions
	setUpMockDependencies ()
	Some wiring up of dependencies to get all the examples running. More...

	getEntriesFromCrawler ()

Protected Member Functions inherited from ILIAS_UI_TestBase
	brutallyTrimHTML (string $html)
	A more radical version of normalizeHTML. More...

	brutallyTrimSignals (string $html)
	A naive replacement of all il_signal-ids with dots to ease comparisons of rendered output. More...

Protected Attributes
string	$path_to_base_factory = "src/UI/Factory.php"

Container	$dic

Detailed Description

Class ExamplesTest Checks if all examples are implemented and properly returning strings.

Definition at line 32 of file ExamplesTest.php.

Member Function Documentation

◆ getEntriesFromCrawler()

ExamplesTest::getEntriesFromCrawler ( )

protected

Exceptions

Crawler

Exception\CrawlerException

Definition at line 132 of file ExamplesTest.php.

                                              : Crawler\Entry\ComponentEntries
    {
        $crawler = new Crawler\FactoriesCrawler();
        return $crawler->crawlFactory($this->path_to_base_factory);
    }

Referenced by provideExampleFullFunctionNamesAndPath(), and testAllNonAbstractComponentsShowcaseExamples().

Here is the caller graph for this function:

◆ provideExampleFullFunctionNamesAndPath()

ExamplesTest::provideExampleFullFunctionNamesAndPath ( )

Definition at line 138 of file ExamplesTest.php.

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

References $name, and getEntriesFromCrawler().

Here is the call graph for this function:

◆ provideListOfFullscreenExamples()

ExamplesTest::provideListOfFullscreenExamples ( )

Definition at line 168 of file ExamplesTest.php.

                                                     : array
    {
        return [
            ['ILIAS\UI\examples\MainControls\Footer\renderFooterInFullscreenMode', "src/UI/examples/MainControls/Footer/footer.php"],
            ['ILIAS\UI\examples\MainControls\Footer\renderFooterWithModalsInFullscreenMode', "src/UI/examples/MainControls/Footer/footer_with_modals.php"],
            ['ILIAS\UI\examples\MainControls\MetaBar\renderMetaBarInFullscreenMode', "src/UI/examples/MainControls/MetaBar/base_metabar.php"],
            ['ILIAS\UI\examples\Layout\Page\Standard\getUIMainbarExampleCondensed', "src/UI/examples/Layout/Page/Standard/ui_mainbar.php"],
            ['ILIAS\UI\examples\Layout\Page\Standard\getUIMainbarExampleFull', "src/UI/examples/Layout/Page/Standard/ui_mainbar.php"],
            ['ILIAS\UI\examples\Layout\Page\Standard\renderFooterInFullscreenMode', "src/UI/examples/Layout/Page/Standard/ui.php"]
        ];
    }

◆ setUp()

ExamplesTest::setUp ( )

Reimplemented from ILIAS_UI_TestBase.

Definition at line 37 of file ExamplesTest.php.

                           : void
    {
        //This avoids various index not set warnings, which are only relevant in test context.
        $_SERVER["REQUEST_URI"] = "";
        $_SERVER['SCRIPT_NAME'] = "";
        $_SERVER['QUERY_STRING'] = "param=1";
 
        //This avoids Undefined index: ilfilehash for the moment
        $_POST["ilfilehash"] = "";
        $this->setUpMockDependencies();
    }

References $_SERVER, and setUpMockDependencies().

Here is the call graph for this function:

◆ setUpMockDependencies()

ExamplesTest::setUpMockDependencies ( )

protected

Some wiring up of dependencies to get all the examples running.

If you examples needs additional dependencies, please add them here. However, please check carefully if those deps are really needed. Even if the examples, we try to keep them minimal. Note the most deps are wired up here as mocks only.

Definition at line 54 of file ExamplesTest.php.

                                              : 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;
 
        (new InitHttpServices())->init($this->dic);
    }

References ILIAS_UI_TestBase\getLanguage(), and ILIAS_UI_TestBase\getTemplateFactory().

Referenced by setUp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ testAllExamplesRenderAString()

ExamplesTest::testAllExamplesRenderAString	(	string	$example_function_name,
		string	$example_path
	)

@dataProvider provideExampleFullFunctionNamesAndPath

Definition at line 116 of file ExamplesTest.php.

                                                                                                     : 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);
        }
    }

References $DIC, $dic, and Vendor\Package\$e.

◆ testAllNonAbstractComponentsShowcaseExamples()

ExamplesTest::testAllNonAbstractComponentsShowcaseExamples ( )

Exceptions

Crawler

Exception\CrawlerException

Definition at line 96 of file ExamplesTest.php.

                                                                  : void
    {
        global $DIC;
        $DIC = $this->dic;
 
        foreach ($this->getEntriesFromCrawler() as $entry) {
            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()
                );
            }
        }
    }

References $DIC, $dic, and getEntriesFromCrawler().

Here is the call graph for this function:

◆ testFullscreenModeExamples()

ExamplesTest::testFullscreenModeExamples	(	string	$example_function_name,
		string	$example_path
	)

@dataProvider provideListOfFullscreenExamples

Definition at line 155 of file ExamplesTest.php.

                                                                                                   : 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);
        }
    }

References $DIC, $dic, and Vendor\Package\$e.

Field Documentation

◆ $dic

Container ExamplesTest::$dic

protected

Definition at line 35 of file ExamplesTest.php.

Referenced by testAllExamplesRenderAString(), testAllNonAbstractComponentsShowcaseExamples(), and testFullscreenModeExamples().

◆ $path_to_base_factory

string ExamplesTest::$path_to_base_factory = "src/UI/Factory.php"

protected

Definition at line 34 of file ExamplesTest.php.

The documentation for this class was generated from the following file:

tests/UI/Examples/ExamplesTest.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ getEntriesFromCrawler()

◆ provideExampleFullFunctionNamesAndPath()

◆ provideListOfFullscreenExamples()

◆ setUp()

◆ setUpMockDependencies()

◆ testAllExamplesRenderAString()

◆ testAllNonAbstractComponentsShowcaseExamples()

◆ testFullscreenModeExamples()

Field Documentation

◆ $dic

◆ $path_to_base_factory