magento · KevinBKozan · Apr 29, 2019 · Dec 28, 2018 · Dec 28, 2018 · Feb 12, 2019
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,3 @@
+# CODEOWNERS file for /docs/ folder.
+# Forces a review from other writers for anything within /docs/.
+/docs/ @magento/devdocs-admins
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -160,7 +160,7 @@ Label| Description
 [create issue]: https://help.github.com/articles/creating-an-issue/
 [create pr]: https://help.github.com/articles/creating-a-pull-request/
 [Definition of Done]: https://devdocs.magento.com/guides/v2.2/contributor-guide/contributing_dod.html
-[devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md
+[devdocs]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.html
 [existing issues]: https://github.com/magento/magento2-functional-testing-framework/issues?q=is%3Aopen+is%3Aissue
 [existing PRs]: https://github.com/magento/magento2-functional-testing-framework/pulls?q=is%3Aopen+is%3Apr
 [GitHub documentation]: https://help.github.com/articles/syncing-a-fork

diff --git a/.gitignore b/.gitignore
@@ -15,4 +15,5 @@ codeception.yml
 dev/tests/functional/MFTF.suite.yml
 dev/tests/functional/_output
 dev/mftf.log
-dev/tests/mftf.log
+dev/tests/mftf.log
+dev/tests/docs/*
diff --git a/.travis.yml b/.travis.yml
@@ -3,6 +3,7 @@ php:
   - 7.0
   - 7.1
   - 7.2
+  - 7.3
 install: composer install --no-interaction --prefer-source
 env:
   matrix:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,32 @@
 Magento Functional Testing Framework Changelog
 ================================================
 
+2.4.0
+-----
+### Enhancements
+* Maintainability
+    * Added new `mftf static-checks` command to run new static checks against the attached test codebase
+        * See DevDocs for details
+    * Added new `mftf generate:docs` command that generates documentation about attached test codebase
+        * See DevDocs for details
+* Traceability
+    * Allure reports for tests now contain collapsible sections for `actionGroup`s used in execution.
+
+### Fixes
+* Fixed an issue where `magentoCli` would treat `argument="0"` as a null value.
+* Fixed an issue where `amOnPage` and `waitForPwaElementVisible` would not utilize the `timeout` attribute correctly when MagentoPwaWebDriver is enabled.
+* Fixed an issue where invalid XML characters would cause Allure to throw an exception without a resulting report.
+* Fixed `codeception.dist.yml` configuration for keeping previous test run results.
+* PHP Notices are no longer thrown when XML is missing non-necessary attributes.
+* Removed unusable `fillSecretField` action from schema.
+
+### GitHub Issues/Pull requests:
+* [#338](https://github.com/magento/magento2-functional-testing-framework/pull/338) -- Return exit codes of process started by 'run:test', 'run:group' or 'run:failed' command
+* [#333](https://github.com/magento/magento2-functional-testing-framework/pull/333) -- Added Nginx specific settings to getting started doc
+* [#332](https://github.com/magento/magento2-functional-testing-framework/pull/332) -- executeInSelenium action does not generate proper code
+* [#318](https://github.com/magento/magento2-functional-testing-framework/pull/318) -- Reduce cyclomatic complexity in Problem Methods
+* [#287](https://github.com/magento/magento2-functional-testing-framework/pull/287) -- Update requirements to include php7.3 support
+
 2.3.14
 -----
 ### Enhancements

diff --git a/README.md b/README.md
@@ -6,15 +6,15 @@
 
 ## Installation
 
-For the installation guidelines and system requirements, refer to [Getting Started](https://devdocs.magento.com/mftf/2.3/getting-started.html).
+For the installation guidelines and system requirements, refer to [Getting Started][].
 
 ## Contributing
 
 We would appreciate your contributions to new components or new features, changes to the existing features, tests, documentation, specifications, bug fixes, optimizations, or just good suggestions.
 Report about an issue or request features opening a GitHub issue.
-Learn more about contributing in our [Contribution Guidelines](.github/CONTRIBUTING.md).
+Learn more about contributing in our [Contribution Guidelines][].
 
-If you want to participate in the documentation work, see [DevDocs Contributing](https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md).
+If you want to participate in the documentation work, see [DevDocs Contributing][].
 
 ### Labels applied by the MFTF team
 
@@ -55,15 +55,26 @@ These labels are applied by the MFTF development team to community contributed i
 
 ## Reporting security issues
 
-To report security vulnerabilities and other security issues in the Magento software or web sites, send an email with the report at [security@magento.com](mailto:security@magento.com).
+To report security vulnerabilities and other security issues in the Magento software or web sites, send an email with the report at [security@magento.com][].
 Do not report security issues using GitHub.
-Be sure to encrypt your e-mail with our [encryption key](https://info2.magento.com/rs/magentoenterprise/images/security_at_magento.asc) if it includes sensitive information.
-Learn more about reporting security issues [here](https://magento.com/security/reporting-magento-security-issue).
+Be sure to encrypt your e-mail with our [encryption key][] if it includes sensitive information.
+Learn more about reporting security issues [here][].
 
-Stay up-to-date on the latest security news and patches for Magento by signing up for [Security Alert Notifications](https://magento.com/security/sign-up).
+Stay up-to-date on the latest security news and patches for Magento by signing up for [Security Alert Notifications][].
 
 ## License
 
 Each Magento source file included in this distribution is licensed under AGPL 3.0.
 
-See the license [here](LICENSE_AGPL3.txt) or contact [license@magentocommerce.com](mailto:license@magentocommerce.com) for a copy.
+See the license [here][] or contact [license@magentocommerce.com][] for a copy.
+
+<!-- Link Definitions -->
+[Getting Started]: docs/getting-started.md
+[Contribution Guidelines]: .github/CONTRIBUTING.html
+[DevDocs Contributing]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md
+[security@magento.com]: mailto:security@magento.com
+[encryption key]: https://info2.magento.com/rs/magentoenterprise/images/security_at_magento.asc
+[here]: https://magento.com/security/reporting-magento-security-issue
+[Security Alert Notifications]: https://magento.com/security/sign-up
+[here]: LICENSE_AGPL3.txt
+[license@magentocommerce.com]: mailto:license@magentocommerce.com
diff --git a/bin/mftf b/bin/mftf
@@ -29,7 +29,7 @@ try {
 try {
     $application = new Symfony\Component\Console\Application();
     $application->setName('Magento Functional Testing Framework CLI');
-    $application->setVersion('2.3.14');
+    $application->setVersion('2.4.0');
     /** @var \Magento\FunctionalTestingFramework\Console\CommandListInterface $commandList */
     $commandList = new \Magento\FunctionalTestingFramework\Console\CommandList;
     foreach ($commandList->getCommands() as $command) {

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.3.14",
+    "version": "2.4.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",
+        "php": "7.0.2||7.0.4||~7.0.6||~7.1.0||~7.2.0||~7.3.0",
         "allure-framework/allure-codeception": "~1.3.0",
         "ext-curl": "*",
         "codeception/codeception": "~2.3.4 || ~2.4.0 ",
@@ -25,7 +25,7 @@
     "require-dev": {
         "squizlabs/php_codesniffer": "~3.2",
         "sebastian/phpcpd": "~3.0 || ~4.0",
-        "brainmaestro/composer-git-hooks": "^2.3",
+        "brainmaestro/composer-git-hooks": "^2.3.1",
         "doctrine/cache": "<1.7.0",
         "codeception/aspect-mock": "^3.0",
         "goaop/framework": "2.2.0",

diff --git a/composer.lock b/composer.lock
diff --git a/dev/tests/_bootstrap.php b/dev/tests/_bootstrap.php
@@ -60,6 +60,28 @@
 defined('TESTS_BP') || define('TESTS_BP', __DIR__);
 defined('TESTS_MODULE_PATH') || define('TESTS_MODULE_PATH', TESTS_BP . $RELATIVE_TESTS_MODULE_PATH);
 defined('MAGENTO_BP') || define('MAGENTO_BP', __DIR__);
+define('DOCS_OUTPUT_DIR',
+    FW_BP .
+    DIRECTORY_SEPARATOR .
+    "dev" .
+    DIRECTORY_SEPARATOR .
+    "tests" .
+    DIRECTORY_SEPARATOR .
+    "unit" .
+    DIRECTORY_SEPARATOR .
+    "_output"
+);
+define('RESOURCE_DIR',
+    FW_BP .
+    DIRECTORY_SEPARATOR .
+    "dev" .
+    DIRECTORY_SEPARATOR .
+    "tests" .
+    DIRECTORY_SEPARATOR .
+    "unit" .
+    DIRECTORY_SEPARATOR .
+    "Resources"
+);
 
 $utilDir = DIRECTORY_SEPARATOR . 'Util'. DIRECTORY_SEPARATOR . '*.php';
 

diff --git a/...sts/unit/Magento/FunctionalTestFramework/Test/Util/ActionGroupAnnotationExtractorTest.php b/...sts/unit/Magento/FunctionalTestFramework/Test/Util/ActionGroupAnnotationExtractorTest.php
@@ -0,0 +1,104 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace tests\unit\Magento\FunctionalTestFramework\Test\Util;
+
+use AspectMock\Test as AspectMock;
+use Magento\FunctionalTestingFramework\Test\Util\ActionGroupAnnotationExtractor;
+use PHPUnit\Framework\TestCase;
+use tests\unit\Util\TestLoggingUtil;
+
+class ActionGroupAnnotationExtractorTest extends TestCase
+{
+    /**
+     * Before test functionality
+     * @return void
+     */
+    public function setUp()
+    {
+        TestLoggingUtil::getInstance()->setMockLoggingUtil();
+    }
+
+    /**
+     * Annotation extractor takes in raw array and condenses it to expected format
+     *
+     * @throws \Exception
+     */
+    public function testActionGroupExtractAnnotations()
+    {
+        // Test Data
+        $actionGroupAnnotations = [
+            "nodeName" => "annotations",
+            "description" => [
+                "nodeName" => "description",
+                "value" => "someDescription"
+            ],
+            "page" => [
+                "nodeName" => "page",
+                "value" => "somePage"
+            ]
+        ];
+        // Perform Test
+        $extractor = new ActionGroupAnnotationExtractor();
+        $returnedAnnotations = $extractor->extractAnnotations($actionGroupAnnotations, "fileName");
+
+        // Asserts
+
+        $this->assertEquals("somePage", $returnedAnnotations['page']);
+        $this->assertEquals("someDescription", $returnedAnnotations['description']);
+    }
+
+    /**
+     * Annotation extractor should throw warning when required annotations are missing
+     *
+     * @throws \Exception
+     */
+    public function testActionGroupMissingAnnotations()
+    {
+        // Action Group Data, missing page and description
+        $testAnnotations = [];
+        // Perform Test
+        $extractor = new ActionGroupAnnotationExtractor();
+        AspectMock::double($extractor, ['isCommandDefined' => true]);
+        $extractor->extractAnnotations($testAnnotations, "fileName");
+
+        // Asserts
+        TestLoggingUtil::getInstance()->validateMockLogStatement(
+            'warning',
+            'DEPRECATION: Action Group File fileName is missing required annotations.',
+            [
+                'actionGroup' => 'fileName',
+                'missingAnnotations' => "description, page"
+            ]
+        );
+    }
+
+    /**
+     * Annotation extractor should not throw warning when required
+     * annotations are missing if command is not generate:docs
+     *
+     * @throws \Exception
+     */
+    public function testActionGroupMissingAnnotationsNoWarning()
+    {
+        // Action Group Data, missing page and description
+        $testAnnotations = [];
+        // Perform Test
+        $extractor = new ActionGroupAnnotationExtractor();
+        $extractor->extractAnnotations($testAnnotations, "fileName");
+
+        // Asserts
+        TestLoggingUtil::getInstance()->validateMockLogEmpty();
+    }
+
+    /**
+     * After class functionality
+     * @return void
+     */
+    public static function tearDownAfterClass()
+    {
+        TestLoggingUtil::getInstance()->clearMockLoggingUtil();
+    }
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,7 @@ php: @@
       - 7.0
       - 7.1
       - 7.2
+      - 7.3
     install: composer install --no-interaction --prefer-source
     env:
       matrix:
@@ Expand Down @@