MFTF deprecation notice attributes

 - added 1 more verification test
 - reduce cli output of deprecated entities

Author: okolesnyk

dev/tests/verification/Resources/DeprecatedEntitiesTest.txt

@@ -0,0 +1,34 @@
+<?php
+namespace Magento\AcceptanceTest\_default\Backend;
+
+use Magento\FunctionalTestingFramework\AcceptanceTester;
+use \Codeception\Util\Locator;
+use Yandex\Allure\Adapter\Annotation\Features;
+use Yandex\Allure\Adapter\Annotation\Stories;
+use Yandex\Allure\Adapter\Annotation\Title;
+use Yandex\Allure\Adapter\Annotation\Description;
+use Yandex\Allure\Adapter\Annotation\Parameter;
+use Yandex\Allure\Adapter\Annotation\Severity;
+use Yandex\Allure\Adapter\Model\SeverityLevel;
+use Yandex\Allure\Adapter\Annotation\TestCaseId;
+
+/**
+ * @Description("<h3 class='y-label y-label_status_broken'>Deprecated Notice(s):</h3><ul><li>DEPRECATED ACTION GROUP in Test: DeprecatedActionGroup Deprecated action group</li><li>DEPRECATED SECTION in Test: {{DeprecatedSection.deprecatedElement}} Deprecated section</li><li>DEPRECATED ELEMENT in Test: {{DeprecatedSection.deprecatedElement}} Deprecated element</li><li>DEPRECATED DATA ENTITY in Test: {{DeprecatedData.field}} Data entity deprecated</li><li>DEPRECATED PAGE in Test: {{DeprecatedPage.url}} Deprecated page</li></ul><h3>Test files</h3>verification/TestModule/Test/DeprecatedEntitiesTest.xml<br>")
+ */
+class DeprecatedEntitiesTestCest
+{
+	/**
+	 * @Features({"TestModule"})
+	 * @Parameter(name = "AcceptanceTester", value="$I")
+	 * @param AcceptanceTester $I
+	 * @return void
+	 * @throws \Exception
+	 */
+	public function DeprecatedEntitiesTest(AcceptanceTester $I)
+	{
+		$I->comment("Entering Action Group [deprecatedActionGroup] DeprecatedActionGroup");
+		$I->see("deprecated", "#element"); // stepKey: deprecatedSeeDeprecatedActionGroup
+		$I->comment("Exiting Action Group [deprecatedActionGroup] DeprecatedActionGroup");
+		$I->amOnPage("/test.html"); // stepKey: amOnPage
+	}
+}

dev/tests/verification/TestModule/Test/DeprecatedEntitiesTest.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+
+<tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="../../../../../src/Magento/FunctionalTestingFramework/Test/etc/testSchema.xsd">
+    <test name="DeprecatedEntitiesTest">
+        <actionGroup ref="DeprecatedActionGroup" stepKey="deprecatedActionGroup" />
+        <amOnPage url="{{DeprecatedPage.url}}" stepKey="amOnPage" />
+    </test>
+</tests>

dev/tests/verification/Tests/DeprecatedTest.php

@@ -19,4 +19,15 @@ public function testDeprecatedTestEntitiesGeneration()
     {
         $this->generateAndCompareTest('DeprecatedTest');
     }
+
+    /**
+     * Tests flat generation of a test which uses deprecated entities.
+     *
+     * @throws \Exception
+     * @throws \Magento\FunctionalTestingFramework\Exceptions\TestReferenceException
+     */
+    public function testDeprecatedEntitiesOnlyGeneration()
+    {
+        $this->generateAndCompareTest('DeprecatedEntitiesTest');
+    }
 }

src/Magento/FunctionalTestingFramework/Config/Reader/Filesystem.php

