Merge pull request #192 from magento-gl/MQE-2953

MQE 2953 | Grab Cookies Attributes in MFTF.

Author: KevinBKozan

dev/tests/verification/Resources/ActionGroupWithStepKeyReferences.txt

@@ -67,6 +67,7 @@ class ActionGroupWithStepKeyReferencesCest
 		$action14ActionGroup = $I->grabMultiple($action14ActionGroup); // stepKey: action14ActionGroup
 		$action15ActionGroup = $I->grabTextFrom($action15ActionGroup); // stepKey: action15ActionGroup
 		$action16ActionGroup = $I->grabValueFrom($action16ActionGroup); // stepKey: action16ActionGroup
+		$action17ActionGroup = $I->grabCookieAttributes($action17ActionGroup, ['domain' => 'www.google.com']); // stepKey: action17ActionGroup
 		$I->comment("Exiting Action Group [actionGroup] FunctionActionGroupWithStepKeyReferences");
 	}
 

dev/tests/verification/Resources/BasicFunctionalTest.txt

@@ -127,6 +127,7 @@ class BasicFunctionalTestCest
 		$getOtpWithInput = $I->getOTP("someInput"); // stepKey: getOtpWithInput
 		$grabAttributeFromKey1 = $I->grabAttributeFrom(".functionalTestSelector", "someInput"); // stepKey: grabAttributeFromKey1
 		$grabCookieKey1 = $I->grabCookie("grabCookieInput", ['domain' => 'www.google.com']); // stepKey: grabCookieKey1
+		$grabCookieAttributesKey1 = $I->grabCookieAttributes("grabCookieAttributesInput", ['domain' => 'www.google.com']); // stepKey: grabCookieAttributesKey1
 		$grabFromCurrentUrlKey1 = $I->grabFromCurrentUrl("/grabCurrentUrl"); // stepKey: grabFromCurrentUrlKey1
 		$grabMultipleKey1 = $I->grabMultiple(".functionalTestSelector"); // stepKey: grabMultipleKey1
 		$grabTextFromKey1 = $I->grabTextFrom(".functionalTestSelector"); // stepKey: grabTextFromKey1

dev/tests/verification/TestModule/ActionGroup/FunctionalActionGroup/FunctionActionGroupWithStepKeyReferencesActionGroup.xml

@@ -28,5 +28,6 @@
         <grabMultiple selector="{$action14}" stepKey="action14"/>
         <grabTextFrom selector="{$action15}" stepKey="action15"/>
         <grabValueFrom selector="{$action16}" stepKey="action16"/>
+        <grabCookieAttributes userInput="{$action17}" parameterArray="['domain' => 'www.google.com']" stepKey="action17"/>
     </actionGroup>
 </actionGroups>

dev/tests/verification/TestModule/ActionGroup/XmlDuplicateActionGroup.xml

@@ -90,6 +90,8 @@
         <grabAttributeFrom selector="1" stepKey="grabattribute12"/>
         <grabCookie stepKey="grabcookie1"/>
         <grabCookie stepKey="grabcookie12"/>
+        <grabCookieAttributes stepKey="grabcookieattributes1"/>
+        <grabCookieAttributes stepKey="grabcookieattributes12"/>
         <grabFromCurrentUrl stepKey="grabfromcurl1"/>
         <grabFromCurrentUrl stepKey="grabfromcurl12"/>
         <grabMultiple selector="1" stepKey="grabmulti1"/>

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

@@ -72,6 +72,7 @@
         <getOTP stepKey="getOtpWithInput" userInput="someInput"/>
         <grabAttributeFrom selector=".functionalTestSelector" userInput="someInput" stepKey="grabAttributeFromKey1" />
         <grabCookie userInput="grabCookieInput" parameterArray="['domain' => 'www.google.com']" stepKey="grabCookieKey1" />
+        <grabCookieAttributes userInput="grabCookieAttributesInput" parameterArray="['domain' => 'www.google.com']" stepKey="grabCookieAttributesKey1" />
         <grabFromCurrentUrl regex="/grabCurrentUrl" stepKey="grabFromCurrentUrlKey1" />
         <grabMultiple selector=".functionalTestSelector" stepKey="grabMultipleKey1" />
         <grabTextFrom selector=".functionalTestSelector" stepKey="grabTextFromKey1" />

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

