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

soumyau · soumyau · commit bf4568118165 · 2020-03-10T11:14:06.000-05:00
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,5 @@
 language: php
 php:
-  - 7.0
-  - 7.1
   - 7.2
   - 7.3
 install: composer install --no-interaction --prefer-source
diff --git a/composer.json b/composer.json
@@ -2,14 +2,14 @@
     "name": "magento/magento2-functional-testing-framework",
     "description": "Magento2 Functional Testing Framework",
     "type": "library",
-    "version": "2.6.3",
+    "version": "3.0.0",
     "license": "AGPL-3.0",
     "keywords": ["magento", "automation", "functional", "testing"],
     "config": {
         "sort-packages": true
     },
     "require": {
-        "php": "7.0.2||7.0.4||~7.0.6||~7.1.0||~7.2.0||~7.3.0",
+        "php": "~7.2.0||~7.3.0",
         "ext-curl": "*",
         "ext-json": "*",
         "ext-openssl": "*",
diff --git a/composer.lock b/composer.lock
diff --git a/dev/tests/functional/standalone_bootstrap.php b/dev/tests/functional/standalone_bootstrap.php
@@ -51,7 +51,7 @@
     $env->setEnvironmentVariable('DEFAULT_TIMEZONE', DEFAULT_TIMEZONE);
 
     defined('WAIT_TIMEOUT') || define('WAIT_TIMEOUT', 30);
-    $env->setEnvironmentVariable('WAIT_TIMEOUT', 30);
+    $env->setEnvironmentVariable('WAIT_TIMEOUT', WAIT_TIMEOUT);
 
     try {
         new DateTimeZone(DEFAULT_TIMEZONE);
diff --git a/dev/tests/unit/Magento/FunctionalTestFramework/Util/ModuleResolverTest.php b/dev/tests/unit/Magento/FunctionalTestFramework/Util/ModuleResolverTest.php
@@ -146,20 +146,6 @@ function ($arg) {
                 'Test' . DIRECTORY_SEPARATOR .'Mftf'
             ]
         );
-        $mockResolver->verifyInvoked(
-            'globRelevantPaths',
-            [
-                $magentoBaseCodePath
-                    . DIRECTORY_SEPARATOR . "dev"
-                    . DIRECTORY_SEPARATOR . "tests"
-                    . DIRECTORY_SEPARATOR . "acceptance"
-                    . DIRECTORY_SEPARATOR . "tests"
-                    . DIRECTORY_SEPARATOR . "functional"
-                    . DIRECTORY_SEPARATOR . "Magento"
-                    . DIRECTORY_SEPARATOR . "FunctionalTest"
-                , ''
-            ]
-        );
     }
 
     /**
diff --git a/docs/metadata.md b/docs/metadata.md
@@ -67,8 +67,8 @@ The following diagram demonstrates the XML structure of a metadata file:
 ## Principles {#principles}
 
 1. A `dataType` value must match the `type` value of the corresponding entity.
-2. A file name should contain data type split with `_` and must end with `-meta`.
-   Example: `product_attribute-meta.xml`.
+2. A file name should be PascalCase and end with `Meta.xml`.
+   Example: `ProductAttributeMeta.xml`.
 3. A metadata file may contain different types of operations (`type`) with the same data entity (`dataType`).
 
 Example:
@@ -139,7 +139,7 @@ _Catalog/Data/CategoryData.xml_:
 Here, `type` is equal to `"category"`, which instructs the MFTF to search an operation with `dataType="category"`.
 Since the action is __to create__ a category, the MFTF will also search for operation with `type="create"` in _Metadata_ for `dataType="category"`.
 
-_Catalog/Metadata/category-meta.xml_:
+_Catalog/Metadata/CategoryMeta.xml_:
 
 ```xml
 <operation name="CreateCategory" dataType="category" type="create" auth="adminOauth" url="/V1/categories" method="POST">
@@ -187,10 +187,10 @@ Comments in the example below are used to demonstrate relation between JSON requ
 JSON does not support comments.
 </div>
 
-Model schema for _catalogCategoryRepositoryV1SavePostBody_ with XML representation of _Catalog/Metadata/category-meta.xml_ in comments:
+Model schema for _catalogCategoryRepositoryV1SavePostBody_ with XML representation of _Catalog/Metadata/CategoryMeta.xml_ in comments:
 
 ```json
-{                                           // XML representation in the MFTF metadata format (see 'Catalog/Metadata/category-meta.xml')
+{                                           // XML representation in the MFTF metadata format (see 'Catalog/Metadata/CategoryMeta.xml')
   "category": {                             // <object key="category" dataType="category">
     "id": 0,                                // Skipped, because Category ID is not available on UI when you create a new category.
     "parent_id": 0,                         // <field key="parent_id">integer</field>
@@ -206,9 +206,9 @@ Model schema for _catalogCategoryRepositoryV1SavePostBody_ with XML representati
       "string"                              // <value>string</value>
     ],                                      // </array>
     "include_in_menu": true,                // <field key="include_in_menu">boolean</field>
-    "extension_attributes": {},             // <field key="extension_attributes">empty_extension_attribute</field>, where 'empty_extension_attribute' is a reference to operation with 'dataType="empty_extension_attribute"' (see 'Catalog/Metadata/empty_extension_attribute-meta.xml')
+    "extension_attributes": {},             // <field key="extension_attributes">empty_extension_attribute</field>, where 'empty_extension_attribute' is a reference to operation with 'dataType="empty_extension_attribute"' (see 'Catalog/Metadata/EmptyExtensionAttributeMeta.xml')
     "custom_attributes": [                  // <array key="custom_attributes">
-      {                                     // <value>custom_attribute</value>, where 'custom_attribute' is a reference to operation with 'dataType="custom_attribute"' (see 'Catalog/Metadata/custom_attribute-meta.xml')
+      {                                     // <value>custom_attribute</value>, where 'custom_attribute' is a reference to operation with 'dataType="custom_attribute"' (see 'Catalog/Metadata/CustomAttributeMeta.xml')
         "attribute_code": "string",
         "value": "string"
       }
@@ -343,7 +343,7 @@ You are able to create assurances with `successRegex`, and, optionally, return v
 
 The `CreateStoreGroup` operation is used to persist a store group:
 
-Source file is _Store/Metadata/store_group-meta.xml_:
+Source file is _Store/Metadata/StoreGroupMeta.xml_:
 
 ```xml
 <operation name="CreateStoreGroup" dataType="group" type="create" auth="adminFormKey" url="/admin/system_store/save" method="POST" successRegex="/messages-message-success/" >
@@ -379,7 +379,7 @@ The operation enables you to assign the following form fields:
 
 The MFTF uses the `CreateWishlist` operation to create a wish list on storefront:
 
-Source file is _Wishlist/Metadata/wishlist-meta.xml_
+Source file is _Wishlist/Metadata/WishlistMeta.xml_
 
 ```xml
 <operation name="CreateWishlist" dataType="wishlist" type="create" auth="customerFormKey" url="/wishlist/index/add/" method="POST" successRegex="" returnRegex="~\/wishlist_id\/(\d*?)\/~" >
diff --git a/docs/mftf-tests-packaging.md b/docs/mftf-tests-packaging.md
@@ -0,0 +1,58 @@
+<style>
+.mftf-dl {
+  margin-bottom: 2.5em;
+}
+dl dt{
+  font-weight:400;
+}
+</style>
+
+# MFTF functional test modules and packaging
+
+## MFTF predefined test module paths
+The Magento Functional Testing Framework can run tests from predefined paths and custom paths. The predefined paths are:
+```
+app/code/<Vendor>/<Module>/Test/Mftf
+dev/tests/acceptance/tests/functional/<Vendor>/<TestModule>
+vendor/<Vendor>/<Module>/Test/Mftf
+vendor/<Vendor>/<TestModule>
+```
+
+To support future service isolation, Test module in `dev/tests/acceptance/tests/functional/<Vendor>/<TestModule>` and 
+`vendor/<Vendor>/<TestModule>` must define the module type as `magento2-functional-test-module` in its `composer.json` file. 
+No `composer.json` file is required for tests in `app/code/<Vendor>/<Module>/Test/Mftf` and `vendor/<Vendor>/<Module>/Test/Mftf` 
+as they are part of the Magento modules.
+
+Test module for a specific Magento module can only be in one of the paths.
+
+## Test module composer.json format
+
+Test module `composer.json` file should use type `magento2-functional-test-module`.
+
+Test module `composer.json` file should define Magento module dependencies in suggests block. 
+MFTF will recognize the dependency if the suggest message of a module specifies `type` using `magento2-module` and `name` 
+using module name registered with Magento.
+
+Here is an example `composer.json` file for the test module `dev/tests/acceptance/tests/functional/Magento/ConfigurableProductCatalogSearch`:
+
+```json
+{
+    "name": "magento/module-configurable-product-catalog-search-functional-test",
+    "description": "MFTF test module for Magento_ConfigurableProduct and Magento_CatalogSearch",
+    "type": "magento2-functional-test-module",
+    "config": {
+        "sort-packages": true
+    },
+    "require": {
+        "magento/magento2-functional-testing-framework": ">=2.5"
+    },
+    "suggest": {
+        "magento/module-configurable-product": "type: magento2-module, name: Magento_ConfigurableProduct, version: *",
+        "magento/module-catalog-search": "type: magento2-module, name: Magento_CatalogSearch, version: *"
+    },
+    "license": [
+        "OSL-3.0",
+        "AFL-3.0"
+    ]
+}
+```
diff --git a/etc/config/functional.suite.dist.yml b/etc/config/functional.suite.dist.yml
@@ -29,6 +29,8 @@ modules:
             username: "%MAGENTO_ADMIN_USERNAME%"
             password: "%MAGENTO_ADMIN_PASSWORD%"
             pageload_timeout: "%WAIT_TIMEOUT%"
+            request_timeout: "%WAIT_TIMEOUT%"
+            connection_timeout: "%WAIT_TIMEOUT%"
             host: "%SELENIUM_HOST%"
             port: "%SELENIUM_PORT%"
             protocol: "%SELENIUM_PROTOCOL%"
diff --git a/etc/di.xml b/etc/di.xml
@@ -198,7 +198,7 @@
             <argument name="mergeablePaths" xsi:type="array">
                 <item name="/operations/operation/object" xsi:type="string"/>
             </argument>
-            <argument name="fileName" xsi:type="string">*-meta.xml</argument>
+            <argument name="fileName" xsi:type="string">*Meta.xml</argument>
             <argument name="defaultScope" xsi:type="string">Metadata</argument>
         </arguments>
     </virtualType>
diff --git a/src/Magento/FunctionalTestingFramework/DataGenerator/etc/dataOperation.xsd b/src/Magento/FunctionalTestingFramework/DataGenerator/etc/dataOperation.xsd
@@ -109,4 +109,4 @@
             <xs:enumeration value="DELETE" />
         </xs:restriction>
     </xs:simpleType>
-</xs:schema>
+</xs:schema>
diff --git a/src/Magento/FunctionalTestingFramework/Upgrade/RenameMetadataFiles.php b/src/Magento/FunctionalTestingFramework/Upgrade/RenameMetadataFiles.php
@@ -0,0 +1,63 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\FunctionalTestingFramework\Upgrade;
+
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Finder\Finder;
+
+/**
+ * Class RenameMetadataFiles
+ * @package Magento\FunctionalTestingFramework\Upgrade
+ */
+class RenameMetadataFiles implements UpgradeInterface
+{
+    /**
+     * Upgrades all test xml files
+     *
+     * @param InputInterface $input
+     * @return string
+     */
+    public function execute(InputInterface $input)
+    {
+        $path = $input->getArgument("path");
+        $finder = new Finder();
+        $finder->files()->in($path)->name("*-meta.xml");
+
+        foreach ($finder->files() as $file) {
+            $oldFileName = $file->getFileName();
+            $newFileName = $this->convertFileName($oldFileName);
+            $oldPath = $file->getPathname();
+            $newPath = $file->getPath() . "/" . $newFileName;
+            print("Renaming " . $oldPath . " => " . $newPath . "\n");
+            rename($oldPath, $newPath);
+        }
+
+        return "Finished renaming -meta.xml files.";
+    }
+
+    /**
+     * Convert filenames like:
+     *     user_role-meta.xml => UserRoleMeta.xml
+     *     store-meta.xml => StoreMeta.xml
+     *
+     * @param string $oldFileName
+     * @return string
+     */
+    private function convertFileName(string $oldFileName)
+    {
+        $stripEnding = preg_replace("/-meta.xml/", "", $oldFileName);
+        $hyphenToUnderscore = str_replace("-", "_", $stripEnding);
+        $parts = explode("_", $hyphenToUnderscore);
+        $ucParts = [];
+        foreach ($parts as $part) {
+            $ucParts[] = ucfirst($part);
+        }
+        $recombine = join("", $ucParts);
+        $addEnding = $recombine . "Meta.xml";
+        return $addEnding;
+    }
+}
diff --git a/src/Magento/FunctionalTestingFramework/Upgrade/UpgradeScriptList.php b/src/Magento/FunctionalTestingFramework/Upgrade/UpgradeScriptList.php
@@ -29,6 +29,7 @@ public function __construct(array $scripts = [])
     {
         $this->scripts = [
             'upgradeTestSchema' => new UpdateTestSchemaPaths(),
+            'renameMetadataFiles' => new RenameMetadataFiles()
         ] + $scripts;
     }
 
