MQE-879: Add support for tests actions in suite pre/post conditions

- update mustahche template to use new actions - update Magento Webdriver to account for no test context - update suiteSchema.xml and di.xml

Author: imeron2433

etc/di.xml

@@ -358,6 +358,10 @@
  <argument name="schemaLocator" xsi:type="object">Magento\FunctionalTestingFramework\Config\SchemaLocator\SuiteData</argument>
  <argument name="idAttributes" xsi:type="array">
  <item name="/suites/suite" xsi:type="string">name</item>
+ <item name="/suites/suite/(before|after)/remove" xsi:type="string">keyForRemoval</item>
+ <item name="/suites/suite/(before|after)/(actionGroup|&commonTestActions;)" xsi:type="string">stepKey</item>
+ <item name="/suites/suite/(before|after)/createData/requiredEntity" xsi:type="string">createDataKey</item>
+ <item name="/suites/suite/(before|after)/createData/field" xsi:type="string">key</item>
  <item name="/suites/suite/include/(group|test|module)" xsi:type="string">name</item>
  <item name="/suites/suite/exclude/(group|test|module)" xsi:type="string">name</item>
  </argument>
@@ -370,8 +374,10 @@
  <arguments>
  <argument name="assocArrayAttributes" xsi:type="array">
  <item name="/suites/suite" xsi:type="string">name</item>
- <item name="/suites/suite/(before|after)/(createData|deleteData)" xsi:type="string">stepKey</item>
+ <item name="/suites/suite/(before|after)/remove" xsi:type="string">keyForRemoval</item>
+ <item name="/suites/suite/(before|after)/(actionGroup|&commonTestActions;)" xsi:type="string">stepKey</item>
  <item name="/suites/suite/(before|after)/createData/requiredEntity" xsi:type="string">createDataKey</item>
+ <item name="/suites/suite/(before|after)/createData/field" xsi:type="string">key</item>
  <item name="/suites/suite/include/(group|test|module)" xsi:type="string">name</item>
  <item name="/suites/suite/exclude/(group|test|module)" xsi:type="string">name</item>
  </argument>

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -435,7 +435,7 @@ public function scrollToTopOfPage()
  * @param string $command
  * @returns string
  */
- public function executeMagentoCLICommand($command)
+ public function magentoCLI($command)
  {
 
  $apiURL = $this->config['url'] . getenv('MAGENTO_CLI_COMMAND_PATH');
@@ -527,6 +527,10 @@ public function _failed(TestInterface $test, $fail)
  $this->saveScreenshot();
  }
 
+ if ($this->current_test == null) {
+ throw new \RuntimeException("Suite condition failure: \n" . $fail->getMessage());
+ }
+
  $this->addAttachment($this->pngReport, $test->getMetadata()->getName() . '.png', 'image/png');
  $this->addAttachment($this->htmlReport, $test->getMetadata()->getName() . '.html', 'text/html');
 
