Skip to content

Commit aef9e31

Browse files
KevinBKozanKevinBKozan
authored
MQE-484: parameter array with data replacement does not generate uniqueness function correctly (#25)
- ParameterArray now correctly replaces "{{data.key}}" uniqueness. - Verification test creation - add support for consistent array declaration - change functionality for pressKey - add exception for improperly formatted parameter array
1 parent 892b1fb commit aef9e31

File tree

7 files changed

+211
-4
lines changed

7 files changed

+211
-4
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,10 @@ class BasicFunctionalCest
8989
$I->moveMouseOver(".functionalTestSelector");
9090
$I->openNewTab();
9191
$I->pauseExecution();
92-
$I->pressKey(".functionalTestSelector");
92+
$I->pressKey("#page", "a");
93+
$I->pressKey("#page", ['ctrl','a'],'new');
94+
$I->pressKey("#page", ['shift','111'],'1','x');
95+
$I->pressKey("#page", ['ctrl', 'a'],\Facebook\WebDriver\WebDriverKeys::DELETE);
9396
$I->reloadPage();
9497
$I->resetCookie("cookieInput");
9598
$I->resizeWindow(0, 0);

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?php
2+
namespace Magento\AcceptanceTest\_generated\Backend;
3+
4+
use Magento\FunctionalTestingFramework\AcceptanceTester;
5+
use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
6+
use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
7+
use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
8+
use Yandex\Allure\Adapter\Annotation\Features;
9+
use Yandex\Allure\Adapter\Annotation\Stories;
10+
use Yandex\Allure\Adapter\Annotation\Title;
11+
use Yandex\Allure\Adapter\Annotation\Description;
12+
use Yandex\Allure\Adapter\Annotation\Parameter;
13+
use Yandex\Allure\Adapter\Annotation\Severity;
14+
use Yandex\Allure\Adapter\Model\SeverityLevel;
15+
use Yandex\Allure\Adapter\Annotation\TestCaseId;
16+
17+
/**
18+
*/
19+
class ParameterArrayCest
20+
{
21+
/**
22+
* @Parameter(name = "AcceptanceTester", value="$I")
23+
* @param AcceptanceTester $I
24+
* @return void
25+
*/
26+
public function ParameterArrayTest(AcceptanceTester $I)
27+
{
28+
$I->amGoingTo("create entity that has the mergeKey: simpleDataKey");
29+
$simpleParamData = DataObjectHandler::getInstance()->getObject("simpleParamData");
30+
$simpleDataKey = new DataPersistenceHandler($simpleParamData);
31+
$simpleDataKey->createEntity();
32+
$I->searchAndMultiSelectOption("#selector", ["name"]);
33+
$I->searchAndMultiSelectOption("#selector", [msq("simpleParamData")."prename"]);
34+
$I->searchAndMultiSelectOption("#selector", ["postname".msq("simpleParamData")]);
35+
$I->searchAndMultiSelectOption("#selector", [$simpleDataKey->getCreatedDataByName('name')]);
36+
$I->searchAndMultiSelectOption("#selector", ["name", $simpleDataKey->getCreatedDataByName('name')]);
37+
$I->searchAndMultiSelectOption("#selector", ['someKey' => $simpleDataKey->getCreatedDataByName('name')]);
38+
$I->searchAndMultiSelectOption("#selector", ['someKey' => "name"]);
39+
$I->searchAndMultiSelectOption("#selector", ['someKey' => msq("simpleParamData")."prename"]);
40+
$I->searchAndMultiSelectOption("#selector", ['someKey' => "postname".msq("simpleParamData")]);
41+
}
42+
}

‎dev/tests/verification/TestModule/Cest/ParameterArrayCest.xml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
/**
4+
* Copyright © Magento, Inc. All rights reserved.
5+
* See COPYING.txt for license details.
6+
*/
7+
-->
8+
9+
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
10+
xsi:noNamespaceSchemaLocation="../../../../../../../../../../magento2-functional-testing-framework/src/Magento/FunctionalTestingFramework/Test/etc/testSchema.xsd">
11+
<cest name="ParameterArrayCest">
12+
<test name="ParameterArrayTest">
13+
<createData entity="simpleParamData" mergeKey="simpleDataKey"/>
14+
<searchAndMultiSelectOption selector="#selector" parameterArray="[{{simpleParamData.name}}]" mergeKey="xmlSimpleReplace"/>
15+
<searchAndMultiSelectOption selector="#selector" parameterArray="[{{simpleParamData.uniqueNamePre}}]" mergeKey="xmlPrefix"/>
16+
<searchAndMultiSelectOption selector="#selector" parameterArray="[{{simpleParamData.uniqueNamePost}}]" mergeKey="xmlSuffix"/>
17+
<searchAndMultiSelectOption selector="#selector" parameterArray="[$simpleDataKey.name$]" mergeKey="persistSimple"/>
18+
<searchAndMultiSelectOption selector="#selector" parameterArray="[{{simpleParamData.name}}, $simpleDataKey.name$]" mergeKey="persistXmlSimple"/>
19+
<searchAndMultiSelectOption selector="#selector" parameterArray="['someKey' => $simpleDataKey.name$]" mergeKey="literalKeyToPersist"/>
20+
<searchAndMultiSelectOption selector="#selector" parameterArray="['someKey' => {{simpleParamData.name}}]" mergeKey="literalKeyToStatic"/>
21+
<searchAndMultiSelectOption selector="#selector" parameterArray="['someKey' => {{simpleParamData.uniqueNamePre}}]" mergeKey="literalKeyToPrefixUnique"/>
22+
<searchAndMultiSelectOption selector="#selector" parameterArray="['someKey' => {{simpleParamData.uniqueNamePost}}]" mergeKey="literalKeyToSuffixUnique"/>
23+
</test>
24+
</cest>
25+
</config>

‎dev/tests/verification/TestModule/Cest/basicFunctionalCest.xml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,10 @@
7474
<moveMouseOver selector=".functionalTestSelector" mergeKey="moveMouseOverKey1"/>
7575
<openNewTab mergeKey="openNewTabKey1"/>
7676
<pauseExecution mergeKey="pauseExecutionKey1"/>
77-
<pressKey selector=".functionalTestSelector" mergeKey="pressKeyKey1"/>
77+
<pressKey selector="#page" userInput="a" mergeKey="pressKey1"/>
78+
<pressKey selector="#page" parameterArray="[['ctrl','a'],'new']" mergeKey="pressKey2"/>
79+
<pressKey selector="#page" parameterArray="[['shift','111'],'1','x']" mergeKey="pressKey3"/>
80+
<pressKey selector="#page" parameterArray="[['ctrl', 'a'], \Facebook\WebDriver\WebDriverKeys::DELETE]" mergeKey="pressKey4"/>
7881
<reloadPage mergeKey="reloadPageKey1"/>
7982
<resetCookie userInput="cookieInput" mergeKey="resetCookieKey1"/>
8083
<resizeWindow width="0" height="0" mergeKey="resizeWindowKey1" />

‎dev/tests/verification/TestModule/Data/ParameterArrayData.xml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
/**
4+
* Copyright © Magento, Inc. All rights reserved.
5+
* See COPYING.txt for license details.
6+
*/
7+
-->
8+
9+
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
10+
xsi:noNamespaceSchemaLocation="../../../../../../vendor/magento/magento2-functional-testing-framework/src/Magento/FunctionalTestingFramework/DataGenerator/etc/dataProfileSchema.xsd">
11+
<entity name="simpleParamData" type="data">
12+
<data key="name">name</data>
13+
<data key="uniqueNamePre" unique="prefix">prename</data>
14+
<data key="uniqueNamePost" unique="suffix">postname</data>
15+
</entity>
16+
</config>

‎dev/tests/verification/Tests/ParameterArrayTest.php‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
namespace tests\verification\Tests;
7+
8+
use Magento\FunctionalTestingFramework\Test\Handlers\CestObjectHandler;
9+
use Magento\FunctionalTestingFramework\Util\TestGenerator;
10+
use PHPUnit\Framework\TestCase;
11+
use tests\verification\Util\FileDiffUtil;
12+
13+
class ParameterArrayTest extends TestCase
14+
{
15+
const PARAMETER_ARRAY_CEST = 'ParameterArrayCest';
16+
const RESOURCES_PATH = __DIR__ . '/../Resources';
17+
18+
/**
19+
* Tests flat generation of a hardcoded cest file with no external references.
20+
*/
21+
public function testParameterArrayGeneration()
22+
{
23+
$cest = CestObjectHandler::getInstance()->getObject(self::PARAMETER_ARRAY_CEST);
24+
$test = TestGenerator::getInstance(null, [$cest]);
25+
$test->createAllCestFiles();
26+
27+
$cestFile = $test->getExportDir() .
28+
DIRECTORY_SEPARATOR .
29+
self::PARAMETER_ARRAY_CEST .
30+
".php";
31+
32+
$this->assertTrue(file_exists($cestFile));
33+
34+
$fileDiffUtil = new FileDiffUtil(
35+
self::RESOURCES_PATH . DIRECTORY_SEPARATOR . self::PARAMETER_ARRAY_CEST . ".txt",
36+
$cestFile
37+
);
38+
39+
$diffResult = $fileDiffUtil->diffContents();
40+
$this->assertNull($diffResult, $diffResult);
41+
}
42+
}

‎src/Magento/FunctionalTestingFramework/Util/TestGenerator.php‎

Lines changed: 78 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -376,8 +376,13 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
376376
$time = $customActionAttributes['timeout'];
377377
}
378378

