NavigationGuiPresentationTester::clickRootNode() - Code Metrics - spryker-shop/b2c-demo-shop - Measure and Improve Code Quality continuously with Scrutinizer

NavigationGuiPresentationTester::clickRootNode() A
last analyzed 2025-10-28 11:24 UTC

↳ Parent: NavigationGuiPresentationTester

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

/**
 * This file is part of the Spryker Commerce OS.
 * For full license information, please view the LICENSE file that was distributed with this source code.
 */

declare(strict_types = 1);

namespace PyzTest\Zed\NavigationGui;

use Codeception\Actor;
use Exception;
use Generated\Shared\Transfer\NavigationTreeNodeTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\NavigationTreeTransfer;
filter:
    dependency_paths: ["lib/*"]
use Orm\Zed\Navigation\Persistence\SpyNavigation;
use Orm\Zed\Navigation\Persistence\SpyNavigationQuery;

/**
 * Inherited Methods
 *
 * @method void wantToTest($text)
 * @method void wantTo($text)
 * @method void execute($callable)
 * @method void expectTo($prediction)
 * @method void expect($prediction)
 * @method void amGoingTo($argumentation)
 * @method void am($role)
 * @method void lookForwardTo($achieveValue)
 * @method void comment($description)
 * @method \Codeception\Lib\Friend haveFriend($name, $actorClass = NULL)
 *
 * @SuppressWarnings(\PyzTest\Zed\NavigationGui\PHPMD)
 */
class NavigationGuiPresentationTester extends Actor
{
    use _generated\NavigationGuiPresentationTesterActions;
filter:
    dependency_paths: ["lib/*"]

    /**
     * @var string
     */
    public const ROOT_NODE_ANCHOR_SELECTOR = '#navigation-node-0_anchor';

    /**
     * @var string
     */
    public const CHILD_NODE_ANCHOR_SELECTOR = '#navigation-node-%d_anchor';

    /**
     * @var string
     */
    public const NAVIGATION_NODE_SELECTOR = '.jstree-node';

    /**
     * @var string
     */
    public const NAVIGATION_TREE_SELECTOR = '#navigation-tree';

    /**
     * @var string
     */
    public const NAVIGATION_TREE_SAVE_BUTTON_SELECTOR = '#navigation-tree-save-btn';

    /**
     * @var string
     */
    public const REMOVE_NODE_BUTTON_SELECTOR = '#remove-selected-node-btn';

    /**
     * @var string
     */
    public const ADD_CHILD_NODE_BUTTON_SELECTOR = '#add-child-node-btn';

    /**
     * @var string
     */
    public const LOCALIZED_FORM_CONTAINER_SELECTOR = '#localized_attributes_container-%s .collapse-link';

    /**
     * @var string
     */
    public const NODE_CHILD_SELECTOR = '#navigation-node-%d #navigation-node-%d';

    /**
     * @var string
     */
    public const NODE_NAME_CHILD_SELECTOR = "//*[@id=\"navigation-node-%d\"]//*[text()[contains(.,'%s')]]";

    /**
     * @var string
     */
    public const NODE_FORM_IFRAME_NAME = 'navigation-node-form-iframe';

    /**
     * @var string
     */
    public const SUCCESS_MESSAGE_SELECTOR = '.flash-messages .alert-success';

    /**
     * @var string
     */
    public const SWEET_ALERT_SELECTOR = '.sweet-alert';

    /**
     * @var string
     */
    public const SWEET_ALERT_CONFIRM_SELECTOR = '.sweet-alert button.confirm';

    /**
     * @var string
     */
    public const NODE_FORM_SELECTOR = 'form';

    /**
     * @var string
     */
    public const NODE_UPDATE_FORM_SELECTOR = '//form[@name="navigation_node"]';

    /**
     * @var string
     */
    public const FLASH_MESSAGE_TEXT_SELECTOR = '//div[@class="flash-messages"]/div';

    /**
     * @var string
     */
    public const NAVIGATION_DELETE_FORM_SELECTOR = '//*[@id="navigation-table"]/tbody/tr/td[5]/form[1]';

    /**
     * @var string
     */
    public const NAVIGATION_ROW_ACTIVE_LINK_SELECTOR = '//*[@id="navigation-table"]/tbody/tr[1]/td[5]/a[2]';

    /**
     * @param string $value
     *
     * @return void
     */
    public function setNameField(string $value): void
    {
        $this->fillField('//*[@id="navigation_name"]', $value);
    }

    /**
     * @param string $value
     *
     * @return void
     */
    public function setKeyField(string $value): void
    {
        $this->fillField('//*[@id="navigation_key"]', $value);
    }

    /**
     * @param bool $checked
     *
     * @return void
     */
    public function checkIsActiveField(bool $checked): void
    {
        if ($checked) {
            $this->checkOption('//*[@id="navigation_is_active"]');
        } else {
            $this->uncheckOption('//*[@id="navigation_is_active"]');
        }
    }

