Merge branch 'main' into feature/allow-running-headfull-tests

uuf6429 · web-flow · commit f850beaa2f4e · 2024-11-19T21:05:45.000+01:00
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -61,7 +61,7 @@ then start the local PHP server which will serve the test pages and then run the
 
 ```sh
 export BROWSER_NAME="htmlunit" # see below for other browsers
-java -jar selenium-server-standalone-X.X.X.jar -log selenium.log &
+java -jar selenium-server-X.XX.0.jar standalone --log selenium.log &
 php -S localhost:8000 -t tests/functional/web/ &
 # Use following to run both unit and functional tests
 composer all
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -46,7 +46,7 @@ jobs:
 
     strategy:
       matrix:
-        php-version: ['7.3', '7.4', '8.0', '8.1', '8.2', '8.3']
+        php-version: ['7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
         dependencies: ['']
         include:
           - { php-version: '7.3', dependencies: '--prefer-lowest' }
@@ -82,7 +82,7 @@ jobs:
   functional-tests:
     runs-on: ${{ matrix.os }}
     env:
-      SELENIUM_SERVER_DOWNLOAD_URL: https://github.com/SeleniumHQ/selenium/releases/download/selenium-4.15.0/selenium-server-4.15.0.jar
+      SELENIUM_SERVER_DOWNLOAD_URL: https://github.com/SeleniumHQ/selenium/releases/download/selenium-4.26.0/selenium-server-4.26.0.jar
 
     strategy:
       fail-fast: false
@@ -127,7 +127,7 @@ jobs:
         run: |
           google-chrome --version
           xvfb-run --server-args="-screen 0, 1280x720x24" --auto-servernum \
-          chromedriver --port=4444 --url-base=/wd/hub &> ./logs/chromedriver.log &
+          chromedriver --port=4444 &> ./logs/chromedriver.log &
 
       - name: Start GeckoDriver
         if: ${{ !matrix.selenium-server && matrix.browser == 'firefox' }}
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -77,6 +77,10 @@
         'no_whitespace_before_comma_in_array' => ['after_heredoc' => true],
         'no_whitespace_in_blank_line' => true,
         'non_printable_character' => true,
+        'nullable_type_declaration' => [
+            'syntax' => 'question_mark',
+        ],
+        'nullable_type_declaration_for_default_null_value' => true,
         'object_operator_without_whitespace' => true,
         'ordered_class_elements' => true,
         'ordered_imports' => true,
diff --git a/example.php b/example.php
@@ -10,8 +10,8 @@
 
 require_once('vendor/autoload.php');
 
-// This is where Selenium server 2/3 listens by default. For Selenium 4, Chromedriver or Geckodriver, use http://localhost:4444/
-$host = 'http://localhost:4444/wd/hub';
+// This is where Selenium, Chromedriver and Geckodriver 4 listens by default. For Selenium 2/3, use http://localhost:4444/wd/hub
+$host = 'http://localhost:4444/';
 
 $capabilities = DesiredCapabilities::chrome();
 
diff --git a/lib/Chrome/ChromeDriver.php b/lib/Chrome/ChromeDriver.php
@@ -21,8 +21,10 @@ class ChromeDriver extends LocalWebDriver
      * @todo Remove $service parameter. Use `ChromeDriver::startUsingDriverService` to pass custom $service instance.
      * @return static
      */
-    public static function start(DesiredCapabilities $desired_capabilities = null, ChromeDriverService $service = null)
-    {
+    public static function start(
+        ?DesiredCapabilities $desired_capabilities = null,
+        ?ChromeDriverService $service = null
+    ) {
         if ($service === null) { // TODO: Remove the condition (always create default service)
             $service = ChromeDriverService::createDefaultService();
         }
@@ -40,7 +42,7 @@ public static function start(DesiredCapabilities $desired_capabilities = null, C
      */
     public static function startUsingDriverService(
         ChromeDriverService $service,
-        DesiredCapabilities $capabilities = null
+        ?DesiredCapabilities $capabilities = null
     ) {
         if ($capabilities === null) {
             $capabilities = DesiredCapabilities::chrome();
diff --git a/lib/Exception/Internal/DriverServerDiedException.php b/lib/Exception/Internal/DriverServerDiedException.php
@@ -9,7 +9,7 @@
  */
 class DriverServerDiedException extends \RuntimeException implements PhpWebDriverExceptionInterface
 {
-    public function __construct(\Exception $previous = null)
+    public function __construct(?\Exception $previous = null)
     {
         parent::__construct('The driver server has died.', 0, $previous);
     }
diff --git a/lib/Firefox/FirefoxDriver.php b/lib/Firefox/FirefoxDriver.php
@@ -26,7 +26,7 @@ class FirefoxDriver extends LocalWebDriver
      *
      * @return static
      */
-    public static function start(DesiredCapabilities $capabilities = null)
+    public static function start(?DesiredCapabilities $capabilities = null)
     {
         $service = FirefoxDriverService::createDefaultService();
 
@@ -43,7 +43,7 @@ public static function start(DesiredCapabilities $capabilities = null)
      */
     public static function startUsingDriverService(
         FirefoxDriverService $service,
-        DesiredCapabilities $capabilities = null
+        ?DesiredCapabilities $capabilities = null
     ) {
         if ($capabilities === null) {
             $capabilities = DesiredCapabilities::firefox();
diff --git a/lib/Interactions/Internal/WebDriverKeysRelatedAction.php b/lib/Interactions/Internal/WebDriverKeysRelatedAction.php
@@ -27,7 +27,7 @@ abstract class WebDriverKeysRelatedAction
     public function __construct(
         WebDriverKeyboard $keyboard,
         WebDriverMouse $mouse,
-        WebDriverLocatable $location_provider = null
+        ?WebDriverLocatable $location_provider = null
     ) {
         $this->keyboard = $keyboard;
         $this->mouse = $mouse;
diff --git a/lib/Interactions/Internal/WebDriverMouseAction.php b/lib/Interactions/Internal/WebDriverMouseAction.php
@@ -19,7 +19,7 @@ class WebDriverMouseAction
      */
     protected $locationProvider;
 
-    public function __construct(WebDriverMouse $mouse, WebDriverLocatable $location_provider = null)
+    public function __construct(WebDriverMouse $mouse, ?WebDriverLocatable $location_provider = null)
     {
         $this->mouse = $mouse;
         $this->locationProvider = $location_provider;
diff --git a/lib/Interactions/Internal/WebDriverMoveToOffsetAction.php b/lib/Interactions/Internal/WebDriverMoveToOffsetAction.php
@@ -23,7 +23,7 @@ class WebDriverMoveToOffsetAction extends WebDriverMouseAction implements WebDri
      */
     public function __construct(
         WebDriverMouse $mouse,
-        WebDriverLocatable $location_provider = null,
+        ?WebDriverLocatable $location_provider = null,
         $x_offset = null,
         $y_offset = null
     ) {
diff --git a/lib/Interactions/Internal/WebDriverSendKeysAction.php b/lib/Interactions/Internal/WebDriverSendKeysAction.php
@@ -20,7 +20,7 @@ class WebDriverSendKeysAction extends WebDriverKeysRelatedAction implements WebD
     public function __construct(
         WebDriverKeyboard $keyboard,
         WebDriverMouse $mouse,
-        WebDriverLocatable $location_provider = null,
+        ?WebDriverLocatable $location_provider = null,
         $keys = ''
     ) {
         parent::__construct($keyboard, $mouse, $location_provider);
diff --git a/lib/Interactions/Internal/WebDriverSingleKeyAction.php b/lib/Interactions/Internal/WebDriverSingleKeyAction.php
@@ -36,7 +36,7 @@ abstract class WebDriverSingleKeyAction extends WebDriverKeysRelatedAction imple
     public function __construct(
         WebDriverKeyboard $keyboard,
         WebDriverMouse $mouse,
-        WebDriverLocatable $location_provider = null,
+        ?WebDriverLocatable $location_provider = null,
         $key = ''
     ) {
         parent::__construct($keyboard, $mouse, $location_provider);
diff --git a/lib/Interactions/Touch/WebDriverTouchAction.php b/lib/Interactions/Touch/WebDriverTouchAction.php
@@ -21,7 +21,7 @@ abstract class WebDriverTouchAction
 
     public function __construct(
         WebDriverTouchScreen $touch_screen,
-        WebDriverLocatable $location_provider = null
+        ?WebDriverLocatable $location_provider = null
     ) {
         $this->touchScreen = $touch_screen;
         $this->locationProvider = $location_provider;
diff --git a/lib/Interactions/WebDriverActions.php b/lib/Interactions/WebDriverActions.php
@@ -47,7 +47,7 @@ public function perform()
      *
      * @return WebDriverActions
      */
-    public function click(WebDriverElement $element = null)
+    public function click(?WebDriverElement $element = null)
     {
         $this->action->addAction(
             new WebDriverClickAction($this->mouse, $element)
@@ -62,7 +62,7 @@ public function click(WebDriverElement $element = null)
      *
      * @return WebDriverActions
      */
-    public function clickAndHold(WebDriverElement $element = null)
+    public function clickAndHold(?WebDriverElement $element = null)
     {
         $this->action->addAction(
             new WebDriverClickAndHoldAction($this->mouse, $element)
@@ -77,7 +77,7 @@ public function clickAndHold(WebDriverElement $element = null)
      *
      * @return WebDriverActions
      */
-    public function contextClick(WebDriverElement $element = null)
+    public function contextClick(?WebDriverElement $element = null)
     {
         $this->action->addAction(
             new WebDriverContextClickAction($this->mouse, $element)
@@ -92,7 +92,7 @@ public function contextClick(WebDriverElement $element = null)
      *
      * @return WebDriverActions
      */
-    public function doubleClick(WebDriverElement $element = null)
+    public function doubleClick(?WebDriverElement $element = null)
     {
         $this->action->addAction(
             new WebDriverDoubleClickAction($this->mouse, $element)
@@ -186,7 +186,7 @@ public function moveToElement(WebDriverElement $element, $x_offset = null, $y_of
      *
      * @return WebDriverActions
      */
-    public function release(WebDriverElement $element = null)
+    public function release(?WebDriverElement $element = null)
     {
         $this->action->addAction(
             new WebDriverButtonReleaseAction($this->mouse, $element)
@@ -203,7 +203,7 @@ public function release(WebDriverElement $element = null)
      * @param string $key
      * @return WebDriverActions
      */
-    public function keyDown(WebDriverElement $element = null, $key = null)
+    public function keyDown(?WebDriverElement $element = null, $key = null)
     {
         $this->action->addAction(
             new WebDriverKeyDownAction($this->keyboard, $this->mouse, $element, $key)
@@ -220,7 +220,7 @@ public function keyDown(WebDriverElement $element = null, $key = null)
      * @param string $key
      * @return WebDriverActions
      */
-    public function keyUp(WebDriverElement $element = null, $key = null)
+    public function keyUp(?WebDriverElement $element = null, $key = null)
     {
         $this->action->addAction(
             new WebDriverKeyUpAction($this->keyboard, $this->mouse, $element, $key)
@@ -237,7 +237,7 @@ public function keyUp(WebDriverElement $element = null, $key = null)
      * @param string $keys
      * @return WebDriverActions
      */
-    public function sendKeys(WebDriverElement $element = null, $keys = null)
+    public function sendKeys(?WebDriverElement $element = null, $keys = null)
     {
         $this->action->addAction(
             new WebDriverSendKeysAction(
diff --git a/lib/Local/LocalWebDriver.php b/lib/Local/LocalWebDriver.php
@@ -20,7 +20,7 @@ public static function create(
         $request_timeout_in_ms = null,
         $http_proxy = null,
         $http_proxy_port = null,
-        DesiredCapabilities $required_capabilities = null
+        ?DesiredCapabilities $required_capabilities = null
     ) {
         throw LogicException::forError('Use start() method to start local WebDriver.');
     }
diff --git a/lib/Remote/RemoteMouse.php b/lib/Remote/RemoteMouse.php
@@ -38,7 +38,7 @@ public function __construct(RemoteExecuteMethod $executor, $isW3cCompliant = fal
     /**
      * @return RemoteMouse
      */
-    public function click(WebDriverCoordinates $where = null)
+    public function click(?WebDriverCoordinates $where = null)
     {
         if ($this->isW3cCompliant) {
             $moveAction = $where ? [$this->createMoveAction($where)] : [];
@@ -67,7 +67,7 @@ public function click(WebDriverCoordinates $where = null)
     /**
      * @return RemoteMouse
      */
-    public function contextClick(WebDriverCoordinates $where = null)
+    public function contextClick(?WebDriverCoordinates $where = null)
     {
         if ($this->isW3cCompliant) {
             $moveAction = $where ? [$this->createMoveAction($where)] : [];
@@ -105,7 +105,7 @@ public function contextClick(WebDriverCoordinates $where = null)
     /**
      * @return RemoteMouse
      */
-    public function doubleClick(WebDriverCoordinates $where = null)
+    public function doubleClick(?WebDriverCoordinates $where = null)
     {
         if ($this->isW3cCompliant) {
             $clickActions = $this->createClickActions();
@@ -133,7 +133,7 @@ public function doubleClick(WebDriverCoordinates $where = null)
     /**
      * @return RemoteMouse
      */
-    public function mouseDown(WebDriverCoordinates $where = null)
+    public function mouseDown(?WebDriverCoordinates $where = null)
     {
         if ($this->isW3cCompliant) {
             $this->executor->execute(DriverCommand::ACTIONS, [
@@ -169,7 +169,7 @@ public function mouseDown(WebDriverCoordinates $where = null)
      * @return RemoteMouse
      */
     public function mouseMove(
-        WebDriverCoordinates $where = null,
+        ?WebDriverCoordinates $where = null,
         $x_offset = null,
         $y_offset = null
     ) {
@@ -207,7 +207,7 @@ public function mouseMove(
     /**
      * @return RemoteMouse
      */
-    public function mouseUp(WebDriverCoordinates $where = null)
+    public function mouseUp(?WebDriverCoordinates $where = null)
     {
         if ($this->isW3cCompliant) {
             $moveAction = $where ? [$this->createMoveAction($where)] : [];
@@ -237,7 +237,7 @@ public function mouseUp(WebDriverCoordinates $where = null)
         return $this;
     }
 
-    protected function moveIfNeeded(WebDriverCoordinates $where = null)
+    protected function moveIfNeeded(?WebDriverCoordinates $where = null)
     {
         if ($where) {
             $this->mouseMove($where);
@@ -251,7 +251,7 @@ protected function moveIfNeeded(WebDriverCoordinates $where = null)
      * @return array
      */
     private function createMoveAction(
-        WebDriverCoordinates $where = null,
+        ?WebDriverCoordinates $where = null,
         $x_offset = null,
         $y_offset = null
     ) {
diff --git a/lib/Remote/RemoteWebDriver.php b/lib/Remote/RemoteWebDriver.php
@@ -89,7 +89,7 @@ public static function create(
         $request_timeout_in_ms = null,
         $http_proxy = null,
         $http_proxy_port = null,
-        DesiredCapabilities $required_capabilities = null
+        ?DesiredCapabilities $required_capabilities = null
     ) {
         $selenium_server_url = preg_replace('#/+$#', '', $selenium_server_url);
 
diff --git a/lib/Support/Events/EventFiringWebDriver.php b/lib/Support/Events/EventFiringWebDriver.php
@@ -26,7 +26,7 @@ class EventFiringWebDriver implements WebDriver, JavaScriptExecutor
      */
     protected $dispatcher;
 
-    public function __construct(WebDriver $driver, WebDriverDispatcher $dispatcher = null)
+    public function __construct(WebDriver $driver, ?WebDriverDispatcher $dispatcher = null)
     {
         $this->dispatcher = $dispatcher ?: new WebDriverDispatcher();
         if (!$this->dispatcher->getDefaultDriver()) {
diff --git a/lib/WebDriverEventListener.php b/lib/WebDriverEventListener.php
@@ -48,5 +48,5 @@ public function beforeChangeValueOf(EventFiringWebElement $element);
 
     public function afterChangeValueOf(EventFiringWebElement $element);
 
-    public function onException(WebDriverException $exception, EventFiringWebDriver $driver = null);
+    public function onException(WebDriverException $exception, ?EventFiringWebDriver $driver = null);
 }
diff --git a/tests/functional/Firefox/FirefoxDriverTest.php b/tests/functional/Firefox/FirefoxDriverTest.php
@@ -69,7 +69,7 @@ public function testShouldSetPreferenceWithFirefoxOptions(): void
         );
     }
 
-    private function startFirefoxDriver(FirefoxOptions $firefoxOptions = null): void
+    private function startFirefoxDriver(?FirefoxOptions $firefoxOptions = null): void
     {
         // The createDefaultService() method expect path to the executable to be present in the environment variable
         putenv(FirefoxDriverService::WEBDRIVER_FIREFOX_DRIVER . '=' . getenv('GECKODRIVER_PATH'));
diff --git a/tests/functional/ShadowDomTest.php b/tests/functional/ShadowDomTest.php
@@ -41,11 +41,6 @@ public function testShouldThrowExceptionWhenGettingShadowRootWithElementNotHavin
         $element->getShadowRoot();
     }
 
-    /**
-     * @group exclude-firefox
-     *        https://bugzilla.mozilla.org/show_bug.cgi?id=1700097
-     *        Finding elements in shadow DOM is not implemented in Geckodriver
-     */
     public function testShouldFindElementUnderShadowRoot(): void
     {
         $this->driver->get($this->getTestPageUrl(TestPage::WEB_COMPONENTS));
@@ -61,11 +56,6 @@ public function testShouldFindElementUnderShadowRoot(): void
         $this->assertCount(2, $elementsInShadow);
     }
 
-    /**
-     * @group exclude-firefox
-     *        https://bugzilla.mozilla.org/show_bug.cgi?id=1700097
-     *        Finding elements in shadow DOM is not implemented in Geckodriver
-     */
     public function testShouldReferenceTheSameShadowRootAsFromExecuteScript(): void
     {
         $this->driver->get($this->getTestPageUrl(TestPage::WEB_COMPONENTS));
diff --git a/tests/functional/WebDriverByTest.php b/tests/functional/WebDriverByTest.php
@@ -16,8 +16,8 @@ class WebDriverByTest extends WebDriverTestCase
     public function testShouldFindTextElementByLocator(
         string $webDriverByLocatorMethod,
         string $webDriverByLocatorValue,
-        string $expectedText = null,
-        string $expectedAttributeValue = null
+        ?string $expectedText = null,
+        ?string $expectedAttributeValue = null
     ): void {
         $this->driver->get($this->getTestPageUrl(TestPage::INDEX));
 
diff --git a/tests/functional/WebDriverTestCase.php b/tests/functional/WebDriverTestCase.php
diff --git a/tests/functional/web/web_components.html b/tests/functional/web/web_components.html

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`*/`
`10`	`10`	`class DriverServerDiedException extends \RuntimeException implements PhpWebDriverExceptionInterface`
`11`	`11`	`{`
`12`		`- public function __construct(\Exception $previous = null)`
	`12`	`+ public function __construct(?\Exception $previous = null)`
`13`	`13`	`{`
`14`	`14`	`parent::__construct('The driver server has died.', 0, $previous);`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class WebDriverMouseAction`
`19`	`19`	`*/`
`20`	`20`	`protected $locationProvider;`
`21`	`21`
`22`		`- public function __construct(WebDriverMouse $mouse, WebDriverLocatable $location_provider = null)`
	`22`	`+ public function __construct(WebDriverMouse $mouse, ?WebDriverLocatable $location_provider = null)`
`23`	`23`	`{`
`24`	`24`	`$this->mouse = $mouse;`
`25`	`25`	`$this->locationProvider = $location_provider;`