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

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

	getDecoratedRenderer (Renderer $default)

	normalizeHTML ($html)

	assertHTMLEquals ($expected_html_as_string, $html_as_string)

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

Detailed Description

Provides common functionality for UI tests.

Definition at line 262 of file Base.php.

Member Function Documentation

◆ assertHTMLEquals()

ILIAS_UI_TestBase::assertHTMLEquals	(	$expected_html_as_string,
		$html_as_string
	)

Parameters

string	$expected_html_as_string
string	$html_as_string

Definition at line 372 of file Base.php.

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

References normalizeHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ brutallyTrimHTML()

ILIAS_UI_TestBase::brutallyTrimHTML ( $html )

protected

A more radical version of normalizeHTML.

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

Parameters

$html

Returns: string

Reimplemented in MetaBarTest, CombinedSlateTest, DrilldownTest, ExpandableTreeTest, and SimpleNodeTest.

Definition at line 392 of file Base.php.

    {
        $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:

◆ getDecoratedRenderer()

ILIAS_UI_TestBase::getDecoratedRenderer ( Renderer $default )

Definition at line 358 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`,
			$with_stub_renderings = `[]`
	)

Reimplemented in FileInputTest, and SystemInfoTest.

Definition at line 311 of file Base.php.

    {
        $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();
 
        $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
                    ),
                    new GlyphRendererFactory(
                        $ui_factory,
                        $tpl_factory,
                        $lng,
                        $js_binding,
                        $refinery,
                        $image_path_resolver
                    ),
                    new FieldRendererFactory(
                        $ui_factory,
                        $tpl_factory,
                        $lng,
                        $js_binding,
                        $refinery,
                        $image_path_resolver
                    )
                )
            )
        );
        return new TestDefaultRenderer($component_renderer_loader, $with_stub_renderings);
    }

References $lng, getImagePathResolver(), getJavaScriptBinding(), getLanguage(), getRefinery(), getResourceRegistry(), getTemplateFactory(), and getUIFactory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImagePathResolver()

ILIAS_UI_TestBase::getImagePathResolver ( )

Definition at line 306 of file Base.php.

    {
        return new ilImagePathResolver();
    }

Referenced by getDefaultRenderer().

Here is the caller graph for this function:

◆ getJavaScriptBinding()

ILIAS_UI_TestBase::getJavaScriptBinding ( )

Definition at line 294 of file Base.php.

    {
        return new LoggingJavaScriptBinding();
    }

Referenced by getDefaultRenderer(), FileInputTest\getDefaultRenderer(), 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 289 of file Base.php.

    {
        return new ilLanguageMock();
    }

Referenced by NumericInputTest\buildFactory(), getDefaultRenderer(), FileInputTest\getDefaultRenderer(), GroupInputTest\getFieldFactory(), SectionInputTest\getFieldFactory(), and GlyphTest\test_dont_render_counter().

Here is the caller graph for this function:

◆ getRefinery()

ILIAS_UI_TestBase::getRefinery ( )

Definition at line 299 of file Base.php.

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

Referenced by getDefaultRenderer(), FileInputTest\getDefaultRenderer(), GroupInputTest\getFieldFactory(), SectionInputTest\getFieldFactory(), 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 284 of file Base.php.

    {
        return new LoggingRegistry();
    }

Referenced by getDefaultRenderer(), and FileInputTest\getDefaultRenderer().

Here is the caller graph for this function:

◆ getTemplateFactory()

ILIAS_UI_TestBase::getTemplateFactory ( )

Definition at line 279 of file Base.php.

    {
        return new ilIndependentTemplateFactory();
    }

Referenced by getDefaultRenderer(), FileInputTest\getDefaultRenderer(), GlyphTest\test_dont_render_counter(), DefaultRendererTest\test_render_async_array(), DefaultRendererTest\test_render_async_no_js(), DefaultRendererTest\test_render_async_with_js(), and DefaultRendererTest\test_render_async_with_js_twice().

Here is the caller graph for this function:

◆ getUIFactory()

ILIAS_UI_TestBase::getUIFactory ( )

Reimplemented in DropzoneRendererTest, FilterTest, StandardFilterTest, FormTest, StandardFormTest, DateTimeInputTest, DurationInputTest, FileInputTest, ItemNotificationTest, LegacyTest, FooterTest, MetaBarTest, ModeInfoTest, CombinedSlateTest, NotificationSlateTest, SystemInfoTest, DrilldownTest, MessageBoxTest, ModalBase, PanelSecondaryLegacyTest, PanelSecondaryListingTest, PanelTest, ExpandableTreeTest, PaginationTest, SortationTest, and ViewControlTest.

Definition at line 274 of file Base.php.

    {
        return new NoUIFactory();
    }

Referenced by getDefaultRenderer(), and GlyphTest\test_dont_render_counter().

Here is the caller graph for this function:

◆ normalizeHTML()

ILIAS_UI_TestBase::normalizeHTML ( $html )

Reimplemented in ModalBase.

Definition at line 363 of file Base.php.

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

Here is the caller graph for this function:

◆ setUp()

ILIAS_UI_TestBase::setUp ( )

Reimplemented in LSLocatorBuilderTest, BulkyButtonTest, DropzoneRendererTest, CheckboxInputTest, DateTimeInputTest, DurationInputTest, FileInputTest, GroupInputTest, InputTest, MultiSelectInputTest, NumericInputTest, OptionalGroupInputTest, PasswordInputTest, RadioInputTest, SelectInputTest, SwitchableGroupInputTest, TagInputTest, TextareaTest, TextInputTest, ItemNotificationTest, StandardPageTest, BulkyLinkTest, LinearWorkflowTest, WorkflowStepTest, FooterTest, MainBarTest, MetaBarTest, ModeInfoTest, CombinedSlateTest, NotificationSlateTest, SlateTest, SystemInfoTest, DrilldownTest, ExpandableTreeTest, BylineNodeTest, SimpleNodeTest, and AbstractRendererTest.

Definition at line 264 of file Base.php.

                            : void
    {
        assert_options(ASSERT_WARNING, 0);
    }

◆ tearDown()

ILIAS_UI_TestBase::tearDown ( )

Definition at line 269 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()

◆ getDecoratedRenderer()

◆ getDefaultRenderer()

◆ getImagePathResolver()

◆ getJavaScriptBinding()

◆ getLanguage()

◆ getRefinery()

◆ getResourceRegistry()

◆ getTemplateFactory()

◆ getUIFactory()

◆ normalizeHTML()

◆ setUp()

◆ tearDown()