Provides common functionality for UI tests. More...

Inheritance diagram for ILIAS_UI_TestBase:

Collaboration diagram for ILIAS_UI_TestBase:

Public Member Functions
	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
	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...

Detailed Description

Provides common functionality for UI tests.

Definition at line 298 of file Base.php.

Member Function Documentation

◆ assertHTMLEquals()

ILIAS_UI_TestBase::assertHTMLEquals	(	string	$expected_html_as_string,
		string	$html_as_string
	)

Definition at line 427 of file Base.php.

                                                                                             : void
    {
        $html = new DOMDocument();
        $html->formatOutput = true;
        $html->preserveWhiteSpace = false;
        $expected = new DOMDocument();
        $expected->formatOutput = true;
        $expected->preserveWhiteSpace = false;
        $html->loadXML($this->normalizeHTML($html_as_string));
        $expected->loadXML($this->normalizeHTML($expected_html_as_string));
        $this->assertEquals($expected->saveHTML(), $html->saveHTML());
    }

Here is the caller graph for this function:

◆ brutallyTrimHTML()

ILIAS_UI_TestBase::brutallyTrimHTML ( string $html )

protected

A more radical version of normalizeHTML.

Use if hard to tackle issues occur by asserting due string outputs produce an equal DOM

Reimplemented in FileInputTest, MetaBarTest, ExpandableTreeTest, and SimpleNodeTest.

Definition at line 444 of file Base.php.

                                                     : string
    {
        $html = str_replace(["\n", "\r", "\t"], "", $html);
        $html = preg_replace('# {2,}#', " ", $html);
        $html = preg_replace('/<!--(.|\s)*?-->/', '', $html);
        $html = preg_replace("/>(\s+)</", "><", $html);
        $html = str_replace(" >", ">", $html);
        $html = str_replace(" <", "<", $html);
        return trim($html);
    }

Here is the caller graph for this function:

◆ brutallyTrimSignals()

ILIAS_UI_TestBase::brutallyTrimSignals ( string $html )

protected

A naive replacement of all il_signal-ids with dots to ease comparisons of rendered output.

Definition at line 459 of file Base.php.

                                                        : string
    {
        $html = preg_replace('/il_signal_(\w+)/', "il_signal...", $html);
        return $html;
    }

Referenced by PresentationTest\testFullRendering(), PresentationTest\testMinimalRendering(), ScoreSettingsTest\testScoreSettingsSectionDetails(), ScoreSettingsTest\testScoreSettingsSectionGamification(), ScoreSettingsTest\testScoreSettingsSectionScoring(), and ScoreSettingsTest\testScoreSettingsSectionSummary().

Here is the caller graph for this function:

◆ getDataFactory()

ILIAS_UI_TestBase::getDataFactory ( )

Reimplemented in ChartBarTest, ViewControlBaseTest, and DataRendererTest.

Definition at line 350 of file Base.php.

                                    : DataFactory
    {
        return $this->createMock(DataFactory::class);
    }

Referenced by GlyphTest\test_dont_render_counter(), BarConfigTest\test_with_color(), and BarConfigTest\test_with_width().

Here is the caller graph for this function:

◆ getDecoratedRenderer()

ILIAS_UI_TestBase::getDecoratedRenderer ( Renderer $default )

Definition at line 417 of file Base.php.

    {
        return new TestDecoratedRenderer($default);
    }

Referenced by DecoratedRendererTest\test_render(), DecoratedRendererTest\test_render_async(), and DecoratedRendererTest\test_render_with_manipulation().

Here is the caller graph for this function:

◆ getDefaultRenderer()

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

Reimplemented in SystemInfoTest.