@@ -93,6 +93,8 @@
             <grabAttributeFrom selector="1" stepKey="grabattribute12"/>
             <grabCookie stepKey="grabcookie1"/>
             <grabCookie stepKey="grabcookie12"/>
+            <grabCookieAttributes stepKey="grabcookieattributes1"/>
+            <grabCookieAttributes stepKey="grabcookieattributes12"/>
             <grabFromCurrentUrl stepKey="grabfromcurl1"/>
             <grabFromCurrentUrl stepKey="grabfromcurl12"/>
             <grabMultiple selector="1" stepKey="grabmulti1"/>
@@ -305,6 +307,8 @@
             <grabAttributeFrom selector="1" stepKey="grabattribute12"/>
             <grabCookie stepKey="grabcookie1"/>
             <grabCookie stepKey="grabcookie12"/>
+            <grabCookieAttributes stepKey="grabcookieattributes1"/>
+            <grabCookieAttributes stepKey="grabcookieattributes12"/>
             <grabFromCurrentUrl stepKey="grabfromcurl1"/>
             <grabFromCurrentUrl stepKey="grabfromcurl12"/>
             <grabMultiple selector="1" stepKey="grabmulti1"/>
@@ -516,6 +520,8 @@
         <grabAttributeFrom selector="1" stepKey="grabattribute12"/>
         <grabCookie stepKey="grabcookie1"/>
         <grabCookie stepKey="grabcookie12"/>
+        <grabCookieAttributes stepKey="grabcookieattributes1"/>
+        <grabCookieAttributes stepKey="grabcookieattributes12"/>
         <grabFromCurrentUrl stepKey="grabfromcurl1"/>
         <grabFromCurrentUrl stepKey="grabfromcurl12"/>
         <grabMultiple selector="1" stepKey="grabmulti1"/>

docs/test/actions.md

