MQE-761: Generation of _failed method with createData action will lead test execution to fatal error

imeron2433 · imeron2433 · commit cbe867041523 · 2018-02-06T14:57:07.000-06:00
- reference _after method in _failed block
- remove unused extractor
- change Test Generator to skip generated stubs for failed function
diff --git a/dev/tests/verification/Resources/ActionGroupWithDataOverrideTest.txt b/dev/tests/verification/Resources/ActionGroupWithDataOverrideTest.txt
@@ -59,8 +59,7 @@ class ActionGroupWithDataOverrideTestCest
 	public function _failed(AcceptanceTester $I)
 	{
 		$I->saveScreenshot();
-		$I->fillField("#foo", "myData1");
-		$I->fillField("#bar", "myData2");
+		$this->_after($I);
 	}
 
 	/**
diff --git a/dev/tests/verification/Resources/ActionGroupWithDataTest.txt b/dev/tests/verification/Resources/ActionGroupWithDataTest.txt
@@ -59,8 +59,7 @@ class ActionGroupWithDataTestCest
 	public function _failed(AcceptanceTester $I)
 	{
 		$I->saveScreenshot();
-		$I->fillField("#foo", "myData1");
-		$I->fillField("#bar", "myData2");
+		$this->_after($I);
 	}
 
 	/**
diff --git a/dev/tests/verification/Resources/ActionGroupWithNoDefaultTest.txt b/dev/tests/verification/Resources/ActionGroupWithNoDefaultTest.txt
@@ -59,8 +59,7 @@ class ActionGroupWithNoDefaultTestCest
 	public function _failed(AcceptanceTester $I)
 	{
 		$I->saveScreenshot();
-		$I->fillField("#foo", "myData1");
-		$I->fillField("#bar", "myData2");
+		$this->_after($I);
 	}
 
 	/**
diff --git a/dev/tests/verification/Resources/ActionGroupWithPersistedData.txt b/dev/tests/verification/Resources/ActionGroupWithPersistedData.txt
@@ -59,8 +59,7 @@ class ActionGroupWithPersistedDataCest
 	public function _failed(AcceptanceTester $I)
 	{
 		$I->saveScreenshot();
-		$I->fillField("#foo", "myData1");
-		$I->fillField("#bar", "myData2");
+		$this->_after($I);
 	}
 
 	/**
diff --git a/dev/tests/verification/Resources/ActionGroupWithTopLevelPersistedData.txt b/dev/tests/verification/Resources/ActionGroupWithTopLevelPersistedData.txt
@@ -59,8 +59,7 @@ class ActionGroupWithTopLevelPersistedDataCest
 	public function _failed(AcceptanceTester $I)
 	{
 		$I->saveScreenshot();
-		$I->fillField("#foo", "myData1");
-		$I->fillField("#bar", "myData2");
+		$this->_after($I);
 	}
 
 	/**
diff --git a/dev/tests/verification/Resources/ArgumentWithSameNameAsElement.txt b/dev/tests/verification/Resources/ArgumentWithSameNameAsElement.txt
@@ -59,8 +59,7 @@ class ArgumentWithSameNameAsElementCest
 	public function _failed(AcceptanceTester $I)
 	{
 		$I->saveScreenshot();
-		$I->fillField("#foo", "myData1");
-		$I->fillField("#bar", "myData2");
+		$this->_after($I);
 	}
 
 	/**
diff --git a/dev/tests/verification/Resources/BasicFunctionalTest.txt b/dev/tests/verification/Resources/BasicFunctionalTest.txt
@@ -48,7 +48,7 @@ class BasicFunctionalTestCest
 	public function _failed(AcceptanceTester $I)
 	{
 		$I->saveScreenshot();
-		$I->amOnPage("/afterUrl");
+		$this->_after($I);
 	}
 
 	/**
diff --git a/dev/tests/verification/Resources/HookActionsTest.txt b/dev/tests/verification/Resources/HookActionsTest.txt
@@ -0,0 +1,88 @@
+<?php
+namespace Magento\AcceptanceTest\_generated\Backend;
+
+use Magento\FunctionalTestingFramework\AcceptanceTester;
+use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
+use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
+use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use \Codeception\Util\Locator;
+use Yandex\Allure\Adapter\Annotation\Features;
+use Yandex\Allure\Adapter\Annotation\Stories;
+use Yandex\Allure\Adapter\Annotation\Title;
+use Yandex\Allure\Adapter\Annotation\Description;
+use Yandex\Allure\Adapter\Annotation\Parameter;
+use Yandex\Allure\Adapter\Annotation\Severity;
+use Yandex\Allure\Adapter\Model\SeverityLevel;
+use Yandex\Allure\Adapter\Annotation\TestCaseId;
+
+/**
+ */
+class HookActionsTestCest
+{
+	/**
+	  * @var DataPersistenceHandler $sampleCreateBefore;
+	  */
+	protected $sampleCreateBefore;
+
+	/**
+	  * @var DataPersistenceHandler $sampleCreateForAfter;
+	  */
+	protected $sampleCreateForAfter;
+
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
+	public function _before(AcceptanceTester $I)
+	{
+		$I->amGoingTo("create entity that has the stepKey: sampleCreateBefore");
+		$sampleCreatedEntity = DataObjectHandler::getInstance()->getObject("sampleCreatedEntity");
+		$this->sampleCreateBefore = new DataPersistenceHandler($sampleCreatedEntity);
+		$this->sampleCreateBefore->createEntity();
+		$I->amGoingTo("delete entity that has the createDataKey: sampleCreateBefore");
+		$this->sampleCreateBefore->deleteEntity();
+		$I->amGoingTo("create entity that has the stepKey: sampleCreateForAfter");
+		$sampleCreatedEntity = DataObjectHandler::getInstance()->getObject("sampleCreatedEntity");
+		$this->sampleCreateForAfter = new DataPersistenceHandler($sampleCreatedEntity);
+		$this->sampleCreateForAfter->createEntity();
+	}
+
+	/**
+	  * @var DataPersistenceHandler $sampleCreateAfter;
+	  */
+	protected $sampleCreateAfter;
+
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
+	public function _after(AcceptanceTester $I)
+	{
+		$I->amGoingTo("create entity that has the stepKey: sampleCreateAfter");
+		$sampleCreatedEntity = DataObjectHandler::getInstance()->getObject("sampleCreatedEntity");
+		$this->sampleCreateAfter = new DataPersistenceHandler($sampleCreatedEntity);
+		$this->sampleCreateAfter->createEntity();
+		$I->amGoingTo("delete entity that has the createDataKey: sampleCreateForAfter");
+		$this->sampleCreateForAfter->deleteEntity();
+	}
+
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
+	public function _failed(AcceptanceTester $I)
+	{
+		$I->saveScreenshot();
+		$this->_after($I);
+	}
+
+	/**
+	 * @Parameter(name = "AcceptanceTester", value="$I")
+	 * @param AcceptanceTester $I
+	 * @return void
+	 * @throws \Exception
+	 */
+	public function HookActionsTest(AcceptanceTester $I)
+	{
+	}
+}
diff --git a/dev/tests/verification/Resources/MergedActionGroupTest.txt b/dev/tests/verification/Resources/MergedActionGroupTest.txt
@@ -59,8 +59,7 @@ class MergedActionGroupTestCest
 	public function _failed(AcceptanceTester $I)
 	{
 		$I->saveScreenshot();
-		$I->fillField("#foo", "myData1");
-		$I->fillField("#bar", "myData2");
+		$this->_after($I);
 	}
 
 	/**
diff --git a/dev/tests/verification/Resources/MultipleActionGroupsTest.txt b/dev/tests/verification/Resources/MultipleActionGroupsTest.txt
@@ -59,8 +59,7 @@ class MultipleActionGroupsTestCest
 	public function _failed(AcceptanceTester $I)
 	{
 		$I->saveScreenshot();
-		$I->fillField("#foo", "myData1");
-		$I->fillField("#bar", "myData2");
+		$this->_after($I);
 	}
 
 	/**
diff --git a/dev/tests/verification/TestModule/Test/HookActionsTest.xml b/dev/tests/verification/TestModule/Test/HookActionsTest.xml
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+
+<tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:noNamespaceSchemaLocation="../../../../../src/Magento/FunctionalTestingFramework/Test/etc/testSchema.xsd">
+    <test name="HookActionsTest">
+        <before>
+            <createData entity="sampleCreatedEntity" stepKey="sampleCreateBefore"/>
+            <deleteData createDataKey="sampleCreateBefore" stepKey="sampleDeleteBefore"/>
+            <createData entity="sampleCreatedEntity" stepKey="sampleCreateForAfter"/>
+        </before>
+        <after>
+            <createData entity="sampleCreatedEntity" stepKey="sampleCreateAfter"/>
+            <deleteData createDataKey="sampleCreateForAfter" stepKey="sampleDeleteAfter"/>
+        </after>
+    </test>
+</tests>
diff --git a/dev/tests/verification/Tests/HookActionsTest.php b/dev/tests/verification/Tests/HookActionsTest.php
@@ -0,0 +1,34 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace tests\verification\Tests;
+
+use Magento\FunctionalTestingFramework\Test\Handlers\TestObjectHandler;
+use Magento\FunctionalTestingFramework\Util\TestGenerator;
+use PHPUnit\Framework\TestCase;
+
+class HookActionsTest extends TestCase
+{
+    const RESOURCES_PATH = __DIR__ . '/../Resources';
+
+    /**
+     * Tests flat generation of a hardcoded test file with no external references.
+     *
+     * @throws \Exception
+     * @throws \Magento\FunctionalTestingFramework\Exceptions\TestReferenceException
+     */
+    public function testHookGenerationWithPersistedDeclarations()
+    {
+        $testName = 'HookActionsTest';
+        $test = TestObjectHandler::getInstance()->getObject($testName);
+        $testHandler = TestGenerator::getInstance(null, [$test]);
+        $testHandler->createAllTestFiles();
+
+        $this->assertFileEquals(
+            self::RESOURCES_PATH . DIRECTORY_SEPARATOR . $testName . ".txt",
+            $testHandler->getExportDir() . DIRECTORY_SEPARATOR . $test->getCodeceptionName() . ".php"
+        );
+    }
+}
diff --git a/src/Magento/FunctionalTestingFramework/Test/Objects/TestHookObject.php b/src/Magento/FunctionalTestingFramework/Test/Objects/TestHookObject.php
@@ -74,12 +74,6 @@ public function getActions()
         $mergeUtil = new ActionMergeUtil($this->parentName, $this->getType());
         $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;
     }
 
