Merge branch 'develop' into sample-test-run

Author: soumyau

.gitignore

@@ -19,4 +19,4 @@ dev/tests/mftf.log
 dev/tests/docs/*
 dev/tests/_output
 dev/tests/functional.suite.yml
-mftf-annotations-static-check.txt
+

CHANGELOG.md

@@ -1,5 +1,57 @@
 Magento Functional Testing Framework Changelog
 ================================================
+3.0.0 RC5
+---------
+
+### Enhancements
+
+* Readability
+    * Removed blacklist/whitelist terminology in MFTF.
+
+### Fixes
+
+* Fixed javascript error seen on chrome 81 for dragAndDrop action.
+* Fixed allure issue when `WebDriverCurlException` is encountered in `afterStep`.
+
+3.0.0 RC4
+---------
+
+### Enhancements
+
+* Customizability
+    * `<group value="skip"/>` no longer skips a test. Instead, the test is added to the `skip` group.
+* Maintainability
+    * `mftf.log` no longer includes notices and warnings at test execution time.
+    * Added the Chrome option `--ignore-certificate-errors` to `functional.suite.dist.yml`.
+* Traceability
+    * Changed the `bin/mftf static-checks` error file directory from the current working directory to `TESTS_BP/tests/_output/static-results/`.
+* Readability
+    * Documented [3.0.0 Backward Incompatible Changes.](./docs/backward-incompatible-changes.md)
+
+### Fixes
+
+* Fixed issue where an extended data entity would not merge array items. Array items should merge properly now.
+* Fixed issue where Chrome remains running after MFTF suite finishes.
+
+3.0.0 RC3
+---------
+
+### Enhancements
+
+*  Maintainability
+    * Added support for Two-Factor Authentication (2FA). [See configure-2fa page for details](./docs/configure-2fa.md)  
+    * Added new static check `annotationsCheck` that checks and reports missing annotations in tests.
+    * Updated `bin/mftf static-checks` command to allow executing static-checks defined in `staticRuleSet.json` by default. [See command page for details](./docs/commands/mftf.md#static-checks)
+    * Added new upgrade script to remove unused arguments from action groups.
+    * Added unhandledPromptBehavior driver capability for Chrome 75+ support.
+    * Removed redundant and unused classes.
+
+### Fixes
+
+* Fixed issue with custom helper usage in suites.
+* Fixed issue with decryption of secrets during data entity creation.
+* Fixed issue with merging of `array` items in data entity.
+
 3.0.0 RC2
 ---------
 
@@ -138,9 +190,9 @@ Magento Functional Testing Framework Changelog
         * Command verifies and troubleshoots some configuration steps required for running tests
         * Please see DevDocs for more details
     * `<*Data>` actions now contain `API Endpoint` and `Request Header` artifacts.
-    * Introduced new `.env` configurations `ENABLE_BROWSER_LOG` and `BROWSER_LOG_BLACKLIST`
+    * Introduced new `.env` configurations `ENABLE_BROWSER_LOG` and `BROWSER_LOG_BLOCKLIST`
         * Configuration enables allure artifacts for browser log entries if they are present after the step.
-        * Blacklist filters out logs from specific sources.
+        * Blocklist filters out logs from specific sources.
 * Customizability
     * Introduced `timeout=""` to `magentoCLI` actions.
 

bin/blacklist.txt renamed to bin/blocklist.txt

@@ -3,7 +3,7 @@
 #                                                                 #
 # THIS FILE CANNOT CONTAIN BLANK LINES                            #
 ###################################################################
-bin/blacklist.txt
+bin/blocklist.txt
 dev/tests/static/Magento/Sniffs/Commenting/FunctionCommentSniff.php
 dev/tests/static/Magento/Sniffs/Commenting/VariableCommentSniff.php
 dev/tests/verification/_generated

bin/copyright-check

@@ -5,13 +5,13 @@
 
 
 FILE_EXTENSIONS='.php\|.xml\|.xsd'
-BLACKLIST='bin/blacklist.txt'
+BLOCKLIST='bin/blocklist.txt'
 RESULT=''
 
 # Iterate through the list of tracked files
 # that have the expected extensions
 # that are not ignored
-for i in `git ls-tree --full-tree -r --name-only HEAD | grep $FILE_EXTENSIONS | grep -v -f $BLACKLIST`
+for i in `git ls-tree --full-tree -r --name-only HEAD | grep $FILE_EXTENSIONS | grep -v -f $BLOCKLIST`
 do
     if echo `cat $i` | grep -q -v "Copyright © Magento, Inc. All rights reserved."; then
         # Copyright is missing

bin/copyright-check.bat

@@ -3,7 +3,7 @@
 
 @echo off
 SETLOCAL EnableDelayedExpansion
-SET BLACKLIST_FILE=bin/blacklist.txt
+SET BLOCKLIST_FILE=bin/blocklist.txt
 SET i=0
 
 FOR /F %%x IN ('git ls-tree --full-tree -r --name-only HEAD') DO (
@@ -12,14 +12,14 @@ FOR /F %%x IN ('git ls-tree --full-tree -r --name-only HEAD') DO (
     if "%%~xx"==".xml" set GOOD_EXT=1
     if "%%~xx"==".xsd" set GOOD_EXT=1
     IF DEFINED GOOD_EXT (
-        SET BLACKLISTED=
-        FOR /F "tokens=* skip=5" %%f IN (%BLACKLIST_FILE%) DO (
+        SET BLOCKLISTED=
+        FOR /F "tokens=* skip=5" %%f IN (%BLOCKLIST_FILE%) DO (
             SET LINE=%%x
             IF NOT "!LINE!"=="!LINE:%%f=!" (
-                SET BLACKLISTED=1
+                SET BLOCKLISTED=1
             )
         )
-        IF NOT DEFINED BLACKLISTED (
+        IF NOT DEFINED BLOCKLISTED (
             FIND "Copyright © Magento, Inc. All rights reserved." %%x >nul
             IF ERRORLEVEL 1 (
                 SET /A i+=1

bin/mftf

@@ -31,7 +31,7 @@ try {
     $version = $version['version'];
     $application = new Symfony\Component\Console\Application();
     $application->setName('Magento Functional Testing Framework CLI');
-    $application->setVersion($version);
+    $application->setVersion('3.0.0');
     /** @var \Magento\FunctionalTestingFramework\Console\CommandListInterface $commandList */
     $commandList = new \Magento\FunctionalTestingFramework\Console\CommandList;
     foreach ($commandList->getCommands() as $command) {

composer.json

@@ -2,7 +2,7 @@
     "name": "magento/magento2-functional-testing-framework",
     "description": "Magento2 Functional Testing Framework",
     "type": "library",
-    "version": "3.0.0",
+    "version": "3.0.0-RC5",
     "license": "AGPL-3.0",
     "keywords": ["magento", "automation", "functional", "testing"],
     "config": {
@@ -32,7 +32,8 @@
         "symfony/finder": "^5.0",
         "symfony/mime": "^5.0",
         "symfony/process": "^4.4",
-        "vlucas/phpdotenv": "^2.4"
+        "vlucas/phpdotenv": "^2.4",
+        "weew/helpers-array": "^1.3"
     },
     "require-dev": {
         "brainmaestro/composer-git-hooks": "^2.3.1",

composer.lock

@@ -54,8 +54,8 @@
     putenv("{$key}=${value}");
 }
 
-// Add our test module to the whitelist
-putenv('MODULE_WHITELIST=Magento_TestModule');
+// Add our test module to the allowlist
+putenv('MODULE_ALLOWLIST=Magento_TestModule');
 
 // Define our own set of paths for the tests
 defined('FW_BP') || define('FW_BP', PROJECT_ROOT);

dev/tests/_bootstrap.php

@@ -17,4 +17,10 @@
             <item name="three">3</item>
         </array>
     </entity>
+
+    <entity name="ExtendedMessageData" extends="MessageData">
+        <array key="numbers">
+            <item name="TESTING CASE">TESTING CASE</item>
+        </array>
+    </entity>
 </entities>

dev/tests/functional/tests/MFTF/DevDocs/Data/MessageData.xml

@@ -48,8 +48,8 @@
         </actionGroup>
 
         <assertEqualsCanonicalizing stepKey="assertMergedArray">
-            <actualResult type="array">{{MessageData.numbers}}</actualResult>
-            <expectedResult type="array">["Something New", "0", "1", "2", "3"]</expectedResult>
+            <actualResult type="array">{{ExtendedMessageData.numbers}}</actualResult>
+            <expectedResult type="array">["Something New", "0", "1", "2", "3", "TESTING CASE"]</expectedResult>
         </assertEqualsCanonicalizing>
     </test>
 </tests>

dev/tests/functional/tests/MFTF/DevDocs/Test/DevDocsTest.xml

@@ -13,7 +13,7 @@ class IsNullSniff implements Sniff
     /**
      * @var string
      */
-    protected $blacklist = 'is_null';
+    protected $blocklist = 'is_null';
 
     /**
      * @inheritdoc
@@ -29,7 +29,7 @@ public function register()
     public function process(File $sourceFile, $stackPtr)
     {
         $tokens = $sourceFile->getTokens();
-        if ($tokens[$stackPtr]['content'] === $this->blacklist) {
+        if ($tokens[$stackPtr]['content'] === $this->blocklist) {
             $sourceFile->addError(
                 "is_null must be avoided. Use strict comparison instead.",
                 $stackPtr,

dev/tests/static/Magento/Sniffs/MicroOptimizations/IsNullSniff.php

@@ -705,12 +705,12 @@ public function testApplyCustomModuleMethods()
     }
 
     /**
-     * Validate blacklisted modules are removed
+     * Validate blocklisted modules are removed
      * Module paths are sorted according to module name in alphabetically ascending order
      *
      * @throws \Exception
      */
-    public function testGetModulePathsBlacklist()
+    public function testGetModulePathsBlocklist()
     {
         $this->setMockResolverClass(
             false,
@@ -946,10 +946,10 @@ private function setMockResolverClass(
      * @param ModuleResolver $instance
      * @param array $mockPaths
      * @param array $mockModules
-     * @param array $mockBlacklist
+     * @param array $mockBlocklist
      * @throws \Exception
      */
-    private function setMockResolverProperties($instance, $mockPaths = null, $mockModules = null, $mockBlacklist = [])
+    private function setMockResolverProperties($instance, $mockPaths = null, $mockModules = null, $mockBlocklist = [])
     {
         $property = new \ReflectionProperty(ModuleResolver::class, 'enabledModulePaths');
         $property->setAccessible(true);
@@ -959,9 +959,9 @@ private function setMockResolverProperties($instance, $mockPaths = null, $mockMo
         $property->setAccessible(true);
         $property->setValue($instance, $mockModules);
 
-        $property = new \ReflectionProperty(ModuleResolver::class, 'moduleBlacklist');
+        $property = new \ReflectionProperty(ModuleResolver::class, 'moduleBlocklist');
         $property->setAccessible(true);
-        $property->setValue($instance, $mockBlacklist);
+        $property->setValue($instance, $mockBlocklist);
     }
 
     /**

dev/tests/unit/Magento/FunctionalTestFramework/Util/ModuleResolverTest.php

@@ -17,47 +17,47 @@ class NameValidationUtilTest extends MagentoTestCase
      */
     public function testCurlyBracesInTestName()
     {
-        $this->validateBlacklistedTestName("{{curlyBraces}}");
+        $this->validateBlocklistedTestName("{{curlyBraces}}");
     }
 
     /**
      * Validate name with quotation marks throws exception
      */
     public function testQuotesInTestName()
     {
-        $this->validateBlacklistedTestName("\"quotes\"");
+        $this->validateBlocklistedTestName("\"quotes\"");
     }
 
     /**
      * Validate name with single quotes throws exception
      */
     public function testSingleQuotesInTestName()
     {
-        $this->validateBlacklistedTestName("'singleQuotes'");
+        $this->validateBlocklistedTestName("'singleQuotes'");
     }
 
     /**
      * Validate name with parenthesis throws execption
      */
     public function testParenthesesInTestName()
     {
-        $this->validateBlacklistedTestName("(parenthesis)");
+        $this->validateBlocklistedTestName("(parenthesis)");
     }
 
     /**
      * Validate name with dollar signs throws exception
      */
     public function testDollarSignInTestName()
     {
-        $this->validateBlacklistedTestName("\$dollarSign\$");
+        $this->validateBlocklistedTestName("\$dollarSign\$");
     }
 
     /**
      * Validate name with spaces throws exception
      */
     public function testSpacesInTestName()
     {
-        $this->validateBlacklistedTestName("Test Name With Spaces");
+        $this->validateBlocklistedTestName("Test Name With Spaces");
     }
 
     /**
@@ -66,7 +66,7 @@ public function testSpacesInTestName()
      * @param string $testName
      * @return void
      */
-    private function validateBlacklistedTestName($testName)
+    private function validateBlocklistedTestName($testName)
     {
         $this->expectException(XmlException::class);
         NameValidationUtil::validateName($testName, "Test");

dev/tests/unit/Magento/FunctionalTestFramework/Util/Validation/NameValidationUtilTest.php

@@ -13,23 +13,22 @@ use Yandex\Allure\Adapter\Model\SeverityLevel;
 use Yandex\Allure\Adapter\Annotation\TestCaseId;
 
 /**
- * @Title("[NO TESTCASEID]: skippedNoIssuesTest")
- * @Description("<h3>Test files</h3>verification/TestModule/Test/SkippedTest/SkippedTestNoIssues.xml<br>")
+ * @Title("[NO TESTCASEID]: GroupSkipGenerationTestTitle")
+ * @Description("GroupSkipGenerationTestDescription<h3>Test files</h3>verification/TestModule/Test/GroupSkipGenerationTest.xml<br>")
  * @group skip
  */
-class SkippedTestNoIssuesCest
+class GroupSkipGenerationTestCest
 {
 	/**
-	 * @Stories({"skippedNo"})
+	 * @Stories({"GroupSkipGenerationTestStory"})
 	 * @Severity(level = SeverityLevel::MINOR)
 	 * @Features({"TestModule"})
 	 * @Parameter(name = "AcceptanceTester", value="$I")
 	 * @param AcceptanceTester $I
 	 * @return void
 	 * @throws \Exception
 	 */
-	public function SkippedTestNoIssues(AcceptanceTester $I, \Codeception\Scenario $scenario)
+	public function GroupSkipGenerationTest(AcceptanceTester $I)
 	{
-		$scenario->skip("This test is skipped due to the following issues:\nNo issues have been specified.");
 	}
 }