    /**
     * @return void
     */
    public function submitNavigationForm(): void
    {
        $this->click('//*[@id="navigation-save-btn"]');
    }

    /**
     * @return void
     */
    public function submitDeleteNavigationForm(): void
    {
        $this->click('//*[@id="delete_navigation_form_submit"]');
    }

    /**
     * @param string $pattern
     * @param string $value
     *
     * @return void
     */
    public function seeMatches(string $pattern, string $value): void
    {
        $this->assertRegExp($pattern, $value);
    }

    /**
     * @return void
     */
    public function clickEditFirstRowInList(): void
    {
        $this->click('//*[@id="navigation-table"]/tbody/tr[1]/td[5]/a');
    }

    /**
     * @param string $expectedMessagePattern
     *
     * @return string
     */
    public function seeSuccessMessage(string $expectedMessagePattern): string
    {
        $this->waitForElementVisible(static::FLASH_MESSAGE_TEXT_SELECTOR, 90);
        $successMessage = $this->grabTextFrom(static::FLASH_MESSAGE_TEXT_SELECTOR);
        $this->seeMatches($expectedMessagePattern, $successMessage);

        preg_match($expectedMessagePattern, $successMessage, $matches);

        return $matches[1];
    }

    /**
     * @return void
     */
    public function activateFirstNavigationRow(): void
    {
        $this->click(static::NAVIGATION_ROW_ACTIVE_LINK_SELECTOR);
    }

    /**
     * @return void
     */
    public function deleteFirstNavigationRow(): void
    {
        $this->submitForm(static::NAVIGATION_DELETE_FORM_SELECTOR, []);
    }

    /**
     * @return int
     */
    public function prepareTestNavigationEntity(): int
    {
        $navigationEntity = new SpyNavigation();
        $navigationEntity
            ->setName('Acceptance navigation (2)')
            ->setKey('acceptance2')
            ->setIsActive(true)
            ->save();

        return $navigationEntity->getIdNavigation();
    }

    /**
     * @param string $localeName
     *
     * @return void
     */
    public function expandLocalizedForm(string $localeName): void
    {
        $this->click(sprintf(self::LOCALIZED_FORM_CONTAINER_SELECTOR, $localeName));
    }

    /**
     * @return void
     */
    public function clickRootNode(): void
    {
        $this->click(self::ROOT_NODE_ANCHOR_SELECTOR);
    }

    /**
     * @param int $idNavigationNode
     *
     * @return void
     */
    public function clickNode(int $idNavigationNode): void
    {
        $this->click(sprintf(self::CHILD_NODE_ANCHOR_SELECTOR, $idNavigationNode));
    }

    /**
     * @return void
     */
    public function waitForNavigationTree(): void
    {
        $this->waitForElement(self::NAVIGATION_TREE_SELECTOR);
        $this->wait(5);
    }

    /**
     * @param int $count
     *
     * @return void
     */
    public function seeNumberOfNavigationNodes(int $count): void
    {
        $this->seeNumberOfElements(self::NAVIGATION_NODE_SELECTOR, $count);
    }

    /**
     * @param int $idParentNavigationNode
     * @param int $idChildNavigationNode
     *
     * @return void
     */
    public function seeNavigationNodeHierarchy(int $idParentNavigationNode, int $idChildNavigationNode): void
    {
        $this->waitForElement(sprintf(
            self::NODE_CHILD_SELECTOR,
            $idParentNavigationNode,
            $idChildNavigationNode,
        ), 1);
    }

    /**
     * @param int $idParentNavigationNode
     * @param string $childNavigationNodeName
     *
     * @return void
     */
    public function seeNavigationNodeHierarchyByChildNodeName(int $idParentNavigationNode, string $childNavigationNodeName): void
    {
        $this->seeElement(sprintf(
            self::NODE_NAME_CHILD_SELECTOR,
            $idParentNavigationNode,
            $childNavigationNodeName,
        ));
    }

    /**
     * @param int $idNavigationNode
     * @param int $idTargetNavigationNode
     *
     * @return void
     */
    public function moveNavigationNode(int $idNavigationNode, int $idTargetNavigationNode): void
    {
        $this->dragAndDrop(
            sprintf(self::CHILD_NODE_ANCHOR_SELECTOR, $idNavigationNode),
            sprintf(self::CHILD_NODE_ANCHOR_SELECTOR, $idTargetNavigationNode),
        );
    }

    /**
     * @return void
     */
    public function saveNavigationTreeOrder(): void
    {
        $this->click(self::NAVIGATION_TREE_SAVE_BUTTON_SELECTOR);
    }

    /**
     * @param string $message
     *
     * @return void
     */
    public function seeSuccessfulOrderSaveMessage(string $message): void
    {
        $this->waitForElement(self::SWEET_ALERT_SELECTOR, 5);
        $this->wait(1);
        $this->see($message);
        $this->click(self::SWEET_ALERT_CONFIRM_SELECTOR);
    }

