Merge pull request #241 from magento-gl/3.11.1-RC

ACQE-3401 : 3.11.1 RC

Author: jilu1

.gitignore

@@ -22,4 +22,4 @@ dev/tests/functional.suite.yml
 /v2/
 dev/.credentials.example
 dev/tests/.phpunit.result.cache
-dev/tests/verification/TestModule/Test/testFile.xml
+dev/tests/verification/TestModule/Test/testFile.xml

CHANGELOG.md

@@ -1,6 +1,14 @@
 Magento Functional Testing Framework Changelog
 ================================================
 
+3.11.1
+---------
+
+### Fixes
+
+* Removed environment variable MAGENTO_ADMIN_PASSWORD
+* Fixed WaitForElementClickable action cannot be used more than once
+
 3.11.0
 ---------
 ### Enhancements

composer.json

@@ -2,7 +2,7 @@
     "name": "magento/magento2-functional-testing-framework",
     "description": "Magento2 Functional Testing Framework",
     "type": "library",
-    "version": "3.11.0",
+    "version": "3.11.1",
     "license": "AGPL-3.0",
     "keywords": ["magento", "automation", "functional", "testing"],
     "config": {

composer.lock

@@ -52,16 +52,6 @@ Example:
 MAGENTO_ADMIN_USERNAME=admin
 ```
 
-### MAGENTO_ADMIN_PASSWORD
-
-The password that tests will use to log in to the Magento Admin page.
-
-Example:
-
-```conf
-MAGENTO_ADMIN_PASSWORD=1234reTyt%$7
-```
-
 ## Advanced configuration
 
 Depending on the environment you use, you may need to configure MFTF more precisely by setting additional configuration parameters.
@@ -362,7 +352,7 @@ WAIT_TIMEOUT=30
 ### ENABLE_PAUSE
 
 Enables the ability to pause test execution at any point, and enter an interactive shell where you can try commands in action.
-When pause is enabled, MFTF will generate pause() command in _failed() hook so that test will pause execution when failed. 
+When pause is enabled, MFTF will generate pause() command in _failed() hook so that test will pause execution when failed.
 
 ```conf
 ENABLE_PAUSE=true

docs/configuration.md

@@ -10,7 +10,6 @@ MAGENTO_BASE_URL=http://devdocs.magento.com/
 #*** Set the Admin Username and Password for your Magento instance ***#
 MAGENTO_BACKEND_NAME=admin
 MAGENTO_ADMIN_USERNAME=admin
-MAGENTO_ADMIN_PASSWORD=123123q
 
 #*** Path to CLI entry point and command parameter name. Uncomment and change if folder structure differs from standard Magento installation
 #MAGENTO_CLI_COMMAND_PATH=dev/tests/acceptance/utils/command.php

etc/config/.env.example

@@ -8,7 +8,7 @@
 
 <!-- Entity value gets replaced in Dom.php before reading $xml -->
 <!DOCTYPE config [
-        <!ENTITY commonTestActions "acceptPopup|actionGroup|amOnPage|amOnUrl|amOnSubdomain|appendField|assertArrayIsSortasserted|assertElementContainsAttribute|attachFile|cancelPopup|checkOption|clearField|click|clickWithLeftButton|clickWithRightButton|closeAdminNotification|closeTab|comment|conditionalClick|createData|deleteData|updateData|getData|dontSee|dontSeeJsError|dontSeeCheckboxIsChecked|dontSeeCookie|dontSeeCurrentUrlEquals|dontSeeCurrentUrlMatches|dontSeeElement|dontSeeElementInDOM|dontSeeInCurrentUrl|dontSeeInField|dontSeeInFormFields|dontSeeInPageSource|dontSeeInSource|dontSeeInTitle|dontSeeLink|dontSeeOptionIsSelected|doubleClick|dragAndDrop|entity|executeJS|fillField|formatCurrency|generateDate|getOTP|grabAttributeFrom|grabCookie|grabCookieAttributes|grabFromCurrentUrl|grabMultiple|grabPageSource|grabTextFrom|grabValueFrom|return|loadSessionSnapshot|loginAsAdmin|magentoCLI|magentoCron|makeScreenshot|maximizeWindow|moveBack|moveForward|moveMouseOver|mSetLocale|mResetLocale|openNewTab|pause|parseFloat|pressKey|reloadPage|resetCookie|submitForm|resizeWindow|saveSessionSnapshot|scrollTo|scrollToTopOfPage|searchAndMultiSelectOption|see|seeCheckboxIsChecked|seeCookie|seeCurrentUrlEquals|seeCurrentUrlMatches|seeElement|seeElementInDOM|seeInCurrentUrl|seeInField|seeInFormFields|seeInPageSource|seeInPopup|seeInSource|seeInTitle|seeLink|seeNumberOfElements|seeOptionIsSelected|selectOption|setCookie|submitForm|switchToIFrame|switchToNextTab|switchToPreviousTab|switchToWindow|typeInPopup|uncheckOption|unselectOption|wait|waitForAjaxLoad|waitForElement|waitForElementChange|waitForElementNotVisible|waitForElementVisible|waitForPwaElementNotVisible|waitForPwaElementVisible|waitForJS|waitForLoadingMaskToDisappear|waitForPageLoad|waitForText|assertArrayHasKey|assertArrayNotHasKey|assertContains|assertStringContainsString|assertStringContainsStringIgnoringCase|assertCount|assertEmpty|assertEquals|assertFalse|assertFileExists|assertFileNotExists|assertGreaterOrEquals|assertGreaterThan|assertGreaterThanOrEqual|assertInstanceOf|assertIsEmpty|assertLessOrEquals|assertLessThan|assertLessThanOrEqual|assertNotContains|assertStringNotContainsString|assertStringNotContainsStringIgnoringCase|assertNotEmpty|assertNotEquals|assertNotInstanceOf|assertNotNull|assertNotRegExp|assertNotSame|assertNull|assertRegExp|assertSame|assertStringStartsNotWith|assertStringStartsWith|assertTrue|expectException|fail|dontSeeFullUrlEquals|dontSee|dontSeeFullUrlMatches|dontSeeInFullUrl|seeFullUrlEquals|seeFullUrlMatches|seeInFullUrl|grabFromFullUrl|helper|assertEqualsWithDelta|assertEqualsCanonicalizing|assertEqualsIgnoringCase|assertNotEqualsWithDelta|assertNotEqualsCanonicalizing|assertNotEqualsIgnoringCase">
+        <!ENTITY commonTestActions "acceptPopup|actionGroup|amOnPage|amOnUrl|amOnSubdomain|appendField|assertArrayIsSortasserted|assertElementContainsAttribute|attachFile|cancelPopup|checkOption|clearField|click|clickWithLeftButton|clickWithRightButton|closeAdminNotification|closeTab|comment|conditionalClick|createData|deleteData|updateData|getData|dontSee|dontSeeJsError|dontSeeCheckboxIsChecked|dontSeeCookie|dontSeeCurrentUrlEquals|dontSeeCurrentUrlMatches|dontSeeElement|dontSeeElementInDOM|dontSeeInCurrentUrl|dontSeeInField|dontSeeInFormFields|dontSeeInPageSource|dontSeeInSource|dontSeeInTitle|dontSeeLink|dontSeeOptionIsSelected|doubleClick|dragAndDrop|entity|executeJS|fillField|formatCurrency|generateDate|getOTP|grabAttributeFrom|grabCookie|grabCookieAttributes|grabFromCurrentUrl|grabMultiple|grabPageSource|grabTextFrom|grabValueFrom|return|loadSessionSnapshot|loginAsAdmin|magentoCLI|magentoCron|makeScreenshot|maximizeWindow|moveBack|moveForward|moveMouseOver|mSetLocale|mResetLocale|openNewTab|pause|parseFloat|pressKey|reloadPage|resetCookie|submitForm|resizeWindow|saveSessionSnapshot|scrollTo|scrollToTopOfPage|searchAndMultiSelectOption|see|seeCheckboxIsChecked|seeCookie|seeCurrentUrlEquals|seeCurrentUrlMatches|seeElement|seeElementInDOM|seeInCurrentUrl|seeInField|seeInFormFields|seeInPageSource|seeInPopup|seeInSource|seeInTitle|seeLink|seeNumberOfElements|seeOptionIsSelected|selectOption|setCookie|submitForm|switchToIFrame|switchToNextTab|switchToPreviousTab|switchToWindow|typeInPopup|uncheckOption|unselectOption|wait|waitForAjaxLoad|waitForElement|waitForElementChange|waitForElementNotVisible|waitForElementVisible|waitForPwaElementNotVisible|waitForPwaElementVisible|waitForElementClickable|waitForJS|waitForLoadingMaskToDisappear|waitForPageLoad|waitForText|assertArrayHasKey|assertArrayNotHasKey|assertContains|assertStringContainsString|assertStringContainsStringIgnoringCase|assertCount|assertEmpty|assertEquals|assertFalse|assertFileExists|assertFileNotExists|assertGreaterOrEquals|assertGreaterThan|assertGreaterThanOrEqual|assertInstanceOf|assertIsEmpty|assertLessOrEquals|assertLessThan|assertLessThanOrEqual|assertNotContains|assertStringNotContainsString|assertStringNotContainsStringIgnoringCase|assertNotEmpty|assertNotEquals|assertNotInstanceOf|assertNotNull|assertNotRegExp|assertNotSame|assertNull|assertRegExp|assertSame|assertStringStartsNotWith|assertStringStartsWith|assertTrue|expectException|fail|dontSeeFullUrlEquals|dontSee|dontSeeFullUrlMatches|dontSeeInFullUrl|seeFullUrlEquals|seeFullUrlMatches|seeInFullUrl|grabFromFullUrl|helper|assertEqualsWithDelta|assertEqualsCanonicalizing|assertEqualsIgnoringCase|assertNotEqualsWithDelta|assertNotEqualsCanonicalizing|assertNotEqualsIgnoringCase">
 ]>
 
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../src/Magento/FunctionalTestingFramework/ObjectManager/etc/config.xsd">

etc/di.xml

@@ -6,6 +6,7 @@
 
 namespace Magento\FunctionalTestingFramework\DataTransport;
 
+use Magento\FunctionalTestingFramework\DataGenerator\Handlers\CredentialStore;
 use Magento\FunctionalTestingFramework\Util\MftfGlobals;
 use Magento\FunctionalTestingFramework\DataTransport\Protocol\CurlInterface;
 use Magento\FunctionalTestingFramework\DataTransport\Protocol\CurlTransport;
@@ -73,9 +74,11 @@ private function authorize()
 
         // Authenticate admin user
         $authUrl = MftfGlobals::getBackendBaseUrl() . 'admin/auth/login/';
+        $encryptedSecret = CredentialStore::getInstance()->getSecret('magento/MAGENTO_ADMIN_PASSWORD');
+        $secret = CredentialStore::getInstance()->decryptSecretValue($encryptedSecret);
         $data = [
             'login[username]' => getenv('MAGENTO_ADMIN_USERNAME'),
-            'login[password]' => getenv('MAGENTO_ADMIN_PASSWORD'),
+            'login[password]' => $secret,
             'form_key' => $this->formKey,
         ];
         $this->transport->write($authUrl, $data, CurlInterface::POST);

src/Magento/FunctionalTestingFramework/DataTransport/AdminFormExecutor.php

@@ -6,6 +6,7 @@
 
 namespace Magento\FunctionalTestingFramework\DataTransport\Auth;
 
+use Magento\FunctionalTestingFramework\DataGenerator\Handlers\CredentialStore;
 use Magento\FunctionalTestingFramework\Exceptions\FastFailException;
 use Magento\FunctionalTestingFramework\Util\MftfGlobals;
 use Magento\FunctionalTestingFramework\DataTransport\Protocol\CurlInterface;
@@ -53,18 +54,26 @@ class WebApiAuth
      * @throws FastFailException
      *
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @SuppressWarnings(PHPMD.NPathComplexity)
      */
     public static function getAdminToken($username = null, $password = null)
     {
         $login = $username ?? getenv('MAGENTO_ADMIN_USERNAME');
-        $password = $password ?? getenv('MAGENTO_ADMIN_PASSWORD');
+        try {
+            $encryptedSecret = CredentialStore::getInstance()->getSecret('magento/MAGENTO_ADMIN_PASSWORD');
+            $secret = CredentialStore::getInstance()->decryptSecretValue($encryptedSecret);
+            $password = $password ?? $secret;
+        } catch (TestFrameworkException $e) {
+            $message = "Password not found in credentials file";
+            throw new FastFailException($message . $e->getMessage(), $e->getContext());
+        }
         if (!$login || !$password) {
             $message = 'Cannot retrieve API token without credentials. Please fill out .env.';
             $context = [
                     'MAGENTO_BASE_URL' => getenv('MAGENTO_BASE_URL'),
                     'MAGENTO_BACKEND_BASE_URL' => getenv('MAGENTO_BACKEND_BASE_URL'),
                     'MAGENTO_ADMIN_USERNAME' => getenv('MAGENTO_ADMIN_USERNAME'),
-                    'MAGENTO_ADMIN_PASSWORD' => getenv('MAGENTO_ADMIN_PASSWORD'),
+                    'MAGENTO_ADMIN_PASSWORD' => $secret,
                 ];
             throw new FastFailException($message, $context);
         }

src/Magento/FunctionalTestingFramework/DataTransport/Auth/WebApiAuth.php

@@ -7,6 +7,7 @@
 namespace Magento\FunctionalTestingFramework\Util;
 
 use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
+use Magento\FunctionalTestingFramework\DataGenerator\Handlers\CredentialStore;
 use Magento\FunctionalTestingFramework\Exceptions\FastFailException;
 use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
 use Magento\FunctionalTestingFramework\Util\ModuleResolver\ModuleResolverService;
@@ -198,10 +199,12 @@ public function getEnabledModules()
 
         if (!$response) {
             $message = "Could not retrieve Modules from Magento Instance.";
+            $encryptedSecret = CredentialStore::getInstance()->getSecret('magento/MAGENTO_ADMIN_PASSWORD');
+            $secret = CredentialStore::getInstance()->decryptSecretValue($encryptedSecret);
             $context = [
                 "Admin Module List Url" => $url,
                 "MAGENTO_ADMIN_USERNAME" => getenv("MAGENTO_ADMIN_USERNAME"),
-                "MAGENTO_ADMIN_PASSWORD" => getenv("MAGENTO_ADMIN_PASSWORD"),
+                "MAGENTO_ADMIN_PASSWORD" => $secret,
             ];
             throw new FastFailException($message, $context);
         }