MQE-751: Screenshot/source capture firing after failed hooks

imeron2433 · imeron2433 · commit d72c92388158 · 2018-02-05T15:38:15.000-06:00
- add auto screenshot logic to capture correct point of failure
diff --git a/dev/tests/verification/Resources/ActionGroupWithDataOverrideTest.txt b/dev/tests/verification/Resources/ActionGroupWithDataOverrideTest.txt
@@ -58,6 +58,7 @@ class ActionGroupWithDataOverrideTestCest
 	  */
 	public function _failed(AcceptanceTester $I)
 	{
+		$I->saveScreenshot();
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
diff --git a/dev/tests/verification/Resources/ActionGroupWithDataTest.txt b/dev/tests/verification/Resources/ActionGroupWithDataTest.txt
@@ -58,6 +58,7 @@ class ActionGroupWithDataTestCest
 	  */
 	public function _failed(AcceptanceTester $I)
 	{
+		$I->saveScreenshot();
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
diff --git a/dev/tests/verification/Resources/ActionGroupWithNoDefaultTest.txt b/dev/tests/verification/Resources/ActionGroupWithNoDefaultTest.txt
@@ -58,6 +58,7 @@ class ActionGroupWithNoDefaultTestCest
 	  */
 	public function _failed(AcceptanceTester $I)
 	{
+		$I->saveScreenshot();
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
diff --git a/dev/tests/verification/Resources/ActionGroupWithPersistedData.txt b/dev/tests/verification/Resources/ActionGroupWithPersistedData.txt
@@ -58,6 +58,7 @@ class ActionGroupWithPersistedDataCest
 	  */
 	public function _failed(AcceptanceTester $I)
 	{
+		$I->saveScreenshot();
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
diff --git a/dev/tests/verification/Resources/ActionGroupWithTopLevelPersistedData.txt b/dev/tests/verification/Resources/ActionGroupWithTopLevelPersistedData.txt
@@ -58,6 +58,7 @@ class ActionGroupWithTopLevelPersistedDataCest
 	  */
 	public function _failed(AcceptanceTester $I)
 	{
+		$I->saveScreenshot();
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
diff --git a/dev/tests/verification/Resources/ArgumentWithSameNameAsElement.txt b/dev/tests/verification/Resources/ArgumentWithSameNameAsElement.txt
@@ -58,6 +58,7 @@ class ArgumentWithSameNameAsElementCest
 	  */
 	public function _failed(AcceptanceTester $I)
 	{
+		$I->saveScreenshot();
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
diff --git a/dev/tests/verification/Resources/BasicFunctionalTest.txt b/dev/tests/verification/Resources/BasicFunctionalTest.txt
@@ -47,6 +47,7 @@ class BasicFunctionalTestCest
 	  */
 	public function _failed(AcceptanceTester $I)
 	{
+		$I->saveScreenshot();
 		$I->amOnPage("/afterUrl");
 	}
 
diff --git a/dev/tests/verification/Resources/MergeFunctionalTest.txt b/dev/tests/verification/Resources/MergeFunctionalTest.txt
@@ -48,6 +48,7 @@ class MergeFunctionalTestCest
 	  */
 	public function _failed(AcceptanceTester $I)
 	{
+	    $I->saveScreenshot();
 		$I->amOnPage("/afterUrl1");
 	}
 
diff --git a/dev/tests/verification/Resources/MergedActionGroupTest.txt b/dev/tests/verification/Resources/MergedActionGroupTest.txt
@@ -58,6 +58,7 @@ class MergedActionGroupTestCest
 	  */
 	public function _failed(AcceptanceTester $I)
 	{
+		$I->saveScreenshot();
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
diff --git a/dev/tests/verification/Resources/MultipleActionGroupsTest.txt b/dev/tests/verification/Resources/MultipleActionGroupsTest.txt
@@ -58,6 +58,7 @@ class MultipleActionGroupsTestCest
 	  */
 	public function _failed(AcceptanceTester $I)
 	{
+		$I->saveScreenshot();
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
diff --git a/src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php b/src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php
@@ -6,6 +6,7 @@
 
 namespace Magento\FunctionalTestingFramework\Module;
 
+use Codeception\Events;
 use Codeception\Module\WebDriver;
 use Codeception\Test\Descriptor;
 use Codeception\TestInterface;
@@ -21,6 +22,7 @@
 use Magento\FunctionalTestingFramework\Util\Protocol\CurlInterface;
 use Magento\Setup\Exception;
 use Magento\FunctionalTestingFramework\Util\ConfigSanitizerUtil;
+use Yandex\Allure\Adapter\Event\TestCaseFinishedEvent;
 use Yandex\Allure\Adapter\Support\AttachmentSupport;
 
 /**
@@ -80,6 +82,27 @@ class MagentoWebDriver extends WebDriver
         LC_MESSAGES => null,
     ];
 
+    /**
+     * Current Test Interface
+     *
+     * @var TestInterface
+     */
+    private $current_test;
+
+    /**
+     * Png image filepath for current test
+     *
+     * @var string
+     */
+    private $pngReport;
+
+    /**
+     * Html filepath for current test
+     *
+     * @var string
+     */
+    private $htmlReport;
+
     public function _initialize()
     {
         $this->config = ConfigSanitizerUtil::sanitizeWebDriverConfig($this->config);
@@ -465,22 +488,43 @@ public function assertElementContainsAttribute($selector, $attribute, $value)
         }
     }
 
+    public function _before(TestInterface $test)
+    {
+        $this->current_test = $test;
+        $this->htmlReport = null;
+        $this->pngReport = null;
+
+        parent::_before($test);
+    }
+
     /**
      * Override for _failed method in Codeception method. Adds png and html attachments to allure report
      * following parent execution of test failure processing.
+     *
      * @param TestInterface $test
      * @param \Exception $fail
      */
     public function _failed(TestInterface $test, $fail)
     {
-        parent::_failed($test, $fail);
+        $this->debugWebDriverLogs($test);
+
+        if ($this->pngReport == null && $this->htmlReport == null) {
+            $this->saveScreenshot();
+        }
+
+        $this->addAttachment($this->pngReport, $test->getMetadata()->getName() . '.png', 'image/png');
+        $this->addAttachment($this->htmlReport, $test->getMetadata()->getName() . '.html', 'text/html');
+    }
 
-        // Reconstruct file naming from codeception method
+    /**
+     * Function which saves a screenshot of the current stat of the browser
+     */
+    public function saveScreenshot()
+    {
+        $test = $this->current_test;
         $filename = preg_replace('~\W~', '.', Descriptor::getTestSignature($test));
         $outputDir = codecept_output_dir();
-        $pngReport = $outputDir . mb_strcut($filename, 0, 245, 'utf-8') . '.fail.png';
-        $htmlReport = $outputDir . mb_strcut($filename, 0, 244, 'utf-8') . '.fail.html';
-        $this->addAttachment($pngReport, $test->getMetadata()->getName() . '.png', 'image/png');
-        $this->addAttachment($htmlReport, $test->getMetadata()->getName() . '.html', 'text/html');
+        $this->_saveScreenshot($this->pngReport = $outputDir . mb_strcut($filename, 0, 245, 'utf-8') . '.fail.png');
+        $this->_savePageSource($this->htmlReport = $outputDir . mb_strcut($filename, 0, 244, 'utf-8') . '.fail.html');
     }
-}
+}
diff --git a/src/Magento/FunctionalTestingFramework/Test/Objects/TestHookObject.php b/src/Magento/FunctionalTestingFramework/Test/Objects/TestHookObject.php
@@ -7,6 +7,7 @@
 namespace Magento\FunctionalTestingFramework\Test\Objects;
 
 use Magento\FunctionalTestingFramework\Test\Util\ActionMergeUtil;
+use Magento\FunctionalTestingFramework\Test\Util\TestObjectExtractor;
 
 /**
  * Class TestHookObject
@@ -71,7 +72,15 @@ public function getType()
     public function getActions()
     {
         $mergeUtil = new ActionMergeUtil($this->parentName, $this->getType());
-        return $mergeUtil->resolveActionSteps($this->actions);
+        $mergedSteps = $mergeUtil->resolveActionSteps($this->actions);
+
+        // add explicit call to save screenshot in order to preserve state of application after failure
+        if ($this->getType() == TestObjectExtractor::TEST_FAILED_HOOK) {
+            $saveScreenshotStep = ["saveScreenshot" => new ActionObject("saveScreenshot", "saveScreenshot", [])];
+            $mergedSteps = $saveScreenshotStep + $mergedSteps;
+        }
+
+        return $mergedSteps;
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ class ActionGroupWithDataOverrideTestCest`
`58`	`58`	`*/`
`59`	`59`	`public function _failed(AcceptanceTester $I)`
`60`	`60`	`{`
	`61`	`+ $I->saveScreenshot();`
`61`	`62`	`$I->fillField("#foo", "myData1");`
`62`	`63`	`$I->fillField("#bar", "myData2");`
`63`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ class ArgumentWithSameNameAsElementCest`
`58`	`58`	`*/`
`59`	`59`	`public function _failed(AcceptanceTester $I)`
`60`	`60`	`{`
	`61`	`+ $I->saveScreenshot();`
`61`	`62`	`$I->fillField("#foo", "myData1");`
`62`	`63`	`$I->fillField("#bar", "myData2");`
`63`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,7 @@ class BasicFunctionalTestCest`
`47`	`47`	`*/`
`48`	`48`	`public function _failed(AcceptanceTester $I)`
`49`	`49`	`{`
	`50`	`+ $I->saveScreenshot();`
`50`	`51`	`$I->amOnPage("/afterUrl");`
`51`	`52`	`}`
`52`	`53`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@ class MergeFunctionalTestCest`
`48`	`48`	`*/`
`49`	`49`	`public function _failed(AcceptanceTester $I)`
`50`	`50`	`{`
	`51`	`+ $I->saveScreenshot();`
`51`	`52`	`$I->amOnPage("/afterUrl1");`
`52`	`53`	`}`
`53`	`54`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ class MergedActionGroupTestCest`
`58`	`58`	`*/`
`59`	`59`	`public function _failed(AcceptanceTester $I)`
`60`	`60`	`{`
	`61`	`+ $I->saveScreenshot();`
`61`	`62`	`$I->fillField("#foo", "myData1");`
`62`	`63`	`$I->fillField("#bar", "myData2");`
`63`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ class MultipleActionGroupsTestCest`
`58`	`58`	`*/`
`59`	`59`	`public function _failed(AcceptanceTester $I)`
`60`	`60`	`{`
	`61`	`+ $I->saveScreenshot();`
`61`	`62`	`$I->fillField("#foo", "myData1");`
`62`	`63`	`$I->fillField("#bar", "myData2");`
`63`	`64`	`}`