Skip to content

Commit 1eec579

Browse files
KevinBKozanKevinBKozan
authored
Merge pull request #192 from magento-gl/MQE-2953
MQE 2953 | Grab Cookies Attributes in MFTF.
2 parents cbff68a + 4082762 commit 1eec579

File tree

12 files changed

+95
-2
lines changed

12 files changed

+95
-2
lines changed

‎dev/tests/verification/Resources/ActionGroupWithStepKeyReferences.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ class ActionGroupWithStepKeyReferencesCest
6767
$action14ActionGroup = $I->grabMultiple($action14ActionGroup); // stepKey: action14ActionGroup
6868
$action15ActionGroup = $I->grabTextFrom($action15ActionGroup); // stepKey: action15ActionGroup
6969
$action16ActionGroup = $I->grabValueFrom($action16ActionGroup); // stepKey: action16ActionGroup
70+
$action17ActionGroup = $I->grabCookieAttributes($action17ActionGroup, ['domain' => 'www.google.com']); // stepKey: action17ActionGroup
7071
$I->comment("Exiting Action Group [actionGroup] FunctionActionGroupWithStepKeyReferences");
7172
}
7273

‎dev/tests/verification/Resources/BasicFunctionalTest.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ class BasicFunctionalTestCest
127127
$getOtpWithInput = $I->getOTP("someInput"); // stepKey: getOtpWithInput
128128
$grabAttributeFromKey1 = $I->grabAttributeFrom(".functionalTestSelector", "someInput"); // stepKey: grabAttributeFromKey1
129129
$grabCookieKey1 = $I->grabCookie("grabCookieInput", ['domain' => 'www.google.com']); // stepKey: grabCookieKey1
130+
$grabCookieAttributesKey1 = $I->grabCookieAttributes("grabCookieAttributesInput", ['domain' => 'www.google.com']); // stepKey: grabCookieAttributesKey1
130131
$grabFromCurrentUrlKey1 = $I->grabFromCurrentUrl("/grabCurrentUrl"); // stepKey: grabFromCurrentUrlKey1
131132
$grabMultipleKey1 = $I->grabMultiple(".functionalTestSelector"); // stepKey: grabMultipleKey1
132133
$grabTextFromKey1 = $I->grabTextFrom(".functionalTestSelector"); // stepKey: grabTextFromKey1

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,6 @@
2828
<grabMultiple selector="{$action14}" stepKey="action14"/>
2929
<grabTextFrom selector="{$action15}" stepKey="action15"/>
3030
<grabValueFrom selector="{$action16}" stepKey="action16"/>
31+
<grabCookieAttributes userInput="{$action17}" parameterArray="['domain' => 'www.google.com']" stepKey="action17"/>
3132
</actionGroup>
3233
</actionGroups>

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@
9090
<grabAttributeFrom selector="1" stepKey="grabattribute12"/>
9191
<grabCookie stepKey="grabcookie1"/>
9292
<grabCookie stepKey="grabcookie12"/>
93+
<grabCookieAttributes stepKey="grabcookieattributes1"/>
94+
<grabCookieAttributes stepKey="grabcookieattributes12"/>
9395
<grabFromCurrentUrl stepKey="grabfromcurl1"/>
9496
<grabFromCurrentUrl stepKey="grabfromcurl12"/>
9597
<grabMultiple selector="1" stepKey="grabmulti1"/>

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@
7272
<getOTP stepKey="getOtpWithInput" userInput="someInput"/>
7373
<grabAttributeFrom selector=".functionalTestSelector" userInput="someInput" stepKey="grabAttributeFromKey1" />
7474
<grabCookie userInput="grabCookieInput" parameterArray="['domain' => 'www.google.com']" stepKey="grabCookieKey1" />
75+
<grabCookieAttributes userInput="grabCookieAttributesInput" parameterArray="['domain' => 'www.google.com']" stepKey="grabCookieAttributesKey1" />
7576
<grabFromCurrentUrl regex="/grabCurrentUrl" stepKey="grabFromCurrentUrlKey1" />
7677
<grabMultiple selector=".functionalTestSelector" stepKey="grabMultipleKey1" />
7778
<grabTextFrom selector=".functionalTestSelector" stepKey="grabTextFromKey1" />

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@
9393
<grabAttributeFrom selector="1" stepKey="grabattribute12"/>
9494
<grabCookie stepKey="grabcookie1"/>
9595
<grabCookie stepKey="grabcookie12"/>
96+
<grabCookieAttributes stepKey="grabcookieattributes1"/>
97+
<grabCookieAttributes stepKey="grabcookieattributes12"/>
9698
<grabFromCurrentUrl stepKey="grabfromcurl1"/>
9799
<grabFromCurrentUrl stepKey="grabfromcurl12"/>
98100
<grabMultiple selector="1" stepKey="grabmulti1"/>
@@ -305,6 +307,8 @@
305307
<grabAttributeFrom selector="1" stepKey="grabattribute12"/>
306308
<grabCookie stepKey="grabcookie1"/>
307309
<grabCookie stepKey="grabcookie12"/>
310+
<grabCookieAttributes stepKey="grabcookieattributes1"/>
311+
<grabCookieAttributes stepKey="grabcookieattributes12"/>
308312
<grabFromCurrentUrl stepKey="grabfromcurl1"/>
309313
<grabFromCurrentUrl stepKey="grabfromcurl12"/>
310314
<grabMultiple selector="1" stepKey="grabmulti1"/>
@@ -516,6 +520,8 @@
516520
<grabAttributeFrom selector="1" stepKey="grabattribute12"/>
517521
<grabCookie stepKey="grabcookie1"/>
518522
<grabCookie stepKey="grabcookie12"/>
523+
<grabCookieAttributes stepKey="grabcookieattributes1"/>
524+
<grabCookieAttributes stepKey="grabcookieattributes12"/>
519525
<grabFromCurrentUrl stepKey="grabfromcurl1"/>
520526
<grabFromCurrentUrl stepKey="grabfromcurl12"/>
521527
<grabMultiple selector="1" stepKey="grabmulti1"/>