    /**
     * @return void
     */
    public function switchToNodeForm(): void
    {
        $this->switchToIFrame(self::NODE_FORM_IFRAME_NAME);
        $this->waitForElement(self::NODE_FORM_SELECTOR, 5);
    }

    /**
     * @return void
     */
    public function switchToNavigationTree(): void
    {
        $this->switchToIFrame();
        $this->waitForNavigationTree();
    }

    /**
     * @return void
     */
    public function clickRemoveNodeButton(): void
    {
        $this->click(self::REMOVE_NODE_BUTTON_SELECTOR);
    }

    /**
     * @return void
     */
    public function clickAddChildNodeButton(): void
    {
        $this->click(self::ADD_CHILD_NODE_BUTTON_SELECTOR);
    }

    /**
     * @param string $title
     *
     * @return void
     */
    public function submitCreateNodeFormWithoutType(string $title): void
    {
        $this->submitForm(self::NODE_FORM_SELECTOR, [
            'navigation_node[navigation_node_localized_attributes][0][title]' => $title,
            'navigation_node[navigation_node_localized_attributes][1][title]' => $title,
            'navigation_node[is_active]' => true,
        ]);
    }

    /**
     * @param string $title
     * @param string $externalUrl
     *
     * @return void
     */
    public function submitCreateNodeFormWithExternalUrlType(string $title, string $externalUrl): void
    {
        $this->submitForm(self::NODE_FORM_SELECTOR, [
            'navigation_node[node_type]' => 'external_url',
            'navigation_node[navigation_node_localized_attributes][0][external_url]' => $externalUrl,
            'navigation_node[navigation_node_localized_attributes][1][external_url]' => $externalUrl,
            'navigation_node[navigation_node_localized_attributes][0][title]' => $title,
            'navigation_node[navigation_node_localized_attributes][1][title]' => $title,
            'navigation_node[is_active]' => true,
        ]);
    }

    /**
     * @param string $categoryUrl_en_US
     * @param string $categoryUrl_de_DE
     *
     * @return void
     */
    public function submitUpdateNodeToCategoryType(string $categoryUrl_en_US, string $categoryUrl_de_DE): void
    {
        $this->submitForm(static::NODE_UPDATE_FORM_SELECTOR, [
            'navigation_node[node_type]' => 'category',
            'navigation_node[navigation_node_localized_attributes][0][category_url]' => $categoryUrl_en_US,
            'navigation_node[navigation_node_localized_attributes][1][category_url]' => $categoryUrl_de_DE,
        ]);
    }

    /**
     * @param string $title
     * @param string $cmsPageUrl_en_US
     * @param string $cmsPageUrl_de_DE
     *
     * @return void
     */
    public function submitCreateNodeFormWithCmsPageType(string $title, string $cmsPageUrl_en_US, string $cmsPageUrl_de_DE): void
    {
        $this->submitForm(self::NODE_FORM_SELECTOR, [
            'navigation_node[node_type]' => 'cms_page',
            'navigation_node[navigation_node_localized_attributes][0][title]' => $title,
            'navigation_node[navigation_node_localized_attributes][0][cms_page_url]' => $cmsPageUrl_en_US,
            'navigation_node[navigation_node_localized_attributes][1][title]' => $title,
            'navigation_node[navigation_node_localized_attributes][1][cms_page_url]' => $cmsPageUrl_de_DE,
            'navigation_node[is_active]' => true,
        ]);
    }

    /**
     * @param \Generated\Shared\Transfer\NavigationTreeTransfer $navigationTreeTransfer
     *
     * @return \Generated\Shared\Transfer\NavigationTreeTransfer
     */
    public function prepareTestNavigationTreeEntities(NavigationTreeTransfer $navigationTreeTransfer): NavigationTreeTransfer
    {
        $navigationTransfer = $this->getLocator()->navigation()->facade()->createNavigation($navigationTreeTransfer->getNavigation());

        foreach ($navigationTreeTransfer->getNodes() as $navigationTreeNodeTransfer) {
            $this->createNavigationNodesRecursively($navigationTreeNodeTransfer, $navigationTransfer->getIdNavigation());
        }

        return $navigationTreeTransfer;
    }

    /**
     * @param \Generated\Shared\Transfer\NavigationTreeNodeTransfer $navigationTreeNodeTransfer
     * @param int $idNavigation
     * @param int|null $idParentNavigationNode
     *
     * @return void
     */
    protected function createNavigationNodesRecursively(
        NavigationTreeNodeTransfer $navigationTreeNodeTransfer,
        int $idNavigation,
        ?int $idParentNavigationNode = null,
    ): void {
        $navigationNodeTransfer = $navigationTreeNodeTransfer->getNavigationNode();
        $navigationNodeTransfer
            ->setFkNavigation($idNavigation)
            ->setFkParentNavigationNode($idParentNavigationNode);

        $navigationNodeTransfer = $this->getLocator()->navigation()->facade()->createNavigationNode($navigationNodeTransfer);

        foreach ($navigationTreeNodeTransfer->getChildren() as $childNavigationTreeNodeTransfer) {
            $this->createNavigationNodesRecursively($childNavigationTreeNodeTransfer, $idNavigation, $navigationNodeTransfer->getIdNavigationNode());
        }
    }

