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)
	testAllExamplesHaveExpectedOutcomeInDocs (string $example_function_name, string $example_path)
	testFullscreenModeExamples (string $example_function_name, string $example_path)

Static Public Member Functions
static	getFullFunctionNamesAndPathExample ()
static	getListOfFullscreenExamples ()

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

Static Protected Member Functions
static	getEntriesFromCrawler ()

Protected Attributes
const	MAY_NOT_HAVE_EXAMPLES
Container	$dic
Crawler ExamplesYamlParser	$example_parser

Static Protected Attributes
static string	$path_to_base_factory = "components/ILIAS/UI/src/Factory.php"

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

static ExamplesTest::getEntriesFromCrawler ( )

staticprotected

Exceptions

Crawler

Exception\CrawlerException

Definition at line 165 of file ExamplesTest.php.

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

Referenced by testAllNonAbstractComponentsShowcaseExamples().

Here is the caller graph for this function:

getFullFunctionNamesAndPathExample()

static ExamplesTest::getFullFunctionNamesAndPathExample ( )

static

Definition at line 171 of file ExamplesTest.php.

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

getListOfFullscreenExamples()

static ExamplesTest::getListOfFullscreenExamples ( )

static

Definition at line 199 of file ExamplesTest.php.

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

setUp()

ExamplesTest::setUp

(

)

Definition at line 50 of file ExamplesTest.php.

                           : 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";
 
        // allows example Unit Tests to find resources like additional data or css
        if (!defined('ILIAS_ABSOLUTE_PATH')) {
            define('ILIAS_ABSOLUTE_PATH', realpath(__DIR__ . '/../../../../../'));
        }
 
        //This avoids Undefined index: ilfilehash for the moment
        $_POST["ilfilehash"] = "";
        $this->setUpMockDependencies();
        $this->example_parser = new Crawler\ExamplesYamlParser();
    }

References $_POST, $_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 76 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;
 
        $this->dic["help.text_retriever"] = new ILIAS\UI\Help\TextRetriever\Echoing();
 
        (new InitHttpServices())->init($this->dic);
    }

References getLanguage(), and init().

Referenced by setUp().

Here is the call graph for this function:

Here is the caller graph for this function:

testAllExamplesHaveExpectedOutcomeInDocs()

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

Definition at line 156 of file ExamplesTest.php.

    {
        $docs = $this->example_parser->parseYamlStringArrayFromFile($example_path);
        $this->assertArrayHasKey('expected output', $docs);
    }

testAllExamplesRenderAString()

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

Definition at line 142 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 121 of file ExamplesTest.php.

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

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

Here is the call graph for this function:

testFullscreenModeExamples()

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

Definition at line 186 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 47 of file ExamplesTest.php.

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

$example_parser

Crawler ExamplesYamlParser ExamplesTest::$example_parser

protected

Definition at line 48 of file ExamplesTest.php.

$path_to_base_factory

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

staticprotected

Definition at line 46 of file ExamplesTest.php.

MAY_NOT_HAVE_EXAMPLES

const ExamplesTest::MAY_NOT_HAVE_EXAMPLES

protected

Initial value:

= [
        \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,
    ]

Definition at line 38 of file ExamplesTest.php.

---

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

• components/ILIAS/UI/tests/Examples/ExamplesTest.php