MQE-345:[DevOps] [Customizability] Create suite schema declaration and supporting interpretation

- fix for codesniff tests

Author: imeron2433

src/Magento/FunctionalTestingFramework/DataGenerator/Persist/Curl/FrontendExecutor.php

@@ -132,7 +132,7 @@ protected function setCookies()
      * @param string $url
      * @param array $data
      * @param string $method
-     * @param mixed $headers
+     * @param array $headers
      * @return void
      * @throws TestFrameworkException
      */
@@ -190,7 +190,7 @@ public function read($successRegex = null, $returnRegex = null)
      * Add additional option to cURL.
      *
      * @param int $option the CURLOPT_* constants
-     * @param mixed $value
+     * @param int|string|bool|array $value
      * @return void
      */
     public function addOption($option, $value)

src/Magento/FunctionalTestingFramework/Suite/Handlers/SuiteObjectHandler.php

@@ -43,6 +43,9 @@ class SuiteObjectHandler implements ObjectHandlerInterface
      */
     private $suiteObjects;
 
+    /**
+     * SuiteObjectHandler constructor.
+     */
     private function __construct()
     {
         // empty constructor
@@ -87,12 +90,23 @@ public function getAllObjects()
         return $this->suiteObjects;
     }
 
+    /**
+     * Method to parse all suite data xml into objects.
+     *
+     * @return void
+     */
     private function initSuiteData()
     {
         $suiteDataParser = ObjectManagerFactory::getObjectManager()->create(SuiteDataParser::class);
         $this->suiteObjects = $this->parseSuiteDataIntoObjects($suiteDataParser->readSuiteData());
     }
 
+    /**
+     * Takes an array of parsed xml and converts into an array of suite objects.
+     *
+     * @param array $parsedSuiteData
+     * @return array
+     */
     private function parseSuiteDataIntoObjects($parsedSuiteData)
     {
         $suiteObjects = [];
@@ -114,7 +128,6 @@ private function parseSuiteDataIntoObjects($parsedSuiteData)
             $includeCests = $includeCests + $this->extractGroups($groupCestsToInclude);
             $excludeCests = $excludeCests + $this->extractGroups($groupCestsToExclude);
 
-
             // get tests by path (dir or file)
             if (array_key_exists(self::MODULE_TAG_NAME, $groupCestsToInclude)) {
                 $includeCests = array_merge(
@@ -141,6 +154,12 @@ private function parseSuiteDataIntoObjects($parsedSuiteData)
         return $suiteObjects;
     }
 
+    /**
+     * Takes an array of Cests/Tests and resolves names into corresponding Cest/Test objects.
+     *
+     * @param array $suiteTestData
+     * @return array
+     */
     private function extractRelevantTests($suiteTestData)
     {
         $relevantCests = [];
@@ -174,6 +193,12 @@ private function extractRelevantTests($suiteTestData)
         return $relevantCests;
     }
 
+    /**
+     * Takes an array of group names and resolves to Cest/Test objects.
+     *
+     * @param array $suiteData
+     * @return array
+     */
     private function extractGroups($suiteData)
     {
         $cestsByGroup = [];
@@ -188,6 +213,12 @@ private function extractGroups($suiteData)
         return $cestsByGroup;
     }
 
+    /**
+     * Takes an array of modules/files and resolves to an array of cest objects.
+     *
+     * @param array $suitePathData
+     * @return array
+     */
     private function extractModuleAndFiles($suitePathData)
     {
         $cestsByModule = [];
@@ -203,6 +234,14 @@ private function extractModuleAndFiles($suitePathData)
         return $cestsByModule;
     }
 
+    /**
+     * Takes a filepath (and optionally a module name) and resolves to a cest object.
+     *
+     * @param string $filename
+     * @param null $moduleName
+     * @return CestObject
+     * @throws Exception
+     */
     private function resolveFilePathCestName($filename, $moduleName = null)
     {
         $filepath = $filename;
@@ -225,6 +264,12 @@ private function resolveFilePathCestName($filename, $moduleName = null)
         return CestObjectHandler::getInstance()->getObject($cestName);
     }
 
+    /**
+     * Takes a single module name and resolves to an array of cests contained within specified module.
+     *
+     * @param string $moduleName
+     * @return array
+     */
     private function resolveModulePathCestNames($moduleName)
     {
         $cestObjects = [];
@@ -245,4 +290,4 @@ private function resolveModulePathCestNames($moduleName)
 
         return $cestObjects;
     }
-}
+}

src/Magento/FunctionalTestingFramework/Suite/Objects/SuiteObject.php

@@ -19,23 +19,20 @@ class SuiteObject
      */
     private $name;
 