diff --git a/src/Magento/FunctionalTestingFramework/Util/ModuleResolver.php b/src/Magento/FunctionalTestingFramework/Util/ModuleResolver.php
@@ -54,12 +54,6 @@ class ModuleResolver
     . 'tests'
     . DIRECTORY_SEPARATOR
     . 'functional';
-    const DEPRECATED_DEV_TESTS = DIRECTORY_SEPARATOR
-        . self:: DEV_TESTS
-        . DIRECTORY_SEPARATOR
-        . "Magento"
-        . DIRECTORY_SEPARATOR
-        . "FunctionalTest";
 
     /**
      * Enabled modules.
@@ -327,8 +321,7 @@ private function aggregateTestModulePaths()
         $codePathsToPattern = [
             $modulePath => '',
             $magentoBaseCodePath . $vendorCodePath => self::TEST_MFTF_PATTERN,
-            $magentoBaseCodePath . $appCodePath => self::TEST_MFTF_PATTERN,
-            $magentoBaseCodePath . self::DEPRECATED_DEV_TESTS => ''
+            $magentoBaseCodePath . $appCodePath => self::TEST_MFTF_PATTERN
         ];
 
         foreach ($codePathsToPattern as $codePath => $pattern) {
@@ -374,22 +367,6 @@ private function globRelevantPaths($testPath, $pattern)
             }
         }
 
-        /* TODO uncomment this to show deprecation warning when we ready to fully deliver test packaging feature
-        if (strpos($testPath, self::DEPRECATED_DEV_TESTS) !== false && !empty($modulePaths)) {
-            $deprecatedPath = ltrim(self::DEPRECATED_DEV_TESTS, DIRECTORY_SEPARATOR);
-            $suggestedPath = self::DEV_TESTS . DIRECTORY_SEPARATOR . 'Magento';
-            $message = "DEPRECATION: Found MFTF test modules in the deprecated path: $deprecatedPath."
-                . " Move these test modules to $suggestedPath.";
-
-            if (MftfApplicationConfig::getConfig()->verboseEnabled()) {
-                LoggingUtil::getInstance()->getLogger(ModuleResolver::class)->warning($message);
-            }
-            // Suppress print during unit testing
-            if (MftfApplicationConfig::getConfig()->getPhase() !== MftfApplicationConfig::UNIT_TEST_PHASE) {
-                print ("\n$message\n\n");
-            }
-        }
-        */
         return $modulePaths;
     }
 
