MQE-2016: Add warning for test materials that violate naming convention

- Extract logging out to its own class

Author: tomreece

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

@@ -14,6 +14,7 @@
 use Magento\FunctionalTestingFramework\ObjectManagerFactory;
 use Magento\FunctionalTestingFramework\DataGenerator\Util\DataExtensionUtil;
 use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
+use Magento\FunctionalTestingFramework\Util\Validation\NameValidationUtil;
 
 class DataObjectHandler implements ObjectHandlerInterface
 {
@@ -59,18 +60,18 @@ class DataObjectHandler implements ObjectHandlerInterface
     private $extendUtil;
 
     /**
-     * Keeps track of data.key's that are not camelCase.
+     * Validates and keeps track of entity name violations. Entity names should be PascalCase.
      *
-     * @var array
+     * @var NameValidationUtil
      */
-    private $entityKeyViolations = [];
+    private $entityNameValidator;
 
     /**
-     * Keeps track of data entity names that are not PascalCase.
+     * Validates and keeps track of entity key violations. Entity keys should be camelCase.
      *
-     * @var array
+     * @var NameValidationUtil
      */
-    private $nameViolations = [];
+    private $entityKeyValidator;
 
     /**
      * Constructor
@@ -82,6 +83,8 @@ private function __construct()
         if (!$parserOutput) {
             return;
         }
+        $this->entityNameValidator = new NameValidationUtil(NameValidationUtil::TYPE_DATA_ENTITY_NAME);
+        $this->entityKeyValidator = new NameValidationUtil(NameValidationUtil::TYPE_DATA_ENTITY_KEY);
         $this->entityDataObjects = $this->processParserOutput($parserOutput);
         $this->extendUtil = new DataExtensionUtil();
     }
@@ -148,18 +151,7 @@ private function processParserOutput($parserOutput)
             }
 
             $filename = $rawEntity[self::_FILENAME] ?? null;
-
-            // Check that data entity name is PascalCase
-            if (!ctype_upper($name[0])) {
-                $this->nameViolations[] = $name;
-                LoggingUtil::getInstance()->getLogger(self::class)->notification(
-                    "The data entity {$name} should be PascalCase with an uppercase first letter."
-                    . " See file {$filename}.",
-                    [],
-                    false
-                );
-            }
-
+            $this->entityNameValidator->validatePascalCase($name, $filename);
             $type = $rawEntity[self::_TYPE] ?? null;
             $data = [];
             $deprecated = null;
@@ -215,7 +207,8 @@ private function processParserOutput($parserOutput)
 
             $entityDataObjects[$entityDataObject->getName()] = $entityDataObject;
         }
-        $this->logViolationSummary();
+        $this->entityNameValidator->logCountPascalCase();
+        $this->entityKeyValidator->logCountCamelCase();
         return $entityDataObjects;
     }
 
@@ -249,18 +242,7 @@ private function processDataElements($entityData)
         foreach ($entityData[self::_DATA] as $dataElement) {
             $originalDataElementKey = $dataElement[self::_KEY];
             $filename = $entityData[self::_FILENAME] ?? null;
-
-            // Check that data.keys are camelCase
-            if (!ctype_lower($originalDataElementKey[0])) {
-                $this->entityKeyViolations[] = $originalDataElementKey;
-                LoggingUtil::getInstance()->getLogger(self::class)->notification(
-                    "The data entity key {$originalDataElementKey} should be camelCase with a lowercase"
-                    . " first letter. See file {$filename}.",
-                    [],
-                    false
-                );
-            }
-
+            $this->entityKeyValidator->validateCamelCase($originalDataElementKey, $filename);
             $dataElementKey = strtolower($originalDataElementKey);
             $dataElementValue = $dataElement[self::_VALUE] ?? "";
             $dataValues[$dataElementKey] = $dataElementValue;
@@ -338,32 +320,4 @@ private function extendDataObject($dataObject)
         }
         return $dataObject;
     }
-
-    /**
-     * Output to the log a summary of data entity name and data entity key violations.
-     *
-     * @throws TestFrameworkException
-     * @return void
-     */
-    private function logViolationSummary()
-    {
-        $nameViolationCount = count($this->nameViolations);
-        if ($nameViolationCount > 0) {
-            LoggingUtil::getInstance()->getLogger(self::class)->notification(
-                "{$nameViolationCount} data entity name violations detected. Data entity names must be"
-                . " PascalCase with an uppercase first letter.",
-                [],
-                true
-            );
-        }
-        $keyViolationCount = count($this->entityKeyViolations);
-        if ($keyViolationCount > 0) {
-            LoggingUtil::getInstance()->getLogger(self::class)->notification(
-                "{$keyViolationCount} data entity key violations detected. Data entity keys must be"
-                . " camelCase with a lowercase first letter.",
-                [],
-                true
-            );
-        }
-    }
 }

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