@@ -540,8 +544,12 @@ public function _failed(TestInterface $test, $fail)
  */
  public function saveScreenshot()
  {
- $test = $this->current_test;
- $filename = preg_replace('~\W~', '.', Descriptor::getTestSignature($test));
+ $testDescription = "unknown." . uniqid();
+ if ($this->current_test != null) {
+ $testDescription = Descriptor::getTestSignature($this->current_test);
+ }
+
+ $filename = preg_replace('~\W~', '.', $testDescription);
  $outputDir = codecept_output_dir();
  $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');

src/Magento/FunctionalTestingFramework/Suite/Generators/GroupClassGenerator.php

@@ -26,7 +26,11 @@ class GroupClassGenerator
  const REQUIRED_ENTITY_KEY = 'requiredEntities';
  const LAST_REQUIRED_ENTITY_TAG = 'last';
  const MUSTACHE_VAR_TAG = 'var';
-
+ const MAGENTO_CLI_COMMAND_COMMAND = 'command';
+ const DATA_PERSISTENCE_ACTIONS = ["createData", "deleteData"];
+ const REPLACEMENT_ACTIONS = [
+ 'comment' => 'print'
+ ];
  const GROUP_DIR_NAME = 'Group';
 
  /**
@@ -83,14 +87,30 @@ private function createClassContent($suiteObject)
 
  $mustacheData[self::BEFORE_MUSTACHE_KEY] = $this->buildHookMustacheArray($suiteObject->getBeforeHook());
  $mustacheData[self::AFTER_MUSTACHE_KEY] = $this->buildHookMustacheArray($suiteObject->getAfterHook());
- $mustacheData[self::MUSTACHE_VAR_TAG] = array_merge(
- $mustacheData[self::BEFORE_MUSTACHE_KEY]['createData'] ?? [],
- $mustacheData[self::AFTER_MUSTACHE_KEY]['createData'] ?? []
+ $mustacheData[self::MUSTACHE_VAR_TAG] = $this->extractClassVar(
+ $mustacheData[self::BEFORE_MUSTACHE_KEY],
+ $mustacheData[self::AFTER_MUSTACHE_KEY]
  );
 
  return $this->mustacheEngine->render(self::MUSTACHE_TEMPLATE_NAME, $mustacheData);
  }
 
+ /**
+ * Function which takes the before and after arrays containing the steps for the hook objects and extracts
+ * any variables names needed by the class template.
+ *
+ * @param array $beforeArray
+ * @param array $afterArray
+ * @return array
+ */
+ private function extractClassVar($beforeArray, $afterArray)
+ {
+ $beforeVar = $beforeArray[self::MUSTACHE_VAR_TAG] ?? [];
+ $afterVar = $afterArray[self::MUSTACHE_VAR_TAG] ?? [];
+
+ return array_merge($beforeVar, $afterVar);
+ }
+
  /**
  * Function which takes hook objects and transforms data into array for mustache template engine.
  *
@@ -100,26 +120,112 @@ private function createClassContent($suiteObject)
  private function buildHookMustacheArray($hookObj)
  {
  $mustacheHookArray = [];
+ $actions = [];
+ $hasWebDriverActions = false;
  foreach ($hookObj->getActions() as $action) {
  /** @var ActionObject $action */
+ $index = count($actions);
+ if (!in_array($action->getType(), self::DATA_PERSISTENCE_ACTIONS)) {
+ if (!$hasWebDriverActions) {
+ $hasWebDriverActions = true;
+ }
+
+ $actions = $this->buildWebDriverActionsMustacheArray($action, $actions, $index);
+ continue;
+ }
+
+ // add these as vars to be created a class level in the template
+ if ($action->getType() == 'createData') {
+ $mustacheHookArray[self::MUSTACHE_VAR_TAG][] = [self::ENTITY_MERGE_KEY => $action->getStepKey()];
+ }
+
  $entityArray = [];
  $entityArray[self::ENTITY_MERGE_KEY] = $action->getStepKey();
- $entityArray[self::ENTITY_NAME_TAG] =
- $action->getCustomActionAttributes()['entity'] ??
- $action->getCustomActionAttributes()[TestGenerator::REQUIRED_ENTITY_REFERENCE];
-
- // if there is more than 1 custom attribute, we can assume there are required entities
- if (count($action->getCustomActionAttributes()) > 1) {
- $entityArray[self::REQUIRED_ENTITY_KEY] =
- $this->buildReqEntitiesMustacheArray($action->getCustomActionAttributes());
- }
+ $entityArray[$action->getType()] = $action->getStepKey();
 
- $mustacheHookArray[$action->getType()][] = $entityArray;
+ $entityArray = $this->buildPersistenceMustacheArray($action, $entityArray);
+ $actions[$index] = $entityArray;
+ }
+ $mustacheHookArray['actions'] = $actions;
+ if ($hasWebDriverActions) {
+ array_unshift($mustacheHookArray['actions'], ['webDriverInit' => true]);
+ $mustacheHookArray['actions'][] = ['webDriverReset' => true];
  }
 
  return $mustacheHookArray;
  }
 
