Merge pull request #444 from magento-commerce/MFTF_5.0.3_RC

MFTF_5.0.3_RC: MFTF 5.0.3 Release Check List

Author: KevinBKozan

CHANGELOG.md

@@ -4,6 +4,7 @@ Magento Functional Testing Framework Changelog
 5.0.3
 ---------
 ### Fixes
+* Allowed additional actions to read from credentials file to fix page builder failures.
 * Added support for chrome 131
 
 5.0.2
@@ -68,16 +69,16 @@ Magento Functional Testing Framework Changelog
 4.7.2
 ---------
 ### Enhancements
-* Fail static test when introduced filename does not equal the MFTF object name 
+* Fail static test when introduced filename does not equal the MFTF object name
   contained within.
 
 4.7.1
 ---------
 ### Enhancements
 *  Bumped all symfony dependencies to `^6.0
-*  Removed abandoned package codacy/coverage 
+*  Removed abandoned package codacy/coverage
 *  Removed abandoned package sebastian/phpcpd
-*  Bumped monolog/monolog to ^3.0 
+*  Bumped monolog/monolog to ^3.0
 *  Bumped nikic/php-parser to ^5.0
 
 4.7.0

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

@@ -284,7 +284,7 @@ public function testInvalidSecretFunctions(): void
     {
         $this->expectException(TestReferenceException::class);
         $this->expectExceptionMessage(
-            'You cannot reference secret data outside of the fillField, magentoCLI and createData actions'
+            'You cannot reference secret data outside of the fillField, magentoCLI, seeInField and createData actions'
         );
 
         $actionObjectOne = new ActionObject(
@@ -307,4 +307,31 @@ public static function tearDownAfterClass(): void
     {
         TestLoggingUtil::getInstance()->clearMockLoggingUtil();
     }
+
+    /**
+     * Verify that a <seeInField> action is replaced by <seeInSecretField> when secret _CREDS are referenced.
+     *
+     * @return void
+     * @throws TestReferenceException
+     * @throws XmlException
+     */
+    public function testValidSeeInSecretFieldFunction(): void
+    {
+        $actionObjectOne = new ActionObject(
+            'actionKey1',
+            'seeInField',
+            ['userInput' => '{{_CREDS.username}}', 'requiredCredentials' => 'username']
+        );
+        $actionObject = [$actionObjectOne];
+
+        $actionMergeUtil = new ActionMergeUtil('actionMergeUtilTest', 'TestCase');
+        $result = $actionMergeUtil->resolveActionSteps($actionObject);
+
+        $expectedValue = new ActionObject(
+            'actionKey1',
+            'seeInSecretField',
+            ['userInput' => '{{_CREDS.username}}','requiredCredentials' => 'username']
+        );
+        $this->assertEquals($expectedValue, $result['actionKey1']);
+    }
 }

dev/tests/verification/Resources/BasicFunctionalTest.txt

@@ -170,6 +170,7 @@ class BasicFunctionalTestCest
 		$I->seeElementInDOM(".functionalTestSelector"); // stepKey: seeElementInDOMKey1
 		$I->seeInCurrentUrl("/functionalUrl"); // stepKey: seeInCurrentUrlKey1
 		$I->seeInField(".functionalTestSelector", "someInput"); // stepKey: seeInFieldKey1
+		$I->seeInSecretField(".functionalTestSelector", $I->getSecret("someKey")); // stepKey: seeInFieldKey2
 		$I->seeInPageSource("Home Page"); // stepKey: seeInPageSourceKey1
 		$I->seeInPageSource("<h1 class=\"page-title\">"); // stepKey: seeInPageSourceKey2
 		$I->seeInPopup("someInput"); // stepKey: seeInPopupKey1

dev/tests/verification/TestModule/Test/BasicFunctionalTest/BasicFunctionalTest.xml

@@ -108,6 +108,7 @@
         <seeElementInDOM selector=".functionalTestSelector" stepKey="seeElementInDOMKey1"/>
         <seeInCurrentUrl url="/functionalUrl" stepKey="seeInCurrentUrlKey1"/>
         <seeInField selector=".functionalTestSelector" userInput="someInput" stepKey="seeInFieldKey1" />
+        <seeInField selector=".functionalTestSelector" userInput="{{_CREDS.someKey}}" stepKey="seeInFieldKey2" />
         <seeInPageSource html="Home Page" stepKey="seeInPageSourceKey1"/>
         <seeInPageSource html="&#60;h1 class&#61;&#34;page-title&#34;&#62;" stepKey="seeInPageSourceKey2"/>
         <seeInPopup userInput="someInput" stepKey="seeInPopupKey1"/>

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -864,6 +864,27 @@ public function magentoCLISecret($command, $timeout = null, $arguments = null)
         return $this->magentoCLI($decryptedCommand, $timeout, $arguments);
     }
 
+    /**
+     * Function used to verify sensitive credentials in the data, data is decrypted immediately prior to see to avoid
+     * exposure in console or log.
+     *
+     * @param string $field
+     * @param string $value
+     * @return void
+     * @throws TestFrameworkException
+     */
+    public function seeInSecretField(string $field, string $value):void
+    {
+        // to protect any secrets from being printed to console the values are executed only at the webdriver level as a
+        // decrypted value
+
+        $decryptedValue = CredentialStore::getInstance()->decryptSecretValue($value);
+        if ($decryptedValue === false) {
+            throw new TestFrameworkException("\nFailed to decrypt value {$value} for field {$field}\n");
+        }
+        $this->seeInField($field, $decryptedValue);
+    }
+
     /**
      * 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

@@ -26,8 +26,9 @@ class ActionMergeUtil
     const DEFAULT_SKIP_ON_ORDER = 'before';
     const DEFAULT_SKIP_OFF_ORDER = 'after';
     const DEFAULT_WAIT_ORDER = 'after';
-    const APPROVED_ACTIONS = ['fillField', 'magentoCLI', 'field'];
-    const SECRET_MAPPING = ['fillField' => 'fillSecretField', 'magentoCLI' => 'magentoCLISecret'];
+    const APPROVED_ACTIONS = ['fillField', 'magentoCLI', 'field', 'seeInField'];
+    const SECRET_MAPPING = ['fillField' => 'fillSecretField', 'magentoCLI' => 'magentoCLISecret',
+         'seeInField' => 'seeInSecretField'];
     const CREDS_REGEX = "/{{_CREDS\.([\w|\/]+)}}/";
 
     /**
@@ -110,7 +111,7 @@ private function resolveSecretFieldAccess($resolvedActions)
 
             if ($actionHasSecretRef && !(in_array($actionType, self::APPROVED_ACTIONS))) {
                 throw new TestReferenceException("You cannot reference secret data outside " .
-                    "of the fillField, magentoCLI and createData actions");
+                    "of the fillField, magentoCLI, seeInField and createData actions");
             }
 
             // Do NOT remap actions that don't need it.

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -1413,6 +1413,7 @@ public function generateStepsPhp($actionObjects, $generationScope = TestGenerato
                 case "loadSessionSnapshot":
                 case "seeInField":
                 case "seeOptionIsSelected":
+                case "seeInSecretField":
                     $testSteps .= $this->wrapFunctionCall($actor, $actionObject, $selector, $input);
                     break;
                 case "seeInPageSource":