MQE-590: Fix PHP Mess Detector Errors

- DataObjectHandler refactoring for cyclomatic complexity.
- Additional Suppression Flags
- Ruleset change to allow unused foreach variables (as key=>value)

Author: KevinBKozan

dev/tests/static/Magento/CodeMessDetector/ruleset.xml

@@ -26,7 +26,10 @@
     </rule>
 
     <!-- Unused code rules -->
-    <rule ref="rulesets/unusedcode.xml" >
+    <rule ref="rulesets/unusedcode.xml/UnusedPrivateField" />
+    <rule ref="rulesets/unusedcode.xml/UnusedPrivateMethod" />
+    <rule ref="rulesets/unusedcode.xml/UnusedFormalParameter" />
+    <rule ref="rulesets/unusedcode.xml/UnusedLocalVariable" >
         <properties>
             <property name="allow-unused-foreach-variables" value="true"/>
         </properties>

src/Magento/FunctionalTestingFramework/Config/FileResolver/Module.php

@@ -25,6 +25,7 @@ class Module implements FileResolverInterface
     /**
      * Module constructor.
      * @param ModuleResolver|null $moduleResolver
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function __construct(ModuleResolver $moduleResolver = null)
     {

src/Magento/FunctionalTestingFramework/DataGenerator/Handlers/DataObjectHandler.php

@@ -173,26 +173,12 @@ private function parseDataEntities()
             $uniquenessValues = [];
 
             if (array_key_exists(self::DATA_VALUES, $entity)) {
-                foreach ($entity[self::DATA_VALUES] as $dataElement) {
-                    $dataElementKey = strtolower($dataElement[self::DATA_ELEMENT_KEY]);
-                    $dataElementValue = $dataElement[self::DATA_ELEMENT_VALUE] ?? "";
-                    if (array_key_exists(self::DATA_ELEMENT_UNIQUENESS_ATTR, $dataElement)) {
-                        $uniquenessValues[$dataElementKey] = $dataElement[self::DATA_ELEMENT_UNIQUENESS_ATTR];
-                    }
-
-                    $dataValues[$dataElementKey] = $dataElementValue;
-                }
-                unset($dataElement);
+                $dataValues = $this->parseDataElements($entity);
+                $uniquenessValues = $this->parseUniquenessValues($entity);
             }
 
             if (array_key_exists(self::REQUIRED_ENTITY, $entity)) {
-                foreach ($entity[self::REQUIRED_ENTITY] as $linkedEntity) {
-                    $linkedEntityName = $linkedEntity[self::REQUIRED_ENTITY_VALUE];
-                    $linkedEntityType = $linkedEntity[self::REQUIRED_ENTITY_TYPE];
-
-                    $linkedEntities[$linkedEntityName] = $linkedEntityType;
-                }
-                unset($linkedEntity);
+                $linkedEntities = $this->parseRequiredEntityElements($entity);
             }
 
             if (array_key_exists(self::ARRAY_VALUES, $entity)) {
@@ -207,11 +193,7 @@ private function parseDataEntities()
             }
 
             if (array_key_exists(self::VAR_VALUES, $entity)) {
-                foreach ($entity[self::VAR_VALUES] as $varElement) {
-                    $varKey = $varElement[self::VAR_KEY];
-                    $varValue = $varElement[self::VAR_ENTITY] . self::VAR_ENTITY_FIELD_SEPARATOR . $varElement[self::VAR_FIELD];
-                    $vars[$varKey] = $varValue;
-                }
+                $vars = $this->parseVarElements($entity);
             }
 
             $entityDataObject = new EntityDataObject(
@@ -224,9 +206,74 @@ private function parseDataEntities()
             );
 
             $this->data[$entityDataObject->getName()] = $entityDataObject;
-
         }
         unset($entityName);
         unset($entity);
     }
+
+    /**
+     * Parses <data> elements in an entity, and returns them as an array of "lowerKey"=>value.
+     * @param array $entityData
+     * @return array
+     */
+    private function parseDataElements($entityData)
+    {
+        $dataValues = [];
+        foreach ($entityData[self::DATA_VALUES] as $dataElement) {
+            $dataElementKey = strtolower($dataElement[self::DATA_ELEMENT_KEY]);
+            $dataElementValue = $dataElement[self::DATA_ELEMENT_VALUE] ?? "";
+            $dataValues[$dataElementKey] = $dataElementValue;
+        }
+        return $dataValues;
+    }
+
+    /**
+     * Parses through <data> elements in an entity to return an array of "DataKey" => "UniquenessAttribute"
+     * @param array $entityData
+     * @return array
+     */
+    private function parseUniquenessValues($entityData)
+    {
+        $uniquenessValues = [];
+        foreach ($entityData[self::DATA_VALUES] as $dataElement) {
+            if (array_key_exists(self::DATA_ELEMENT_UNIQUENESS_ATTR, $dataElement)) {
+                $dataElementKey = strtolower($dataElement[self::DATA_ELEMENT_KEY]);
+                $uniquenessValues[$dataElementKey] = $dataElement[self::DATA_ELEMENT_UNIQUENESS_ATTR];
+            }
+        }
+        return $uniquenessValues;
+    }
+
+    /**
+     * Parses <required-entity> elements given entity, and returns them as an array of "EntityValue"=>"EntityType"
+     * @param array $entityData
+     * @return array
+     */
+    private function parseRequiredEntityElements($entityData)
+    {
+        $linkedEntities = [];
+        foreach ($entityData[self::REQUIRED_ENTITY] as $linkedEntity) {
+            $linkedEntityName = $linkedEntity[self::REQUIRED_ENTITY_VALUE];
+            $linkedEntityType = $linkedEntity[self::REQUIRED_ENTITY_TYPE];
+
+            $linkedEntities[$linkedEntityName] = $linkedEntityType;
+        }
+        return $linkedEntities;
+    }
+
+    /**
+     * Parses <var> elements in given entity, and returns them as an array of "Key"=> entityType -> entityKey
+     * @param array $entityData
+     * @return array
+     */
+    private function parseVarElements($entityData)
+    {
+        $vars = [];
+        foreach ($entityData[self::VAR_VALUES] as $varElement) {
+            $varKey = $varElement[self::VAR_KEY];
+            $varValue = $varElement[self::VAR_ENTITY] . self::VAR_ENTITY_FIELD_SEPARATOR . $varElement[self::VAR_FIELD];
+            $vars[$varKey] = $varValue;
+        }
+        return $vars;
+    }
 }

