MQE-942: MFTF Annotation Static Check

Author: tomreece

src/Magento/FunctionalTestingFramework/StaticCheck/AnnotationsCheck.php

@@ -8,6 +8,7 @@
 
 use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
 use Magento\FunctionalTestingFramework\Test\Handlers\TestObjectHandler;
+use Magento\FunctionalTestingFramework\Test\Objects\TestObject;
 use Magento\FunctionalTestingFramework\Util\Script\ScriptUtil;
 use Symfony\Component\Console\Input\InputInterface;
 use Exception;
@@ -110,7 +111,8 @@ public function getOutput()
      *   description
      *   severity
      *
-     * @param $test
+     * @param TestObject $test
+     * @return void
      */
     private function validateRequiredAnnotations($test)
     {
@@ -146,7 +148,8 @@ private function validateRequiredAnnotations($test)
     /**
      * Add the key = "stories appended to title", value = test name, to the class variable.
      *
-     * @param $test
+     * @param TestObject $test
+     * @return void
      */
     private function aggregateStoriesTitlePairs($test)
     {
@@ -161,7 +164,8 @@ private function aggregateStoriesTitlePairs($test)
     /**
      * Add the key = "testCaseId appended to title", value = test name, to the class variable.
      *
-     * @param $test
+     * @param TestObject $test
+     * @return void
      */
     private function aggregateTestCaseIdTitlePairs($test)
     {
@@ -177,7 +181,7 @@ private function aggregateTestCaseIdTitlePairs($test)
      * Strip away the testCaseId prefix that was automatically added to the test title
      * so that way we have just the raw title from the XML file.
      *
-     * @param $test
+     * @param TestObject $test
      * @return string|null
      */
     private function getTestTitleWithoutPrefix($test)
@@ -194,6 +198,8 @@ private function getTestTitleWithoutPrefix($test)
 
     /**
      * Adds an error if any story+title pairs are used by more than one test.
+     *
+     * @return void
      */
     private function validateStoriesTitlePairs()
     {
@@ -206,6 +212,8 @@ private function validateStoriesTitlePairs()
 
     /**
      * Adds an error if any testCaseId+title pairs are used by more than one test.
+     *
+     * @return void
      */
     private function validateTestCaseIdTitlePairs()
     {

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

@@ -17,12 +17,13 @@ class ActionGroupAnnotationExtractor extends AnnotationExtractor
      * This method trims away irrelevant tags and returns annotations used in the array passed. The annotations
      * can be found in both Tests and their child element tests.
      *
-     * @param array  $testAnnotations
-     * @param string $filename
+     * @param array   $testAnnotations
+     * @param string  $filename
+     * @param boolean $validateAnnotations
      * @return array
      * @throws \Exception
      */
-    public function extractAnnotations($testAnnotations, $filename)
+    public function extractAnnotations($testAnnotations, $filename, $validateAnnotations = true)
     {
         $annotationObjects = [];
         $annotations = $this->stripDescriptorTags($testAnnotations, parent::NODE_NAME);

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

@@ -59,6 +59,7 @@ public function __construct()
      * @param string $filename
      * @return array
      * @throws XmlException
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     public function extractAnnotations($testAnnotations, $filename, $validateAnnotations = true)
     {