Merge remote-tracking branch 'origin/develop' into MQE-2141

Author: soumyau

.gitignore

@@ -19,4 +19,4 @@ dev/tests/mftf.log
 dev/tests/docs/*
 dev/tests/_output
 dev/tests/functional.suite.yml
-mftf-annotations-static-check.txt
+

CHANGELOG.md

@@ -1,5 +1,24 @@
 Magento Functional Testing Framework Changelog
 ================================================
+3.0.0 RC3
+---------
+
+### Enhancements
+
+*  Maintainability
+    * Added support for Two-Factor Authentication (2FA). [See configure-2fa page for details](./docs/configure-2fa.md)  
+    * Added new static check `annotationsCheck` that checks and reports missing annotations in tests.
+    * Updated `mftf static-checks` command to allow executing static-checks defined in `staticRuleSet.json` by default. [See command page for details](./docs/commands/mftf.md#static-checks)
+    * Added new upgrade script to remove unused arguments from action groups.
+    * Added unhandledPromptBehavior driver capability for Chrome 75+ support.
+    * Removed redundant and unused classes.
+
+### Fixes
+
+* Fixed issue with custom helper usage in suites.
+* Fixed issue with decryption of secrets during data entity creation.
+* Fixed issue with merging of `array` items in data entity.
+
 3.0.0 RC2
 ---------
 

docs/commands/mftf.md

@@ -430,13 +430,15 @@ The example parameters are taken from the `etc/config/.env.example` file.
 
 ### `static-checks`
 
-Runs all or specific MFTF static-checks on the test codebase that MFTF is currently attached to.
+Runs all or specific MFTF static-checks on the test codebase that MFTF is currently attached to. 
 Behavior for determining what tests to run is as follows:
 
 *  If test names are specified, only those tests are run.
 *  If no test names are specified, tests are run according to `staticRuleset.json`.
 *  If no `staticRuleset.json` is found, all tests are run.
 
+Static checks errors are written to *.txt files under TEST_BP/tests/_output/static-results/
+
 #### Usage
 
 ```bash

etc/config/functional.suite.dist.yml

@@ -16,6 +16,7 @@ modules:
         - \Magento\FunctionalTestingFramework\Module\MagentoAssert
         - \Magento\FunctionalTestingFramework\Module\MagentoActionProxies
         - Asserts
+        - \Magento\FunctionalTestingFramework\Helper\HelperContainer
     config:
         \Magento\FunctionalTestingFramework\Module\MagentoWebDriver:
             url: "%MAGENTO_BASE_URL%"
@@ -34,5 +35,6 @@ modules:
             protocol: "%SELENIUM_PROTOCOL%"
             path: "%SELENIUM_PATH%"
             capabilities:
-              chromeOptions:
-                args: ["--window-size=1280,1024", "--disable-extensions", "--enable-automation", "--disable-gpu", "--enable-Passthrough"]
+                unhandledPromptBehavior: "ignore"
+                chromeOptions:
+                    args: ["--window-size=1280,1024", "--disable-extensions", "--enable-automation", "--disable-gpu", "--enable-Passthrough", "--disable-dev-shm-usage"]

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

@@ -86,17 +86,6 @@ public function createEntity(
         foreach ($dependentObjectKeys as $objectKey) {
             $retrievedDependentObjects[] = $this->retrieveEntity($objectKey, $scope);
         }
-
-        foreach ($overrideFields as $index => $field) {
-            try {
-                $decrptedField = CredentialStore::getInstance()->decryptAllSecretsInString($field);
-                if ($decrptedField !== false) {
-                    $overrideFields[$index] = $decrptedField;
-                }
-            } catch (TestFrameworkException $e) {
-                //catch exception if Credentials are not defined
-            }
-        }
 
         $retrievedEntity = DataObjectHandler::getInstance()->getObject($entity);
 
@@ -107,6 +96,8 @@ public function createEntity(
             );
         }
 
+        $overrideFields = $this->resolveOverrideFields($overrideFields);
+
         $persistedObject = new DataPersistenceHandler(
             $retrievedEntity,
             $retrievedDependentObjects,
@@ -262,4 +253,29 @@ public function clearSuiteObjects()
     {
         $this->suiteObjects = [];
     }
+
+    /**
+     * Resolve secret values in $overrideFields
+     *
+     * @param array $overrideFields
+     * @return array
+     */
+    private function resolveOverrideFields($overrideFields)
+    {
+        foreach ($overrideFields as $index => $field) {
+            if (is_array($field)) {
+                $overrideFields[$index] = $this->resolveOverrideFields($field);
+            } elseif (is_string($field)) {
+                try {
+                    $decrptedField = CredentialStore::getInstance()->decryptAllSecretsInString($field);
+                    if ($decrptedField !== false) {
+                        $overrideFields[$index] = $decrptedField;
+                    }
+                } catch (TestFrameworkException $e) {
+                    //catch exception if Credentials are not defined
+                }
+            }
+        }
+        return $overrideFields;
+    }
 }

