MQE-2270: Pausing of test during a failure is not intuitive for ENABLE_PAUSE=true

Author: jilu1

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -54,7 +54,9 @@
 class MagentoWebDriver extends WebDriver
 {
     use AttachmentSupport;
-    use Pause;
+    use Pause {
+        pause as codeceptPause;
+    }
 
     const MAGENTO_CRON_INTERVAL = 60;
     const MAGENTO_CRON_COMMAND = 'cron:run';
@@ -843,7 +845,7 @@ public function _failed(TestInterface $test, $fail)
         if ($this->pngReport === null && $this->htmlReport === null) {
             $this->saveScreenshot();
             if (getenv('ENABLE_PAUSE') === 'true') {
-                $this->pause();
+                $this->pause(true);
             }
         }
 
@@ -1028,4 +1030,23 @@ public function switchToIFrame($locator = null)
             $this->webDriver->switchTo()->frame($els[0]);
         }
     }
+
+    /**
+     * Invoke Codeption pause()
+     *
+     * @param boolean $pauseOnFail
+     * @return void
+     */
+    public function pause($pauseOnFail = false)
+    {
+        if (!\Codeception\Util\Debug::isEnabled()) {
+            return;
+        }
+
+        if ($pauseOnFail) {
+            print(PHP_EOL . "Failure encountered. Pausing execution..." . PHP_EOL . PHP_EOL);
+        }
+
+        $this->codeceptPause();
+    }
 }

src/Magento/FunctionalTestingFramework/Test/Objects/ActionObject.php

@@ -77,6 +77,7 @@ class ActionObject
     const ACTION_TYPE_COMMENT = 'comment';
     const ACTION_TYPE_HELPER = 'helper';
     const INVISIBLE_STEP_ACTIONS = ['retrieveEntityField', 'getSecret'];
+    const PAUSE_ACTION_INTERNAL_ATTRIBUTE = 'pauseOnFail';
 
     /**
      * The unique identifier for the action

src/Magento/FunctionalTestingFramework/Test/Util/TestHookObjectExtractor.php

@@ -66,7 +66,11 @@ public function createDefaultFailedHook($parentName)
     {
         $defaultSteps['saveScreenshot'] = new ActionObject("saveScreenshot", "saveScreenshot", []);
         if (getenv('ENABLE_PAUSE') === 'true') {
-            $defaultSteps['pauseWhenFailed'] = new ActionObject('pauseWhenFailed', 'pause', []);
+            $defaultSteps['pauseWhenFailed'] = new ActionObject(
+                'pauseWhenFailed',
+                'pause',
+                [ActionObject::PAUSE_ACTION_INTERNAL_ATTRIBUTE => true]
+            );
         }
 
         $hook = new TestHookObject(

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -1441,6 +1441,16 @@ public function generateStepsPhp($actionObjects, $generationScope = TestGenerato
 
                     $testSteps .= $dateGenerateCode;
                     break;
+                case "pause":
+                    $pauseAttr =  $actionObject->getCustomActionAttributes(
+                        ActionObject::PAUSE_ACTION_INTERNAL_ATTRIBUTE
+                    );
+                    if ($pauseAttr) {
+                        $testSteps .= sprintf("\t\t$%s->%s(%s);", $actor, $actionObject->getType(), 'true');
+                    } else {
+                        $testSteps .= sprintf("\t\t$%s->%s();", $actor, $actionObject->getType());
+                    }
+                    break;
                 case "comment":
                     $input = $input === null ? strtr($value, ['$' => '\$', '{' => '\{', '}' => '\}']) : $input;
                 // Combining userInput from native XML comment and <comment/> action to fall-through 'default' case