MQE-148: Add Code Sniffer static test to Acceptance Test Framework & Tests projects and run it in Jenkins

Author: okolesnyk

src/Magento/AcceptanceTestFramework/DataGenerator/Api/ApiExecutor.php

@@ -1,5 +1,8 @@
 <?php
-
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 namespace Magento\AcceptanceTestFramework\DataGenerator\Api;
 
 use Magento\AcceptanceTestFramework\DataGenerator\Handlers\DataObjectHandler;
@@ -12,8 +15,9 @@ class ApiExecutor
 {
     /**
      * Describes the operation for the executor ('create','update','delete')
-     * @var string $operation
-     **/
+     *
+     * @var string
+     */
     private $operation;
 
     /**
@@ -32,7 +36,6 @@ class ApiExecutor
 
     /**
      * ApiSubObject constructor.
-     * @constructor
      * @param string $operation
      * @param EntityDataObject $entityObject
      */
@@ -49,6 +52,7 @@ public function __construct($operation, $entityObject)
 
     /**
      * Executes an api request based on parameters given by constructor.
+     *
      * @return string | null
      */
     public function executeRequest()
@@ -153,6 +157,7 @@ private function getJsonDataArray($entityObject, $jsonDefMetadata = null)
 
     /**
      * This function retrieves an array representative of json body for a request and returns it encoded as a string.
+     *
      * @return string
      */
     public function getEncodedJsonString()
@@ -162,12 +167,14 @@ public function getEncodedJsonString()
         return json_encode([$this->entityObject->getType() => $jsonArray], JSON_PRETTY_PRINT);
     }
 
+    // @codingStandardsIgnoreStart
     /**
      * This function takes a string value and its corresponding type and returns the string cast
      * into its the type passed.
+     *
      * @param string $type
      * @param string $value
-     * @return bool|float|int|string
+     * @return mixed
      */
     private function castValue($type, $value)
     {
@@ -189,4 +196,5 @@ private function castValue($type, $value)
 
         return $newVal;
     }
+    // @codingStandardsIgnoreEnd
 }

src/Magento/AcceptanceTestFramework/DataGenerator/Api/EntityApiHandler.php

@@ -1,4 +1,8 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 
 namespace Magento\AcceptanceTestFramework\DataGenerator\Api;
 