src/Magento/FunctionalTestingFramework/Helper/HelperContainer.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types = 1);
 
 namespace Magento\FunctionalTestingFramework\Helper;
 
@@ -11,20 +12,30 @@
 /**
  * Class HelperContainer
  */
-class HelperContainer
+class HelperContainer extends \Codeception\Module
 {
     /**
      * @var Helper[]
      */
     private $helpers = [];
 
     /**
-     * HelperContainer constructor.
-     * @param array $helpers
+     * Create custom helper class.
+     *
+     * @param string $helperClass
+     * @return Helper
+     * @throws \Exception
      */
-    public function __construct(array $helpers = [])
+    public function create(string $helperClass): Helper
     {
-        $this->helpers = $helpers;
+        if (get_parent_class($helperClass) !== Helper::class) {
+            throw new \Exception("Helper class must extend " . Helper::class);
+        }
+        if (!isset($this->helpers[$helperClass])) {
+            $this->helpers[$helperClass] = $this->moduleContainer->create($helperClass);
+        }
+
+        return $this->helpers[$helperClass];
     }
 
     /**
@@ -34,7 +45,7 @@ public function __construct(array $helpers = [])
      * @return Helper
      * @throws TestFrameworkException
      */
-    public function get(string $className)
+    public function get(string $className): Helper
     {
         if ($this->has($className)) {
             return $this->helpers[$className];
@@ -48,7 +59,7 @@ public function get(string $className)
      * @param string $className
      * @return boolean
      */
-    public function has(string $className)
+    public function has(string $className): bool
     {
         return array_key_exists($className, $this->helpers);
     }

src/Magento/FunctionalTestingFramework/Helper/views/TestInjectMethod.mustache

@@ -6,14 +6,10 @@
     /**
      * Special method which automatically creates the respective objects.
      */
-    public function _inject(
-        {{argumentsWithTypes}}
-    ) {
-        $this->helperContainer = new \Magento\FunctionalTestingFramework\Helper\HelperContainer(
-            [
-            {{#arguments}}
-                '{{type}}' => {{var}},
-            {{/arguments}}
-            ]
-        );
+    public function _inject(\Magento\FunctionalTestingFramework\Helper\HelperContainer $helperContainer)
+    {
+        $this->helperContainer = $helperContainer;
+        {{#arguments}}
+        $this->helperContainer->create("{{type}}");
+        {{/arguments}}
     }

src/Magento/FunctionalTestingFramework/ObjectManager/ObjectHandlerInterface.php

@@ -24,7 +24,7 @@ public static function getInstance();
      * Function to return a single object by name
      *
      * @param string $objectName
-     * @return object
+     * @return mixed
      */
     public function getObject($objectName);
 

src/Magento/FunctionalTestingFramework/StaticCheck/ActionGroupArgumentsCheck.php

@@ -65,7 +65,7 @@ public function execute(InputInterface $input)
 
         $this->output = $this->scriptUtil->printErrorsToFile(
             $this->errors,
-            self::ERROR_LOG_FILENAME,
+            StaticChecksList::getErrorFilesPath() . DIRECTORY_SEPARATOR . self::ERROR_LOG_FILENAME . '.txt',
             self::ERROR_LOG_MESSAGE
         );
     }

src/Magento/FunctionalTestingFramework/StaticCheck/AnnotationsCheck.php

@@ -70,8 +70,11 @@ public function execute(InputInterface $input)
         $allTests = TestObjectHandler::getInstance(false)->getAllObjects();
 
         foreach ($allTests as $test) {
+            if ($this->validateSkipIssueId($test)) {
+                //if test is skipped ignore other checks
+                continue;
+            }
             $this->validateRequiredAnnotations($test);
-            $this->validateSkipIssueId($test);
             $this->aggregateStoriesTitlePairs($test);
             $this->aggregateTestCaseIdTitlePairs($test);
         }
@@ -82,7 +85,7 @@ public function execute(InputInterface $input)
         $scriptUtil = new ScriptUtil();
         $this->output = $scriptUtil->printErrorsToFile(
             $this->errors,
-            self::ERROR_LOG_FILENAME,
+            StaticChecksList::getErrorFilesPath() . DIRECTORY_SEPARATOR . self::ERROR_LOG_FILENAME . '.txt',
             self::ERROR_LOG_MESSAGE
         );
     }
@@ -150,19 +153,22 @@ private function validateRequiredAnnotations($test)
      * Validates that if the test is skipped, that it has an issueId value.
      *
      * @param TestObject $test
-     * @return void
+     * @return boolean
      */
     private function validateSkipIssueId($test)
     {
+        $validateSkipped = false;
         $annotations = $test->getAnnotations();
 
         $skip = $annotations['skip'] ?? null;
         if ($skip !== null) {
-            $issueId = $skip[0] ?? null;
-            if ($issueId === null || strlen($issueId) == 0) {
+            $validateSkipped = true;
+            if ((!isset($skip[0]) || strlen($skip[0]) == 0)
+                && (!isset($skip['issueId']) || strlen($skip['issueId']) == 0)) {
                 $this->errors[][] = "Test {$test->getName()} is skipped but the issueId is empty.";
             }
         }
+        return $validateSkipped;
     }
 
     /**

src/Magento/FunctionalTestingFramework/StaticCheck/DeprecatedEntityUsageCheck.php

@@ -128,7 +128,7 @@ public function execute(InputInterface $input)
         // Hold on to the output and print any errors to a file
         $this->output = $this->scriptUtil->printErrorsToFile(
             $this->errors,
-            self::ERROR_LOG_FILENAME,
+            StaticChecksList::getErrorFilesPath() . DIRECTORY_SEPARATOR . self::ERROR_LOG_FILENAME . '.txt',
             self::ERROR_LOG_MESSAGE
         );
     }

src/Magento/FunctionalTestingFramework/StaticCheck/StaticChecksList.php

@@ -7,13 +7,17 @@
 
 namespace Magento\FunctionalTestingFramework\StaticCheck;
 
+use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
+use Magento\FunctionalTestingFramework\Util\Path\FilePathFormatter;
+
 /**
  * Class StaticChecksList has a list of static checks to run on test xml
  * @codingStandardsIgnoreFile
  */
 class StaticChecksList implements StaticCheckListInterface
 {
     const DEPRECATED_ENTITY_USAGE_CHECK_NAME = 'deprecatedEntityUsage';
+    const STATIC_RESULTS = 'tests' . DIRECTORY_SEPARATOR .'_output' . DIRECTORY_SEPARATOR . 'static-results';
 
     /**
      * Property contains all static check scripts.
@@ -22,10 +26,18 @@ class StaticChecksList implements StaticCheckListInterface
      */
     private $checks;
 
+    /**
+     * Directory path for static checks error files
+     *
+     * @var string
+     */
+    private static $errorFilesPath = null;
+
     /**
      * Constructor
      *
      * @param array $checks
+     * @throws TestFrameworkException
      */
     public function __construct(array $checks = [])
     {
@@ -35,6 +47,11 @@ public function __construct(array $checks = [])
             self::DEPRECATED_ENTITY_USAGE_CHECK_NAME => new DeprecatedEntityUsageCheck(),
             'annotations' => new AnnotationsCheck()
         ] + $checks;
+
+        // Static checks error files directory
+        if (null === self::$errorFilesPath) {
+            self::$errorFilesPath = FilePathFormatter::format(TESTS_BP) . self::STATIC_RESULTS;
+        }
     }
 
     /**
@@ -44,4 +61,12 @@ public function getStaticChecks()
     {
         return $this->checks;
     }
+
+    /**
+     * Return the directory path for the static check error files
+     */
+    public static function getErrorFilesPath()
+    {
+        return self::$errorFilesPath;
+    }
 }

src/Magento/FunctionalTestingFramework/StaticCheck/TestDependencyCheck.php

@@ -121,7 +121,7 @@ public function execute(InputInterface $input)
         // hold on to the output and print any errors to a file
         $this->output = $this->scriptUtil->printErrorsToFile(
             $this->errors,
-            self::ERROR_LOG_FILENAME,
+            StaticChecksList::getErrorFilesPath() . DIRECTORY_SEPARATOR . self::ERROR_LOG_FILENAME . '.txt',
             self::ERROR_LOG_MESSAGE
         );
     }

src/Magento/FunctionalTestingFramework/Suite/Generators/GroupClassGenerator.php

@@ -131,14 +131,18 @@ private function buildHookMustacheArray($hookObj)
     {
         $actions = [];
         $mustacheHookArray['actions'][] = ['webDriverInit' => true];
+        $mustacheHookArray['helpers'] = [];
 
         foreach ($hookObj->getActions() as $action) {
             /** @var ActionObject $action */
             $index = count($actions);
+            if ($action->getType() === ActionObject::ACTION_TYPE_HELPER) {
+                $mustacheHookArray['helpers'][] = $action->getCustomActionAttributes()['class'];
+            }
             //deleteData contains either url or createDataKey, if it contains the former it needs special formatting
             if ($action->getType() !== "createData"
                 && !array_key_exists(TestGenerator::REQUIRED_ENTITY_REFERENCE, $action->getCustomActionAttributes())) {
-                $actions = $this->buildWebDriverActionsMustacheArray($action, $actions, $index);
+                $actions = $this->buildWebDriverActionsMustacheArray($action, $actions);
                 continue;
             }
 

src/Magento/FunctionalTestingFramework/Suite/views/SuiteClass.mustache

@@ -20,12 +20,25 @@ class {{suiteName}} extends \Codeception\GroupObject
     private $testCount = {{testCount}};
     private $preconditionFailure = null;
     private $currentTestRun = 0;
+    {{#helpers}}
+    /**
+     * @var \Magento\FunctionalTestingFramework\Helper\HelperContainer $helperContainer
+     */
+    private $helperContainer;
+    {{/helpers}}
     private static $HOOK_EXECUTION_INIT = "\n/******** Beginning execution of {{suiteName}} suite %s block ********/\n";
     private static $HOOK_EXECUTION_END = "\n/******** Execution of {{suiteName}} suite %s block complete ********/\n";
 
     {{#before}}
     public function _before(\Codeception\Event\TestEvent $e)
     {
+        {{#helpers}}
+        /** @var \Magento\FunctionalTestingFramework\Helper\HelperContainer $helperContainer */
+        $this->helperContainer = $this->getModule('\Magento\FunctionalTestingFramework\Helper\HelperContainer');
+        {{/helpers}}
+        {{#helpers}}
+        $this->helperContainer->create("{{ . }}");
+        {{/helpers}}
         // increment test count per execution
         $this->currentTestRun++;
         $this->executePreConditions();