Merge remote-tracking branch 'origin/main' into chore/depend-on-interfaces

Author: uuf6429

src/WebdriverClassicDriver.php

@@ -993,7 +993,7 @@ private function executeJsOnXpath(
      * @throws DriverException
      */
     private function executeJsOnElement(
-        $element,
+        WebDriverElement $element,
         #[Language('JavaScript')]
         string $script
     ) {
@@ -1070,7 +1070,7 @@ private function getWindowHandleFromName(string $name): string
      * @param TWebDriverElement $element
      * @throws DriverException
      */
-    private function clickOnElement($element): void
+    private function clickOnElement(WebDriverElement $element): void
     {
         $element->getLocationOnScreenOnceScrolledIntoView();
         $element->click();
@@ -1124,7 +1124,7 @@ private function findElement(
      * @param TWebDriverElement $element
      * @throws DriverException
      */
-    private function selectRadioValue($element, string $value): void
+    private function selectRadioValue(WebDriverElement $element, string $value): void
     {
         try {
             (new WebDriverRadios($element))->selectByValue($value);
@@ -1143,7 +1143,7 @@ private function selectRadioValue($element, string $value): void
      * @param TWebDriverElement $element
      * @throws DriverException
      */
-    private function selectOptionOnElement($element, string $value, bool $multiple = false): void
+    private function selectOptionOnElement(WebDriverElement $element, string $value, bool $multiple = false): void
     {
         try {
             $select = new WebDriverSelect($element);
@@ -1174,7 +1174,7 @@ private function selectOptionOnElement($element, string $value, bool $multiple =
      * @param TWebDriverElement $element
      * @throws DriverException
      */
-    private function deselectAllOptions($element): void
+    private function deselectAllOptions(WebDriverElement $element): void
     {
         try {
             (new WebDriverSelect($element))->deselectAll();
@@ -1193,7 +1193,7 @@ private function deselectAllOptions($element): void
      * @throws DriverException
      */
     private function ensureInputType(
-        $element,
+        WebDriverElement $element,
         #[Language('XPath')]
         string $xpath,
         string $type,
@@ -1237,7 +1237,7 @@ private function jsonEncode($value, string $action, string $field): string
      * @param mixed $value
      * @throws DriverException
      */
-    private function setElementDomProperty($element, string $property, $value): void
+    private function setElementDomProperty(WebDriverElement $element, string $property, $value): void
     {
         $this->executeJsOnElement(
             $element,
@@ -1250,7 +1250,7 @@ private function setElementDomProperty($element, string $property, $value): void
      * @return mixed
      * @throws DriverException
      */
-    private function getElementDomProperty($element, string $property)
+    private function getElementDomProperty(WebDriverElement $element, string $property)
     {
         try {
             return $this->isW3cCompliant()

tests/Custom/CapabilityTest.php

@@ -2,16 +2,16 @@
 
 namespace Mink\WebdriverClassicDriver\Tests\Custom;
 
-use Facebook\WebDriver\Remote\RemoteWebDriver;
-use Facebook\WebDriver\WebDriverOptions;
-use Facebook\WebDriver\WebDriverTimeouts;
+use Mink\WebdriverClassicDriver\Tests\WebDriverMockingTrait;
 use Mink\WebdriverClassicDriver\WebdriverClassicDriver;
 
 /**
  * @phpstan-import-type TCapabilities from WebdriverClassicDriver
  */
 class CapabilityTest extends \PHPUnit\Framework\TestCase
 {
+    use WebDriverMockingTrait;
+
     /**
      * @param TCapabilities $desiredCapabilities
      * @param TCapabilities $expectedCapabilities
@@ -20,11 +20,7 @@ class CapabilityTest extends \PHPUnit\Framework\TestCase
      */
     public function testThatCapabilitiesAreAsExpected(string $browserName, array $desiredCapabilities, array $expectedCapabilities): void
     {
-        $mockWebDriver = $this->createMock(RemoteWebDriver::class);
-        $mockWebDriverOptions = $this->createMock(WebDriverOptions::class);
-        $mockWebDriverTimeouts = $this->createMock(WebDriverTimeouts::class);
-        $mockWebDriver->method('manage')->willReturn($mockWebDriverOptions);
-        $mockWebDriverOptions->method('timeouts')->willReturn($mockWebDriverTimeouts);
+        $mockWebDriver = $this->createMockWebDriver();
 
         $actualCapabilities = null;
         $driver = new WebdriverClassicDriver(

tests/Custom/WebDriverTest.php

@@ -3,14 +3,14 @@
 namespace Mink\WebdriverClassicDriver\Tests\Custom;
 
 use Behat\Mink\Exception\DriverException;
-use Facebook\WebDriver\Remote\RemoteWebDriver;
 use Facebook\WebDriver\Remote\RemoteWebElement;
-use Facebook\WebDriver\WebDriverOptions;
-use Facebook\WebDriver\WebDriverTimeouts;
+use Mink\WebdriverClassicDriver\Tests\WebDriverMockingTrait;
 use Mink\WebdriverClassicDriver\WebdriverClassicDriver;
 
 class WebDriverTest extends TestCase
 {
+    use WebDriverMockingTrait;
+
     public function testDriverMustBeStartedBeforeUse(): void
     {
         $this->expectException(DriverException::class);
@@ -39,11 +39,9 @@ public function testStartedDriverCannotBeSubsequentlyStarted(): void
 
     public function testDriverCatchesUpstreamErrorsDuringStart(): void
     {
-        $driver = $this->createPartialMock(WebdriverClassicDriver::class, ['createWebDriver', 'getWebDriver']);
-        $driver
-            ->expects($this->once())
-            ->method('createWebDriver')
-            ->willThrowException(new \RuntimeException('An upstream error'));
+        $driver = new WebdriverClassicDriver('fake browser', [], 'example.com', function () {
+            throw new \RuntimeException('An upstream error');
+        });
 
         $this->expectException(DriverException::class);
         $this->expectExceptionMessage('Could not start driver: An upstream error');
@@ -53,15 +51,11 @@ public function testDriverCatchesUpstreamErrorsDuringStart(): void
 
     public function testDriverCatchesUpstreamErrorsDuringStop(): void
     {
-        $driver = $this->createPartialMock(WebdriverClassicDriver::class, ['createWebDriver', 'isStarted', 'getWebDriver']);
-        $driver
-            ->expects($this->once())
-            ->method('isStarted')
-            ->willReturn(true);
-        $driver
-            ->expects($this->once())
-            ->method('getWebDriver')
-            ->willThrowException(new \RuntimeException('An upstream error'));
+        $mockWebDriver = $this->createMockWebDriver();
+        $mockWebDriver->method('quit')->willThrowException(new \RuntimeException('An upstream error'));
+        $driver = new WebdriverClassicDriver('fake browser', [], 'example.com', fn() => $mockWebDriver);
+
+        $driver->start();
 
         $this->expectException(DriverException::class);
         $this->expectExceptionMessage('Could not close connection: An upstream error');
@@ -79,12 +73,8 @@ public function testClassicDriverCanProvideBrowserName(): void
 
     public function testThatDriverCatchesUnexpectedAttributeValueType(): void
     {
-        $mockWebDriver = $this->createMock(RemoteWebDriver::class);
-        $mockWebDriverOptions = $this->createMock(WebDriverOptions::class);
-        $mockWebDriverTimeouts = $this->createMock(WebDriverTimeouts::class);
+        $mockWebDriver = $this->createMockWebDriver();
         $mockElement = $this->createMock(RemoteWebElement::class);
-        $mockWebDriver->method('manage')->willReturn($mockWebDriverOptions);
-        $mockWebDriverOptions->method('timeouts')->willReturn($mockWebDriverTimeouts);
         $mockWebDriver
             ->expects($this->once())
             ->method('findElement')

tests/WebDriverMockingTrait.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Mink\WebdriverClassicDriver\Tests;
+
+use Facebook\WebDriver\Remote\RemoteWebDriver;
+use Facebook\WebDriver\WebDriverOptions;
+use Facebook\WebDriver\WebDriverTimeouts;
+use PHPUnit\Framework\MockObject\MockObject;
+
+trait WebDriverMockingTrait
+{
+    /**
+     * @template T
+     * @param class-string<T> $class
+     * @return T&MockObject
+     */
+    abstract function createMock(string $class): object;
+
+    /**
+     * @return RemoteWebDriver&MockObject
+     */
+    private function createMockWebDriver(): RemoteWebDriver
+    {
+        $mockWebDriverTimeouts = $this->createMock(WebDriverTimeouts::class);
+
+        $mockWebDriverOptions = $this->createMock(WebDriverOptions::class);
+        $mockWebDriverOptions->method('timeouts')->willReturn($mockWebDriverTimeouts);
+
+        $mockWebDriver = $this->createMock(RemoteWebDriver::class);
+        $mockWebDriver->method('manage')->willReturn($mockWebDriverOptions);
+
+        return $mockWebDriver;
+    }
+}