Added handling for first shots

Author: Nils Langner

module/VisualCeption.php

@@ -4,6 +4,7 @@
 
 /**
  * Class VisualCeption
+ *
  * @copyright Copyright (c) 2014 G+J Digital Products GmbH
  * @license MIT license, http://www.opensource.org/licenses/mit-license.php
  * @package Codeception\Module
@@ -42,7 +43,7 @@ public function _before (\Codeception\TestCase $test)
         $this->test = $test;
     }
 
-    private function getDeviation($identifier, $elementID)
+    private function getDeviation ($identifier, $elementID)
     {
         $coords = $this->getCoordinates($elementID);
         $this->createScreenshot($identifier, $coords);
@@ -52,7 +53,7 @@ private function getDeviation($identifier, $elementID)
         unlink($this->getScreenshotPath($identifier));
 
         $deviation = round($compareResult[1] * 100, 2);
-        return array("deviation" => $deviation, "deviationImage" => $compareResult[0]);
+        return array ("deviation" => $deviation, "deviationImage" => $compareResult[0]);
     }
 
     /**
@@ -62,13 +63,15 @@ private function getDeviation($identifier, $elementID)
      * @param string $identifier identifies your test object
      * @param string $elementID DOM ID of the element, which should be screenshotted
      */
-    public function dontseeVisualChanges($identifier, $elementID = null)
+    public function dontseeVisualChanges ($identifier, $elementID = null)
     {
         $deviationResult = $this->getDeviation($identifier, $elementID);
-        if ($deviationResult["deviation"] > $this->maximumDeviation) {
-            $compareScreenshotPath = $this->getDeviationScreenshotPath($identifier);
-            $deviationResult["deviationImage"]->writeImage($compareScreenshotPath);
-            $this->assertTrue(false, "The deviation of the taken screenshot is too high (".$deviationResult["deviation"]."%).\nSee $compareScreenshotPath for a deviation screenshot.");
+        if (! is_null($deviationResult["deviationImage"])) {
+            if ($deviationResult["deviation"] > $this->maximumDeviation) {
+                $compareScreenshotPath = $this->getDeviationScreenshotPath($identifier);
+                $deviationResult["deviationImage"]->writeImage($compareScreenshotPath);
+                $this->assertTrue(false, "The deviation of the taken screenshot is too high (" . $deviationResult["deviation"] . "%).\nSee $compareScreenshotPath for a deviation screenshot.");
+            }
         }
     }
 
@@ -79,18 +82,21 @@ public function dontseeVisualChanges($identifier, $elementID = null)
      * @param string $identifier identifies your test object
      * @param string $elementID DOM ID of the element, which should be screenshotted
      */
-    public function seeVisualChanges($identifier, $elementID = null)
+    public function seeVisualChanges ($identifier, $elementID = null)
     {
         $deviationResult = $this->getDeviation($identifier, $elementID);
-        if ($deviationResult["deviation"] <= $this->maximumDeviation) {
-            $compareScreenshotPath = $this->getDeviationScreenshotPath($identifier);
-            $deviationResult["deviationImage"]->writeImage($compareScreenshotPath);
-            $this->assertTrue(false, "The deviation of the taken screenshot is too low (".$deviationResult["deviation"]."%).\nSee $compareScreenshotPath for a deviation screenshot.");
+        if (! is_null($deviationResult["deviationImage"])) {
+            if ($deviationResult["deviation"] <= $this->maximumDeviation) {
+                $compareScreenshotPath = $this->getDeviationScreenshotPath($identifier);
+                $deviationResult["deviationImage"]->writeImage($compareScreenshotPath);
+                $this->assertTrue(false, "The deviation of the taken screenshot is too low (" . $deviationResult["deviation"] . "%).\nSee $compareScreenshotPath for a deviation screenshot.");
+            }
         }
     }
 
     /**
-     * Initialize the module and read the config. Throws a runtime exception, if the
+     * Initialize the module and read the config.
+     * Throws a runtime exception, if the
      * reference image dir is not set in the config
      *
      * @throws \RuntimeException
@@ -114,7 +120,8 @@ private function init ()
     }
 
     /**
-     * Find the position and proportion of a DOM element, specified by it's ID. The method inject the
+     * Find the position and proportion of a DOM element, specified by it's ID.
+     * The method inject the
      * JQuery Framework and uses the "noConflict"-mode to get the width, height and offset params.
      *
      * @param $elementId DOM ID of the element, which should be screenshotted
@@ -127,7 +134,7 @@ private function getCoordinates ($elementId)
             $elementId = 'body';
         }
 
-        $jQueryString = file_get_contents(__DIR__."/jquery.js");
+        $jQueryString = file_get_contents(__DIR__ . "/jquery.js");
         $webDriver->executeScript($jQueryString);
         $webDriver->executeScript('jQuery.noConflict();');
 
@@ -165,12 +172,11 @@ private function getScreenshotPath ($identifier)
         $debugDir = \Codeception\Configuration::logDir() . 'debug/tmp/';
         if (! is_dir($debugDir)) {
             $created = mkdir($debugDir, 0777, true);
-            if( $created ) {
-            $this->debug("Creating directory: $debugDir");
-            }else{
+            if ($created) {
+                $this->debug("Creating directory: $debugDir");
+            } else {
                 throw new \RuntimeException("Unable to create temporary screenshot dir ($debugDir)");
             }
-
         }
         return $debugDir . $this->getScreenshotName($identifier);
     }
@@ -204,9 +210,9 @@ private function createScreenshot ($identifier, array $coords)
         $webDriver->takeScreenshot($screenshotPath);
 
         $screenShotImage = new \Imagick();
-        $screenShotImage->readImage( $screenshotPath );
-        $screenShotImage->cropImage( $coords['width'], $coords['height'], $coords['offset_x'], $coords['offset_y'] );
-        $screenShotImage->writeImage( $elementPath );
+        $screenShotImage->readImage($screenshotPath);
+        $screenShotImage->cropImage($coords['width'], $coords['height'], $coords['offset_x'], $coords['offset_y']);
+        $screenShotImage->writeImage($elementPath);
 
         unlink($screenshotPath);
 
@@ -226,7 +232,8 @@ private function getDeviationScreenshotPath ($identifier)
     }
 
     /**
-     * Compare two images by its identifiers. If the reference image doesn't exists
+     * Compare two images by its identifiers.
+     * If the reference image doesn't exists
      * the image is copied to the reference path.
      *
      * @param $identifier identifies your test object