ExamplesTest Class Reference

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)
	getFullFunctionNamesAndPathExample More...
	getFullFunctionNamesAndPathExample ()
	testFullscreenModeExamples (string $example_function_name, string $example_path)
	getListOfFullscreenExamples More...
	getListOfFullscreenExamples ()
Public Member Functions inherited from ILIAS_UI_TestBase
	setUp ()
	tearDown ()
	getUIFactory ()
	getTemplateFactory ()
	getResourceRegistry ()
	getLanguage ()
	getJavaScriptBinding ()
	getRefinery ()
	getImagePathResolver ()
	getDataFactory ()
	getHelpTextRetriever ()
	getUploadLimitResolver ()
	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

Definition at line 145 of file ExamplesTest.php.

Referenced by getFullFunctionNamesAndPathExample(), and testAllNonAbstractComponentsShowcaseExamples().

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

Here is the caller graph for this function:

getFullFunctionNamesAndPathExample()

ExamplesTest::getFullFunctionNamesAndPathExample

(

)

Definition at line 151 of file ExamplesTest.php.

References getEntriesFromCrawler().

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

Here is the call graph for this function:

getListOfFullscreenExamples()

ExamplesTest::getListOfFullscreenExamples

(

)

Definition at line 181 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\ui', "src/UI/examples/Layout/Page/Standard/ui.php"],
            ['ILIAS\UI\examples\MainControls\ModeInfo\renderModeInfoFullscreenMode', "src/UI/examples/MainControls/ModeInfo/modeinfo.php"]
        ];
    }

setUp()

ExamplesTest::setUp

(

)

Definition at line 37 of file ExamplesTest.php.

References $_SERVER, and setUpMockDependencies().

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

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 57 of file ExamplesTest.php.

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

Referenced by setUp().

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

        $this->dic["ilUser"] = $this->getMockBuilder(\ilObjUser::class)
                ->disableOriginalConstructor()
                ->onlyMethods(["getDateFormat"])
                ->getMock();

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

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
	)

getFullFunctionNamesAndPathExample

Definition at line 129 of file ExamplesTest.php.

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

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

testAllNonAbstractComponentsShowcaseExamples()

ExamplesTest::testAllNonAbstractComponentsShowcaseExamples

(

)

Exceptions

Crawler

Definition at line 106 of file ExamplesTest.php.

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

                                                                  : void
    {
        global $DIC;
        $DIC = $this->dic;

        foreach ($this->getEntriesFromCrawler() as $entry) {
            if ($entry->getNamespace() === "\ILIAS\UI\Help\Topic[]") {
                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()
                );
            }
        }
    }

Here is the call graph for this function:

testFullscreenModeExamples()

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

getListOfFullscreenExamples

Definition at line 168 of file ExamplesTest.php.

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

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

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