MQE-1089: Allow usage of $ JavaScript variables in executeJs

- Added conditional in testGenerator to escape javascript variables only in executeJS functions.

Author: KevinBKozan

dev/tests/verification/Resources/ExecuteJsEscapingTest.txt

@@ -0,0 +1,35 @@
+<?php
+namespace Magento\AcceptanceTest\_default\Backend;
+
+use Magento\FunctionalTestingFramework\AcceptanceTester;
+use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
+use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
+use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use Magento\FunctionalTestingFramework\DataGenerator\Handlers\CredentialStore;
+use \Codeception\Util\Locator;
+use Yandex\Allure\Adapter\Annotation\Features;
+use Yandex\Allure\Adapter\Annotation\Stories;
+use Yandex\Allure\Adapter\Annotation\Title;
+use Yandex\Allure\Adapter\Annotation\Description;
+use Yandex\Allure\Adapter\Annotation\Parameter;
+use Yandex\Allure\Adapter\Annotation\Severity;
+use Yandex\Allure\Adapter\Model\SeverityLevel;
+use Yandex\Allure\Adapter\Annotation\TestCaseId;
+
+/**
+ */
+class ExecuteJsEscapingTestCest
+{
+	/**
+	 * @Features({"TestModule"})
+	 * @Parameter(name = "AcceptanceTester", value="$I")
+	 * @param AcceptanceTester $I
+	 * @return void
+	 * @throws \Exception
+	 */
+	public function ExecuteJsEscapingTest(AcceptanceTester $I)
+	{
+		$javaVariableEscape = $I->executeJS("return \$javascriptVariable");
+		$mftfVariableNotEscaped = $I->executeJS("return {$doNotEscape}");
+	}
+}

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

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+
+<tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="../../../../../src/Magento/FunctionalTestingFramework/Test/etc/testSchema.xsd">
+    <test name="ExecuteJsEscapingTest">
+        <executeJS function="return $javascriptVariable" stepKey="javaVariableEscape"/>
+        <executeJS function="return {$doNotEscape}" stepKey="mftfVariableNotEscaped"/>
+    </test>
+</tests>

dev/tests/verification/Tests/ExecuteJsTest.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace tests\verification\Tests;
+
+use tests\util\MftfTestCase;
+
+class ExecuteJsTest extends MftfTestCase
+{
+    /**
+     * Tests escaping of $javascriptVariable => \$javascriptVariable in the executeJs function
+     *
+     * @throws \Exception
+     * @throws \Magento\FunctionalTestingFramework\Exceptions\TestReferenceException
+     */
+    public function testExecuteJsTest()
+    {
+        $this->generateAndCompareTest('ExecuteJsEscapingTest');
+    }
+}

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -618,6 +618,10 @@ public function generateStepsPhp($actionObjects, $hookObject = false, $actor = "
                     // Argument must be a closure function, not a string.
                     $function = trim($function, '"');
                 }
+                // turn $javaVariable => \$javaVariable but not {$mftfVariable}
+                if ($actionObject->getType() == "executeJS") {
+                    $function = preg_replace('/(?<!{)(\$[\w\d_]+)/', '\\\\$1', $function);
+                }
             }
 
             if (isset($customActionAttributes['html'])) {