Definition at line 355 of file Base.php.

     : TestDefaultRenderer {
        $ui_factory = $this->getUIFactory();
        $tpl_factory = $this->getTemplateFactory();
        $resource_registry = $this->getResourceRegistry();
        $lng = $this->getLanguage();
        if (!$js_binding) {
            $js_binding = $this->getJavaScriptBinding();
        }
 
        $refinery = $this->getRefinery();
        $image_path_resolver = $this->getImagePathResolver();
        $data_factory = $this->getDataFactory();
 
        $component_renderer_loader = new Render\LoaderCachingWrapper(
            new Render\LoaderResourceRegistryWrapper(
                $resource_registry,
                new Render\FSLoader(
                    new DefaultRendererFactory(
                        $ui_factory,
                        $tpl_factory,
                        $lng,
                        $js_binding,
                        $refinery,
                        $image_path_resolver,
                        $data_factory
                    ),
                    new GlyphRendererFactory(
                        $ui_factory,
                        $tpl_factory,
                        $lng,
                        $js_binding,
                        $refinery,
                        $image_path_resolver,
                        $data_factory
                    ),
                    new IconRendererFactory(
                        $ui_factory,
                        $tpl_factory,
                        $lng,
                        $js_binding,
                        $refinery,
                        $image_path_resolver,
                        $data_factory
                    ),
                    new FieldRendererFactory(
                        $ui_factory,
                        $tpl_factory,
                        $lng,
                        $js_binding,
                        $refinery,
                        $image_path_resolver,
                        $data_factory
                    )
                )
            )
        );
        return new TestDefaultRenderer($component_renderer_loader, $with_stub_renderings);
    }

Here is the caller graph for this function:

◆ getImagePathResolver()

ILIAS_UI_TestBase::getImagePathResolver ( )

Definition at line 345 of file Base.php.

                                          : ilImagePathResolver
    {
        return new ilImagePathResolver();
    }

◆ getJavaScriptBinding()

ILIAS_UI_TestBase::getJavaScriptBinding ( )

Definition at line 330 of file Base.php.

                                          : LoggingJavaScriptBinding
    {
        return new LoggingJavaScriptBinding();
    }

Referenced by DataRendererTest\getRenderer(), GlyphTest\test_dont_render_counter(), and DateTimeInputTest\test_jsConfigRendering().

Here is the caller graph for this function:

◆ getLanguage()

ILIAS_UI_TestBase::getLanguage ( )

Reimplemented in DateTimeInputTest.

Definition at line 325 of file Base.php.

                                 : ilLanguageMock
    {
        return new ilLanguageMock();
    }

Referenced by NumericInputTest\buildFactory(), ViewControlContainerTest\buildFieldFactory(), ViewControlBaseTest\buildFieldFactory(), TableTestBase\buildFieldFactory(), ViewControlContainerTest\buildVCFactory(), ViewControlBaseTest\buildVCFactory(), DataRendererTest\getColumnFactory(), ScoreSettingsTest\getFieldFactory(), GroupInputTest\getFieldFactory(), SectionInputTest\getFieldFactory(), DataRendererTest\getRenderer(), TableTestBase\getTableFactory(), ScoreSettingsTest\getUIPack(), TableTestBase\getViewControlFactory(), ILIAS\Tests\UI\Component\Input\Container\Form\NoSubmitFormTest\setUp(), ExamplesTest\setUpMockDependencies(), GlyphTest\test_dont_render_counter(), DataRendererTest\testRenderEmptyDataCell(), and ScoreSettingsTest\testScoreSettingsSectionSummary().

Here is the caller graph for this function:

◆ getRefinery()

ILIAS_UI_TestBase::getRefinery ( )

Returns: \ILIAS\Refinery\Factory|mixed|MockObject

Definition at line 338 of file Base.php.

    {
        return $this->getMockBuilder(\ILIAS\Refinery\Factory::class)
            ->disableOriginalConstructor()
            ->getMock();
    }

Referenced by ScoreSettingsTest\getFieldFactory(), GroupInputTest\getFieldFactory(), SectionInputTest\getFieldFactory(), DataRendererTest\getRenderer(), ScoreSettingsTest\getUIPack(), and GlyphTest\test_dont_render_counter().

Here is the caller graph for this function:

◆ getResourceRegistry()

ILIAS_UI_TestBase::getResourceRegistry ( )

Reimplemented in DefaultRendererTest.

Definition at line 320 of file Base.php.

                                         : LoggingRegistry
    {
        return new LoggingRegistry();
    }

◆ getTemplateFactory()

ILIAS_UI_TestBase::getTemplateFactory ( )

Definition at line 315 of file Base.php.

                                        : ilIndependentTemplateFactory
    {
        return new ilIndependentTemplateFactory();
    }

