Updated VisualCeption; added getReferenceImageDir()

Author: Nils Langner

module/VisualCeption.php

@@ -20,7 +20,6 @@ class VisualCeption extends \Codeception\Module
     private $referenceImageDir;
 
     private $maximumDeviation = 0;
-    private $saveCurrentImageIfFailure = false;
 
     private $webDriver = null;
     private $webDriverModule = null;
@@ -60,6 +59,11 @@ public function _before(\Codeception\TestCase $test)
         $this->test = $test;
     }
 
+    public function getReferenceImageDir()
+    {
+        return $this->referenceImageDir;
+    }
+
     /**
      * Compare the reference image with a current screenshot, identified by their indentifier name
      * and their element ID.
@@ -83,11 +87,6 @@ public function seeVisualChanges($identifier, $elementID = null, $excludeElement
                 $compareScreenshotPath = $this->getDeviationScreenshotPath($identifier);
                 $deviationResult["deviationImage"]->writeImage($compareScreenshotPath);
 
-                if ($this->saveCurrentImageIfFailure === true) {
-                    $saveCurrentImagePath = $this->getDeviationScreenshotPath($identifier, 'current');
-                    $deviationResult['currentImage']->writeImage($saveCurrentImagePath);
-                }
-
                 throw new ImageDeviationException("The deviation of the taken screenshot is too low (" . $deviationResult["deviation"] . "%).\nSee $compareScreenshotPath for a deviation screenshot.",
                     $this->getExpectedScreenshotPath($identifier),
                     $this->getScreenshotPath($identifier),
@@ -119,11 +118,6 @@ public function dontSeeVisualChanges($identifier, $elementID = null, $excludeEle
                 $compareScreenshotPath = $this->getDeviationScreenshotPath($identifier);
                 $deviationResult["deviationImage"]->writeImage($compareScreenshotPath);
 
-                if ($this->saveCurrentImageIfFailure === true) {
-                    $saveCurrentImagePath = $this->getDeviationScreenshotPath($identifier, 'current.');
-                    $deviationResult['currentImage']->writeImage($saveCurrentImagePath);
-                }
-
                 throw new ImageDeviationException("The deviation of the taken screenshot is too hight (" . $deviationResult["deviation"] . "%).\nSee $compareScreenshotPath for a deviation screenshot.",
                     $this->getExpectedScreenshotPath($identifier),
                     $this->getScreenshotPath($identifier),
@@ -177,8 +171,6 @@ private function getDeviation($identifier, $elementID, array $excludeElements =
 
         $compareResult = $this->compare($identifier);
 
-        unlink($this->getScreenshotPath($identifier));
-
         $deviation = round($compareResult[1] * 100, 2);
 
         $this->debug("The deviation between the images is ". $deviation . " percent");
@@ -366,7 +358,7 @@ private function resetHideElementsForScreenshot(array $excludeElements)
     private function getDeviationScreenshotPath ($identifier, $alternativePrefix = '')
     {
         $debugDir = \Codeception\Configuration::logDir() . 'debug/';
-        $prefix = ( $alternativePrefix === '') ? 'compare.' : $alternativePrefix;
+        $prefix = ( $alternativePrefix === '') ? 'compare' : $alternativePrefix;
         return $debugDir . $prefix . $this->getScreenshotName($identifier);
     }
 
@@ -428,4 +420,4 @@ private function compareImages($image1, $image2)
         }
         return $result;
     }
-}
+}