    /**
     * @param string $locale
     *
     * @return int
     */
    public function getIdLocale(string $locale): int
    {
        return $this->getLocator()->locale()->facade()->getLocale($locale)->getIdLocale();
    }

    /**
     * @param \Generated\Shared\Transfer\NavigationTreeTransfer $navigationTreeTransfer
     *
     * @return void
     */
    public function cleanUpNavigationTree(NavigationTreeTransfer $navigationTreeTransfer): void
    {
        $navigationEntity = $this->findNavigationByIdNavigation(
            $navigationTreeTransfer->getNavigationOrFail()->getIdNavigationOrFail(),
        );

        if (!$navigationEntity) {
            return;
        }

        $navigationNodeEntities = $navigationEntity->getSpyNavigationNodes();

        foreach ($navigationNodeEntities as $navigationNodeEntity) {
            $navigationNodeEntity->getSpyNavigationNodeLocalizedAttributess()->delete();
        }

        $navigationNodeEntities->delete();
        $navigationEntity->delete();
    }

    /**
     * @param int $idNavigation
     *
     * @return \Orm\Zed\Navigation\Persistence\SpyNavigation|null
     */
    protected function findNavigationByIdNavigation(int $idNavigation): ?SpyNavigation
    {
        return (new SpyNavigationQuery())->findOneByIdNavigation($idNavigation);
    }

    /**
     * @param array $data
     *
     * @return void
     */
    public function submitCreateNodeFormWithCmsPageTypeWithFormData(array $data): void
    {
        $formData = [
            'navigation_node[node_type]' => 'cms_page',
            'navigation_node[is_active]' => true,
        ];
        foreach ($data as $index => $localizedData) {
            $titleKey = sprintf('navigation_node[navigation_node_localized_attributes][%s][title]', $index);
            $urlKey = sprintf('navigation_node[navigation_node_localized_attributes][%s][cms_page_url]', $index);
            $formData[$titleKey] = $localizedData['title'];
            $formData[$urlKey] = $localizedData['url'];
        }
        $this->submitForm(static::NODE_FORM_SELECTOR, $formData);
    }

    /**
     * @param string $defaultSlug
     * @param array<string> $localizedSlugs
     *
     * @return array
     */
    public function generateUrlByAvailableLocaleTransfers(string $defaultSlug, array $localizedSlugs): array
    {
        $localeTransfers = $this->getLocator()->locale()->facade()->getLocaleCollection();

        $localeUrls = [];
        foreach ($localeTransfers as $localeTransfer) {
            $localePrefix = substr($localeTransfer->getLocaleName(), 0, 2);
            $localeUrls[] = sprintf('/%s/%s', $localePrefix, $localizedSlugs[$localeTransfer->getLocaleName()] ?? $defaultSlug);
        }

        return $localeUrls;
    }

    /**
     * @param callable $callable
     * @param int $maxCount
     * @param bool $verbose
     *
     * @return void
     */
    public function repeatUnstableActions(callable $callable, int $maxCount = 10, bool $verbose = false): void
    {
        $count = 0;

        while ($count < $maxCount) {
            try {
                $callable();

                break;
            } catch (Exception $exception) {
                $count++;
                if ($verbose) {
                    echo "Try: {$count}: ";
                }
            }
        }
    }
}


1			<?php
2
3			/**
4			* This file is part of the Spryker Commerce OS.
5			* For full license information, please view the LICENSE file that was distributed with this source code.
6			*/
7
8			declare(strict_types = 1);
9
10			namespace PyzTest\Zed\NavigationGui;
11
12			use Codeception\Actor;
13			use Exception;
14			use Generated\Shared\Transfer\NavigationTreeNodeTransfer;
			0 ignored issues – show Bug introduced 2019-03-19 12:11 UTC by Report Bug Copy Issue Report The type `Generated\Shared\Transfe...igationTreeNodeTransfer` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
15			use Generated\Shared\Transfer\NavigationTreeTransfer;
			0 ignored issues – show Bug introduced 2019-03-19 12:11 UTC by Report Bug Copy Issue Report The type `Generated\Shared\Transfer\NavigationTreeTransfer` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