+ /**
+ * Takes an action object and array of generated action steps. Converst the action object into generated php and
+ * appends the entry to the given array. The result is returned by the function.
+ *
+ * @param ActionObject $action
+ * @param array $actionEntries
+ * @return array
+ */
+ private function buildWebDriverActionsMustacheArray($action, $actionEntries)
+ {
+ $step = TestGenerator::getInstance()->generateStepsPhp([$action], false, 'webDriver');
+ $rawPhp = str_replace(["\t", "\n"], "", $step);
+ $multipleCommands = explode(";", $rawPhp, -1);
+ foreach ($multipleCommands as $command) {
+ $actionEntries = $this->replaceReservedTesterFunctions($command . ";", $actionEntries, 'webDriver');
+ }
+
+ return $actionEntries;
+ }
+
+ /**
+ * Takes a generated php step, an array containing generated php entries for the template, and the actor name
+ * for the generated step.
+ *
+ * @param string $formattedStep
+ * @param array $actionEntries
+ * @param string $actor
+ * @return array
+ */
+ private function replaceReservedTesterFunctions($formattedStep, $actionEntries, $actor)
+ {
+ foreach (self::REPLACEMENT_ACTIONS as $testAction => $replacement) {
+ $testActionCall = "\${$actor}->{$testAction}";
+ if (substr($formattedStep, 0, strlen($testActionCall)) == $testActionCall) {
+ $resultingStep = str_replace($testActionCall, $replacement, $formattedStep);
+ $actionEntries[] = ['action' => $resultingStep];
+ } else {
+ $actionEntries[] = ['action' => $formattedStep];
+ }
+ }
+
+ return $actionEntries;
+ }
+
+ /**
+ * Takes an action object of persistence type and formats an array entiry for mustache template interpretation.
+ *
+ * @param ActionObject $action
+ * @param array $entityArray
+ * @return array
+ */
+ private function buildPersistenceMustacheArray($action, $entityArray)
+ {
+ $entityArray[self::ENTITY_NAME_TAG] =
+ $action->getCustomActionAttributes()['entity'] ??
+ $action->getCustomActionAttributes()[TestGenerator::REQUIRED_ENTITY_REFERENCE];
+
+ // append entries for any required entities to this entry
+ if (array_key_exists('requiredEntities', $action->getCustomActionAttributes())) {
+ $entityArray[self::REQUIRED_ENTITY_KEY] =
+ $this->buildReqEntitiesMustacheArray($action->getCustomActionAttributes());
+ }
+
+ // append entries for customFields if specified by the user.
+ if (array_key_exists('customFields', $action->getCustomActionAttributes())) {
+ $entityArray['customFields'] = $action->getStepKey() . 'Fields';
+ }
+ 
+ return $entityArray;
+ }
+
  /**
  * Function which takes any required entities under a 'createData' tag and transforms data into array to be consumed
  * by mustache template.

src/Magento/FunctionalTestingFramework/Suite/SuiteGenerator.php

@@ -119,7 +119,8 @@ private function appendEntriesToConfig($suiteName, $suitePath, $groupNamespace)
 
  $ymlArray[self::YAML_GROUPS_TAG][$suiteName] = [$relativeSuitePath];
 
- if ($groupNamespace) {
+ if ($groupNamespace &&
+ !in_array($groupNamespace, $ymlArray[self::YAML_EXTENSIONS_TAG][self::YAML_ENABLED_TAG])) {
  $ymlArray[self::YAML_EXTENSIONS_TAG][self::YAML_ENABLED_TAG][] = $groupNamespace;
  }
 

src/Magento/FunctionalTestingFramework/Suite/Util/SuiteObjectExtractor.php

@@ -6,6 +6,7 @@
 namespace Magento\FunctionalTestingFramework\Suite\Util;
 
 use Exception;
+use Magento\FunctionalTestingFramework\Exceptions\XmlException;
 use Magento\FunctionalTestingFramework\Suite\Objects\SuiteObject;
 use Magento\FunctionalTestingFramework\Test\Handlers\TestObjectHandler;
 use Magento\FunctionalTestingFramework\Test\Objects\TestObject;
@@ -37,6 +38,7 @@ public function __construct()
  *
  * @param array $parsedSuiteData
  * @return array
+ * @throws XmlException
  */
  public function parseSuiteDataIntoObjects($parsedSuiteData)
  {
@@ -78,6 +80,12 @@ public function parseSuiteDataIntoObjects($parsedSuiteData)
  $parsedSuite[TestObjectExtractor::TEST_AFTER_HOOK]
  );
  }