@@ -9,10 +9,10 @@
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\OperationElement;
 use Magento\FunctionalTestingFramework\DataGenerator\Parsers\OperationDefinitionParser;
 use Magento\FunctionalTestingFramework\DataGenerator\Util\OperationElementExtractor;
-use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
 use Magento\FunctionalTestingFramework\ObjectManager\ObjectHandlerInterface;
 use Magento\FunctionalTestingFramework\ObjectManagerFactory;
 use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
+use Magento\FunctionalTestingFramework\Util\Validation\NameValidationUtil;
 
 class OperationDefinitionObjectHandler implements ObjectHandlerInterface
 {
@@ -138,18 +138,9 @@ private function initialize()
         $parser = $objectManager->create(OperationDefinitionParser::class);
         $parserOutput = $parser->readOperationMetadata()[OperationDefinitionObjectHandler::ENTITY_OPERATION_ROOT_TAG];
 
-        $nameViolations = [];
+        $operationNameValidator = new NameValidationUtil(NameValidationUtil::TYPE_METADATA_OPERATION_NAME);
         foreach ($parserOutput as $dataDefName => $opDefArray) {
-            // Check that operation names are PascalCase
-            if (!ctype_upper($dataDefName[0])) {
-                $nameViolations[] = $dataDefName;
-                LoggingUtil::getInstance()->getLogger(self::class)->notification(
-                    "The metadata operation {$dataDefName} should be PascalCase with an uppercase"
-                    . " first letter.",
-                    [],
-                    false
-                );
-            }
+            $operationNameValidator->validatePascalCase($dataDefName);
 
             $operation = $opDefArray[OperationDefinitionObjectHandler::ENTITY_OPERATION_TYPE];
             $dataType = $opDefArray[OperationDefinitionObjectHandler::ENTITY_OPERATION_DATA_TYPE];
@@ -244,27 +235,7 @@ private function initialize()
                 $deprecated
             );
         }
-        $this->logViolationSummary($nameViolations);
-    }
-
-    /**
-     * Output to the log a summary of metadata operation name violations.
-     *
-     * @param string[] $nameViolations An array of metadata operation names that are not PascalCase.
-     * @throws TestFrameworkException
-     * @return void
-     */
-    private function logViolationSummary($nameViolations)
-    {
-        $nameViolationCount = count($nameViolations);
-        if ($nameViolationCount > 0) {
-            LoggingUtil::getInstance()->getLogger(self::class)->notification(
-                "{$nameViolationCount} metadata operation name violations detected. Metadata operation names"
-                . " must be PascalCase with an uppercase first letter.",
-                [],
-                true
-            );
-        }
+        $operationNameValidator->logCountPascalCase();
     }
 
     /**

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

@@ -6,11 +6,11 @@
 
 namespace Magento\FunctionalTestingFramework\Page\Handlers;
 
-use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
 use Magento\FunctionalTestingFramework\ObjectManager\ObjectHandlerInterface;
 use Magento\FunctionalTestingFramework\ObjectManagerFactory;
 use Magento\FunctionalTestingFramework\Page\Objects\PageObject;
 use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
+use Magento\FunctionalTestingFramework\Util\Validation\NameValidationUtil;
 use Magento\FunctionalTestingFramework\XmlParser\PageParser;
 use Magento\FunctionalTestingFramework\Exceptions\XmlException;
 
@@ -55,25 +55,14 @@ private function __construct()
             return;
         }
 
-        $nameViolations = [];
+        $pageNameValidator = new NameValidationUtil(NameValidationUtil::TYPE_PAGE_NAME);
         foreach ($parserOutput as $pageName => $pageData) {
             if (preg_match('/[^a-zA-Z0-9_]/', $pageName)) {
                 throw new XmlException(sprintf(self::NAME_BLACKLIST_ERROR_MSG, $pageName));
             }
 
             $filename = $pageData[self::FILENAME] ?? null;
-
-            // Check that page names are PascalCase
-            if (!ctype_upper($pageName[0])) {
-                $nameViolations[] = $pageName;
-                LoggingUtil::getInstance()->getLogger(self::class)->notification(
-                    "The page name {$pageName} should be PascalCase with an uppercase first letter."
-                    . " See file {$filename}.",
-                    [],
-                    false
-                );
-            }
-
+            $pageNameValidator->validatePascalCase($pageName, $filename);
             $area = $pageData[self::AREA] ?? null;
             $url = $pageData[self::URL] ?? null;
 
@@ -96,7 +85,7 @@ private function __construct()
             $this->pageObjects[$pageName] =
                 new PageObject($pageName, $url, $module, $sectionNames, $parameterized, $area, $filename, $deprecated);
         }
-        $this->logViolationSummary($nameViolations);
+        $pageNameValidator->logCountPascalCase();
     }
 
     /**
@@ -138,24 +127,4 @@ public function getAllObjects()
     {
         return $this->pageObjects;
     }
-
-    /**
-     * Output to the log a summary of page name violations.
-     *
-     * @param string[] $nameViolations An array of page names that are not PascalCase.
-     * @throws TestFrameworkException
-     * @return void
-     */
-    private function logViolationSummary($nameViolations)
-    {
-        $nameViolationCount = count($nameViolations);
-        if ($nameViolationCount > 0) {
-            LoggingUtil::getInstance()->getLogger(self::class)->notification(
-                "{$nameViolationCount} page name violations detected. Page names must be PascalCase with"
-                . " an uppercase first letter.",
-                [],
-                true
-            );
-        }
-    }
 }

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