src/Magento/FunctionalTestingFramework/DataGenerator/Handlers/OperationDefinitionObjectHandler.php

@@ -125,10 +125,11 @@ public function getOperationDefinition($operation, $dataType)
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      * @SuppressWarnings(PHPMD.NPathComplexity)
      * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
+     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
     private function initDataDefinitions()
     {
-        //TODO: Reduce CyclomaticComplexity/NPathComplexity of method, remove warning suppression.
+        //TODO: Reduce CyclomaticComplexity/NPathComplexity/Length of method, remove warning suppression.
         $objectManager = ObjectManagerFactory::getObjectManager();
         $metadataParser = $objectManager->create(OperationDefinitionParser::class);
         foreach ($metadataParser->readOperationMetadata()

src/Magento/FunctionalTestingFramework/DataGenerator/Objects/OperationDefinitionObject.php

@@ -118,6 +118,7 @@ class OperationDefinitionObject
      * @param string $contentType
      * @param string $successRegex
      * @param string $returnRegex
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         $name,

src/Magento/FunctionalTestingFramework/DataGenerator/Persist/DataPersistenceHandler.php

@@ -142,7 +142,7 @@ public function deleteEntity($storeCode = null)
             $this->storeCode = $storeCode;
         }
         $curlHandler = new CurlHandler('delete', $this->createdObject, $this->storeCode);
-        $result = $curlHandler->executeRequest($this->dependentObjects);
+        $curlHandler->executeRequest($this->dependentObjects);
     }
 
     /**

src/Magento/FunctionalTestingFramework/Test/Util/TestNameValidationUtil.php

@@ -52,6 +52,7 @@ public static function validateName($testName)
      *
      * @param string $val
      * @return string
+     * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
      */
     private static function nameMapper($val)
     {

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -1234,14 +1234,10 @@ private function generateHooksPhp($hookObjects)
                 throw new TestReferenceException($e->getMessage() . " in Element \"" . $type . "\"");
             }
 
-            if ($type == "after" or $type == "before") {
-                $hooks .= sprintf("\tpublic function _{$type}(%s)\n", $dependencies);
-                $hooks .= "\t{\n";
-                $hooks .= $steps;
-                $hooks .= "\t}\n\n";
-            }
-
-            $hooks .= "";
+            $hooks .= sprintf("\tpublic function _{$type}(%s)\n", $dependencies);
+            $hooks .= "\t{\n";
+            $hooks .= $steps;
+            $hooks .= "\t}\n\n";
         }
 
         return $hooks;