Referenced by DataRendererTest\getRenderer(), ExamplesTest\setUpMockDependencies(), GlyphTest\test_dont_render_counter(), DefaultRendererTest\test_render_async_array(), DefaultRendererTest\test_render_async_no_js(), DefaultRendererTest\test_render_async_with_js(), DefaultRendererTest\test_render_async_with_js_twice(), DataRendererTest\testDataTableRenderHeaderWithActions(), DataRendererTest\testDataTableRenderHeaderWithoutSortableColums(), and DataRendererTest\testDataTableRenderTableHeader().

Here is the caller graph for this function:

◆ getUIFactory()

ILIAS_UI_TestBase::getUIFactory ( )

Reimplemented in ScoreSettingsTest, ChartBarTest, FilterTest, StandardFilterTest, FormTest, StandardFormTest, DateTimeInputTest, DurationInputTest, FileInputTest, ViewControlBaseTest, ItemNotificationClientHtmlTest, ItemNotificationTest, StandardPageTest, LegacyTest, FooterTest, MainBarTest, MetaBarTest, ModeInfoTest, CombinedSlateTest, DrilldownSlateTest, NotificationSlateTest, SystemInfoTest, DrilldownTest, MessageBoxTest, ModalBase, PanelSecondaryLegacyTest, PanelSecondaryListingTest, PanelTest, PlayerAudioTest, PlayerVideoTest, DataRendererTest, PresentationTest, ToastClientHtmlTest, ExpandableTreeTest, PaginationTest, SortationTest, and ViewControlTest.

Definition at line 310 of file Base.php.

                                  : NoUIFactory
    {
        return new NoUIFactory();
    }

Referenced by GlyphTest\test_dont_render_counter().

Here is the caller graph for this function:

◆ normalizeHTML()

ILIAS_UI_TestBase::normalizeHTML ( string $html )

Reimplemented in ModalBase.

Definition at line 422 of file Base.php.

                                               : string
    {
        return trim(str_replace(["\n", "\r"], "", $html));
    }

Here is the caller graph for this function:

◆ setUp()

ILIAS_UI_TestBase::setUp ( )

Reimplemented in LSLocatorBuilderTest, BulkyButtonTest, MinimizeButtonTest, ILIAS\Tests\UI\Component\Dropzone\File\FileTestBase, ILIAS\Tests\UI\Component\Input\Container\Form\NoSubmitFormTest, CheckboxInputTest, DateTimeInputTest, DurationInputTest, FileInputTest, GroupInputTest, HiddenInputTest, InputTest, LinkInputTest, MultiSelectInputTest, NumericInputTest, OptionalGroupInputTest, PasswordInputTest, RadioInputTest, SelectInputTest, SwitchableGroupInputTest, TagInputTest, TextareaTest, TextInputTest, UrlInputTest, ItemNotificationClientHtmlTest, ItemNotificationTest, StandardPageTest, BulkyLinkTest, LinearWorkflowTest, WorkflowStepTest, FooterTest, MainBarTest, MetaBarTest, ModeInfoTest, CombinedSlateTest, NotificationSlateTest, SlateTest, SystemInfoTest, DrilldownTest, ActionTest, ColumnTest, ExpandableTreeTest, BylineNodeTest, SimpleNodeTest, ExamplesTest, and AbstractRendererTest.

Definition at line 300 of file Base.php.

                           : void
    {
        assert_options(ASSERT_WARNING, 0);
    }

◆ tearDown()

ILIAS_UI_TestBase::tearDown ( )

Definition at line 305 of file Base.php.

                              : void
    {
        assert_options(ASSERT_WARNING, 1);
    }

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

tests/UI/Base.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ assertHTMLEquals()

◆ brutallyTrimHTML()

◆ brutallyTrimSignals()

◆ getDataFactory()

◆ getDecoratedRenderer()

◆ getDefaultRenderer()

◆ getImagePathResolver()

◆ getJavaScriptBinding()

◆ getLanguage()

◆ getRefinery()

◆ getResourceRegistry()

◆ getTemplateFactory()

◆ getUIFactory()

◆ normalizeHTML()

◆ setUp()

◆ tearDown()