MQE-1472: Action Group context in Tests and Allure

- Added Context comment in ActionGroupObject
- Allure now nests actionGroup steps a parent step

Author: KevinBKozan

src/Magento/FunctionalTestingFramework/Allure/Adapter/MagentoAllureAdapter.php

@@ -6,11 +6,14 @@
 namespace Magento\FunctionalTestingFramework\Allure\Adapter;
 
 use Magento\FunctionalTestingFramework\Suite\Handlers\SuiteObjectHandler;
+use Magento\FunctionalTestingFramework\Test\Objects\ActionGroupObject;
+use Yandex\Allure\Adapter\Model\Step;
 use Yandex\Allure\Codeception\AllureCodeception;
 use Yandex\Allure\Adapter\Event\StepStartedEvent;
 use Yandex\Allure\Adapter\Event\StepFinishedEvent;
 use Yandex\Allure\Adapter\Event\StepFailedEvent;
 use Yandex\Allure\Adapter\Event\TestCaseFailedEvent;
+use Yandex\Allure\Adapter\Event\TestCaseFinishedEvent;
 use Codeception\Event\FailEvent;
 use Codeception\Event\SuiteEvent;
 use Codeception\Event\StepEvent;
@@ -25,6 +28,8 @@
 
 class MagentoAllureAdapter extends AllureCodeception
 {
+    const STEP_PASSED = "passed";
+
     /**
      * Array of group values passed to test runner command
      *
@@ -107,7 +112,13 @@ public function stepBefore(StepEvent $stepEvent)
     {
         //Hard set to 200; we don't expose this config in MFTF
         $argumentsLength = 200;
-        $stepAction = $stepEvent->getStep()->getHumanizedActionWithoutArguments();
+
+        // DO NOT alter action if actionGroup is starting, need the exact actionGroup name for good logging
+        if (strpos($stepEvent->getStep()->getAction(), ActionGroupObject::ACTION_GROUP_CONTEXT_START) !== false) {
+            $stepAction = $stepEvent->getStep()->getAction();
+        } else {
+            $stepAction = $stepEvent->getStep()->getHumanizedActionWithoutArguments();
+        }
         $stepArgs = $stepEvent->getStep()->getArgumentsAsString($argumentsLength);
 
         if (!trim($stepAction)) {
@@ -148,4 +159,54 @@ public function testIncomplete(FailEvent $failEvent)
         $message = $e->getMessage();
         $this->getLifecycle()->fire($event->withException($e)->withMessage($message));
     }
+
+    /**
+     * Override of parent method, polls stepStorage for testcase and formats it according to actionGroup nesting.
+     *
+     * @return void
+     */
+    public function testEnd()
+    {
+        $rootStep = $this->getLifecycle()->getStepStorage()->pollLast();
+        $formattedStep = new Step();
+        $formattedStep->setName($rootStep->getName());
+        $formattedStep->setStart($rootStep->getStart());
+        $formattedStep->setStatus($rootStep->getStatus());
+
+        $actionGroupStepContainer = null;
+
+        foreach ($rootStep->getSteps() as $step) {
+            // if actionGroup flag, start nesting
+            if (strpos($step->getName(), ActionGroupObject::ACTION_GROUP_CONTEXT_START) !== false) {
+                $step->setName(str_replace(ActionGroupObject::ACTION_GROUP_CONTEXT_START, '', $step->getName()));
+                $actionGroupStepContainer = $step;
+                continue;
+            }
+            // if actionGroup ended, add stack to steps
+            if (stripos($step->getName(), ActionGroupObject::ACTION_GROUP_CONTEXT_END) !== false) {
+                $formattedStep->addStep($actionGroupStepContainer);
+                $actionGroupStepContainer = null;
+                continue;
+            }
+
+            if ($actionGroupStepContainer !== null) {
+                $actionGroupStepContainer->addStep($step);
+                if ($step->getStatus() !== self::STEP_PASSED) {
+                    // If step didn't pass, need to end action group nesting and set overall step status
+                    $actionGroupStepContainer->setStatus($step->getStatus());
+                    $formattedStep->addStep($actionGroupStepContainer);
+                    $actionGroupStepContainer = null;                    
+                }
+            } else {
+                // Add step as normal
+                $formattedStep->addStep($step);
+            }
+        }
+
+        // Reset storage with new formatted nested steps
+        $this->getLifecycle()->getStepStorage()->clear();
+        $this->getLifecycle()->getStepStorage()->put($formattedStep);
+
+        $this->getLifecycle()->fire(new TestCaseFinishedEvent());
+    }
 }

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

@@ -19,6 +19,8 @@ class ActionGroupObject
 {
     const ACTION_GROUP_ORIGIN_NAME = "actionGroupName";
     const ACTION_GROUP_ORIGIN_TEST_REF = "testInvocationRef";
+    const ACTION_GROUP_CONTEXT_START = "Entering Action Group ";
+    const ACTION_GROUP_CONTEXT_END = "Exiting Action Group";
     const STEPKEY_REPLACEMENT_ENABLED_TYPES = [
         "executeJS",
         "magentoCLI",
@@ -190,6 +192,8 @@ private function getResolvedActionsWithArgs($arguments, $actionReferenceKey)
             );
         }
 
+        $resolvedActions = $this->addContextCommentsToActionList($resolvedActions);
+
         return $resolvedActions;
     }
 
@@ -481,4 +485,24 @@ private function replaceCreateDataKeys($action, $replacementStepKeys)
 
         return $resolvedActionAttributes;
     }
+
+    /**
+     * Adds comment ActionObjects before and after given actionList for context setting.
+     * @param array $actionList
+     * @return array
+     */
+    private function addContextCommentsToActionList($actionList)
+    {
+        $startAction = new ActionObject(
+            self::ACTION_GROUP_CONTEXT_START . $this->name,
+            ActionObject::ACTION_TYPE_COMMENT,
+            [ActionObject::ACTION_ATTRIBUTE_USERINPUT => self::ACTION_GROUP_CONTEXT_START . $this->name]
+        );
+        $endAction = new ActionObject(
+            self::ACTION_GROUP_CONTEXT_END,
+            ActionObject::ACTION_TYPE_COMMENT,
+            [ActionObject::ACTION_ATTRIBUTE_USERINPUT => self::ACTION_GROUP_CONTEXT_END]
+        );
+        return [$startAction->getStepKey() => $startAction] + $actionList + [$endAction->getStepKey() => $endAction];
+    }
 }

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

@@ -69,6 +69,8 @@ class ActionObject
     const ACTION_ATTRIBUTE_VARIABLE_REGEX_PARAMETER = '/\(.+\)/';
     const ACTION_ATTRIBUTE_VARIABLE_REGEX_PATTERN = '/({{[\w]+\.[\w\[\]]+}})|({{[\w]+\.[\w]+\((?(?!}}).)+\)}})/';
     const DEFAULT_WAIT_TIMEOUT = 10;
+    const ACTION_ATTRIBUTE_USERINPUT = 'userInput';
+    const ACTION_TYPE_COMMENT = 'comment';
 
     /**
      * The unique identifier for the action