diff --git a/src/Magento/FunctionalTestingFramework/Test/Util/ActionObjectExtractor.php b/src/Magento/FunctionalTestingFramework/Test/Util/ActionObjectExtractor.php
@@ -45,9 +45,6 @@ public function extractActions($testActions)
 
         foreach ($testActions as $actionName => $actionData) {
             $stepKey = $actionData[self::TEST_STEP_MERGE_KEY];
-            if ($actionData[self::NODE_NAME] === TestEntityExtractor::TEST_STEP_ENTITY_CREATION) {
-                $actionData = $this->stripDataFields($actionData);
-            }
 
             $actionAttributes = $this->stripDescriptorTags(
                 $actionData,
@@ -112,23 +109,4 @@ private function processActionGroupArgs($actionAttributeData)
 
         return $actionAttributeArgData;
     }
-
-    /**
-     * Function which checks an entity definition for type array and strips this key out (as data is not stores in this
-     * type of object).
-     *
-     * @param array $entityDataArray
-     * @return array
-     */
-    private function stripDataFields($entityDataArray)
-    {
-        $results = $entityDataArray;
-        foreach ($entityDataArray as $key => $attribute) {
-            if (is_array($attribute)) {
-                unset($results[$key]);
-            }
-        }
-
-        return $results;
-    }
 }
