AbstractElementsBasicCest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Acceptance\Backend\FormEngine;
 
use Codeception\Example;
use Facebook\WebDriver\Exception\UnknownErrorException;
use Facebook\WebDriver\Remote\RemoteWebDriver;
use Facebook\WebDriver\Remote\RemoteWebElement;
use Facebook\WebDriver\WebDriverKeys;
use ‪TYPO3\CMS\Core\Tests\Acceptance\Support\BackendTester;
 
abstract class ‪AbstractElementsBasicCest
{
    protected function ‪runInputFieldTest(‪BackendTester $I, Example $testData)
    {
        $fieldLabel = $testData['label'];
        $initializedInputFieldXpath = '(//label[contains(text(),"' . $fieldLabel . '")])'
            . '[1]/parent::*//*/input[@data-formengine-input-name][@data-formengine-input-initialized]';
 
        // Wait until JS initialized everything
        $I->waitForElement($initializedInputFieldXpath, 30);
 
        $formSection = $this->‪getFormSectionByFieldLabel($I, $fieldLabel);
        $inputField = $this->‪getInputField($formSection);
        $hiddenField = $this->‪getHiddenField($formSection, $inputField);
 
        if ($testData['comment'] !== '') {
            $I->comment($testData['comment']);
        }
 
        $I->fillField($inputField, $testData['inputValue']);
        // Change focus to trigger validation
        $inputField->sendKeys(WebDriverKeys::TAB);
        // Press ESC so that any opened popup (potentially from the field below) is closed
        $inputField->sendKeys(WebDriverKeys::ESCAPE);
        $I->waitForElementNotVisible('#t3js-ui-block');
 
        $I->comment('Test value of visible and hidden field');
        $I->seeInField($inputField, $testData['expectedValue']);
        $I->seeInField($hiddenField, $testData['expectedInternalValue']);
 
        $I->comment('Save the form');
        $saveButtonLink = '//*/button[@name="_savedok"][1]';
        $I->waitForElement($saveButtonLink, 30);
        $I->click($saveButtonLink);
        $I->waitForElementNotVisible('#t3js-ui-block');
        $I->waitForElement('//*/button[@name="_savedok"][not(@disabled)][1]', 30);
        $I->waitForElement($initializedInputFieldXpath, 30);
 
        // Find the fields again (after reload of iFrame)
        $formSection = $this->‪getFormSectionByFieldLabel($I, $fieldLabel);
        $inputField = $this->‪getInputField($formSection);
        $hiddenField = $this->‪getHiddenField($formSection, $inputField);
 
        // Validate save was successful
        $I->comment('Test value of visible and hidden field');
        $I->seeInField($inputField, $testData['expectedValue']);
        $I->seeInField($hiddenField, $testData['expectedValueAfterSave']);
    }
 
    protected function ‪getInputField(RemoteWebElement $formSection)
    {
        return $formSection->findElement(\Facebook\WebDriver\WebDriverBy::xpath('.//*/input[@data-formengine-input-name]'));
    }
 
    protected function ‪getHiddenField(RemoteWebElement $formSection, RemoteWebElement $inputField)
    {
        $hiddenFieldXPath = './/*/input[@name="' . $inputField->getAttribute('data-formengine-input-name') . '"]';
        return $formSection->findElement(\Facebook\WebDriver\WebDriverBy::xpath($hiddenFieldXPath));
    }
 
    protected function ‪getFormSectionByFieldLabel(‪BackendTester $I, string $fieldLabel)
    {
        $I->comment('Get context for field "' . $fieldLabel . '"');
        return $I->executeInSelenium(
            function (RemoteWebDriver $webDriver) use ($fieldLabel) {
                return $webDriver->findElement(
                    \Facebook\WebDriver\WebDriverBy::xpath(
                        '(//label[contains(text(),"' . $fieldLabel . '")])[1]/ancestor::fieldset[@class="form-section"][1]'
                    )
                );
            }
        );
    }
 
    protected function ‪ensureTopOfFrameIsUsedAndClickTab(‪BackendTester $I, string $tabTitle, string $referenceField)
    {
        try {
            $I->click($tabTitle);
        } catch (UnknownErrorException $exception) {
            // this is fired if the element can't be clicked, because for example another element overlays it.
            $this->‪scrollToTopOfFrame($I, $tabTitle, $referenceField);
        }
    }
 
    protected function ‪scrollToTopOfFrame(‪BackendTester $I, string $tabTitle, string $referenceField)
    {
        $formSection = $this->‪getFormSectionByFieldLabel($I, $referenceField);
        $field = $this->‪getInputField($formSection);
        $maxPageUp = 10;
        do {
            $doItAgain = false;
            $maxPageUp--;
            try {
                $field->sendKeys(WebDriverKeys::PAGE_UP);
                $I->click($tabTitle);
            } catch (UnknownErrorException $exception) {
                $doItAgain = true;
            }
        } while ($doItAgain === true && $maxPageUp > 0);
    }
}