MQE-672: Generate failed hook with after hook

- Modified the Object Extractor so it creates a "_failed" block when it generates an "_after" block.

Author: KevinBKozan

dev/tests/unit/Magento/FunctionalTestFramework/Test/Handlers/TestObjectHandlerTest.php

@@ -24,14 +24,17 @@
 class TestObjectHandlerTest extends TestCase
 {
     /**
-     * Basic test to validate array => test object conversion
+     * Basic test to validate array => test object conversion.
+     *
+     * @throws \Exception
      */
     public function testGetTestObject()
     {
         // set up mock data
         $testDataArrayBuilder = new TestDataArrayBuilder();
         $mockData = $testDataArrayBuilder
             ->withAnnotations()
+            ->withFailedHook()
             ->withAfterHook()
             ->withBeforeHook()
             ->withTestActions()
@@ -54,17 +57,26 @@ public function testGetTestObject()
             $testDataArrayBuilder->testActionType,
             []
         );
+        $expectedFailedActionObject = new ActionObject(
+            $testDataArrayBuilder->testActionAfterName,
+            $testDataArrayBuilder->testActionType,
+            []
+        );
+
         $expectedBeforeHookObject = new TestHookObject(
             TestObjectExtractor::TEST_BEFORE_HOOK,
             $testDataArrayBuilder->testName,
-            [$expectedBeforeActionObject],
-            []
+            [$expectedBeforeActionObject]
         );
         $expectedAfterHookObject = new TestHookObject(
             TestObjectExtractor::TEST_AFTER_HOOK,
             $testDataArrayBuilder->testName,
-            [$expectedAfterActionObject],
-            []
+            [$expectedAfterActionObject]
+        );
+        $expectedFailedHookObject = new TestHookObject(
+            TestObjectExtractor::TEST_FAILED_HOOK,
+            $testDataArrayBuilder->testName,
+            [$expectedFailedActionObject]
         );
 
         $expectedTestActionObject = new ActionObject(
@@ -80,7 +92,8 @@ public function testGetTestObject()
             ],
             [
                 TestObjectExtractor::TEST_BEFORE_HOOK => $expectedBeforeHookObject,
-                TestObjectExtractor::TEST_AFTER_HOOK => $expectedAfterHookObject
+                TestObjectExtractor::TEST_AFTER_HOOK => $expectedAfterHookObject,
+                TestObjectExtractor::TEST_FAILED_HOOK => $expectedFailedHookObject
             ],
             []
         );