diff --git a/src/Magento/FunctionalTestingFramework/_bootstrap.php b/src/Magento/FunctionalTestingFramework/_bootstrap.php
@@ -51,7 +51,7 @@
     $env->setEnvironmentVariable('DEFAULT_TIMEZONE', DEFAULT_TIMEZONE);
 
     defined('WAIT_TIMEOUT') || define('WAIT_TIMEOUT', 30);
-    $env->setEnvironmentVariable('WAIT_TIMEOUT', 30);
+    $env->setEnvironmentVariable('WAIT_TIMEOUT', WAIT_TIMEOUT);
 
     try {
         new DateTimeZone(DEFAULT_TIMEZONE);
@@ -66,7 +66,7 @@
 // define TEST_PATH and TEST_MODULE_PATH
 defined('TESTS_BP') || define('TESTS_BP', realpath(MAGENTO_BP . DIRECTORY_SEPARATOR . 'dev/tests/acceptance'));
 
-$RELATIVE_TESTS_MODULE_PATH = '/tests/functional/Magento/FunctionalTest';
+$RELATIVE_TESTS_MODULE_PATH = '/tests/functional/Magento';
 defined('TESTS_MODULE_PATH') || define(
     'TESTS_MODULE_PATH',
     realpath(TESTS_BP . $RELATIVE_TESTS_MODULE_PATH)

-Original file line number
+Diff line change
@@ @@ -1,7 +1,5 @@ @@
 language: php
 php:
 -  - 7.0
 -  - 7.1
   - 7.2
   - 7.3
 install: composer install --no-interaction --prefer-source