‎docs/test/actions.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ The following test actions return a variable:
144144

145145
* [grabAttributeFrom](#grabattributefrom)
146146
* [grabCookie](#grabcookie)
147+
* [grabCookieAttributes](#grabCookieAttributes)
147148
* [grabFromCurrentUrl](#grabfromcurrenturl)
148149
* [grabMultiple](#grabmultiple)
149150
* [grabPageSource](#grabpagesource)
@@ -1158,6 +1159,34 @@ To access this value, use `{$grabCookieExampleDomain}` in later actions. -->
11581159
<grabCookie userInput="cookie1" parameterArray="['domainName' => '.example.com']" stepKey="grabCookieExampleDomain"/>
11591160
```
11601161

1162+
### grabCookieAttributes
1163+
1164+
See [grabCookieAttributes docs on codeception.com](http://codeception.com/docs/modules/WebDriver#grabCookieAttributes).
1165+
1166+
Attribute|Type|Use|Description
1167+
---|---|---|---
1168+
`userInput`|string|optional| Name of the cookie to grab.
1169+
`parameterArray`|string|optional| Array of cookie parameters to grab.
1170+
`stepKey`|string|required| A unique identifier of the action.
1171+
`before`|string|optional| `stepKey` of action that must be executed next.
1172+
`after`|string|optional| `stepKey` of preceding action.
1173+
1174+
#### Examples
1175+
1176+
```xml
1177+
<!-- Grab the cookie attributes with the given name `cookie1`.
1178+
To access these values, use `{$grabCookie1}` in later actions. -->
1179+
<grabCookieAttributes userInput="cookie1" stepKey="grabCookie1"/>
1180+
```
1181+
1182+
```xml
1183+
<!-- Grab the cookie attributes with the given name `cookie1` from the domain `www.example.com`.
1184+
To access these values, use `{$grabCookieExampleDomain}` in later actions.
1185+
To access expiry date, use `{$grabCookieExampleDomain.expiry}` in later actions.
1186+
-->
1187+
<grabCookieAttributes userInput="cookie1" parameterArray="['domainName' => '.example.com']" stepKey="grabCookieExampleDomain"/>
1188+
```
1189+
11611190
### grabFromCurrentUrl
11621191

11631192
See [grabFromCurrentUrl docs on codeception.com](http://codeception.com/docs/modules/WebDriver#grabFromCurrentUrl)..

‎etc/di.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<!-- Entity value gets replaced in Dom.php before reading $xml -->
1010
<!DOCTYPE config [
11-
<!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">
11+
<!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">
1212
]>
1313

1414
<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‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -808,6 +808,39 @@ public function rapidClick($selector, $count)
808808
}
809809
}
810810

811+
/**
812+
* Grabs a cookie attributes value.
813+
* You can set additional cookie params like `domain`, `path` in array passed as last argument.
814+
* If the cookie is set by an ajax request (XMLHttpRequest),
815+
* there might be some delay caused by the browser, so try `$I->wait(0.1)`.
816+
* @param string $cookie
817+
* @param array $params
818+
* @return mixed
819+
*/
820+
public function grabCookieAttributes(string $cookie, array $params = []): array
821+
{
822+
$params['name'] = $cookie;
823+
$cookieArrays = $this->filterCookies($this->webDriver->manage()->getCookies(), $params);
824+
$cookieAttributes = [];
825+
if (is_array($cookieArrays)) { // Microsoft Edge returns null if there are no cookies...
826+
foreach ($cookieArrays as $cookieArray) {
827+
if ($cookieArray->getName() === $cookie) {
828+
$cookieAttributes['name'] = $cookieArray->getValue();
829+
$cookieAttributes['path'] = $cookieArray->getPath();
830+
$cookieAttributes['domain'] = $cookieArray->getDomain();
831+
$cookieAttributes['secure'] = $cookieArray->isSecure();
832+
$cookieAttributes['httpOnly'] = $cookieArray->isHttpOnly();
833+
$cookieAttributes['sameSite'] = $cookieArray->getSameSite();
834+
$cookieAttributes['expiry'] = date('d/m/Y', $cookieArray->getExpiry());
835+
836+
return $cookieAttributes;
837+
}
838+
}
839+
}
840+
841+
return $cookieAttributes;
842+
}
843+
811844
/**
812845
* Function used to fill sensitive credentials with user data, data is decrypted immediately prior to fill to avoid
813846
* exposure in console or log.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ class ActionGroupObject
3131
"createData",
3232
"grabAttributeFrom",
3333
"grabCookie",
34+
"grabCookieAttributes",
3435
"grabFromCurrentUrl",
3536
"grabMultiple",
3637
"grabPageSource",

0 commit comments

Comments
 (0)