@@ -8,19 +12,20 @@ class EntityApiHandler
 {
     /**
      * Entity object data to use for create, delete, or update.
+     *
      * @var EntityDataObject $entityObject
      */
     private $entityObject;
 
     /**
      * Resulting created object from create or update.
+     *
      * @var EntityDataObject $createdObject
      */
     private $createdObject;
 
     /**
      * ApiPersistenceHandler constructor.
-     * @constructor
      * @param EntityDataObject $entityObject
      */
     public function __construct($entityObject)
@@ -30,6 +35,7 @@ public function __construct($entityObject)
 
     /**
      * Function which executes a create request based on specific operation metadata
+     *
      * @return string | false
      */
     public function createEntity()
@@ -49,6 +55,7 @@ public function createEntity()
 
     /**
      * Function which executes a delete request based on specific operation metadata
+     *
      * @return string | false
      */
     public function deleteEntity()

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

@@ -7,6 +7,7 @@
 use Magento\AcceptanceTestFramework\ObjectManager\ObjectHandlerInterface;
 use Magento\AcceptanceTestFramework\ObjectManagerFactory;
 
+// @codingStandardsIgnoreFile
 class DataObjectHandler implements ObjectHandlerInterface
 {
     /**

src/Magento/AcceptanceTestFramework/DataGenerator/Handlers/JsonDefinitionObjectHandler.php

@@ -10,12 +10,6 @@
 
 class JsonDefinitionObjectHandler implements ObjectHandlerInterface
 {
-    /**
-     * Singleton Instance of class
-     * @var JsonDefinitionObjectHandler $JSON_DEFINITION_ARRAY_PROCESSOR
-     */
-    private static $JSON_DEFINITION_OBJECT_HANDLER;
-
     const ENTITY_OPERATION_ROOT_TAG = 'operation';
     const ENTITY_OPERATION_TYPE = 'type';
     const ENTITY_OPERATION_DATA_TYPE = 'dataType';
@@ -36,14 +30,23 @@ class JsonDefinitionObjectHandler implements ObjectHandlerInterface
     const ENTITY_OPERATION_ARRAY_KEY = 'key';
     const ENTITY_OPERATION_ARRAY_VALUE = 'value';
 
+    /**
+     * Singleton Instance of class
+     *
+     * @var JsonDefinitionObjectHandler
+     */
+    private static $JSON_DEFINITION_OBJECT_HANDLER;
+
     /**
      * Array containing all Json Definition Objects
-     * @var array $jsonDefinitions
+     *
+     * @var array
      */
     private $jsonDefinitions = [];
 
     /**
      * Singleton method to return JsonDefinitionProcessor.
+     *
      * @return JsonDefinitionObjectHandler
      */
     public static function getInstance()
@@ -58,7 +61,8 @@ public static function getInstance()
 
     /**
      * Returns a JsonDefinition object based on name
-     * @param string $jsonDefitionName
+     *
+     * @param string $jsonDefinitionName
      * @return JsonDefinition
      */
     public function getObject($jsonDefinitionName)
@@ -68,6 +72,7 @@ public function getObject($jsonDefinitionName)
 
     /**
      * Returns all Json Definition objects
+     *
      * @return array
      */
     public function getAllObjects()
@@ -77,7 +82,6 @@ public function getAllObjects()
 
     /**
      * JsonDefintionArrayProcessor constructor.
-     * @constructor
      */
     private function __construct()
     {
@@ -87,6 +91,7 @@ private function __construct()
     /**
      * This method takes an operation such as create and a data type such as 'customer' and returns the corresponding
      * json definition defined in metadata.xml
+     *
      * @param string $operation
      * @param string $dataType
      * @return JsonDefinition
@@ -98,6 +103,7 @@ public function getJsonDefinition($operation, $dataType)
 
     /**
      * This method reads all jsonDefinitions from metadata xml into memory.
+     * @return void
      */
     private function initJsonDefinitions()
     {

src/Magento/AcceptanceTestFramework/DataGenerator/Objects/EntityDataObject.php

@@ -1,30 +1,41 @@
 <?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 
 namespace Magento\AcceptanceTestFramework\DataGenerator\Objects;
 
+/**
+ * Class EntityDataObject
+ */
 class EntityDataObject
 {
     /**
      * Name of the entity
-     * @var string $name
+     *
+     * @var string
      */
     private $name;
 
     /**
      * Type of the entity
-     * @var string $type
+     *
+     * @var string
      */
     private $type;
 
     /**
      * An array of required entity name to corresponding type
-     * @var array $linkedEntities
+     *
+     * @var array
      */
     private $linkedEntities = [];
 
     /**
      * An array of Data Name to Data Value
-     * @var array $data
+     *
+     * @var array
      */
     private $data = [];
 
@@ -45,6 +56,7 @@ public function __construct($entityName, $entityType, $data, $linkedEntities)
 
     /**
      * Getter for linked entity names
+     *
      * @return array
      */
     public function getLinkedEntities()
@@ -54,6 +66,7 @@ public function getLinkedEntities()
 
     /**
      * Getter for entity name
+     *
      * @return string
      */
     public function getName()
@@ -63,6 +76,7 @@ public function getName()
 
     /**
      * Getter for entity type
+     *
      * @return string
      */
     public function getType()
@@ -74,7 +88,7 @@ public function getType()
      * This function retrieves data from an entity defined in xml.
      *
      * @param string $dataName
-     * @return string
+     * @return string|null
      */
     public function getDataByName($dataName)
     {