MQE-1427 - Support _CREDS in <magentoCLI> action and in Data (#368)

- added support for _creds in magentoCLI and Data

Author: ivy00johns

dev/tests/unit/Magento/FunctionalTestFramework/Test/Util/ActionMergeUtilTest.php

@@ -8,6 +8,8 @@
 use AspectMock\Test as AspectMock;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use Magento\FunctionalTestingFramework\Exceptions\TestReferenceException;
+use Magento\FunctionalTestingFramework\Exceptions\XmlException;
 use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
 use Magento\FunctionalTestingFramework\Test\Util\ActionMergeUtil;
 use Magento\FunctionalTestingFramework\Test\Util\ActionObjectExtractor;
@@ -100,7 +102,7 @@ public function testResolveActionStepEntityData()
         $dataFieldName = 'myfield';
         $dataFieldValue = 'myValue';
         $userInputKey = "userInput";
-        $userinputValue = "{{" . "${dataObjectName}.${dataFieldName}}}";
+        $userInputValue = "{{" . "${dataObjectName}.${dataFieldName}}}";
         $actionName = "myAction";
         $actionType = "myCustomType";
 
@@ -113,10 +115,10 @@ public function testResolveActionStepEntityData()
         AspectMock::double(DataObjectHandler::class, ['getInstance' => $mockDOHInstance]);
 
         // Create test object and action object
-        $actionAttributes = [$userInputKey => $userinputValue];
+        $actionAttributes = [$userInputKey => $userInputValue];
         $actions[$actionName] = new ActionObject($actionName, $actionType, $actionAttributes);
 
-        $this->assertEquals($userinputValue, $actions[$actionName]->getCustomActionAttributes()[$userInputKey]);
+        $this->assertEquals($userInputValue, $actions[$actionName]->getCustomActionAttributes()[$userInputKey]);
 
         $mergeUtil = new ActionMergeUtil("test", "TestCase");
         $resolvedActions = $mergeUtil->resolveActionSteps($actions);
@@ -127,8 +129,14 @@ public function testResolveActionStepEntityData()
     /**
      * Verify that an XmlException is thrown when an action references a non-existant action.
      *
+     * @throws TestReferenceException
+     * @throws XmlException
      * @return void
      */
+    /**
+     * @throws TestReferenceException
+     * @throws XmlException
+     */
     public function testNoActionException()
     {
         $actionObjects = [];
@@ -151,6 +159,8 @@ public function testNoActionException()
     /**
      * Verify that a <waitForPageLoad> action is added after actions that have a wait (timeout property).
      *
+     * @throws TestReferenceException
+     * @throws XmlException
      * @return void
      */
     public function testInsertWait()
@@ -173,6 +183,111 @@ public function testInsertWait()
         $this->assertEquals($expected, $actual);
     }
 
+    /**
+     * Verify that a <fillField> action is replaced by <fillSecretField> when secret _CREDS are referenced.
+     *
+     * @throws TestReferenceException
+     * @throws XmlException
+     */
+    public function testValidFillFieldSecretFunction()
+    {
+        $actionObjectOne = new ActionObject(
+            'actionKey1',
+            'fillField',
+            ['userInput' => '{{_CREDS.username}}']
+        );
+        $actionObject = [$actionObjectOne];
+
+        $actionMergeUtil = new ActionMergeUtil('actionMergeUtilTest', 'TestCase');
+
+        $result = $actionMergeUtil->resolveActionSteps($actionObject);
+
+        $expectedValue = new ActionObject(
+            'actionKey1',
+            'fillSecretField',
+            ['userInput' => '{{_CREDS.username}}']
+        );
+        $this->assertEquals($expectedValue, $result['actionKey1']);
+    }
+
+    /**
+     * Verify that a <magentoCLI> action uses <magentoCLI> when secret _CREDS are referenced.
+     *
+     * @throws TestReferenceException
+     * @throws XmlException
+     */
+    public function testValidMagentoCLISecretFunction()
+    {
+        $actionObjectOne = new ActionObject(
+            'actionKey1',
+            'magentoCLI',
+            ['command' => 'config:set cms/wysiwyg/enabled {{_CREDS.payment_authorizenet_login}}']
+        );
+        $actionObject = [$actionObjectOne];
+
+        $actionMergeUtil = new ActionMergeUtil('actionMergeUtilTest', 'TestCase');
+
+        $result = $actionMergeUtil->resolveActionSteps($actionObject);
+
+        $expectedValue = new ActionObject(
+            'actionKey1',
+            'magentoCLISecret',
+            ['command' => 'config:set cms/wysiwyg/enabled {{_CREDS.payment_authorizenet_login}}']
+        );
+        $this->assertEquals($expectedValue, $result['actionKey1']);
+    }
+
+    /**
+     * Verify that a <field> override in a <createData> action uses <field> when secret _CREDS are referenced.
+     *
+     * @throws TestReferenceException
+     * @throws XmlException
+     */
+    public function testValidCreateDataSecretFunction()
+    {
+        $actionObjectOne = new ActionObject(
+            'actionKey1',
+            'field',
+            ['value' => '{{_CREDS.payment_authorizenet_login}}']
+        );
+        $actionObject = [$actionObjectOne];
+
+        $actionMergeUtil = new ActionMergeUtil('actionMergeUtilTest', 'TestCase');
+
+        $result = $actionMergeUtil->resolveActionSteps($actionObject);
+
+        $expectedValue = new ActionObject(
+            'actionKey1',
+            'field',
+            ['value' => '{{_CREDS.payment_authorizenet_login}}']
+        );
+        $this->assertEquals($expectedValue, $result['actionKey1']);
+    }
+
+    /**
+     * Verify that a <click> action throws an exception when secret _CREDS are referenced.
+     *
+     * @throws TestReferenceException
+     * @throws XmlException
+     */
+    public function testInvalidSecretFunctions()
+    {
+        $this->expectException(TestReferenceException::class);
+        $this->expectExceptionMessage(
+            'You cannot reference secret data outside of the fillField, magentoCLI and createData actions'
+        );
+
+        $actionObjectOne = new ActionObject(
+            'actionKey1',
+            'click',
+            ['userInput' => '{{_CREDS.username}}']
+        );
+        $actionObject = [$actionObjectOne];
+
+        $actionMergeUtil = new ActionMergeUtil('actionMergeUtilTest', 'TestCase');
+        $actionMergeUtil->resolveActionSteps($actionObject);
+    }
+
     /**
      * After class functionality
      * @return void

dev/tests/verification/Resources/ActionGroupUsingCreateData.txt

@@ -31,7 +31,7 @@ class ActionGroupUsingCreateDataCest
 			"hook",
 			"ApiCategory",
 			[],
-			null
+			[]
 		);
 
 		$I->comment("[createConfigProductKey1] create 'ApiConfigurableProduct' entity");
@@ -40,7 +40,7 @@ class ActionGroupUsingCreateDataCest
 			"hook",
 			"ApiConfigurableProduct",
 			["createCategoryKey1"],
-			null
+			[]
 		);
 
 		$I->comment("Exiting Action Group [Key1] actionGroupWithCreateData");

dev/tests/verification/Resources/ActionGroupWithDataOverrideTest.txt

@@ -31,7 +31,7 @@ class ActionGroupWithDataOverrideTestCest
 			"hook",
 			"ReplacementPerson",
 			[],
-			null
+			[]
 		);
 
 		$I->comment("Entering Action Group [beforeGroup] FunctionalActionGroup");

dev/tests/verification/Resources/ActionGroupWithDataTest.txt

@@ -31,7 +31,7 @@ class ActionGroupWithDataTestCest
 			"hook",
 			"ReplacementPerson",
 			[],
-			null
+			[]
 		);
 
 		$I->comment("Entering Action Group [beforeGroup] FunctionalActionGroup");

dev/tests/verification/Resources/ActionGroupWithNoDefaultTest.txt

@@ -31,7 +31,7 @@ class ActionGroupWithNoDefaultTestCest
 			"hook",
 			"ReplacementPerson",
 			[],
-			null
+			[]
 		);
 
 		$I->comment("Entering Action Group [beforeGroup] FunctionalActionGroup");

dev/tests/verification/Resources/ActionGroupWithPersistedData.txt

@@ -31,7 +31,7 @@ class ActionGroupWithPersistedDataCest
 			"hook",
 			"ReplacementPerson",
 			[],
-			null
+			[]
 		);
 
 		$I->comment("Entering Action Group [beforeGroup] FunctionalActionGroup");
@@ -78,7 +78,7 @@ class ActionGroupWithPersistedDataCest
 			"test",
 			"DefaultPerson",
 			[],
-			null
+			[]
 		);
 
 		$I->comment("Entering Action Group [actionGroupWithPersistedData1] FunctionalActionGroupWithData");

dev/tests/verification/Resources/ActionGroupWithStepKeyReferences.txt

@@ -34,7 +34,7 @@ class ActionGroupWithStepKeyReferencesCest
 			"test",
 			"simpleData",
 			[],
-			null
+			[]
 		);
 
 		$grabTextDataActionGroup = $I->grabTextFrom(".class"); // stepKey: grabTextDataActionGroup
@@ -46,7 +46,6 @@ class ActionGroupWithStepKeyReferencesCest
 		$action3ActionGroup = $I->executeJS($action3ActionGroup); // stepKey: action3ActionGroup
 		$action4ActionGroup = $I->magentoCLI($action4ActionGroup, "\"stuffHere\""); // stepKey: action4ActionGroup
 		$I->comment($action4ActionGroup);
-
 		$date = new \DateTime();
 		$date->setTimestamp(strtotime("{$action5}"));
 		$date->setTimezone(new \DateTimeZone("America/Los_Angeles"));
@@ -82,7 +81,7 @@ class ActionGroupWithStepKeyReferencesCest
 			"test",
 			"{$action10}",
 			[],
-			null
+			[]
 		);
 
 		$action11ActionGroup = $I->grabAttributeFrom($action11ActionGroup, "someInput"); // stepKey: action11ActionGroup

dev/tests/verification/Resources/ActionGroupWithTopLevelPersistedData.txt

@@ -31,7 +31,7 @@ class ActionGroupWithTopLevelPersistedDataCest
 			"hook",
 			"ReplacementPerson",
 			[],
-			null
+			[]
 		);
 
 		$I->comment("Entering Action Group [beforeGroup] FunctionalActionGroup");

dev/tests/verification/Resources/ArgumentWithSameNameAsElement.txt

@@ -31,7 +31,7 @@ class ArgumentWithSameNameAsElementCest
 			"hook",
 			"ReplacementPerson",
 			[],
-			null
+			[]
 		);
 
 		$I->comment("Entering Action Group [beforeGroup] FunctionalActionGroup");

dev/tests/verification/Resources/AssertTest.txt

@@ -30,7 +30,7 @@ class AssertTestCest
 			"hook",
 			"ReplacementPerson",
 			[],
-			null
+			[]
 		);
 
 	}
@@ -50,7 +50,7 @@ class AssertTestCest
 			"test",
 			"UniquePerson",
 			[],
-			null
+			[]
 		);
 
 		$grabTextFrom1 = $I->grabTextFrom(".copyright>span"); // stepKey: grabTextFrom1