16			use Orm\Zed\Navigation\Persistence\SpyNavigation;
17			use Orm\Zed\Navigation\Persistence\SpyNavigationQuery;
18
19			/**
20			* Inherited Methods
21			*
22			* @method void wantToTest($text)
23			* @method void wantTo($text)
24			* @method void execute($callable)
25			* @method void expectTo($prediction)
26			* @method void expect($prediction)
27			* @method void amGoingTo($argumentation)
28			* @method void am($role)
29			* @method void lookForwardTo($achieveValue)
30			* @method void comment($description)
31			* @method \Codeception\Lib\Friend haveFriend($name, $actorClass = NULL)
32			*
33			* @SuppressWarnings(\PyzTest\Zed\NavigationGui\PHPMD)
34			*/
35			class NavigationGuiPresentationTester extends Actor
36			{
37			use _generated\NavigationGuiPresentationTesterActions;
			0 ignored issues – show Bug introduced 2019-03-19 12:11 UTC by Report Bug Copy Issue Report The type `PyzTest\Zed\NavigationGu...esentationTesterActions` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
38
39			/**
40			* @var string
41			*/
42			public const ROOT_NODE_ANCHOR_SELECTOR = '#navigation-node-0_anchor';
43
44			/**
45			* @var string
46			*/
47			public const CHILD_NODE_ANCHOR_SELECTOR = '#navigation-node-%d_anchor';
48
49			/**
50			* @var string
51			*/
52			public const NAVIGATION_NODE_SELECTOR = '.jstree-node';
53
54			/**
55			* @var string
56			*/
57			public const NAVIGATION_TREE_SELECTOR = '#navigation-tree';
58
59			/**
60			* @var string
61			*/
62			public const NAVIGATION_TREE_SAVE_BUTTON_SELECTOR = '#navigation-tree-save-btn';
63
64			/**
65			* @var string
66			*/
67			public const REMOVE_NODE_BUTTON_SELECTOR = '#remove-selected-node-btn';
68
69			/**
70			* @var string
71			*/
72			public const ADD_CHILD_NODE_BUTTON_SELECTOR = '#add-child-node-btn';
73
74			/**
75			* @var string
76			*/
77			public const LOCALIZED_FORM_CONTAINER_SELECTOR = '#localized_attributes_container-%s .collapse-link';
78
79			/**
80			* @var string
81			*/
82			public const NODE_CHILD_SELECTOR = '#navigation-node-%d #navigation-node-%d';
83
84			/**
85			* @var string
86			*/
87			public const NODE_NAME_CHILD_SELECTOR = "//[@id=\"navigation-node-%d\"]//[text()[contains(.,'%s')]]";
88
89			/**
90			* @var string
91			*/
92			public const NODE_FORM_IFRAME_NAME = 'navigation-node-form-iframe';
93
94			/**
95			* @var string
96			*/
97			public const SUCCESS_MESSAGE_SELECTOR = '.flash-messages .alert-success';
98
99			/**
100			* @var string
101			*/
102			public const SWEET_ALERT_SELECTOR = '.sweet-alert';
103
104			/**
105			* @var string
106			*/
107			public const SWEET_ALERT_CONFIRM_SELECTOR = '.sweet-alert button.confirm';
108
109			/**
110			* @var string
111			*/
112			public const NODE_FORM_SELECTOR = 'form';
113
114			/**
115			* @var string
116			*/
117			public const NODE_UPDATE_FORM_SELECTOR = '//form[@name="navigation_node"]';
118
119			/**
120			* @var string
121			*/
122			public const FLASH_MESSAGE_TEXT_SELECTOR = '//div[@class="flash-messages"]/div';
123
124			/**
125			* @var string
126			*/
127			public const NAVIGATION_DELETE_FORM_SELECTOR = '//*[@id="navigation-table"]/tbody/tr/td[5]/form[1]';
128
129			/**
130			* @var string
131			*/
132			public const NAVIGATION_ROW_ACTIVE_LINK_SELECTOR = '//*[@id="navigation-table"]/tbody/tr[1]/td[5]/a[2]';
133
134			/**
135			* @param string $value
136			*
137			* @return void
138			*/
139			public function setNameField(string $value): void
140			{
141			$this->fillField('//*[@id="navigation_name"]', $value);
142			}
143
144			/**
145			* @param string $value
146			*
147			* @return void
148			*/
149			public function setKeyField(string $value): void
150			{
151			$this->fillField('//*[@id="navigation_key"]', $value);
152			}
153
154			/**
155			* @param bool $checked
156			*
157			* @return void
158			*/
159			public function checkIsActiveField(bool $checked): void
160			{
161			if ($checked) {
162			$this->checkOption('//*[@id="navigation_is_active"]');
163			} else {
164			$this->uncheckOption('//*[@id="navigation_is_active"]');
165			}
166			}
167
168			/**
169			* @return void
170			*/
171			public function submitNavigationForm(): void
172			{
173			$this->click('//*[@id="navigation-save-btn"]');
174			}
175
176			/**
177			* @return void
178			*/
179			public function submitDeleteNavigationForm(): void
180			{
181			$this->click('//*[@id="delete_navigation_form_submit"]');
182			}
183
184			/**
185			* @param string $pattern
186			* @param string $value
187			*
188			* @return void
189			*/
190			public function seeMatches(string $pattern, string $value): void
191			{
192			$this->assertRegExp($pattern, $value);
193			}
194
195			/**
196			* @return void
197			*/
198			public function clickEditFirstRowInList(): void
199			{
200			$this->click('//*[@id="navigation-table"]/tbody/tr[1]/td[5]/a');
201			}
202
203			/**
204			* @param string $expectedMessagePattern
205			*
206			* @return string
207			*/
208			public function seeSuccessMessage(string $expectedMessagePattern): string
209			{
210			$this->waitForElementVisible(static::FLASH_MESSAGE_TEXT_SELECTOR, 90);
211			$successMessage = $this->grabTextFrom(static::FLASH_MESSAGE_TEXT_SELECTOR);
212			$this->seeMatches($expectedMessagePattern, $successMessage);
213
214			preg_match($expectedMessagePattern, $successMessage, $matches);
215
216			return $matches[1];
217			}
218
219			/**
220			* @return void
221			*/
222			public function activateFirstNavigationRow(): void
223			{
224			$this->click(static::NAVIGATION_ROW_ACTIVE_LINK_SELECTOR);
225			}
226
227			/**
228			* @return void
229			*/
230			public function deleteFirstNavigationRow(): void
231			{
232			$this->submitForm(static::NAVIGATION_DELETE_FORM_SELECTOR, []);
233			}
234
235			/**
236			* @return int
237			*/
238			public function prepareTestNavigationEntity(): int
239			{
240			$navigationEntity = new SpyNavigation();
241			$navigationEntity
242			->setName('Acceptance navigation (2)')
243			->setKey('acceptance2')
244			->setIsActive(true)
245			->save();
246
247			return $navigationEntity->getIdNavigation();
248			}
249
250			/**
251			* @param string $localeName
252			*
253			* @return void
254			*/
255			public function expandLocalizedForm(string $localeName): void
256			{
257			$this->click(sprintf(self::LOCALIZED_FORM_CONTAINER_SELECTOR, $localeName));
258			}
259
260			/**
261			* @return void
262			*/
263			public function clickRootNode(): void
264			{
265			$this->click(self::ROOT_NODE_ANCHOR_SELECTOR);
266			}
267
268			/**
269			* @param int $idNavigationNode
270			*
271			* @return void
272			*/
273			public function clickNode(int $idNavigationNode): void
274			{
275			$this->click(sprintf(self::CHILD_NODE_ANCHOR_SELECTOR, $idNavigationNode));
276			}
277
278			/**
279			* @return void
280			*/
281			public function waitForNavigationTree(): void
282			{
283			$this->waitForElement(self::NAVIGATION_TREE_SELECTOR);
284			$this->wait(5);
285			}
286
287			/**
288			* @param int $count
289			*
290			* @return void
291			*/
292			public function seeNumberOfNavigationNodes(int $count): void
293			{
294			$this->seeNumberOfElements(self::NAVIGATION_NODE_SELECTOR, $count);
295			}
296
297			/**
298			* @param int $idParentNavigationNode
299			* @param int $idChildNavigationNode
300			*
301			* @return void
302			*/
303			public function seeNavigationNodeHierarchy(int $idParentNavigationNode, int $idChildNavigationNode): void
304			{
305			$this->waitForElement(sprintf(
306			self::NODE_CHILD_SELECTOR,
307			$idParentNavigationNode,
308			$idChildNavigationNode,
309			), 1);
310			}
311
312			/**
313			* @param int $idParentNavigationNode
314			* @param string $childNavigationNodeName
315			*
316			* @return void
317			*/
318			public function seeNavigationNodeHierarchyByChildNodeName(int $idParentNavigationNode, string $childNavigationNodeName): void
319			{
320			$this->seeElement(sprintf(
321			self::NODE_NAME_CHILD_SELECTOR,
322			$idParentNavigationNode,
323			$childNavigationNodeName,
324			));
325			}
326
327			/**
328			* @param int $idNavigationNode
329			* @param int $idTargetNavigationNode
330			*
331			* @return void
332			*/
333			public function moveNavigationNode(int $idNavigationNode, int $idTargetNavigationNode): void
334			{
335			$this->dragAndDrop(
336			sprintf(self::CHILD_NODE_ANCHOR_SELECTOR, $idNavigationNode),
337			sprintf(self::CHILD_NODE_ANCHOR_SELECTOR, $idTargetNavigationNode),
338			);
339			}
340
341			/**
342			* @return void
343			*/
344			public function saveNavigationTreeOrder(): void
345			{
346			$this->click(self::NAVIGATION_TREE_SAVE_BUTTON_SELECTOR);
347			}
348
349			/**
350			* @param string $message
351			*
352			* @return void
353			*/
354			public function seeSuccessfulOrderSaveMessage(string $message): void
355			{
356			$this->waitForElement(self::SWEET_ALERT_SELECTOR, 5);
357			$this->wait(1);
358			$this->see($message);
359			$this->click(self::SWEET_ALERT_CONFIRM_SELECTOR);
360			}
361
362			/**
363			* @return void
364			*/
365			public function switchToNodeForm(): void
366			{
367			$this->switchToIFrame(self::NODE_FORM_IFRAME_NAME);
368			$this->waitForElement(self::NODE_FORM_SELECTOR, 5);
369			}
370
371			/**
372			* @return void
373			*/
374			public function switchToNavigationTree(): void
375			{
376			$this->switchToIFrame();
377			$this->waitForNavigationTree();
378			}
379
380			/**
381			* @return void
382			*/
383			public function clickRemoveNodeButton(): void
384			{
385			$this->click(self::REMOVE_NODE_BUTTON_SELECTOR);
386			}
387
388			/**
389			* @return void
390			*/
391			public function clickAddChildNodeButton(): void
392			{
393			$this->click(self::ADD_CHILD_NODE_BUTTON_SELECTOR);
394			}
395
396			/**
397			* @param string $title
398			*
399			* @return void
400			*/
401			public function submitCreateNodeFormWithoutType(string $title): void
402			{
403			$this->submitForm(self::NODE_FORM_SELECTOR, [
404			'navigation_node[navigation_node_localized_attributes][0][title]' => $title,
405			'navigation_node[navigation_node_localized_attributes][1][title]' => $title,
406			'navigation_node[is_active]' => true,
407			]);
408			}
409
410			/**
411			* @param string $title
412			* @param string $externalUrl
413			*
414			* @return void
415			*/
416			public function submitCreateNodeFormWithExternalUrlType(string $title, string $externalUrl): void
417			{
418			$this->submitForm(self::NODE_FORM_SELECTOR, [
419			'navigation_node[node_type]' => 'external_url',
420			'navigation_node[navigation_node_localized_attributes][0][external_url]' => $externalUrl,
421			'navigation_node[navigation_node_localized_attributes][1][external_url]' => $externalUrl,
422			'navigation_node[navigation_node_localized_attributes][0][title]' => $title,
423			'navigation_node[navigation_node_localized_attributes][1][title]' => $title,
424			'navigation_node[is_active]' => true,
425			]);
426			}
427
428			/**
429			* @param string $categoryUrl_en_US
430			* @param string $categoryUrl_de_DE
431			*
432			* @return void
433			*/
434			public function submitUpdateNodeToCategoryType(string $categoryUrl_en_US, string $categoryUrl_de_DE): void
435			{
436			$this->submitForm(static::NODE_UPDATE_FORM_SELECTOR, [
437			'navigation_node[node_type]' => 'category',
438			'navigation_node[navigation_node_localized_attributes][0][category_url]' => $categoryUrl_en_US,
439			'navigation_node[navigation_node_localized_attributes][1][category_url]' => $categoryUrl_de_DE,
440			]);
441			}
442
443			/**
444			* @param string $title
445			* @param string $cmsPageUrl_en_US
446			* @param string $cmsPageUrl_de_DE
447			*
448			* @return void
449			*/
450			public function submitCreateNodeFormWithCmsPageType(string $title, string $cmsPageUrl_en_US, string $cmsPageUrl_de_DE): void
451			{
452			$this->submitForm(self::NODE_FORM_SELECTOR, [
453			'navigation_node[node_type]' => 'cms_page',
454			'navigation_node[navigation_node_localized_attributes][0][title]' => $title,
455			'navigation_node[navigation_node_localized_attributes][0][cms_page_url]' => $cmsPageUrl_en_US,
456			'navigation_node[navigation_node_localized_attributes][1][title]' => $title,
457			'navigation_node[navigation_node_localized_attributes][1][cms_page_url]' => $cmsPageUrl_de_DE,
458			'navigation_node[is_active]' => true,
459			]);
460			}
461
462			/**
463			* @param \Generated\Shared\Transfer\NavigationTreeTransfer $navigationTreeTransfer
464			*
465			* @return \Generated\Shared\Transfer\NavigationTreeTransfer
466			*/
467			public function prepareTestNavigationTreeEntities(NavigationTreeTransfer $navigationTreeTransfer): NavigationTreeTransfer
468			{
469			$navigationTransfer = $this->getLocator()->navigation()->facade()->createNavigation($navigationTreeTransfer->getNavigation());
470
471			foreach ($navigationTreeTransfer->getNodes() as $navigationTreeNodeTransfer) {
472			$this->createNavigationNodesRecursively($navigationTreeNodeTransfer, $navigationTransfer->getIdNavigation());
473			}
474
475			return $navigationTreeTransfer;
476			}
477
478			/**
479			* @param \Generated\Shared\Transfer\NavigationTreeNodeTransfer $navigationTreeNodeTransfer
480			* @param int $idNavigation
481			* @param int\|null $idParentNavigationNode
482			*
483			* @return void
484			*/
485			protected function createNavigationNodesRecursively(
486			NavigationTreeNodeTransfer $navigationTreeNodeTransfer,
487			int $idNavigation,
488			?int $idParentNavigationNode = null,
489			): void {
490			$navigationNodeTransfer = $navigationTreeNodeTransfer->getNavigationNode();
491			$navigationNodeTransfer
492			->setFkNavigation($idNavigation)
493			->setFkParentNavigationNode($idParentNavigationNode);
494
495			$navigationNodeTransfer = $this->getLocator()->navigation()->facade()->createNavigationNode($navigationNodeTransfer);
496
497			foreach ($navigationTreeNodeTransfer->getChildren() as $childNavigationTreeNodeTransfer) {
498			$this->createNavigationNodesRecursively($childNavigationTreeNodeTransfer, $idNavigation, $navigationNodeTransfer->getIdNavigationNode());
499			}
500			}
501
502			/**
503			* @param string $locale
504			*
505			* @return int
506			*/
507			public function getIdLocale(string $locale): int
508			{
509			return $this->getLocator()->locale()->facade()->getLocale($locale)->getIdLocale();
510			}
511
512			/**
513			* @param \Generated\Shared\Transfer\NavigationTreeTransfer $navigationTreeTransfer
514			*
515			* @return void
516			*/
517			public function cleanUpNavigationTree(NavigationTreeTransfer $navigationTreeTransfer): void
518			{
519			$navigationEntity = $this->findNavigationByIdNavigation(
520			$navigationTreeTransfer->getNavigationOrFail()->getIdNavigationOrFail(),
521			);
522
523			if (!$navigationEntity) {
524			return;
525			}
526
527			$navigationNodeEntities = $navigationEntity->getSpyNavigationNodes();
528
529			foreach ($navigationNodeEntities as $navigationNodeEntity) {
530			$navigationNodeEntity->getSpyNavigationNodeLocalizedAttributess()->delete();
531			}
532
533			$navigationNodeEntities->delete();
534			$navigationEntity->delete();
535			}
536
537			/**
538			* @param int $idNavigation
539			*
540			* @return \Orm\Zed\Navigation\Persistence\SpyNavigation\|null
541			*/
542			protected function findNavigationByIdNavigation(int $idNavigation): ?SpyNavigation
543			{
544			return (new SpyNavigationQuery())->findOneByIdNavigation($idNavigation);
545			}
546
547			/**
548			* @param array $data
549			*
550			* @return void
551			*/
552			public function submitCreateNodeFormWithCmsPageTypeWithFormData(array $data): void
553			{
554			$formData = [
555			'navigation_node[node_type]' => 'cms_page',
556			'navigation_node[is_active]' => true,
557			];
558			foreach ($data as $index => $localizedData) {
559			$titleKey = sprintf('navigation_node[navigation_node_localized_attributes][%s][title]', $index);
560			$urlKey = sprintf('navigation_node[navigation_node_localized_attributes][%s][cms_page_url]', $index);
561			$formData[$titleKey] = $localizedData['title'];
562			$formData[$urlKey] = $localizedData['url'];
563			}
564			$this->submitForm(static::NODE_FORM_SELECTOR, $formData);
565			}
566
567			/**
568			* @param string $defaultSlug
569			* @param array<string> $localizedSlugs
570			*
571			* @return array
572			*/
573			public function generateUrlByAvailableLocaleTransfers(string $defaultSlug, array $localizedSlugs): array
574			{
575			$localeTransfers = $this->getLocator()->locale()->facade()->getLocaleCollection();
576
577			$localeUrls = [];
578			foreach ($localeTransfers as $localeTransfer) {
579			$localePrefix = substr($localeTransfer->getLocaleName(), 0, 2);
580			$localeUrls[] = sprintf('/%s/%s', $localePrefix, $localizedSlugs[$localeTransfer->getLocaleName()] ?? $defaultSlug);
581			}
582
583			return $localeUrls;
584			}
585
586			/**
587			* @param callable $callable
588			* @param int $maxCount
589			* @param bool $verbose
590			*
591			* @return void
592			*/
593			public function repeatUnstableActions(callable $callable, int $maxCount = 10, bool $verbose = false): void
594			{
595			$count = 0;
596
597			while ($count < $maxCount) {
598			try {
599			$callable();
600
601			break;
602			} catch (Exception $exception) {
603			$count++;
604			if ($verbose) {
605			echo "Try: {$count}: ";
606			}
607			}
608			}
609			}
610			}
611

spryker-shop / b2c-demo-shop

NavigationGuiPresentationTester::clickRootNode() A last analyzed 2025-10-28 11:24 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

NavigationGuiPresentationTester::clickRootNode() A
last analyzed 2025-10-28 11:24 UTC