ILIAS  trunk Revision v12.0_alpha-377-g3641b37b9db
FieldAsyncNodeTest.php
Go to the documentation of this file.
1<?php
2
18declare(strict_types=1);
19
20use ILIAS\UI\Component\Input\Field\Node\NodeRetrieval;
21use ILIAS\UI\Implementation\Render\JavaScriptBinding;
22use ILIAS\UI\Implementation\Component\Input\Field;
23use ILIAS\UI\Implementation\Component;
24use PHPUnit\Framework\MockObject\MockObject;
25use PHPUnit\Framework\Attributes\DataProvider;
26
27require_once(__DIR__ . "/../../../../../../../../vendor/composer/vendor/autoload.php");
28require_once(__DIR__ . "/../../../../Base.php");
29
33class FieldAsyncNodeTest extends \ILIAS_UI_TestBase
34{
35 protected Component\Symbol\Glyph\Glyph & MockObject $glyph_stub;
36 protected string $glyph_html;
37 protected Component\Symbol\Icon\Icon & MockObject $icon_stub;
38 protected string $icon_html;
39 protected \ILIAS\Data\URI & MockObject $uri_stub;
40 protected string $uri_string;
41
42 protected Component\Symbol\Glyph\Factory & MockObject $glyph_factory;
43 protected Component\Symbol\Icon\Factory & MockObject $icon_factory;
44 protected Component\Symbol\Factory & MockObject $symbol_factory;
45
46 protected function setUp(): void
47 {
48 $this->uri_string = sha1(\ILIAS\Data\URI::class);
49 $this->uri_stub = $this->createMock(\ILIAS\Data\URI::class);
50 $this->uri_stub->method('__toString')->willReturn($this->uri_string);
51
52 [$this->glyph_stub, $this->glyph_html] = $this->getGlyphStub();
53 [$this->icon_stub, $this->icon_html] = $this->getIconStub();
54
55 $this->glyph_factory = $this->createMock(Component\Symbol\Glyph\Factory::class);
56 $this->glyph_factory->method($this->anything())->willReturn($this->glyph_stub);
57
58 $this->icon_factory = $this->createMock(Component\Symbol\Icon\Factory::class);
59 $this->icon_factory->method('standard')->willReturn($this->icon_stub);
60
61 $this->symbol_factory = $this->createMock(Component\Symbol\Factory::class);
62 $this->symbol_factory->method('glyph')->willReturn($this->glyph_factory);
63 $this->symbol_factory->method('icon')->willReturn($this->icon_factory);
64
65 parent::setUp();
66 }
67
68 public function getDefaultRenderer(
69 ?JavaScriptBinding $js_binding = null,
70 array $with_stub_renderings = [],
71 array $with_additional_contexts = [],
72 ): TestDefaultRenderer {
73 $with_stub_renderings = array_merge($with_stub_renderings, [
74 $this->glyph_stub,
75 $this->icon_stub,
76 ]);
77
78 return parent::getDefaultRenderer($js_binding, $with_stub_renderings, $with_additional_contexts);
79 }
80
81 public function getUIFactory(): \NoUIFactory
82 {
83 return new class ($this->symbol_factory) extends \NoUIFactory {
84 public function __construct(
85 protected Component\Symbol\Factory $symbol_factory,
86 ) {
87 }
88 public function symbol(): Component\Symbol\Factory
89 {
90 return $this->symbol_factory;
91 }
92 };
93 }
94
95 public function testRenderWithUrl(): void
96 {
97 $node_id = 'some-existing-node-id';
98 $node_name = 'some existing node name';
99
100 $component = $this->getNodeFactory()->async($this->uri_stub, [$node_id], $node_name);
101 $renderer = $this->getDefaultRenderer();
102
103 $expected = <<<HTML
104<li data-node-id="$node_id" class="c-input-node c-input-node__async c-drilldown__branch" data-render-url="$this->uri_string">
105 <button type="button" class="c-drilldown__menulevel--trigger" aria-expanded="false">
106 <span> $this->icon_html<span data-node-name>$node_name</span></span>
107 <span> $this->glyph_html</span>
108 </button>
109 <button type="button" class="c-input-node__select" aria-label="select_node">
110 <span data-action="select">$this->glyph_html</span>
111 <span class="hidden" data-action="remove">$this->glyph_html</span>
112 </button>
113 <ul></ul>
114</li>
115HTML;
116
117 $actual = $renderer->render($component);
118
119 $this->assertEquals(
120 $this->brutallyTrimHTML($expected),
121 $this->brutallyTrimHTML($actual),
122 );
123 }
124
125 protected function testRenderWithIcon(): void
126 {
127 [$icon_stub, $icon_html] = $this->createSimpleRenderingStub(Component\Symbol\Icon\Custom::class);
128
129 $component = $this->getNodeFactory()->async($this->uri_stub, [''], $icon_stub);
130 $renderer = $this->getDefaultRenderer(null, [$icon_stub]);
131
132 $actual = $renderer->render($component);
133
134 $this->assertTrue(str_contains($actual, $icon_html));
135 }
136
137 public function testRenderWithoutIcon(): void
138 {
139 $first_node_name_letter = 's';
140 $node_name = "{$first_node_name_letter}ome existing node name";
141
142 $this->icon_factory->expects($this->once())->method('standard');
143 $this->icon_stub->expects($this->once())->method('withAbbreviation')->with($first_node_name_letter);
144
145 $component = $this->getNodeFactory()->async($this->uri_stub, [''], $node_name);
146 $renderer = $this->getDefaultRenderer();
147
148 $actual = $renderer->render($component);
149
150 $this->assertTrue(str_contains($actual, $this->icon_html));
151 }
152
153 protected function testConstructorWithValidNodePath(): void
154 {
155 $root_node_id = 0;
156 $level_one_node_id = 1;
157 $level_two_node_id = 2;
158 $parent_ids = [$root_node_id, $level_one_node_id];
159 $full_node_path = [...$parent_ids, $level_two_node_id];
160
161 $node = $this->getNodeFactory()->async($this->uri_stub, $full_node_path, "");
162
163 $this->assertEquals($full_node_path, $node->getFullPath());
164 $this->assertEquals($parent_ids, $node->getParentIds());
165 $this->assertEquals($level_two_node_id, $node->getId());
166 }
167
168 #[DataProvider('provideInvalidNodePaths')]
169 protected function testConstructorWithInvalidNodePath(array $path): void
170 {
171 $this->expectException(\InvalidArgumentException::class);
172 $this->getNodeFactory()->async($this->uri_stub, $path, "");
173 }
174
175 public static function provideInvalidNodePaths(): array
176 {
177 return [
178 [1.0],
179 [false],
180 [null],
181 [],
182 ];
183 }
184
185 protected function getNodeFactory(): Field\Node\Factory
186 {
187 return new Field\Node\Factory();
188 }
189
191 protected function getGlyphStub(): array
192 {
193 return $this->createSimpleRenderingStub(Component\Symbol\Glyph\Glyph::class);
194 }
195
197 protected function getIconStub(): array
198 {
199 return $this->createSimpleRenderingStub(Component\Symbol\Icon\Standard::class);
200 }
201
203 protected function createSimpleRenderingStub(string $class_name): array
204 {
205 $stub = $this->createMock($class_name);
206 $html = sha1($class_name);
207 $stub->method('getCanonicalName')->willReturn($html);
208 $stub->method($this->anything())->willReturnSelf();
209 return [$stub, $html];
210 }
211}
$renderer
$renderer
Definition: build_bootstrap.php:83
FieldAsyncNodeTest\$icon_stub
Component Symbol Icon Icon &MockObject $icon_stub
Definition: FieldAsyncNodeTest.php:37
FieldAsyncNodeTest\createSimpleRenderingStub
createSimpleRenderingStub(string $class_name)
Definition: FieldAsyncNodeTest.php:203
FieldAsyncNodeTest\testConstructorWithInvalidNodePath
testConstructorWithInvalidNodePath(array $path)
Definition: FieldAsyncNodeTest.php:169
FieldAsyncNodeTest\$icon_factory
Component Symbol Icon Factory &MockObject $icon_factory
Definition: FieldAsyncNodeTest.php:43
FieldAsyncNodeTest\$uri_stub
ILIAS Data URI &MockObject $uri_stub
Definition: FieldAsyncNodeTest.php:39
FieldAsyncNodeTest\getDefaultRenderer
getDefaultRenderer(?JavaScriptBinding $js_binding=null, array $with_stub_renderings=[], array $with_additional_contexts=[],)
Definition: FieldAsyncNodeTest.php:68
FieldAsyncNodeTest\$glyph_factory
Component Symbol Glyph Factory &MockObject $glyph_factory
Definition: FieldAsyncNodeTest.php:42
FieldAsyncNodeTest\$glyph_stub
Component Symbol Glyph Glyph &MockObject $glyph_stub
Definition: FieldAsyncNodeTest.php:35
FieldAsyncNodeTest\$symbol_factory
Component Symbol Factory &MockObject $symbol_factory
Definition: FieldAsyncNodeTest.php:44
ILIAS\Data\DateFormat\Factory
Factory for Date Formats.
Definition: Factory.php:27
ILIAS_UI_TestBase
Provides common functionality for UI tests.
Definition: Base.php:337
ILIAS\UI\Component\Input\Field\Factory
This is what a factory for input fields looks like.
Definition: Factory.php:31
ILIAS\UI\Component\Symbol\Symbol
This describes a symbol.
Definition: Symbol.php:30
ILIAS\UI\Implementation\Render\JavaScriptBinding
Provides methods to interface with javascript.
Definition: JavaScriptBinding.php:27
$path
$path
Definition: ltiservices.php:30
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
Definition: PluginProviderHelper.php:38
ILIAS\Repository\button
button(string $caption, string $cmd)
Definition: trait.GlobalDICGUIServices.php:193
ILIAS\UI\Implementation\Component\Input\Field
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: Checkbox.php:21
ILIAS
Interface Observer \BackgroundTasks Contains several chained tasks and infos about them.
Definition: AccessControl.php:21