@@ -12,6 +12,7 @@
 use Magento\FunctionalTestingFramework\Page\Objects\ElementObject;
 use Magento\FunctionalTestingFramework\Page\Objects\SectionObject;
 use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
+use Magento\FunctionalTestingFramework\Util\Validation\NameValidationUtil;
 use Magento\FunctionalTestingFramework\XmlParser\SectionParser;
 use Magento\FunctionalTestingFramework\Exceptions\XmlException;
 
@@ -61,8 +62,8 @@ private function __construct()
             return;
         }
 
-        $sectionNameViolations = [];
-        $elementNameViolations = [];
+        $sectionNameValidator = new NameValidationUtil(NameValidationUtil::TYPE_SECTION_NAME);
+        $elementNameValidator = new NameValidationUtil(NameValidationUtil::TYPE_ELEMENT_NAME);
         foreach ($parserOutput as $sectionName => $sectionData) {
             $elements = [];
 
@@ -71,35 +72,15 @@ private function __construct()
             }
 
             $filename = $sectionData[self::FILENAME] ?? null;
-
-            // Check that section names are PascalCase
-            if (!ctype_upper($sectionName[0])) {
-                $sectionNameViolations[] = $sectionName;
-                LoggingUtil::getInstance()->getLogger(self::class)->notification(
-                    "The section name {$sectionName} should be PascalCase with an uppercase first letter."
-                    . " See file {$filename}.",
-                    [],
-                    false
-                );
-            }
+            $sectionNameValidator->validatePascalCase($sectionName, $filename);
 
             try {
                 foreach ($sectionData[SectionObjectHandler::ELEMENT] as $elementName => $elementData) {
                     if (preg_match('/[^a-zA-Z0-9_]/', $elementName)) {
                         throw new XmlException(sprintf(self::ELEMENT_NAME_ERROR_MSG, $elementName, $sectionName));
                     }
 
-                    // Check that element names are camelCase
-                    if (!ctype_lower($elementName[0])) {
-                        $elementNameViolations[] = $elementName;
-                        LoggingUtil::getInstance()->getLogger(self::class)->notification(
-                            "The section element name {$elementName} should be camelCase with a lowercase"
-                            . " first letter. See file {$filename}.",
-                            [],
-                            false
-                        );
-                    }
-
+                    $elementNameValidator->validateCamelCase($elementName, $filename);
                     $elementType = $elementData[SectionObjectHandler::TYPE] ?? null;
                     $elementSelector = $elementData[SectionObjectHandler::SELECTOR] ?? null;
                     $elementLocatorFunc = $elementData[SectionObjectHandler::LOCATOR_FUNCTION] ?? null;
@@ -142,7 +123,8 @@ private function __construct()
                 $sectionDeprecated
             );
         }
-        $this->logViolationSummary($sectionNameViolations, $elementNameViolations);
+        $sectionNameValidator->logCountPascalCase();
+        $elementNameValidator->logCountCamelCase();
     }
 
     /**
@@ -184,34 +166,4 @@ public function getAllObjects()
     {
         return $this->sectionObjects;
     }
-
-    /**
-     * Output to the log a summary of section name and element name violations.
-     *
-     * @param string[] $sectionNameViolations A list of section names that are not PascalCase.
-     * @param string[] $elementNameViolations A list of element names that are not camelCase.
-     * @throws TestFrameworkException
-     * @return void
-     */
-    private function logViolationSummary($sectionNameViolations, $elementNameViolations)
-    {
-        $nameViolationCount = count($sectionNameViolations);
-        if ($nameViolationCount > 0) {
-            LoggingUtil::getInstance()->getLogger(self::class)->notification(
-                "{$nameViolationCount} section name violations detected. Section names must be PascalCase"
-                . " with an uppercase first letter.",
-                [],
-                true
-            );
-        }
-        $keyViolationCount = count($elementNameViolations);
-        if ($keyViolationCount > 0) {
-            LoggingUtil::getInstance()->getLogger(self::class)->notification(
-                "{$keyViolationCount} section element name violations detected. Element names must be"
-                . " camelCase with a lowercase first letter.",
-                [],
-                true
-            );
-        }
-    }
 }