-
     /**
      * Array of Cests to include for the suite.
      *
      * @var array
      */
     private $includeCests = [];
 
-
     /**
      * Array of Cests to exclude for the suite.
      *
      * @var array
      */
     private $excludeCests = [];
 
-
     /**
      * SuiteObject constructor.
      * @param string $name
@@ -134,6 +131,8 @@ private function resolveTests($relevantTestNames, $tests)
 
     /**
      * Getter for before hooks.
+     *
+     * @return void
      */
     public function getBeforeHook()
     {
@@ -142,9 +141,11 @@ public function getBeforeHook()
 
     /**
      * Getter for after hooks.
+     *
+     * @return void
      */
     public function getAfterHook()
     {
         //TODO implement getter for after hooks
     }
-}
+}

src/Magento/FunctionalTestingFramework/Suite/Parsers/SuiteDataParser.php

@@ -35,4 +35,4 @@ public function readSuiteData()
     {
         return $this->suiteData->get();
     }
-}
+}

src/Magento/FunctionalTestingFramework/Suite/SuiteGenerator.php

@@ -55,6 +55,7 @@ public static function getInstance()
      * yml configuration for group run.
      *
      * @param string $suiteName
+     * @return void
      */
     public function generateSuite($suiteName)
     {
@@ -71,6 +72,8 @@ public function generateSuite($suiteName)
 
     /**
      * Method which will be needed for adding preconditions and creating a corresponding group file for codeception.
+     *
+     * @return void
      */
     private function generateGroupFile()
     {
@@ -83,6 +86,7 @@ private function generateGroupFile()
      *
      * @param string $suiteName
      * @param string $suitePath
+     * @return void
      */
     private function appendGroupEntryToConfig($suiteName, $suitePath)
     {
@@ -116,10 +120,11 @@ private function appendGroupEntryToConfig($suiteName, $suitePath)
      *
      * @param string $path
      * @param array $cests
+     * @return void
      */
     private function generateRelevantGroupTests($path, $cests)
     {
         $testGenerator = TestGenerator::getInstance($path, $cests);
         $testGenerator->createAllCestFiles();
     }
-}
+}

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

@@ -74,6 +74,12 @@ public function getAnnotations()
         return $this->annotations;
     }
 
+    /**
+     * Returns the value(s) of an annotation by a specific name such as group
+     *
+     * @param string $name
+     * @return array
+     */
     public function getAnnotationByName($name)
     {
         if (array_key_exists($name, $this->annotations)) {

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

@@ -78,6 +78,12 @@ public function getAnnotations()
         return $this->annotations;
     }
 
+    /**
+     * Method to return the value(s) of a corresponding annotation such as group.
+     *
+     * @param string $name
+     * @return array
+     */
     public function getAnnotationByName($name)
     {
         if (array_key_exists($name, $this->annotations)) {

src/Magento/FunctionalTestingFramework/Util/Filesystem/DirSetupUtil.php

@@ -10,6 +10,7 @@ class DirSetupUtil
     /**
      * Method used to clean export dir if needed and create new empty export dir.
      *
+     * @param string $fullPath
      * @return void
      */
     public static function createGroupDir($fullPath)
@@ -44,4 +45,4 @@ private static function rmdirRecursive($directory)
 
         rmdir($directory);
     }
-}
+}

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -20,7 +20,6 @@ class TestGenerator
     const REQUIRED_ENTITY_REFERENCE = 'createDataKey';
     const GENERATED_DIR = '_generated';
 
-
     /**
      * Path to the export dir.
      *
@@ -44,20 +43,26 @@ class TestGenerator
 
     /**
      * TestGenerator constructor.
+     *
      * @param string $exportDir
+     * @param array $cests
      */
     private function __construct($exportDir, $cests)
     {
         // private constructor for factory
         $this->exportDirName = $exportDir ?? self::GENERATED_DIR;
-        $this->exportDirectory = rtrim(TESTS_MODULE_PATH . DIRECTORY_SEPARATOR .
-            self::GENERATED_DIR . DIRECTORY_SEPARATOR . $exportDir, DIRECTORY_SEPARATOR);
+        $this->exportDirectory = rtrim(
+            TESTS_MODULE_PATH . DIRECTORY_SEPARATOR . self::GENERATED_DIR . DIRECTORY_SEPARATOR . $exportDir,
+            DIRECTORY_SEPARATOR
+        );
         $this->cests = $cests;
     }
 
     /**
      * Singleton method to retrieve Test Generator
      *
+     * @param string $dir
+     * @param array $cests
      * @return TestGenerator
      */
     public static function getInstance($dir = null, $cests = null)