@@ -89,7 +102,9 @@ public function testGetTestObject()
     }
 
     /**
-     * Tests the function used to get a series of relevant tests by group
+     * Tests the function used to get a series of relevant tests by group.
+     *
+     * @throws \Exception
      */
     public function testGetTestsByGroup()
     {
@@ -120,6 +135,7 @@ public function testGetTestsByGroup()
      * Function used to set mock for parser return and force init method to run between tests.
      *
      * @param array $data
+     * @throws \Exception
      */
     private function setMockParserOutput($data)
     {

dev/tests/unit/Util/TestDataArrayBuilder.php

@@ -32,6 +32,13 @@ class TestDataArrayBuilder
      */
     public $testActionAfterName = 'testActionAfter';
 
+    /**
+     * Mock failed action name
+     *
+     * @var string
+     */
+    public $testActionFailedName = 'testActionFailed';
+
     /**
      * Mock test action in test name
      *
@@ -61,6 +68,11 @@ class TestDataArrayBuilder
      */
     private $afterHook = [];
 
+    /**
+     * @var array
+     */
+    private $failedHook = [];
+
     /**
      * @var array
      */
@@ -134,6 +146,27 @@ public function withAfterHook($afterHook = null)
         return $this;
     }
 
+    /**
+     * Add a failed hook passed in by arg (or default if no arg)
+     *
+     * @param null $failedHook
+     * @return $this
+     */
+    public function withFailedHook($failedHook = null)
+    {
+        if ($failedHook == null) {
+            $this->failedHook = [$this->testActionFailedName => [
+                ActionObjectExtractor::NODE_NAME => $this->testActionType,
+                ActionObjectExtractor::TEST_STEP_MERGE_KEY => $this->testActionFailedName
+
+            ]];
+        } else {
+            $this->failedHook = $failedHook;
+        }
+
+        return $this;
+    }
+
     /**
      * Add test actions passed in by arg (or default if no arg)
      *
@@ -167,7 +200,8 @@ public function build()
                 TestObjectExtractor::NAME => $this->testName,
                 TestObjectExtractor::TEST_ANNOTATIONS => $this->annotations,
                 TestObjectExtractor::TEST_BEFORE_HOOK => $this->beforeHook,
-                TestObjectExtractor::TEST_AFTER_HOOK => $this->afterHook
+                TestObjectExtractor::TEST_AFTER_HOOK => $this->afterHook,
+                TestObjectExtractor::TEST_FAILED_HOOK => $this->failedHook
             ],
             $this->testActions
         )];

dev/tests/verification/Resources/ActionGroupWithDataOverrideTest.txt

@@ -25,9 +25,13 @@ class ActionGroupWithDataOverrideTestCest
 {
 	/**
 	  * @var DataPersistenceHandler $createPersonParam;
-	 */
+	  */
 	protected $createPersonParam;
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
 	public function _before(AcceptanceTester $I)
 	{
 		$I->amGoingTo("create entity that has the stepKey: createPersonParam");
@@ -38,12 +42,26 @@ class ActionGroupWithDataOverrideTestCest
 		$I->fillField("#bar", "myData2");
 	}
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
 	public function _after(AcceptanceTester $I)
 	{
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
+	public function _failed(AcceptanceTester $I)
+	{
+		$I->fillField("#foo", "myData1");
+		$I->fillField("#bar", "myData2");
+	}
+
 	/**
 	 * @Severity(level = SeverityLevel::CRITICAL)
 	 * @Parameter(name = "AcceptanceTester", value="$I")

dev/tests/verification/Resources/ActionGroupWithDataTest.txt

@@ -25,9 +25,13 @@ class ActionGroupWithDataTestCest
 {
 	/**
 	  * @var DataPersistenceHandler $createPersonParam;
-	 */
+	  */
 	protected $createPersonParam;
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
 	public function _before(AcceptanceTester $I)
 	{
 		$I->amGoingTo("create entity that has the stepKey: createPersonParam");
@@ -38,12 +42,26 @@ class ActionGroupWithDataTestCest
 		$I->fillField("#bar", "myData2");
 	}
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
 	public function _after(AcceptanceTester $I)
 	{
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
+	public function _failed(AcceptanceTester $I)
+	{
+		$I->fillField("#foo", "myData1");
+		$I->fillField("#bar", "myData2");
+	}
+
 	/**
 	 * @Severity(level = SeverityLevel::CRITICAL)
 	 * @Parameter(name = "AcceptanceTester", value="$I")

dev/tests/verification/Resources/ActionGroupWithNoDefaultTest.txt

@@ -25,9 +25,13 @@ class ActionGroupWithNoDefaultTestCest
 {
 	/**
 	  * @var DataPersistenceHandler $createPersonParam;
-	 */
+	  */
 	protected $createPersonParam;
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
 	public function _before(AcceptanceTester $I)
 	{
 		$I->amGoingTo("create entity that has the stepKey: createPersonParam");
@@ -38,12 +42,26 @@ class ActionGroupWithNoDefaultTestCest
 		$I->fillField("#bar", "myData2");
 	}
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
 	public function _after(AcceptanceTester $I)
 	{
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
+	public function _failed(AcceptanceTester $I)
+	{
+		$I->fillField("#foo", "myData1");
+		$I->fillField("#bar", "myData2");
+	}
+
 	/**
 	 * @Severity(level = SeverityLevel::CRITICAL)
 	 * @Parameter(name = "AcceptanceTester", value="$I")

dev/tests/verification/Resources/ActionGroupWithPersistedData.txt

@@ -25,9 +25,13 @@ class ActionGroupWithPersistedDataCest
 {
 	/**
 	  * @var DataPersistenceHandler $createPersonParam;
-	 */
+	  */
 	protected $createPersonParam;
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
 	public function _before(AcceptanceTester $I)
 	{
 		$I->amGoingTo("create entity that has the stepKey: createPersonParam");
@@ -38,12 +42,26 @@ class ActionGroupWithPersistedDataCest
 		$I->fillField("#bar", "myData2");
 	}
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
 	public function _after(AcceptanceTester $I)
 	{
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
+	public function _failed(AcceptanceTester $I)
+	{
+		$I->fillField("#foo", "myData1");
+		$I->fillField("#bar", "myData2");
+	}
+
 	/**
 	 * @Severity(level = SeverityLevel::CRITICAL)
 	 * @Parameter(name = "AcceptanceTester", value="$I")

dev/tests/verification/Resources/ActionGroupWithTopLevelPersistedData.txt

@@ -25,9 +25,13 @@ class ActionGroupWithTopLevelPersistedDataCest
 {
 	/**
 	  * @var DataPersistenceHandler $createPersonParam;
-	 */
+	  */
 	protected $createPersonParam;
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
 	public function _before(AcceptanceTester $I)
 	{
 		$I->amGoingTo("create entity that has the stepKey: createPersonParam");
@@ -38,12 +42,26 @@ class ActionGroupWithTopLevelPersistedDataCest
 		$I->fillField("#bar", "myData2");
 	}
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
 	public function _after(AcceptanceTester $I)
 	{
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
+	public function _failed(AcceptanceTester $I)
+	{
+		$I->fillField("#foo", "myData1");
+		$I->fillField("#bar", "myData2");
+	}
+
 	/**
 	 * @Severity(level = SeverityLevel::CRITICAL)
 	 * @Parameter(name = "AcceptanceTester", value="$I")

dev/tests/verification/Resources/ArgumentWithSameNameAsElement.txt

@@ -25,9 +25,13 @@ class ArgumentWithSameNameAsElementCest
 {
 	/**
 	  * @var DataPersistenceHandler $createPersonParam;
-	 */
+	  */
 	protected $createPersonParam;
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
 	public function _before(AcceptanceTester $I)
 	{
 		$I->amGoingTo("create entity that has the stepKey: createPersonParam");
@@ -38,12 +42,26 @@ class ArgumentWithSameNameAsElementCest
 		$I->fillField("#bar", "myData2");
 	}
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
 	public function _after(AcceptanceTester $I)
 	{
 		$I->fillField("#foo", "myData1");
 		$I->fillField("#bar", "myData2");
 	}
 
+	/**
+	  * @param AcceptanceTester $I
+	  * @throws \Exception
+	  */
+	public function _failed(AcceptanceTester $I)
+	{
+		$I->fillField("#foo", "myData1");
+		$I->fillField("#bar", "myData2");
+	}
+
 	/**
 	 * @Severity(level = SeverityLevel::CRITICAL)
 	 * @Parameter(name = "AcceptanceTester", value="$I")