379-
if (isset($customActionAttributes['parameterArray'])) {
380-
$parameterArray = $customActionAttributes['parameterArray'];
379+
if (isset($customActionAttributes['parameterArray']) && $actionName != 'pressKey') {
380+
// validate the param array is in the correct format
381+
$this->validateParameterArray($customActionAttributes['parameterArray']);
382+
383+
$parameterArray = "[" . $this->addUniquenessToParamArray(
384+
$customActionAttributes['parameterArray']
385+
) . "]";
381386
}
382387

383388
if (isset($customActionAttributes['requiredAction'])) {
@@ -721,6 +726,29 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
721726
$testSteps .= $this->wrapFunctionCall($actor, $actionName, $selector, $parameterArray);
722727
break;
723728
case "pressKey":
729+
$parameterArray = $customActionAttributes['parameterArray'] ?? null;
730+
if ($parameterArray) {
731+
// validate the param array is in the correct format
732+
$this->validateParameterArray($parameterArray);
733+
734+
// trim off the outer braces and add commas for the regex match
735+
$params = "," . substr($parameterArray, 1, strlen($parameterArray) - 2) . ",";
736+
737+
// we are matching any nested arrays for a simultaneous press, any string literals, and any
738+
// explicit function calls from a class.
739+
preg_match_all('/(\[.*?\])|(\'.*?\')|(\\\\.*?\,)/', $params, $paramInput);
740+
741+
//clean up the input by trimming any extra commas
742+
$tmpParameterArray = [];
743+
foreach ($paramInput[0] as $params) {
744+
$tmpParameterArray[] = trim($params, ",");
745+
}
746+
747+
// put the array together as a string to be passed as args
748+
$parameterArray = implode(",", $tmpParameterArray);
749+
}
750+
$testSteps .= $this->wrapFunctionCall($actor, $actionName, $selector, $input, $parameterArray);
751+
break;
724752
case "selectOption":
725753
$testSteps .= $this->wrapFunctionCall($actor, $actionName, $selector, $input, $parameterArray);
726754
break;
@@ -1168,6 +1196,40 @@ private function generateTestsPhp($testsObject)
11681196
return $testPhp;
11691197
}
11701198

1199+
/**
1200+
* Detects uniqueness function calls on given attribute, and calls addUniquenessFunctionCall on matches.
1201+
* @param string $input
1202+
* @return string
1203+
*/
1204+
private function addUniquenessToParamArray($input)
1205+
{
1206+
$tempInput = trim($input, "[]");
1207+
$paramArray = explode(",", $tempInput);
1208+
$result = [];
1209+
1210+
foreach ($paramArray as $param) {
1211+
// Determine if param has key/value array notation
1212+
if (preg_match_all('/(.+)=>(.+)/', trim($param), $paramMatches)) {
1213+
$param1 = $this->addUniquenessToParamArray($paramMatches[1][0]);
1214+
$param2 = $this->addUniquenessToParamArray($paramMatches[2][0]);
1215+
$result[] = trim($param1) . " => " . trim($param2);
1216+
continue;
1217+
}
1218+
1219+
// Matches strings wrapped in ', we assume these are string literals
1220+
if (preg_match('/^(["\']).*\1$/m', trim($param))) {
1221+
$result[] = $param;
1222+
continue;
1223+
}
1224+
1225+
$replacement = $this->addUniquenessFunctionCall(trim($param));
1226+
1227+
$result[] = $replacement;
1228+
}
1229+
1230+
return implode(", ", $result);
1231+
}
1232+
11711233
/**
11721234
* Add uniqueness function call to input string based on regex pattern.
11731235
*
@@ -1302,4 +1364,18 @@ private function wrapFunctionCallWithReturnValue($returnVariable, $actor, $actio
13021364
return $this->resolveTestVariable($output, $args);
13031365
}
13041366
// @codingStandardsIgnoreEnd
1367+
1368+
/**
1369+
* Validates parameter array format, making sure user has enclosed string with square brackets.
1370+
*
1371+
* @param string $paramArray
1372+
* @return void
1373+
* @throws TestReferenceException
1374+
*/
1375+
private function validateParameterArray($paramArray)
1376+
{
1377+
if (substr($paramArray, 0, 1) != "[" || substr($paramArray, strlen($paramArray)-1, 1)!= "]") {
1378+
throw new TestReferenceException("parameterArray must begin with `[` and end with `]");
1379+
}
1380+
}
13051381
}

0 commit comments

Comments
 (0)