+ if (count($suiteHooks) == 1) {
+ throw new XmlException(sprintf(
+ "Suites that contain hooks must contain both a 'before' and an 'after' hook. Suite: \"%s\"",
+ $parsedSuite[self::NAME]
+ ));
+ }
 
  // create the new suite object
  $suiteObjects[$parsedSuite[self::NAME]] = new SuiteObject(

src/Magento/FunctionalTestingFramework/Suite/etc/suiteSchema.xsd

@@ -48,17 +48,17 @@
  <xs:element type="moduleSuiteOptionType" name="module" minOccurs="0"/>
  </xs:choice>
  </xs:complexType>
- <xs:complexType name="suiteHookType">
- <xs:choice minOccurs="0" maxOccurs="unbounded">
- <xs:group ref="dataOperationTags" maxOccurs="unbounded" minOccurs="0"/>
- </xs:choice>
- </xs:complexType>
+ <!--<xs:complexType name="suiteHookType">-->
+ <!--<xs:choice minOccurs="0" maxOccurs="unbounded">-->
+ <!--<xs:group ref="dataOperationTags" maxOccurs="unbounded" minOccurs="0"/>-->
+ <!--</xs:choice>-->
+ <!--</xs:complexType>-->
  <xs:complexType name="suiteType">
  <xs:choice minOccurs="0" maxOccurs="unbounded">
  <xs:element type="includeType" name="include" maxOccurs="1"/>
  <xs:element type="excludeType" name="exclude" maxOccurs="1"/>
- <xs:element type="suiteHookType" name="before" maxOccurs="1"/>
- <xs:element type="suiteHookType" name="after" maxOccurs="1"/>
+ <xs:element type="hookType" name="before" maxOccurs="1"/>
+ <xs:element type="hookType" name="after" maxOccurs="1"/>
  </xs:choice>
  <xs:attribute type="xs:string" name="name"/>
  </xs:complexType>

src/Magento/FunctionalTestingFramework/Suite/views/SuiteClass.mustache

@@ -19,7 +19,8 @@ class {{suiteName}} extends \Codeception\GroupObject
  public static $group = '{{suiteName}}';
  private static $TEST_COUNT = {{testCount}};
  private static $CURRENT_TEST_RUN = 0;
-
+ private static $HOOK_EXECUTION_INIT = "\n/******** Beginning execution of {{suiteName}} suite %s block ********/\n";
+ private static $HOOK_EXECUTION_END = "\n/******** Execution of {{suiteName}} suite %s block complete ********/\n";
  {{#var}}
  private ${{stepKey}};
  {{/var}}
@@ -31,7 +32,11 @@ class {{suiteName}} extends \Codeception\GroupObject
  self::$CURRENT_TEST_RUN++;
 
  if (self::$CURRENT_TEST_RUN == 1) {
- {{> dataPersistence}}
+ print sprintf(self::$HOOK_EXECUTION_INIT, "before");
+
+ {{> testActions}}
+
+ print sprintf(self::$HOOK_EXECUTION_END, "before");
  }
  }
  {{/before}}
@@ -40,14 +45,11 @@ class {{suiteName}} extends \Codeception\GroupObject
  public function _after(\Codeception\Event\TestEvent $e)
  {
  if (self::$CURRENT_TEST_RUN == self::$TEST_COUNT) {
- {{> dataPersistence}}
- }
- }
+ print sprintf(self::$HOOK_EXECUTION_INIT, "after");
 
- public function _failed(\Codeception\Event\TestEvent $e)
- {
- if (self::$CURRENT_TEST_RUN == self::$TEST_COUNT) {
- {{> dataPersistence}}
+ {{> testActions}}
+
+ print sprintf(self::$HOOK_EXECUTION_END, "after");
  }
  }
  {{/after}}

src/Magento/FunctionalTestingFramework/Suite/views/partials/dataPersistence.mustache

@@ -0,0 +1,33 @@
+{{#actions}}
+{{#webDriverInit}}
+$webDriver = $this->getModule('\Magento\FunctionalTestingFramework\Module\MagentoWebDriver');
+
+// close any open sessions
+if ($webDriver->webDriver != null) {
+ $webDriver->webDriver->close();
+ $webDriver->webDriver = null;
+}
+
+// initialize the webdriver session
+$webDriver->_initializeSession();
+
+// execute user specified actions
+{{/webDriverInit}}
+{{#webDriverReset}}
+// reset configuration and close session
+$this->getModule('\Magento\FunctionalTestingFramework\Module\MagentoWebDriver')->_resetConfig();
+$webDriver->webDriver->close();
+$webDriver->webDriver = null;
+{{/webDriverReset}}
+{{#action}}
+{{{action}}}
+{{/action}}
+{{#createData}}
+${{entityName}} = DataObjectHandler::getInstance()->getObject("{{entityName}}");
+$this->{{stepKey}} = new DataPersistenceHandler(${{entityName}}, [{{#requiredEntities}}$this->{{entityName}}{{^last}}, {{/last}}{{/requiredEntities}}]{{#customFields}}, ${{customFields}}{{/customFields}});
+$this->{{stepKey}}->createEntity();
+{{/createData}}
+{{#deleteData}}
+$this->{{entityName}}->deleteEntity();
+{{/deleteData}}
+{{/actions}}

src/Magento/FunctionalTestingFramework/Suite/views/partials/testActions.mustache

@@ -178,7 +178,7 @@ private function extractFieldReferences($actionData, $actionAttributes)
  return $actionAttributes;
  }
 
- $attributes[self::ACTION_OBJECT_PERSISTENCE_FIELDS][self::NODE_NAME] = 'fields';
+ $attributes = [];
  foreach ($actionAttributes as $attributeName => $attributeValue) {
  if (!is_array($attributeValue) || $attributeValue[self::NODE_NAME] != self::DATA_PERSISTENCE_CUSTOM_FIELD) {
  $attributes[$attributeName] = $attributeValue;
@@ -188,6 +188,10 @@ private function extractFieldReferences($actionData, $actionAttributes)
  $attributes[self::ACTION_OBJECT_PERSISTENCE_FIELDS][] = $attributeName;
  }
 
+ if (array_key_exists(self::ACTION_OBJECT_PERSISTENCE_FIELDS, $attributes)) {
+ $attributes[self::ACTION_OBJECT_PERSISTENCE_FIELDS][self::NODE_NAME] = 'fields';
+ }
+
  return $attributes;
  }
 }