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

- Add pattern validation

Author: tomreece

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

@@ -55,14 +55,16 @@ private function __construct()
             return;
         }
 
-        $pageNameValidator = new NameValidationUtil(NameValidationUtil::TYPE_PAGE_NAME);
+        $pageNameCaseValidator = new NameValidationUtil(NameValidationUtil::TYPE_PAGE_NAME);
+        $pageNamePatternValidator = new NameValidationUtil(NameValidationUtil::TYPE_PAGE);
         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;
-            $pageNameValidator->validatePascalCase($pageName, $filename);
+            $pageNameCaseValidator->validatePascalCase($pageName, $filename);
+            $pageNamePatternValidator->validateNamePattern($pageName, $filename);
             $area = $pageData[self::AREA] ?? null;
             $url = $pageData[self::URL] ?? null;
 
@@ -85,7 +87,8 @@ private function __construct()
             $this->pageObjects[$pageName] =
                 new PageObject($pageName, $url, $module, $sectionNames, $parameterized, $area, $filename, $deprecated);
         }
-        $pageNameValidator->logCountPascalCase();
+        $pageNameCaseValidator->logCountPascalCase();
+        $pageNamePatternValidator->logCountPattern();
     }
 
     /**

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

@@ -6,7 +6,6 @@
 
 namespace Magento\FunctionalTestingFramework\Page\Handlers;
 
-use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
 use Magento\FunctionalTestingFramework\ObjectManager\ObjectHandlerInterface;
 use Magento\FunctionalTestingFramework\ObjectManagerFactory;
 use Magento\FunctionalTestingFramework\Page\Objects\ElementObject;
@@ -59,7 +58,8 @@ private function __construct()
             return;
         }
 
-        $sectionNameValidator = new NameValidationUtil(NameValidationUtil::TYPE_SECTION_NAME);
+        $sectionNameCaseValidator = new NameValidationUtil(NameValidationUtil::TYPE_SECTION_NAME);
+        $sectionNamePatternValidator = new NameValidationUtil(NameValidationUtil::TYPE_SECTION);
         $elementNameValidator = new NameValidationUtil(NameValidationUtil::TYPE_ELEMENT_NAME);
         foreach ($parserOutput as $sectionName => $sectionData) {
             $elements = [];
@@ -69,7 +69,8 @@ private function __construct()
             }
 
             $filename = $sectionData[self::FILENAME] ?? null;
-            $sectionNameValidator->validatePascalCase($sectionName, $filename);
+            $sectionNameCaseValidator->validatePascalCase($sectionName, $filename);
+            $sectionNamePatternValidator->validateNamePattern($sectionName, $filename);
 
             try {
                 foreach ($sectionData[SectionObjectHandler::ELEMENT] as $elementName => $elementData) {
@@ -120,7 +121,8 @@ private function __construct()
                 $sectionDeprecated
             );
         }
-        $sectionNameValidator->logCountPascalCase();
+        $sectionNameCaseValidator->logCountPascalCase();
+        $sectionNamePatternValidator->logCountPattern();
         $elementNameValidator->logCountCamelCase();
     }
 

src/Magento/FunctionalTestingFramework/Util/Validation/NameValidationUtil.php

@@ -21,6 +21,9 @@ class NameValidationUtil
     const TYPE_TEST_NAME = "test name";
     const TYPE_SECTION_NAME = "section name";
     const TYPE_ELEMENT_NAME = "element name";
+    const TYPE_PAGE = "Page";
+    const TYPE_SECTION = "Section";
+    const NAME_PATTERN_PREFIX = "{Admin or Storefront}{Description}";
 
     /**
      * The number of violations this instance has detected.
@@ -140,6 +143,38 @@ public function validatePascalCase($str, $filename = null)
         }
     }
 
+    /**
+     * Validates that the input string is of the pattern {Admin or Storefront}{Description}{Type}
+     *
+     * @param string $str
+     * @param string $filename
+     * @return void
+     * @throws Exception
+     */
+    public function validateNamePattern($str, $filename = null)
+    {
+        $isPrefixAdmin = substr($str, 0, 5) === "Admin";
+        $isPrefixStorefront = substr($str, 0, 10) === "Storefront";
+        $isSuffixType = substr($str, -strlen($this->type)) === $this->type;
+
+        if ((!$isPrefixAdmin && !$isPrefixStorefront) || !$isSuffixType) {
+            $message = "The {$this->type} name {$str} should follow the pattern "
+                . self::NAME_PATTERN_PREFIX . $this->type . ".";
+
+            if ($filename !== null) {
+                $message .= " See file {$filename}.";
+            }
+
+            LoggingUtil::getInstance()->getLogger(self::class)->notification(
+                $message,
+                [],
+                false
+            );
+
+            $this->count++;
+        }
+    }
+
     /**
      * Outputs a summary message of the count of violations this instance has tracked.
      *
@@ -177,4 +212,23 @@ public function logCountCamelCase()
             );
         }
     }
+
+    /**
+     * Outputs a summary message of the count of violations this instance has tracked.
+     *
+     * @return void
+     * @throws Exception
+     */
+    public function logCountPattern()
+    {
+        if ($this->count > 0) {
+            LoggingUtil::getInstance()->getLogger(self::class)->notification(
+                "{$this->count} {$this->type} name pattern violations detected."
+                . " Use " . self::NAME_PATTERN_PREFIX . $this->type . "."
+                . " See mftf.log for details.",
+                [],
+                true
+            );
+        }
+    }
 }