@@ -144,6 +144,7 @@ The following test actions return a variable:
 
 *  [grabAttributeFrom](#grabattributefrom)
 *  [grabCookie](#grabcookie)
+*  [grabCookieAttributes](#grabCookieAttributes)
 *  [grabFromCurrentUrl](#grabfromcurrenturl)
 *  [grabMultiple](#grabmultiple)
 *  [grabPageSource](#grabpagesource)
@@ -1158,6 +1159,34 @@ To access this value, use `{$grabCookieExampleDomain}` in later actions. -->
 <grabCookie userInput="cookie1" parameterArray="['domainName' => '.example.com']" stepKey="grabCookieExampleDomain"/>
 ```
 
+### grabCookieAttributes
+
+See [grabCookieAttributes docs on codeception.com](http://codeception.com/docs/modules/WebDriver#grabCookieAttributes).
+
+Attribute|Type|Use|Description
+---|---|---|---
+`userInput`|string|optional| Name of the cookie to grab.
+`parameterArray`|string|optional| Array of cookie parameters to grab.
+`stepKey`|string|required| A unique identifier of the action.
+`before`|string|optional| `stepKey` of action that must be executed next.
+`after`|string|optional| `stepKey` of preceding action.
+
+#### Examples
+
+```xml
+<!-- Grab the cookie attributes with the given name `cookie1`.
+To access these values, use `{$grabCookie1}` in later actions. -->
+<grabCookieAttributes userInput="cookie1" stepKey="grabCookie1"/>
+```
+
+```xml
+<!-- Grab the cookie attributes with the given name `cookie1` from the domain `www.example.com`.
+To access these values, use `{$grabCookieExampleDomain}` in later actions.
+To access expiry date, use  `{$grabCookieExampleDomain.expiry}` in later actions.
+-->
+<grabCookieAttributes userInput="cookie1" parameterArray="['domainName' => '.example.com']" stepKey="grabCookieExampleDomain"/>
+```
+
 ### grabFromCurrentUrl
 
 See [grabFromCurrentUrl docs on codeception.com](http://codeception.com/docs/modules/WebDriver#grabFromCurrentUrl)..

etc/di.xml

@@ -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|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|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">

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -808,6 +808,39 @@ public function rapidClick($selector, $count)
         }
     }
 
+  /**
+   * Grabs a cookie attributes value.
+   * You can set additional cookie params like `domain`, `path` in array passed as last argument.
+   * If the cookie is set by an ajax request (XMLHttpRequest),
+   * there might be some delay caused by the browser, so try `$I->wait(0.1)`.
+   * @param  string $cookie
+   * @param array  $params
+   * @return mixed
+   */
+    public function grabCookieAttributes(string $cookie, array $params = []): array
+    {
+        $params['name'] = $cookie;
+        $cookieArrays = $this->filterCookies($this->webDriver->manage()->getCookies(), $params);
+        $cookieAttributes = [];
+        if (is_array($cookieArrays)) { // Microsoft Edge returns null if there are no cookies...
+            foreach ($cookieArrays as $cookieArray) {
+                if ($cookieArray->getName() === $cookie) {
+                    $cookieAttributes['name'] = $cookieArray->getValue();
+                    $cookieAttributes['path'] = $cookieArray->getPath();
+                    $cookieAttributes['domain'] = $cookieArray->getDomain();
+                    $cookieAttributes['secure'] = $cookieArray->isSecure();
+                    $cookieAttributes['httpOnly'] = $cookieArray->isHttpOnly();
+                    $cookieAttributes['sameSite'] = $cookieArray->getSameSite();
+                    $cookieAttributes['expiry']  = date('d/m/Y', $cookieArray->getExpiry());
+
+                    return $cookieAttributes;
+                }
+            }
+        }
+
+        return $cookieAttributes;
+    }
+
     /**
      * Function used to fill sensitive credentials with user data, data is decrypted immediately prior to fill to avoid
      * exposure in console or log.

src/Magento/FunctionalTestingFramework/Test/Objects/ActionGroupObject.php

@@ -31,6 +31,7 @@ class ActionGroupObject
         "createData",
         "grabAttributeFrom",
         "grabCookie",
+        "grabCookieAttributes",
         "grabFromCurrentUrl",
         "grabMultiple",
         "grabPageSource",

src/Magento/FunctionalTestingFramework/Test/etc/Actions/grabActions.xsd

@@ -13,6 +13,7 @@
         <xs:choice>
             <xs:element type="grabAttributeFromType" name="grabAttributeFrom" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="grabCookieType" name="grabCookie" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element type="grabCookieAttributesType" name="grabCookieAttributes" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="grabFromCurrentUrlType" name="grabFromCurrentUrl" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="grabMultipleType" name="grabMultiple" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="grabPageSourceType" name="grabPageSource" minOccurs="0" maxOccurs="unbounded"/>
@@ -53,6 +54,21 @@
         </xs:simpleContent>
     </xs:complexType>
 
+    <xs:complexType name="grabCookieAttributesType">
+      <xs:annotation>
+        <xs:documentation>
+          Grabs a cookie attributes value.
+        </xs:documentation>
+      </xs:annotation>
+      <xs:simpleContent>
+        <xs:extension base="xs:string">
+          <xs:attribute ref="userInput"/>
+          <xs:attribute ref="parameterArray"/>
+          <xs:attributeGroup ref="commonActionAttributes"/>
+        </xs:extension>
+      </xs:simpleContent>
+    </xs:complexType>
+
     <xs:complexType name="grabFromCurrentUrlType">
         <xs:annotation>
             <xs:documentation>
@@ -129,4 +145,4 @@
             </xs:extension>
         </xs:simpleContent>
     </xs:complexType>
-</xs:schema>
+</xs:schema>

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -1120,6 +1120,7 @@ public function generateStepsPhp($actionObjects, $generationScope = TestGenerato
                         $parameterArray
                     );
                     break;
+                case "grabCookieAttributes":
                 case "grabCookie":
                     $testSteps .= $this->wrapFunctionCallWithReturnValue(
                         $stepKey,
@@ -2391,6 +2392,7 @@ private function validateXmlAttributesMutuallyExclusive($key, $tagName, $attribu
                 'excludes' => [
                     'dontSeeCookie',
                     'grabCookie',
+                    'grabCookieAttributes',
                     'resetCookie',
                     'seeCookie',
                     'setCookie',