MFTF deprecation notice attributes

 - fix review comments

Author: okolesnyk

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

@@ -166,8 +166,8 @@ private function processParserOutput($parserOutput)
                 $parentEntity = $rawEntity[self::_EXTENDS];
             }
 
-            if (array_key_exists('deprecated', $rawEntity)) {
-                $deprecated = $rawEntity['deprecated'];
+            if (array_key_exists(self::OBJ_DEPRECATED, $rawEntity)) {
+                $deprecated = $rawEntity[self::OBJ_DEPRECATED];
                 LoggingUtil::getInstance()->getLogger(self::class)->deprecation(
                     $deprecated,
                     ["dataName" => $filename, "deprecatedEntity" => $deprecated]

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

@@ -144,7 +144,7 @@ private function initialize()
             $auth = $opDefArray[OperationDefinitionObjectHandler::ENTITY_OPERATION_AUTH] ?? null;
             $successRegex = $opDefArray[OperationDefinitionObjectHandler::ENTITY_OPERATION_SUCCESS_REGEX] ?? null;
             $returnRegex = $opDefArray[OperationDefinitionObjectHandler::ENTITY_OPERATION_RETURN_REGEX] ?? null;
-            $deprecated = $opDefArray['deprecated'] ?? null;
+            $deprecated = $opDefArray[ObjectHandlerInterface::OBJ_DEPRECATED] ?? null;
             $returnIndex = $opDefArray[OperationDefinitionObjectHandler::ENTITY_OPERATION_RETURN_INDEX] ?? 0;
             $contentType = $opDefArray[OperationDefinitionObjectHandler::ENTITY_OPERATION_CONTENT_TYPE][0]['value']
                 ?? null;

src/Magento/FunctionalTestingFramework/ObjectManager/ObjectHandlerInterface.php

@@ -11,6 +11,8 @@
  */
 interface ObjectHandlerInterface
 {
+    const OBJ_DEPRECATED = 'deprecated';
+
     /**
      * Function to enforce singleton design pattern
      *

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

@@ -69,7 +69,7 @@ private function __construct()
             $sectionNames = array_keys($pageData[self::SECTION] ?? []);
             $parameterized = $pageData[self::PARAMETERIZED] ?? false;
             $filename = $pageData[self::FILENAME] ?? null;
-            $deprecated = $pageData['deprecated'] ?? null;
+            $deprecated = $pageData[self::OBJ_DEPRECATED] ?? null;
 
             if ($deprecated !== null) {
                 LoggingUtil::getInstance()->getLogger(self::class)->deprecation(

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

@@ -75,7 +75,7 @@ private function __construct()
                     $elementLocatorFunc = $elementData[SectionObjectHandler::LOCATOR_FUNCTION] ?? null;
                     $elementTimeout = $elementData[SectionObjectHandler::TIMEOUT] ?? null;
                     $elementParameterized = $elementData[SectionObjectHandler::PARAMETERIZED] ?? false;
-                    $elementDeprecated = $elementData['deprecated'] ?? null;
+                    $elementDeprecated = $elementData[self::OBJ_DEPRECATED] ?? null;
                     if ($elementDeprecated !== null) {
                         LoggingUtil::getInstance()->getLogger(ElementObject::class)->deprecation(
                             $elementDeprecated,
@@ -97,7 +97,7 @@ private function __construct()
             }
 
             $filename = $sectionData[self::FILENAME] ?? null;
-            $sectionDeprecated = $sectionData['deprecated'] ?? null;
+            $sectionDeprecated = $sectionData[self::OBJ_DEPRECATED] ?? null;
 
             if ($sectionDeprecated !== null) {
                 LoggingUtil::getInstance()->getLogger(ElementObject::class)->deprecation(

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

@@ -62,8 +62,8 @@ public function extractActionGroup($actionGroupData)
         $arguments = [];
         $deprecated = null;
 
-        if (array_key_exists('deprecated', $actionGroupData)) {
-            $deprecated = $actionGroupData['deprecated'];
+        if (array_key_exists(self::OBJ_DEPRECATED, $actionGroupData)) {
+            $deprecated = $actionGroupData[self::OBJ_DEPRECATED];
             LoggingUtil::getInstance()->getLogger(ActionGroupObject::class)->deprecation(
                 $deprecated,
                 ["actionGroupName" => $actionGroupData[self::FILENAME], "deprecatedActionGroup" => $deprecated]

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

@@ -13,6 +13,7 @@ class BaseObjectExtractor
 {
     const NODE_NAME = 'nodeName';
     const NAME = 'name';
+    const OBJ_DEPRECATED = 'deprecated';
 
     /**
      * BaseObjectExtractor constructor.

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

@@ -22,7 +22,6 @@
 class TestObjectExtractor extends BaseObjectExtractor
 {
     const TEST_ANNOTATIONS = 'annotations';
-    const TEST_DEPRECATED = 'deprecated';
     const TEST_BEFORE_HOOK = 'before';
     const TEST_AFTER_HOOK = 'after';
     const TEST_FAILED_HOOK = 'failed';
@@ -100,7 +99,7 @@ public function extractTestData($testData)
         $baseFileName = $fileNames[0];
         $module = $this->modulePathExtractor->extractModuleName($baseFileName);
         $testReference = $testData['extends']  ?? null;
-        $deprecated = isset($testData[self::TEST_DEPRECATED]) ? $testData[self::TEST_DEPRECATED] : null;
+        $deprecated = isset($testData[self::OBJ_DEPRECATED]) ? $testData[self::OBJ_DEPRECATED] : null;
         $testActions = $this->stripDescriptorTags(
             $testData,
             self::NODE_NAME,
@@ -112,7 +111,7 @@ public function extractTestData($testData)
             self::TEST_INSERT_BEFORE,
             self::TEST_INSERT_AFTER,
             self::TEST_FILENAME,
-            self::TEST_DEPRECATED,
+            self::OBJ_DEPRECATED,
             'extends'
         );
 
@@ -134,9 +133,9 @@ public function extractTestData($testData)
         }
         $testAnnotations["description"]['test_files'] = $this->appendFileNamesInDescriptionAnnotation($fileNames);
 
-        $testAnnotations["description"][self::TEST_DEPRECATED] = [];
+        $testAnnotations["description"][self::OBJ_DEPRECATED] = [];
         if ($deprecated !== null) {
-            $testAnnotations["description"][self::TEST_DEPRECATED][] = $deprecated;
+            $testAnnotations["description"][self::OBJ_DEPRECATED][] = $deprecated;
             LoggingUtil::getInstance()->getLogger(TestObject::class)->deprecation(
                 $deprecated,
                 ["testName" => $filename, "deprecatedTest" => $deprecated]
@@ -166,8 +165,8 @@ public function extractTestData($testData)
             );
         }
 
-        if (!empty($testData[self::TEST_DEPRECATED])) {
-            $testAnnotations[self::TEST_DEPRECATED] = $testData[self::TEST_DEPRECATED];
+        if (!empty($testData[self::OBJ_DEPRECATED])) {
+            $testAnnotations[self::OBJ_DEPRECATED] = $testData[self::OBJ_DEPRECATED];
         }
 
         // TODO extract filename info and store

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -7,7 +7,6 @@
 namespace Magento\FunctionalTestingFramework\Util;
 
 use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
-use Magento\FunctionalTestingFramework\DataGenerator\Handlers\CredentialStore;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\PersistedObjectHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
 use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
@@ -17,14 +16,11 @@
 use Magento\FunctionalTestingFramework\Test\Handlers\TestObjectHandler;
 use Magento\FunctionalTestingFramework\Test\Objects\ActionGroupObject;
 use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
-use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
 use Magento\FunctionalTestingFramework\Test\Objects\TestHookObject;
 use Magento\FunctionalTestingFramework\Test\Objects\TestObject;
-use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
+use Magento\FunctionalTestingFramework\Test\Util\BaseObjectExtractor;
 use Magento\FunctionalTestingFramework\Util\Manifest\BaseTestManifest;
-use Magento\FunctionalTestingFramework\Util\Manifest\TestManifestFactory;
 use Magento\FunctionalTestingFramework\Test\Util\ActionObjectExtractor;
-use Magento\FunctionalTestingFramework\Test\Util\TestObjectExtractor;
 use Magento\FunctionalTestingFramework\Util\Filesystem\DirSetupUtil;
 use Magento\FunctionalTestingFramework\Test\Util\ActionMergeUtil;
 use Magento\FunctionalTestingFramework\Util\Path\FilePathFormatter;
@@ -510,9 +506,9 @@ private function generateDescriptionAnnotation(array $descriptions)
         $descriptionText = "";
 
         $descriptionText .= $descriptions["main"] ?? '';
-        if (!empty($descriptions[TestObjectExtractor::TEST_DEPRECATED]) || !empty($this->deprecationMessages)) {
+        if (!empty($descriptions[BaseObjectExtractor::OBJ_DEPRECATED]) || !empty($this->deprecationMessages)) {
             $deprecatedMessages = array_merge(
-                $descriptions[TestObjectExtractor::TEST_DEPRECATED],
+                $descriptions[BaseObjectExtractor::OBJ_DEPRECATED],
                 $this->deprecationMessages
             );