Improve take element screenshot unit tests

Author: OndraM

CHANGELOG.md

@@ -5,7 +5,8 @@ This project versioning adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 - Experimental W3C WebDriver protocol support. The protocol will be used automatically when remote end (like Geckodriver, newer Chromedriver etc.) supports it.
-- `getStatus()` method of RemoteWebDriver to get information about remote-end readiness to create new sessions.
+- `getStatus()` method of `RemoteWebDriver` to get information about remote-end readiness to create new sessions.
+- `takeElementScreenshot()` method of `RemoteWebElement` to do the obvious - take screenshot of the particular element.
 
 ### Changed
 - Revert no longer needed workaround for Chromedriver bug [2943](https://bugs.chromium.org/p/chromedriver/issues/detail?id=2943).

lib/Remote/RemoteWebElement.php

@@ -445,7 +445,13 @@ public function takeElementScreenshot($save_as = null)
                 [':id' => $this->id]
             )
         );
+
         if ($save_as) {
+            $directoryPath = dirname($save_as);
+            if (!file_exists($directoryPath)) {
+                mkdir($directoryPath, 0777, true);
+            }
+
             file_put_contents($save_as, $screenshot);
         }
 

tests/functional/RemoteWebElementTest.php

@@ -339,56 +339,47 @@ public function testShouldFindMultipleChildElements()
     }
 
     /**
-     * @covers ::takeScreenshot
+     * @covers ::takeElementScreenshot
+     * @group exclude-saucelabs
      */
-    public function testShouldTakeElementScreenshot()
+    public function testShouldTakeAndSaveElementScreenshot()
     {
-        if (!extension_loaded('gd')) {
-            $this->markTestSkipped('GD extension must be enabled');
-        }
-        if ($this->desiredCapabilities->getBrowserName() === WebDriverBrowserType::HTMLUNIT) {
-            $this->markTestSkipped('Screenshots are not supported by HtmlUnit browser');
-        }
-
-        $this->driver->get($this->getTestPageUrl('index.html'));
-
-        $firstElement = $this->driver->findElement(WebDriverBy::cssSelector('ul.list'));
-        $outputPng = $firstElement->takeElementScreenshot();
+        self::skipForJsonWireProtocol('Take element screenshot is only part of W3C protocol');
 
-        $image = imagecreatefromstring($outputPng);
-        $this->assertInternalType('resource', $image);
-
-        $size = $firstElement->getSize();
-        $this->assertEquals($size->getWidth(), imagesx($image));
-        $this->assertEquals($size->getHeight(), imagesy($image));
-    }
-
-    /**
-     * @covers ::takeScreenshot
-     */
-    public function testShouldSaveElementScreenshotToFile()
-    {
         if (!extension_loaded('gd')) {
             $this->markTestSkipped('GD extension must be enabled');
         }
         if ($this->desiredCapabilities->getBrowserName() === WebDriverBrowserType::HTMLUNIT) {
             $this->markTestSkipped('Screenshots are not supported by HtmlUnit browser');
         }
 
-        $screenshotPath = sys_get_temp_dir() . '/selenium-screenshot.png';
+        // Intentionally save screenshot to subdirectory to tests it is being created
+        $screenshotPath = sys_get_temp_dir() . '/' . uniqid('php-webdriver-') . '/element-screenshot.png';
 
         $this->driver->get($this->getTestPageUrl('index.html'));
 
-        $firstElement = $this->driver->findElement(WebDriverBy::cssSelector('ul.list'));
-        $firstElement->takeElementScreenshot($screenshotPath);
+        $element = $this->driver->findElement(WebDriverBy::id('red-box'));
+
+        $outputPngString = $element->takeElementScreenshot($screenshotPath);
 
-        $image = imagecreatefrompng($screenshotPath);
-        $this->assertInternalType('resource', $image);
+        // Assert file output
+        $imageFromFile = imagecreatefrompng($screenshotPath);
+        $this->assertEquals(5, imagesx($imageFromFile));
+        $this->assertEquals(5, imagesy($imageFromFile));
+
+        // Validate element is actually red
+        $this->assertSame(
+            ['red' => 255, 'green' => 0, 'blue' => 0, 'alpha' => 0],
+            imagecolorsforindex($imageFromFile, imagecolorat($imageFromFile, 0, 0))
+        );
 
-        $size = $firstElement->getSize();
-        $this->assertEquals($size->getWidth(), imagesx($image));
-        $this->assertEquals($size->getHeight(), imagesy($image));
+        // Assert string output
+        $imageFromString = imagecreatefromstring($outputPngString);
+        $this->assertInternalType('resource', $imageFromString);
+        $this->assertEquals(5, imagesx($imageFromString));
+        $this->assertEquals(5, imagesy($imageFromString));
 
         unlink($screenshotPath);
+        rmdir(dirname($screenshotPath));
     }
 }