MQE-1957: Entity Deprecation Reference - Static Check

Author: jilu1

src/Magento/FunctionalTestingFramework/StaticCheck/DeprecatedEntityUsageCheck.php

@@ -10,7 +10,10 @@
 use Magento\FunctionalTestingFramework\Exceptions\XmlException;
 use Magento\FunctionalTestingFramework\Page\Objects\SectionObject;
 use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
-use Symfony\Component\Console\Exception\InvalidArgumentException;
+use Magento\FunctionalTestingFramework\Page\Objects\ElementObject;
+use Magento\FunctionalTestingFramework\Test\Objects\ActionGroupObject;
+use Magento\FunctionalTestingFramework\Page\Objects\PageObject;
+use Magento\FunctionalTestingFramework\Test\Objects\TestObject;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Finder\Finder;
 use Exception;
@@ -26,6 +29,7 @@
 /**
  * Class DeprecatedEntityUsageCheck
  * @package Magento\FunctionalTestingFramework\StaticCheck
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class DeprecatedEntityUsageCheck implements StaticCheckInterface
 {
@@ -68,7 +72,7 @@ class DeprecatedEntityUsageCheck implements StaticCheckInterface
      *
      * @param InputInterface $input
      * @return string
-     * @throws Exception;
+     * @throws Exception
      */
     public function execute(InputInterface $input)
     {
@@ -79,7 +83,7 @@ public function execute(InputInterface $input)
         $path = $input->getOption('path');
         if ($path) {
             if (!realpath($path)) {
-                throw new InvalidArgumentException("Invalid --path option: " . $path);
+                return "Invalid --path option: " . $path;
             }
             MftfApplicationConfig::create(
                 true,
@@ -251,6 +255,7 @@ private function findReferenceErrorsInActionFiles($files)
      *
      * @param Finder $files
      * @return array
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     private function findReferenceErrorsInDataFiles($files)
     {
@@ -329,7 +334,7 @@ private function twoDimensionArrayUnique($inArray)
      * Return attribute value for each node in DOMNodeList as an array
      *
      * @param DOMNodeList $nodes
-     * @param string $attributeName
+     * @param string      $attributeName
      * @return array
      */
     private function getAttributesFromDOMNodeList($nodes, $attributeName)
@@ -411,6 +416,8 @@ private function getMetadataFromData($references, $type)
      *
      * @param array $references
      * @return array
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @SuppressWarnings(PHPMD.NPathComplexity)
      */
     private function findViolatingMetadataReferences($references)
     {
@@ -526,9 +533,9 @@ private function findViolatingReferences($references)
             if ($entity->getDeprecated()) {
                 $classType = get_class($entity);
                 $name = $entity->getName();
-                if ($classType === 'Magento\FunctionalTestingFramework\Page\Objects\ElementObject') {
+                if ($classType === ElementObject::class) {
                     $name = $key;
-                    list($section, $field) = explode('.', $key, 2);
+                    list($section,) = explode('.', $key, 2);
                     /** @var SectionObject $references[$section] */
                     $file = $references[$section]->getFilename();
                 } else {
@@ -578,19 +585,19 @@ private function setErrorOutput($violatingReferences, $path)
     private function getSubjectFromClassType($classname)
     {
         $subject = null;
-        if ($classname === 'Magento\FunctionalTestingFramework\Test\Objects\ActionGroupObject') {
+        if ($classname === ActionGroupObject::class) {
             $subject = 'Deprecated ActionGroup(s)';
-        } elseif ($classname === 'Magento\FunctionalTestingFramework\Test\Objects\TestObject') {
+        } elseif ($classname === TestObject::class) {
             $subject = 'Deprecated Test(s)';
-        } elseif ($classname === 'Magento\FunctionalTestingFramework\Page\Objects\SectionObject') {
+        } elseif ($classname === SectionObject::class) {
             $subject = 'Deprecated Section(s)';
-        } elseif ($classname === 'Magento\FunctionalTestingFramework\Page\Objects\PageObject') {
+        } elseif ($classname === PageObject::class) {
             $subject = 'Deprecated Page(s)';
-        } elseif ($classname === 'Magento\FunctionalTestingFramework\Page\Objects\ElementObject') {
+        } elseif ($classname === ElementObject::class) {
             $subject = 'Deprecated Element(s)';
-        } elseif ($classname === 'Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject') {
+        } elseif ($classname === EntityDataObject::class) {
             $subject = 'Deprecated Data(s)';
-        } elseif ($classname === 'Magento\FunctionalTestingFramework\DataGenerator\Objects\OperationDefinitionObject') {
+        } elseif ($classname === OperationDefinitionObject::class) {
             $subject = 'Deprecated Metadata(s)';
         }
         return $subject;

src/Magento/FunctionalTestingFramework/StaticCheck/TestDependencyCheck.php

@@ -85,7 +85,7 @@ class TestDependencyCheck implements StaticCheckInterface
      *
      * @param InputInterface $input
      * @return string
-     * @throws Exception;
+     * @throws Exception
      */
     public function execute(InputInterface $input)
     {

src/Magento/FunctionalTestingFramework/Util/Script/ScriptUtil.php

@@ -144,7 +144,7 @@ public function resolveEntityReferences($braceReferences, $contents, $resolveSec
             if ($entity !== null) {
                 $entities[$entity->getName()] = $entity;
                 if ($resolveSectionElement) {
-                    if (get_class($entity) === 'Magento\FunctionalTestingFramework\Page\Objects\SectionObject') {
+                    if (get_class($entity) === SectionObject::class) {
                         // trim `{{data.field}}` to `field`
                         preg_match('/.([^.]+)}}/', $reference, $elementName);
                         /** @var ElementObject $element */
@@ -168,6 +168,7 @@ public function resolveEntityReferences($braceReferences, $contents, $resolveSec
      * @param boolean $resolveSectionElement
      * @return array
      * @throws XmlException
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     public function resolveParametrizedReferences($braceReferences, $contents, $resolveSectionElement = false)
     {
@@ -197,7 +198,7 @@ public function resolveParametrizedReferences($braceReferences, $contents, $reso
                 if ($entity !== null) {
                     $entities[$entity->getName()] = $entity;
                     if ($resolveSectionElement) {
-                        if (get_class($entity) === 'Magento\FunctionalTestingFramework\Page\Objects\SectionObject') {
+                        if (get_class($entity) === SectionObject::class) {
                             // trim `data.field` to `field`
                             preg_match('/.([^.]+)/', $argument, $elementName);
                             /** @var ElementObject $element */