MQE-2164: Remove terms from MFTF (#739)

Author: soumyau

CHANGELOG.md

@@ -177,9 +177,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

dev/tests/_bootstrap.php

@@ -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/static/Magento/Sniffs/MicroOptimizations/IsNullSniff.php

@@ -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/unit/Magento/FunctionalTestFramework/Util/ModuleResolverTest.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/Validation/NameValidationUtilTest.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");

docs/configuration.md

@@ -214,15 +214,15 @@ Example:
 TESTS_MODULE_PATH=~/magento2/dev/tests/acceptance/tests/functional/Magento/FunctionalTest
 ```
 
-### MODULE_WHITELIST
+### MODULE_ALLOWLIST
 
 Use for a new module.
-When adding a new directory at `Magento/FunctionalTest`, add the directory name to `MODULE_WHITELIST` to enable the MFTF to process it.
+When adding a new directory at `Magento/FunctionalTest`, add the directory name to `MODULE_ALLOWLIST` to enable the MFTF to process it.
 
 Example:
 
 ```conf
-MODULE_WHITELIST=Magento_Framework,Magento_ConfigurableProductWishlist,Magento_ConfigurableProductCatalogSearch
+MODULE_ALLOWLIST=Magento_Framework,Magento_ConfigurableProductWishlist,Magento_ConfigurableProductCatalogSearch
 ```
 
 ### MAGENTO_CLI_COMMAND_PATH
@@ -331,14 +331,14 @@ Use this if you're having issues with sessions hanging in an MFTF suite.
 SELENIUM_CLOSE_ALL_SESSIONS=true
 ```
 
-### BROWSER_LOG_BLACKLIST
+### BROWSER_LOG_BLOCKLIST
 
-Blacklists types of browser log entries from appearing in Allure steps.
+Blocklists types of browser log entries from appearing in Allure steps.
 
 Denoted in browser log entry as `"SOURCE": "type"`.
 
 ```conf
-BROWSER_LOG_BLACKLIST=other,console-api
+BROWSER_LOG_BLOCKLIST=other,console-api
 ```
 
 ### WAIT_TIMEOUT

etc/codecoverage/index.php

@@ -48,7 +48,7 @@ BROWSER=chrome
 #DEFAULT_TIMEZONE=America/Los_Angeles
 
 #*** These properties impact the modules loaded into MFTF, you can point to your own full path, or a custom set of modules located with the core set
-MODULE_WHITELIST=Magento_Framework,ConfigurableProductWishlist,ConfigurableProductCatalogSearch
+MODULE_ALLOWLIST=Magento_Framework,ConfigurableProductWishlist,ConfigurableProductCatalogSearch
 #CUSTOM_MODULE_PATHS=
 
 #*** Bool property which allows the user to toggle debug output during test execution
@@ -63,9 +63,9 @@ MODULE_WHITELIST=Magento_Framework,ConfigurableProductWishlist,ConfigurableProdu
 #*** Uncomment and set to enable all tests, regardless of passing status, to have all their Allure artifacts.
 #VERBOSE_ARTIFACTS=true
 
-#*** Uncomment and set to enable browser log entries on actions in Allure. Blacklist is used to filter logs of a specific "source"
+#*** Uncomment and set to enable browser log entries on actions in Allure. Blocklist is used to filter logs of a specific "source"
 #ENABLE_BROWSER_LOG=true
-#BROWSER_LOG_BLACKLIST=other
+BROWSER_LOG_BLOCKLIST=other
 
 #*** Elastic Search version used for test ***#
 ELASTICSEARCH_VERSION=7

etc/codecoverage/test.php

@@ -201,7 +201,7 @@ public function afterStep(\Codeception\Event\StepEvent $e)
     {
         $browserLog = $this->getDriver()->webDriver->manage()->getLog("browser");
         if (getenv('ENABLE_BROWSER_LOG') === 'true') {
-            foreach (explode(',', getenv('BROWSER_LOG_BLACKLIST')) as $source) {
+            foreach (explode(',', getenv('BROWSER_LOG_BLOCKLIST')) as $source) {
                 $browserLog = BrowserLogUtil::filterLogsOfType($browserLog, $source);
             }
             if (!empty($browserLog)) {

etc/config/.env.example

@@ -23,7 +23,7 @@ class PageObjectHandler implements ObjectHandlerInterface
     const PARAMETERIZED = 'parameterized';
     const AREA = 'area';
     const FILENAME = 'filename';
-    const NAME_BLACKLIST_ERROR_MSG = "Page names cannot contain non alphanumeric characters.\tPage='%s'";
+    const NAME_BLOCKLIST_ERROR_MSG = "Page names cannot contain non alphanumeric characters.\tPage='%s'";
 
     /**
      * The singleton instance of this class
@@ -58,7 +58,7 @@ private function __construct()
         $pageNameValidator = new NameValidationUtil();
         foreach ($parserOutput as $pageName => $pageData) {
             if (preg_match('/[^a-zA-Z0-9_]/', $pageName)) {
-                throw new XmlException(sprintf(self::NAME_BLACKLIST_ERROR_MSG, $pageName));
+                throw new XmlException(sprintf(self::NAME_BLOCKLIST_ERROR_MSG, $pageName));
             }
 
             $filename = $pageData[self::FILENAME] ?? null;

src/Magento/FunctionalTestingFramework/Extension/TestContextExtension.php

@@ -27,7 +27,7 @@ class ActionObjectExtractor extends BaseObjectExtractor
     const ACTION_GROUP_ARGUMENTS = 'arguments';
     const ACTION_GROUP_ARG_VALUE = 'value';
     const BEFORE_AFTER_ERROR_MSG = "Merge Error - Steps cannot have both before and after attributes.\tStepKey='%s'";
-    const STEP_KEY_BLACKLIST_ERROR_MSG = "StepKeys cannot contain non alphanumeric characters.\tStepKey='%s'";
+    const STEP_KEY_BLOCKLIST_ERROR_MSG = "StepKeys cannot contain non alphanumeric characters.\tStepKey='%s'";
     const STEP_KEY_EMPTY_ERROR_MSG = "StepKeys cannot be empty.\tAction='%s'";
     const DATA_PERSISTENCE_CUSTOM_FIELD = 'field';
     const DATA_PERSISTENCE_CUSTOM_FIELD_KEY = 'key';
@@ -70,7 +70,7 @@ public function extractActions($testActions, $testName = null)
             }
 
             if (preg_match('/[^a-zA-Z0-9_]/', $stepKey)) {
-                throw new XmlException(sprintf(self::STEP_KEY_BLACKLIST_ERROR_MSG, $actionName));
+                throw new XmlException(sprintf(self::STEP_KEY_BLOCKLIST_ERROR_MSG, $actionName));
             }
 
             $actionAttributes = $this->stripDescriptorTags(

src/Magento/FunctionalTestingFramework/Page/Handlers/PageObjectHandler.php

@@ -90,7 +90,7 @@ public function getAnnotationExtractor()
      */
     public function extractTestData($testData, $validateAnnotations = true)
     {
-        // validate the test name for blacklisted char (will cause allure report issues) MQE-483
+        // validate the test name for blocklisted char (will cause allure report issues) MQE-483
         NameValidationUtil::validateName($testData[self::NAME], "Test");
 
         $testAnnotations = [];