Mouse.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\Support\Helper;
 
use Facebook\WebDriver\Exception\InvalidSelectorException;
use Facebook\WebDriver\Interactions\Internal\WebDriverButtonReleaseAction;
use Facebook\WebDriver\Interactions\Internal\WebDriverClickAndHoldAction;
use Facebook\WebDriver\Interactions\Internal\WebDriverMouseMoveAction;
use Facebook\WebDriver\Interactions\WebDriverCompositeAction;
use Facebook\WebDriver\Remote\RemoteWebDriver;
use Facebook\WebDriver\Remote\RemoteWebElement;
use Facebook\WebDriver\WebDriverBy;
use Facebook\WebDriver\WebDriverMouse;
use ‪TYPO3\CMS\Core\Tests\Acceptance\Support\ApplicationTester;
 
final class ‪Mouse
{
    private ‪ApplicationTester ‪$tester;
 
    public function ‪__construct(‪ApplicationTester $I)
    {
        $this->tester = $I;
    }
 
    public function ‪dragAndDrop(string $source, string $target): void
    {
        $I = ‪$this->tester;
        $this->‪dragTo($source, $target, false);
        $I->canSeeElement('.node-dd');
        $this->‪release();
    }
 
    public function ‪dragTo(string $source, string $target, bool $release = true): void
    {
        // webdriver does not support native HTML draggable
        // (all utility methods do only emulate DOM mouse events instead
        // of *real* browser mouse movements, that is why no drag* events
        // will ever be generated. This issue is only properly fixable by
        // ditching webdriver API and use devtools API => playwright.
        // https://github.com/w3c/webdriver/issues/1488
        // https://bugs.chromium.org/p/chromedriver/issues/detail?id=841
        $this->tester->markTestSkipped('selenium/chromedriver does not support native HTML draggable. (We need playwright.)');
 
        (new WebDriverCompositeAction())
            ->addAction(
                new WebDriverClickAndHoldAction($this->‪getMouse(), $this->‪findElement($source))
            )
            ->addAction(
                new WebDriverMouseMoveAction($this->‪getMouse(), $this->‪findElement($target))
            )
            ->perform();
        if ($release) {
            $this->‪release();
        }
    }
 
    public function ‪release(): void
    {
        $action = new WebDriverButtonReleaseAction($this->‪getMouse());
        $action->perform();
    }
 
    private function ‪findElement(string $selector): RemoteWebElement
    {
        $I = ‪$this->tester;
        try {
            $I->wait(0.5);
            return $I->executeInSelenium(static function (RemoteWebDriver $webDriver) use ($selector) {
                return $webDriver->findElement(WebDriverBy::cssSelector($selector));
            });
        } catch (InvalidSelectorException $exception) {
            return $I->executeInSelenium(static function (RemoteWebDriver $webDriver) use ($selector) {
                return $webDriver->findElement(WebDriverBy::xpath($selector));
            });
        }
    }
 
    private function ‪getMouse(): WebDriverMouse
    {
        $I = ‪$this->tester;
        return $I->executeInSelenium(static function (RemoteWebDriver $webDriver) {
            return $webDriver->getMouse();
        });
    }
}