diff --git a/src/Magento/FunctionalTestingFramework/Test/Util/TestEntityExtractor.php b/src/Magento/FunctionalTestingFramework/Test/Util/TestEntityExtractor.php
diff --git a/src/Magento/FunctionalTestingFramework/Test/Util/TestHookObjectExtractor.php b/src/Magento/FunctionalTestingFramework/Test/Util/TestHookObjectExtractor.php
@@ -6,6 +6,7 @@
 
 namespace Magento\FunctionalTestingFramework\Test\Util;
 
+use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
 use Magento\FunctionalTestingFramework\Test\Objects\TestHookObject;
 
 /**
@@ -20,20 +21,12 @@ class TestHookObjectExtractor extends BaseObjectExtractor
      */
     private $actionObjectExtractor;
 
-    /**
-     * Test Entity Extractor object
-     *
-     * @var TestEntityExtractor
-     */
-    private $testEntityExtractor;
-
     /**
      * TestHookObjectExtractor constructor
      */
     public function __construct()
     {
         $this->actionObjectExtractor = new ActionObjectExtractor();
-        $this->testEntityExtractor = new TestEntityExtractor();
     }
 
     /**
@@ -55,8 +48,21 @@ public function extractHook($parentName, $hookType, $testHook)
         $hook = new TestHookObject(
             $hookType,
             $parentName,
-            $this->actionObjectExtractor->extractActions($hookActions),
-            $this->testEntityExtractor->extractTestEntities($hookActions)
+            $this->actionObjectExtractor->extractActions($hookActions)
+        );
+
+        return $hook;
+    }
+
+    public function createDefaultFailedHook($parentName)
+    {
+
+        $saveScreenshotStep = ["saveScreenshot" => new ActionObject("saveScreenshot", "saveScreenshot", [])];
+
+        $hook = new TestHookObject(
+            TestObjectExtractor::TEST_FAILED_HOOK,
+            $parentName,
+            $saveScreenshotStep
         );
 
         return $hook;
diff --git a/src/Magento/FunctionalTestingFramework/Test/Util/TestObjectExtractor.php b/src/Magento/FunctionalTestingFramework/Test/Util/TestObjectExtractor.php
diff --git a/src/Magento/FunctionalTestingFramework/Util/TestGenerator.php b/src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

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