MQE-1427 - Support _CREDS in <magentoCLI> action and in Data

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -620,7 +620,7 @@ public function dragAndDrop($source, $target, $xOffset = null, $yOffset = null)
     }
 
     /**
-     * Function used to fill sensitive crednetials with user data, data is decrypted immediately prior to fill to avoid
+     * Function used to fill sensitive credentials with user data, data is decrypted immediately prior to fill to avoid
      * exposure in console or log.
      *
      * @param string $field
@@ -636,6 +636,23 @@ public function fillSecretField($field, $value)
         $this->fillField($field, $decryptedValue);
     }
 
+    /**
+     * Function used to create data that contains sensitive credentials in a <createData> <field> override.
+     * The data is decrypted immediately prior to data creation to avoid exposure in console or log.
+     *
+     * @param string $command
+     * @throws TestFrameworkException
+     * @return void
+     */
+    public function magentoCliSecret($command)
+    {
+        // to protect any secrets from being printed to console the values are executed only at the webdriver level as a
+        // decrypted value
+
+        $decryptedCommand = CredentialStore::getInstance()->decryptSecretValue($command);
+        $this->magentoCLI($decryptedCommand);
+    }
+
     /**
      * Override for _failed method in Codeception method. Adds png and html attachments to allure report
      * following parent execution of test failure processing.

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

@@ -95,7 +95,7 @@ public function resolveActionSteps($parsedSteps, $skipActionGroupResolution = fa
 
     /**
      * Takes an array of actions and resolves any references to secret fields. The function then validates whether the
-     * refernece is valid and replaces the function name accordingly to hide arguments at runtime.
+     * reference is valid and replaces the function name accordingly to hide arguments at runtime.
      *
      * @param ActionObject[] $resolvedActions
      * @return ActionObject[]
@@ -106,22 +106,28 @@ private function resolveSecretFieldAccess($resolvedActions)
         $actions = [];
         foreach ($resolvedActions as $resolvedAction) {
             $action = $resolvedAction;
-            $hasSecretRef = $this->actionAttributeContainsSecretRef($resolvedAction->getCustomActionAttributes());
-
-            if ($resolvedAction->getType() !== 'fillField' && $hasSecretRef) {
-                throw new TestReferenceException("You cannot reference secret data outside of fill field actions");
+            $actionHasSecretRef = $this->actionAttributeContainsSecretRef($resolvedAction->getCustomActionAttributes());
+            $approvedActions = ['fillField', 'magentoCLI', 'field'];
+            $secretMapping = ['fillField' => 'fillSecretField'];
+            $actionType = $resolvedAction->getType();
+
+            if ($actionHasSecretRef && !(in_array($actionType, $approvedActions))) {
+                throw new TestReferenceException("You cannot reference secret data outside " .
+                    "of the fillField, magentoCli and createData actions");
             }
 
-            if ($resolvedAction->getType() === 'fillField' && $hasSecretRef) {
-                $action = new ActionObject(
-                    $action->getStepKey(),
-                    'fillSecretField',
-                    $action->getCustomActionAttributes(),
-                    $action->getLinkedAction(),
-                    $action->getActionOrigin()
-                );
+            if (isset($secretMapping[$actionType])) {
+                $actionType = $secretMapping[$actionType];
             }
 
+            $action = new ActionObject(
+                $action->getStepKey(),
+                $actionType,
+                $action->getCustomActionAttributes(),
+                $action->getLinkedAction(),
+                $action->getActionOrigin()
+            );
+
             $actions[$action->getStepKey()] = $action;
         }
 
@@ -151,6 +157,29 @@ private function actionAttributeContainsSecretRef($actionAttributes)
         return false;
     }
 
+    /**
+     * Returns a boolean based on whether or not the createData field contains a reference to a secret field.
+     *
+     * @param array $dataFields
+     * @return boolean
+     */
+    private function dataFieldContainsSecretRef($dataFields)
+    {
+        foreach ($dataFields as $dataField) {
+            if (is_array($dataField)) {
+                return $this->dataFieldContainsSecretRef($dataField);
+            }
+
+            preg_match_all("/{{_CREDS\.([\w]+)}}/", $dataField, $matches);
+
+            if (!empty($matches[0])) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     /**
      * Method to resolve action group references and insert relevant actions into step flow
      *
@@ -261,7 +290,7 @@ private function insertReadinessSkips()
      *
      * @param array $parsedSteps
      * @return void
-     * @throws XmlException
+     * @throws TestReferenceException
      */
     private function sortActions($parsedSteps)
     {

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -1267,7 +1267,11 @@ public function generateStepsPhp($actionObjects, $generationScope = TestGenerato
                         $actionObject->getActionOrigin()
                     )[0];
                     $argRef = "\t\t\$";
-                    $argRef .= str_replace(ucfirst($fieldKey), "", $stepKey) . "Fields['{$fieldKey}'] = ${input};\n";
+
+                    $input = $this->resolveAllRuntimeReferences([$input])[0];
+                    $argRef .= str_replace(ucfirst($fieldKey), "", $stepKey) .
+                        "Fields['{$fieldKey}'] = ${input};\n";
+
                     $testSteps .= $argRef;
                     break;
                 case "generateDate":