@@ -235,7 +235,8 @@ protected function validateSchema($configMerger, $filename = null)
                     $error = str_replace(PHP_EOL, "", $error);
                     LoggingUtil::getInstance()->getLogger(Filesystem::class)->criticalFailure(
                         "Schema validation error ",
-                        ($filename ? [ "file"=> $filename, "error" => $error]: ["error" => $error])
+                        ($filename ? [ "file"=> $filename, "error" => $error]: ["error" => $error]),
+                        true
                     );
                 }
                 throw new \Exception("Schema validation errors found in xml file(s)" . $filename);

src/Magento/FunctionalTestingFramework/Test/Objects/ActionObject.php

@@ -314,7 +314,8 @@ public function trimAssertionAttributes()
             if ($appConfig->getPhase() == MftfApplicationConfig::GENERATION_PHASE && $appConfig->verboseEnabled()) {
                 LoggingUtil::getInstance()->getLogger(ActionObject::class)->deprecation(
                     "use of one line Assertion actions will be deprecated in MFTF 3.0.0, please use nested syntax",
-                    ["action" => $this->type, "stepKey" => $this->stepKey]
+                    ["action" => $this->type, "stepKey" => $this->stepKey],
+                    true
                 );
             }
             return;

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

@@ -64,7 +64,8 @@ private function validateMissingAnnotations($annotationObjects, $filename)
             $message = "Action Group File {$filename} is missing required annotations.";
             LoggingUtil::getInstance()->getLogger(ActionObject::class)->deprecation(
                 $message,
-                ["actionGroup" => $filename, "missingAnnotations" => implode(", ", $missingAnnotations)]
+                ["actionGroup" => $filename, "missingAnnotations" => implode(", ", $missingAnnotations)],
+                true
             );
         }
     }

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

@@ -164,7 +164,8 @@ private function validateMissingAnnotations($annotationObjects, $filename)
             $message = "Test {$filename} is missing required annotations.";
             LoggingUtil::getInstance()->getLogger(ActionObject::class)->deprecation(
                 $message,
-                ["testName" => $filename, "missingAnnotations" => implode(", ", $missingAnnotations)]
+                ["testName" => $filename, "missingAnnotations" => implode(", ", $missingAnnotations)],
+                true
             );
         }
     }

src/Magento/FunctionalTestingFramework/Util/Logger/MftfLogger.php

@@ -15,15 +15,17 @@ class MftfLogger extends Logger
     /**
      * Prints a deprecation warning, as well as adds a log at the WARNING level.
      *
-     * @param  string $message The log message.
-     * @param  array  $context The log context.
+     * @param string $message The log message.
+     * @param array $context The log context.
+     * @param bool $verbose
      * @return void
+     * @throws \Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException
      */
-    public function deprecation($message, array $context = [])
+    public function deprecation($message, array $context = [], $verbose = false)
     {
         $message = "DEPRECATION: " . $message;
         // Suppress print during unit testing
-        if (MftfApplicationConfig::getConfig()->getPhase() !== MftfApplicationConfig::UNIT_TEST_PHASE) {
+        if (MftfApplicationConfig::getConfig()->getPhase() !== MftfApplicationConfig::UNIT_TEST_PHASE && $verbose) {
             print ($message . json_encode($context) . "\n");
         }
         parent::warning($message, $context);
@@ -32,15 +34,17 @@ public function deprecation($message, array $context = [])
     /**
      * Prints a critical failure, as well as adds a log at the CRITICAL level.
      *
-     * @param  string $message The log message.
-     * @param  array  $context The log context.
+     * @param string $message The log message.
+     * @param array $context The log context.
+     * @param bool $verbose
      * @return void
+     * @throws \Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException
      */
-    public function criticalFailure($message, array $context = [])
+    public function criticalFailure($message, array $context = [], $verbose = false)
     {
         $message = "FAILURE: " . $message;
         // Suppress print during unit testing
-        if (MftfApplicationConfig::getConfig()->getPhase() !== MftfApplicationConfig::UNIT_TEST_PHASE) {
+        if (MftfApplicationConfig::getConfig()->getPhase() !== MftfApplicationConfig::UNIT_TEST_PHASE && $verbose) {
             print ($message . implode("\n", $context) . "\n");
         }
         parent::critical($message, $context);