Merge pull request #16 from magento-commerce/3.2.1-RC

3.2.1 rc

Author: jilu1

CHANGELOG.md

@@ -1,6 +1,18 @@
 Magento Functional Testing Framework Changelog
 ================================================
 
+3.2.1
+---------
+
+### Fixes
+
+* Fixed issue that causes Magento bin/magento to fail when xdebug 3 is used. [GitHub Issue #808](https://github.com/magento/magento2-functional-testing-framework/issues/808)
+
+### GitHub Pull Requests:
+
+  * [#806](https://github.com/magento/magento2-functional-testing-framework/pull/806) -- Enable an extending entity to overwrite a requiredEntity binding
+  * [#809](https://github.com/magento/magento2-functional-testing-framework/pull/809) -- Add MFTF documentation for AWS S3
+
 3.2.0
 ---------
 
@@ -53,7 +65,7 @@ Fixed issue with XPath locators for waits in MagentoPwaWebDriver.
 
 * Fixed issue with suite precondition failure for `createData` with required entity.
 
-### GitHub Issues/Pull requests:
+### GitHub Issues/Pull Requests:
 
   * [#547](https://github.com/magento/magento2-functional-testing-framework/pull/547) -- Fix invalid behavior of MAGENTO_BACKEND_BASE_URL
   * [#742](https://github.com/magento/magento2-functional-testing-framework/pull/742) -- Fix Waits In MagentoPwaWebDriver

composer.json

@@ -2,7 +2,7 @@
     "name": "magento/magento2-functional-testing-framework",
     "description": "Magento2 Functional Testing Framework",
     "type": "library",
-    "version": "3.2.0",
+    "version": "3.2.1",
     "license": "AGPL-3.0",
     "keywords": ["magento", "automation", "functional", "testing"],
     "config": {

composer.lock

@@ -70,10 +70,3 @@
 
 $RELATIVE_TESTS_MODULE_PATH = '/tests/functional/tests/MFTF';
 defined('TESTS_MODULE_PATH') || define('TESTS_MODULE_PATH', realpath(TESTS_BP . $RELATIVE_TESTS_MODULE_PATH));
-
-
-// add the debug flag here
-$debug_mode = $_ENV['MFTF_DEBUG'] ?? false;
-if (!(bool)$debug_mode && extension_loaded('xdebug')) {
-    xdebug_disable();
-}

dev/tests/functional/standalone_bootstrap.php

@@ -477,6 +477,60 @@ public function testNestedMetadataArrayOfDiverseObjects()
         $this->assertEquals($expectedResult, $result);
     }
 
+    public function testExtendedWithRequiredEntity()
+    {
+        $entityDataObjectBuilder = new EntityDataObjectBuilder();
+        $extEntityDataObject = $entityDataObjectBuilder
+            ->withName("extEntity")
+            ->withType("entity")
+            ->withLinkedEntities(["baseSubentity" => "subentity","extSubentity" => "subentity"])
+            ->build();
+
+        $mockDOHInstance = AspectMock::double(DataObjectHandler::class, ["getObject" => function ($name) {
+            $entityDataObjectBuilder = new EntityDataObjectBuilder();
+
+            if ($name == "baseSubentity") {
+                return $entityDataObjectBuilder
+                    ->withName("baseSubentity")
+                    ->withType("subentity")
+                    ->withDataFields(["subtest" => "BaseSubtest"])
+                    ->build();
+            }
+
+            if ($name == "extSubentity") {
+                return $entityDataObjectBuilder
+                    ->withName("extSubentity")
+                    ->withType("subentity")
+                    ->withDataFields(["subtest" => "ExtSubtest"])
+                    ->build();
+            }
+        }])->make();
+        AspectMock::double(DataObjectHandler::class, ['getInstance' => $mockDOHInstance]);
+
+        $subentityOpElementBuilder = new OperationElementBuilder();
+        $subentityOpElement = $subentityOpElementBuilder
+            ->withKey("sub")
+            ->withType("subentity")
+            ->withElementType("object")
+            ->withFields(["subtest" => "string"])
+            ->build();
+
+        $operationResolver = new OperationDataArrayResolver();
+        $result = $operationResolver->resolveOperationDataArray(
+            $extEntityDataObject,
+            [$subentityOpElement],
+            "create",
+            false
+        );
+
+        $expected = [
+            "sub" => [
+                "subtest" => "ExtSubtest"
+            ]
+        ];
+
+        $this->assertEquals($expected, $result);
+    }
     /**
      * After class functionality
      * @return void

dev/tests/unit/Magento/FunctionalTestFramework/DataGenerator/Persist/OperationDataArrayResolverTest.php

@@ -368,6 +368,46 @@ When pause is enabled, MFTF will generate pause() command in _failed() hook so t
 ENABLE_PAUSE=true
 ```
 
+### REMOTE_STORAGE_AWSS3_DRIVER
+
+The remote storage driver. To enable AWS S3, use `aws-s3`.
+
+Example:
+
+```conf
+REMOTE_STORAGE_AWSS3_DRIVER=aws-s3
+```
+
+### REMOTE_STORAGE_AWSS3_REGION
+
+The region of S3 bucket.
+
+Example:
+
+```conf
+REMOTE_STORAGE_AWSS3_REGION=us-west-2
+```
+
+### REMOTE_STORAGE_AWSS3_BUCKET
+
+The name of S3 bucket.
+
+Example:
+
+```conf
+REMOTE_STORAGE_AWSS3_BUCKET=my-test-bucket
+```
+
+### REMOTE_STORAGE_AWSS3_PREFIX
+
+The optional prefix inside S3 bucket.
+
+Example:
+
+```conf
+REMOTE_STORAGE_AWSS3_PREFIX=local
+```
+
 <!-- Link definitions -->
 
 [`MAGENTO_CLI_COMMAND_PATH`]: #magento_cli_command_path

docs/configuration.md

@@ -100,17 +100,15 @@ private function __construct(
 
         $this->phase = $phase;
         $this->verboseEnabled = $verboseEnabled;
-        if (isset($debugLevel) && !in_array(strtolower($debugLevel), self::MFTF_DEBUG_LEVEL)) {
+        if (!in_array(strtolower($debugLevel), self::MFTF_DEBUG_LEVEL)) {
             throw new TestFrameworkException("{$debugLevel} is not a debug level. Use 'DEFAULT' or 'DEVELOPER'");
         }
         switch (strtolower($debugLevel)) {
-            case self::LEVEL_DEVELOPER:
             case self::LEVEL_DEFAULT:
-                $this->debugLevel = $debugLevel;
+                $this->debugLevel = self::LEVEL_DEFAULT;
                 break;
-            case null:
+            default:
                 $this->debugLevel = self::LEVEL_DEVELOPER;
-                break;
         }
         $this->allowSkipped = $allowSkipped;
         $this->filterList = new FilterList($filters);
@@ -196,7 +194,7 @@ public function verboseEnabled()
      */
     public function getDebugLevel()
     {
-        return $this->debugLevel ?? getenv('MFTF_DEBUG');
+        return $this->debugLevel;
     }
 
     /**

src/Magento/FunctionalTestingFramework/Config/MftfApplicationConfig.php

@@ -245,10 +245,11 @@ private function getDependentEntitiesOfType($type)
     private function resolveOperationObjectAndEntityData($entityObject, $operationElementValue)
     {
         if ($operationElementValue != $entityObject->getType()) {
-            // if we have a mismatch attempt to retrieve linked data and return just the first linkage
+            // if we have a mismatch attempt to retrieve linked data and return just the last linkage
+            // this enables overwriting of required entity fields
             $linkName = $entityObject->getLinkedEntitiesOfType($operationElementValue);
             if (!empty($linkName)) {
-                $linkName = $linkName[0];
+                $linkName = array_pop($linkName);
                 return DataObjectHandler::getInstance()->getObject($linkName);
             }
             return null;

src/Magento/FunctionalTestingFramework/DataGenerator/Persist/OperationDataArrayResolver.php

@@ -74,9 +74,3 @@
     'TESTS_MODULE_PATH',
     realpath(TESTS_BP . $RELATIVE_TESTS_MODULE_PATH)
 );
-
-// add the debug flag here
-$debugMode = $_ENV['MFTF_DEBUG'] ?? false;
-if (!(bool)$debugMode && extension_loaded('xdebug')) {
-    xdebug_disable();
-}