From f003618b7249726d2e90046340085b91216f5c2d Mon Sep 17 00:00:00 2001 From: Heather Guthrie Date: Mon, 24 Jun 2019 19:22:38 -0500 Subject: [PATCH 1/8] MAGECLOUD-3684 add functional testing --- _data/toc/cloud-guide.yml | 3 + .../docker/docker-development-testing.md | 97 +++++++++++++++++++ .../v2.1/cloud/docker/docker-development.md | 75 ++++++++------ .../v2.1/cloud/release-notes/cloud-tools.md | 2 + 4 files changed, 150 insertions(+), 27 deletions(-) create mode 100644 guides/v2.1/cloud/docker/docker-development-testing.md diff --git a/_data/toc/cloud-guide.yml b/_data/toc/cloud-guide.yml index 0da95222453..d6853a57b47 100644 --- a/_data/toc/cloud-guide.yml +++ b/_data/toc/cloud-guide.yml @@ -108,6 +108,9 @@ pages: - label: Connect to the database url: /cloud/docker/docker-database.html + - label: Functional testing in Docker + url: /cloud/docker/docker-development-testing.html + - label: Docker quick reference url: /cloud/docker/docker-quick-reference.html diff --git a/guides/v2.1/cloud/docker/docker-development-testing.md b/guides/v2.1/cloud/docker/docker-development-testing.md new file mode 100644 index 00000000000..b73b640411e --- /dev/null +++ b/guides/v2.1/cloud/docker/docker-development-testing.md @@ -0,0 +1,97 @@ +--- +group: cloud-guide +title: Functional testing in Docker +functional_areas: + - Cloud + - Docker + - Configuration +--- + +You can use the `{{site.data.var.ct}}` package to run functional tests in the Docker environment. Functional tests are in the `src/Test/Functional/Acceptance` folder. See an example in the [ece-tools repository](https://github.com/magento/ece-tools/tree/develop/src/Test/Functional/Acceptance). + +## Prerequisites + +Before you run functional tests, you must prepare your environment with the following steps. + +1. Stop all services that use the following ports: + + - `80`—varnish + - `443`—web, tls + - `3306`—apache, mysql + +1. Switch to the preferred PHP version for running tests. + +1. Update the project dependencies. + + ```bash + composer update + ``` + +1. Add credentials to the Docker environment. + + ```bash + echo "COMPOSER_MAGENTO_USERNAME=your_public_key" >> ./.docker/composer.env + ``` + + ```bash + echo "COMPOSER_MAGENTO_PASSWORD=your_private_key" >> ./.docker/composer.env + ``` + +## Run tests + +By default, tests produce a short output. If you need a more detailed output, you can edit the `codeception.dist.yml` file and set the `printOutput:` property to `true`. !!! need location and example of `codeception.dist.yml` + +### Run a specific test + +Use the following format to run a specific functional test: + +```bash +./vendor/bin/codecept run Acceptance Cest +``` + +For example, the following runs a test on the post deploy...explain more here... + +```bash +./vendor/bin/codecept run Acceptance PostDeployCest +``` + +Sample response: + +```terminal +Need sample output here. +``` +{: .no-copy} + +### Run all tests + +The following lists the scripts to run all tests for each version of PHP. + +- **PHP 7.0** + + ```bash + ./vendor/bin/codecept run -g php70 --steps + ``` + +- **PHP 7.1** + + ```bash + ./vendor/bin/codecept run -g php71 --steps + ``` + +- **PHP 7.2** + + ```bash + ./tests/travis/prepare_functional_parallel.sh + ``` + + ```bash + ./vendor/bin/codecept run -g php72parallel_1 --steps + ``` + + ```bash + ./vendor/bin/codecept run -g php72parallel_2 --steps + ``` + + ```bash + ./vendor/bin/codecept run -g php72parallel_3 --steps + ``` diff --git a/guides/v2.1/cloud/docker/docker-development.md b/guides/v2.1/cloud/docker/docker-development.md index 289052a86de..0fb6735fba5 100644 --- a/guides/v2.1/cloud/docker/docker-development.md +++ b/guides/v2.1/cloud/docker/docker-development.md @@ -9,28 +9,27 @@ functional_areas: {{site.data.var.ece}} provides a Docker environment option for those who use their local environment for development, test, or automation tasks. The {{site.data.var.ece}} Docker environment requires three, essential components: a {{site.data.var.ee}} v2 template, Docker Compose, and the {{site.data.var.ece}} `{{site.data.var.ct}}` package. See the instructions in [Launch Docker]({{page.baseurl}}/cloud/docker/docker-config.html). -The [Magento Cloud Docker repository](https://github.com/magento/magento-cloud-docker) contains build information for the following Docker images: +The [Magento Cloud Docker repository](https://github.com/magento/magento-cloud-docker) contains build information for the following Docker containers. -Image | Docker link -:------------------ | :------------------------------------------- -**DB** | [mariadb:10.0](https://hub.docker.com/_/mariadb) -**FPM**
PHP-CLI: version 7
PHP-FPM: version 7 | [magento/magento-cloud-docker-php](https://hub.docker.com/r/magento/magento-cloud-docker-php) -**ElasticSearch** | [magento/magento-cloud-docker-elasticsearch](https://hub.docker.com/r/magento/magento-cloud-docker-elasticsearch) -**NGINX** |[magento/magento-cloud-docker-nginx](https://hub.docker.com/r/magento/magento-cloud-docker-nginx) -**Node** | [official Node Docker image](https://hub.docker.com/_/node/) -**RabbitMQ** | [rabbitmq](https://hub.docker.com/_/rabbitmq) -**Redis** | [magento/magento-cloud-docker-redis](https://hub.docker.com/r/magento/magento-cloud-docker-redis) -**TLS** | [magento/magento-cloud-docker-tls](https://hub.docker.com/r/magento/magento-cloud-docker-tls) -**Varnish** | [magento/magento-cloud-docker-varnish](https://hub.docker.com/r/magento/magento-cloud-docker-varnish) +## Database container -{:.bs-callout .bs-callout-info} -See the [service version values available]({{page.baseurl}}/cloud/docker/docker-config.html) for use when launching Docker. +The database container is based on the [mariadb](https://hub.docker.com/_/mariadb) image. -## Web container +- Port: 3306 +- Volumes: + - `/var/lib/mysql` + - `./docker/mysql` + +#### To import a database dump: -The web container works with the [PHP-FPM](https://php-fpm.org) to serve PHP code, the **DB** image for the local database, and the **Varnish** image to send requests and cache the results. +Place the SQL file into the `.docker/mysql/docker-entrypoint-initdb.d` folder. + +The `{{site.data.var.ct}}` package imports and processes the SQL file the next time you build and start the Docker environment using the `docker-compose up` command. + +Although it is a more complex approach, you can use GZIP by _sharing_ the `.sql.gz` file using the `.docker/mnt` directory and importing it inside the Docker container. ## CLI containers +**FPM**
PHP-CLI: version 7
PHP-FPM: version 7 | [magento/magento-cloud-docker-php](https://hub.docker.com/r/magento/magento-cloud-docker-php) The following CLI containers, which are based on a PHP-CLI image, provide `magento-cloud` and `{{site.data.var.ct}}` commands to perform file system operations: @@ -56,7 +55,7 @@ The configured state is not ideal ``` {: .no-copy} -## Cron container +### Cron container The Cron container is based on PHP-CLI images, and executes operations in the background immediately after the Docker environment start. It uses the cron configuration defined in the [`crons` property of the `.magento.app.yaml` file]({{page.baseurl}}/cloud/project/project-conf-files_magento-app.html#crons). @@ -66,28 +65,50 @@ The Cron container is based on PHP-CLI images, and executes operations in the ba docker-compose run deploy bash -c "cat /app/var/cron.log" ``` -## Node Container +### Node container -The Node container is based on the [official Node Docker image](https://hub.docker.com/_/node/). It can be used to install NPM dependencies or run any Node-based command line tools. +The Node container is based on the [official Node Docker image](https://hub.docker.com/_/node/). It can be used to install NPM dependencies, such as [Gulp](), or run any Node-based command line tools. -## Database container +## PHP-FPM container -The database container is based on the `mariadb:10` image. +The PHP-FPM container is based on the [magento/magento-cloud-docker-php](https://hub.docker.com/r/magento/magento-cloud-docker-php) image. -#### To import a database dump: +- Port: 9000 +- Read-only volumes: + - `/app` + - `/app/vendor` + - `/app/generated` + - `/app/setup` +- Read/Write volumes: + - `/app/var` + - `/app/app/etc` + - `/app/pub/static` + - `/app/pub/media` -Place the SQL file into the `.docker/mysql/docker-entrypoint-initdb.d` folder. +### Web container -The `{{site.data.var.ct}}` package imports and processes the SQL file the next time you build and start the Docker environment using the `docker-compose up` command. +The web container works with the [PHP-FPM](https://php-fpm.org) to serve PHP code, the [**DB** image](#database-container) for the local database, and the **Varnish** image to send requests and cache the results. -Although it is a more complex approach, you can use GZIP by _sharing_ the `.sql.gz` file using the `.docker/mnt` directory and importing it inside the Docker container. +### Varnish container -## Varnish container +The Varnish container is based on the [magento/magento-cloud-docker-varnish](https://hub.docker.com/r/magento/magento-cloud-docker-varnish) image. Varnish works on port 80. -The Varnish container is based on the `magento-cloud-docker-varnish` image. Varnish works on port 80. +### TLS container The TLS termination proxy container, based on the [magento/magento-cloud-docker-tls](https://hub.docker.com/r/magento/magento-cloud-docker-tls) image, facilitates the Varnish SSL termination over HTTPS. +## Service containers + +Service | Image +------- | ----- +**ElasticSearch** | [magento/magento-cloud-docker-elasticsearch](https://hub.docker.com/r/magento/magento-cloud-docker-elasticsearch) +**NGINX** | [magento/magento-cloud-docker-nginx](https://hub.docker.com/r/magento/magento-cloud-docker-nginx) +**RabbitMQ** | [rabbitmq](https://hub.docker.com/_/rabbitmq) +**Redis** | [magento/magento-cloud-docker-redis](https://hub.docker.com/r/magento/magento-cloud-docker-redis) + +{:.bs-callout .bs-callout-info} +See the [service version values available]({{page.baseurl}}/cloud/docker/docker-config.html) for use when launching Docker. + ## Sharing data between host machine and container You can share files easily between your machine and a Docker container by placing the files in the `.docker/mnt` directory. You can find the files in the `/mnt` directory the next time you build and start the Docker environment using the `docker-compose up` command. diff --git a/guides/v2.1/cloud/release-notes/cloud-tools.md b/guides/v2.1/cloud/release-notes/cloud-tools.md index bb1f7f3291c..57e7cea0fba 100644 --- a/guides/v2.1/cloud/release-notes/cloud-tools.md +++ b/guides/v2.1/cloud/release-notes/cloud-tools.md @@ -37,6 +37,8 @@ The release notes include: - {:.new}Added a new command to the `{{site.data.var.ct}}` package that displays environment services, routes, or variables. See [Services, routes, and variable]({{page.baseurl}}/cloud/reference/ece-tools-reference.html#services-routes-and-variables). [Feature submitted by Vladimir Kerkhoff](https://github.com/magento/ece-tools/pull/486). +- {:.new}You can now perform functional testing using the `{{site.data.var.ct}}` package in the Docker environment. See [Functional testing in Docker]({{page.baseurl}}/cloud/docker/docker-development-testing.html). + ## v2002.0.19 - {:.fix}Fixed an issue that overwrites the `env.php` file during a deploy, resulting in a loss of custom configurations. This update ensures that {{site.data.var.ece}} updates the `env.php` file with every deployment, while preserving custom configurations. From 499d278702b45efbaa79f5526b82fb02614f80c8 Mon Sep 17 00:00:00 2001 From: Heather Guthrie Date: Mon, 24 Jun 2019 20:04:15 -0500 Subject: [PATCH 2/8] add to all versions --- .../docker/docker-development-testing.md | 97 +++++++++++++++++++ .../docker/docker-development-testing.md | 1 + 2 files changed, 98 insertions(+) create mode 100644 guides/v2.2/cloud/docker/docker-development-testing.md create mode 120000 guides/v2.3/cloud/docker/docker-development-testing.md diff --git a/guides/v2.2/cloud/docker/docker-development-testing.md b/guides/v2.2/cloud/docker/docker-development-testing.md new file mode 100644 index 00000000000..b73b640411e --- /dev/null +++ b/guides/v2.2/cloud/docker/docker-development-testing.md @@ -0,0 +1,97 @@ +--- +group: cloud-guide +title: Functional testing in Docker +functional_areas: + - Cloud + - Docker + - Configuration +--- + +You can use the `{{site.data.var.ct}}` package to run functional tests in the Docker environment. Functional tests are in the `src/Test/Functional/Acceptance` folder. See an example in the [ece-tools repository](https://github.com/magento/ece-tools/tree/develop/src/Test/Functional/Acceptance). + +## Prerequisites + +Before you run functional tests, you must prepare your environment with the following steps. + +1. Stop all services that use the following ports: + + - `80`—varnish + - `443`—web, tls + - `3306`—apache, mysql + +1. Switch to the preferred PHP version for running tests. + +1. Update the project dependencies. + + ```bash + composer update + ``` + +1. Add credentials to the Docker environment. + + ```bash + echo "COMPOSER_MAGENTO_USERNAME=your_public_key" >> ./.docker/composer.env + ``` + + ```bash + echo "COMPOSER_MAGENTO_PASSWORD=your_private_key" >> ./.docker/composer.env + ``` + +## Run tests + +By default, tests produce a short output. If you need a more detailed output, you can edit the `codeception.dist.yml` file and set the `printOutput:` property to `true`. !!! need location and example of `codeception.dist.yml` + +### Run a specific test + +Use the following format to run a specific functional test: + +```bash +./vendor/bin/codecept run Acceptance Cest +``` + +For example, the following runs a test on the post deploy...explain more here... + +```bash +./vendor/bin/codecept run Acceptance PostDeployCest +``` + +Sample response: + +```terminal +Need sample output here. +``` +{: .no-copy} + +### Run all tests + +The following lists the scripts to run all tests for each version of PHP. + +- **PHP 7.0** + + ```bash + ./vendor/bin/codecept run -g php70 --steps + ``` + +- **PHP 7.1** + + ```bash + ./vendor/bin/codecept run -g php71 --steps + ``` + +- **PHP 7.2** + + ```bash + ./tests/travis/prepare_functional_parallel.sh + ``` + + ```bash + ./vendor/bin/codecept run -g php72parallel_1 --steps + ``` + + ```bash + ./vendor/bin/codecept run -g php72parallel_2 --steps + ``` + + ```bash + ./vendor/bin/codecept run -g php72parallel_3 --steps + ``` diff --git a/guides/v2.3/cloud/docker/docker-development-testing.md b/guides/v2.3/cloud/docker/docker-development-testing.md new file mode 120000 index 00000000000..e6d5e401e69 --- /dev/null +++ b/guides/v2.3/cloud/docker/docker-development-testing.md @@ -0,0 +1 @@ +../../../v2.2/cloud/docker/docker-development-testing.md \ No newline at end of file From bf21160589fcc184cc951fccabc0bbaa6cddf1cb Mon Sep 17 00:00:00 2001 From: Heather Guthrie Date: Tue, 25 Jun 2019 12:00:59 -0500 Subject: [PATCH 3/8] Update examples and leftover questions --- .../docker/docker-development-testing.md | 30 ++++++++++++++++--- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/guides/v2.1/cloud/docker/docker-development-testing.md b/guides/v2.1/cloud/docker/docker-development-testing.md index b73b640411e..1a44260e3f8 100644 --- a/guides/v2.1/cloud/docker/docker-development-testing.md +++ b/guides/v2.1/cloud/docker/docker-development-testing.md @@ -39,7 +39,18 @@ Before you run functional tests, you must prepare your environment with the foll ## Run tests -By default, tests produce a short output. If you need a more detailed output, you can edit the `codeception.dist.yml` file and set the `printOutput:` property to `true`. !!! need location and example of `codeception.dist.yml` +The `codeception.dist.yml` file contains the global testing configuration and is located in the `{{site.data.var.ct}}` root directory. See it in the [`{{site.data.var.ct}}` repository](https://github.com/magento/ece-tools/blob/develop/codeception.dist.yml). + +By default, the functional tests produce a short output. If you need a more detailed output, you can edit the `codeception.dist.yml` file and set the `printOutput:` property to `true`. + +```yaml +modules: + config: + Magento\MagentoCloud\Test\Functional\Codeception\Docker: + ... + printOutput: true +``` +{:.no-copy} ### Run a specific test @@ -49,7 +60,7 @@ Use the following format to run a specific functional test: ./vendor/bin/codecept run Acceptance Cest ``` -For example, the following runs a test on the post deploy...explain more here... +For example, the following test verifies the post-deploy task runs to completion. ```bash ./vendor/bin/codecept run Acceptance PostDeployCest @@ -58,13 +69,24 @@ For example, the following runs a test on the post deploy...explain more here... Sample response: ```terminal -Need sample output here. +Codeception PHP Testing Framework v2.5.6 +Powered by PHPUnit 6.5.14 by Sebastian Bergmann and contributors. +Running with seed: +Acceptance Tests (1) ----------------------------------------------------------------------------------------------- +-------------------------------------------------------------------------------------------------------------------- +------------------------------------------------------------------------------- +PostDeployCest: Test post deploy | {"ADMIN_EMAIL":"admin@example.com"} + [Magento\MagentoCloud\Test\Functional\Robo\Tasks\GenerateDockerCompose] Running ./bin/ece-tools docker:build + --mode=functional --php=7.2 +... +... +✔ PostDeployCest: Test post deploy | {"ADMIN_EMAIL":"admin@example.com"} (210.41s) ``` {: .no-copy} ### Run all tests -The following lists the scripts to run all tests for each version of PHP. +There is a different script or set of scripts to run all available tests for each version of PHP. - **PHP 7.0** From b42b6a1f2503dd6fc4b21d6c39eb2d8f4bcba74e Mon Sep 17 00:00:00 2001 From: Heather Guthrie Date: Tue, 25 Jun 2019 12:10:50 -0500 Subject: [PATCH 4/8] slight fix --- guides/v2.1/cloud/docker/docker-development-testing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/v2.1/cloud/docker/docker-development-testing.md b/guides/v2.1/cloud/docker/docker-development-testing.md index 1a44260e3f8..f4bd4a53812 100644 --- a/guides/v2.1/cloud/docker/docker-development-testing.md +++ b/guides/v2.1/cloud/docker/docker-development-testing.md @@ -60,7 +60,7 @@ Use the following format to run a specific functional test: ./vendor/bin/codecept run Acceptance Cest ``` -For example, the following test verifies the post-deploy task runs to completion. +For example, the following test verifies that the post-deploy task runs successfully. ```bash ./vendor/bin/codecept run Acceptance PostDeployCest From a627d61881f76438c32577341f910a81a7a03625 Mon Sep 17 00:00:00 2001 From: Heather Guthrie Date: Tue, 25 Jun 2019 12:21:44 -0500 Subject: [PATCH 5/8] fix bad formatting in docker arch --- guides/v2.1/cloud/docker/docker-development.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/guides/v2.1/cloud/docker/docker-development.md b/guides/v2.1/cloud/docker/docker-development.md index 0fb6735fba5..898c72da09a 100644 --- a/guides/v2.1/cloud/docker/docker-development.md +++ b/guides/v2.1/cloud/docker/docker-development.md @@ -29,9 +29,8 @@ The `{{site.data.var.ct}}` package imports and processes the SQL file the next t Although it is a more complex approach, you can use GZIP by _sharing_ the `.sql.gz` file using the `.docker/mnt` directory and importing it inside the Docker container. ## CLI containers -**FPM**
PHP-CLI: version 7
PHP-FPM: version 7 | [magento/magento-cloud-docker-php](https://hub.docker.com/r/magento/magento-cloud-docker-php) -The following CLI containers, which are based on a PHP-CLI image, provide `magento-cloud` and `{{site.data.var.ct}}` commands to perform file system operations: +The following CLI containers, which are based on a [PHP-CLI version 7 image](https://hub.docker.com/r/magento/magento-cloud-docker-php), provide `magento-cloud` and `{{site.data.var.ct}}` commands to perform file system operations: - `build`—extends the CLI container to perform operations with writable filesystem, similar to the build phase - `deploy`—extends the CLI container to use read-only file system, similar to the deploy phase @@ -67,7 +66,7 @@ docker-compose run deploy bash -c "cat /app/var/cron.log" ### Node container -The Node container is based on the [official Node Docker image](https://hub.docker.com/_/node/). It can be used to install NPM dependencies, such as [Gulp](), or run any Node-based command line tools. +The Node container is based on the [official Node Docker image](https://hub.docker.com/_/node/). It can be used to install NPM dependencies, such as Gulp, or run any Node-based command line tools. ## PHP-FPM container From 6a4f325bedcc35f1460d4bb55348184e3a3aaab8 Mon Sep 17 00:00:00 2001 From: Heather Guthrie Date: Tue, 25 Jun 2019 13:16:37 -0500 Subject: [PATCH 6/8] forgot about version 2.2 --- .../docker/docker-development-testing.md | 2 +- .../docker/docker-development-testing.md | 30 ++++++++++++++++--- 2 files changed, 27 insertions(+), 5 deletions(-) diff --git a/guides/v2.1/cloud/docker/docker-development-testing.md b/guides/v2.1/cloud/docker/docker-development-testing.md index f4bd4a53812..ff8e02ee421 100644 --- a/guides/v2.1/cloud/docker/docker-development-testing.md +++ b/guides/v2.1/cloud/docker/docker-development-testing.md @@ -86,7 +86,7 @@ PostDeployCest: Test post deploy | {"ADMIN_EMAIL":"admin@example.com"} ### Run all tests -There is a different script or set of scripts to run all available tests for each version of PHP. +There is a different script, or set of scripts, to run all available tests for each version of PHP. - **PHP 7.0** diff --git a/guides/v2.2/cloud/docker/docker-development-testing.md b/guides/v2.2/cloud/docker/docker-development-testing.md index b73b640411e..ff8e02ee421 100644 --- a/guides/v2.2/cloud/docker/docker-development-testing.md +++ b/guides/v2.2/cloud/docker/docker-development-testing.md @@ -39,7 +39,18 @@ Before you run functional tests, you must prepare your environment with the foll ## Run tests -By default, tests produce a short output. If you need a more detailed output, you can edit the `codeception.dist.yml` file and set the `printOutput:` property to `true`. !!! need location and example of `codeception.dist.yml` +The `codeception.dist.yml` file contains the global testing configuration and is located in the `{{site.data.var.ct}}` root directory. See it in the [`{{site.data.var.ct}}` repository](https://github.com/magento/ece-tools/blob/develop/codeception.dist.yml). + +By default, the functional tests produce a short output. If you need a more detailed output, you can edit the `codeception.dist.yml` file and set the `printOutput:` property to `true`. + +```yaml +modules: + config: + Magento\MagentoCloud\Test\Functional\Codeception\Docker: + ... + printOutput: true +``` +{:.no-copy} ### Run a specific test @@ -49,7 +60,7 @@ Use the following format to run a specific functional test: ./vendor/bin/codecept run Acceptance Cest ``` -For example, the following runs a test on the post deploy...explain more here... +For example, the following test verifies that the post-deploy task runs successfully. ```bash ./vendor/bin/codecept run Acceptance PostDeployCest @@ -58,13 +69,24 @@ For example, the following runs a test on the post deploy...explain more here... Sample response: ```terminal -Need sample output here. +Codeception PHP Testing Framework v2.5.6 +Powered by PHPUnit 6.5.14 by Sebastian Bergmann and contributors. +Running with seed: +Acceptance Tests (1) ----------------------------------------------------------------------------------------------- +-------------------------------------------------------------------------------------------------------------------- +------------------------------------------------------------------------------- +PostDeployCest: Test post deploy | {"ADMIN_EMAIL":"admin@example.com"} + [Magento\MagentoCloud\Test\Functional\Robo\Tasks\GenerateDockerCompose] Running ./bin/ece-tools docker:build + --mode=functional --php=7.2 +... +... +✔ PostDeployCest: Test post deploy | {"ADMIN_EMAIL":"admin@example.com"} (210.41s) ``` {: .no-copy} ### Run all tests -The following lists the scripts to run all tests for each version of PHP. +There is a different script, or set of scripts, to run all available tests for each version of PHP. - **PHP 7.0** From a1600a6c10a029e686a9d8abd799103c7425b5fa Mon Sep 17 00:00:00 2001 From: hguthrie Date: Tue, 25 Jun 2019 16:01:28 -0500 Subject: [PATCH 7/8] Apply suggestions from code review Co-Authored-By: Margaret Eker --- guides/v2.1/cloud/docker/docker-development-testing.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/guides/v2.1/cloud/docker/docker-development-testing.md b/guides/v2.1/cloud/docker/docker-development-testing.md index ff8e02ee421..0e83114b439 100644 --- a/guides/v2.1/cloud/docker/docker-development-testing.md +++ b/guides/v2.1/cloud/docker/docker-development-testing.md @@ -39,7 +39,7 @@ Before you run functional tests, you must prepare your environment with the foll ## Run tests -The `codeception.dist.yml` file contains the global testing configuration and is located in the `{{site.data.var.ct}}` root directory. See it in the [`{{site.data.var.ct}}` repository](https://github.com/magento/ece-tools/blob/develop/codeception.dist.yml). +The `codeception.dist.yml` file in the `{{site.data.var.ct}}` root directory contains the global testing configuration. See the [`{{site.data.var.ct}}` repository](https://github.com/magento/ece-tools/blob/develop/codeception.dist.yml). By default, the functional tests produce a short output. If you need a more detailed output, you can edit the `codeception.dist.yml` file and set the `printOutput:` property to `true`. @@ -54,7 +54,7 @@ modules: ### Run a specific test -Use the following format to run a specific functional test: +Use the following command format to run a specific functional test: ```bash ./vendor/bin/codecept run Acceptance Cest @@ -86,7 +86,7 @@ PostDeployCest: Test post deploy | {"ADMIN_EMAIL":"admin@example.com"} ### Run all tests -There is a different script, or set of scripts, to run all available tests for each version of PHP. +The following list provides the commands to run all available tests for each version of PHP. - **PHP 7.0** From 3885e910264cfba1c92ae2f03e640de5c0773352 Mon Sep 17 00:00:00 2001 From: Heather Guthrie Date: Tue, 25 Jun 2019 16:14:34 -0500 Subject: [PATCH 8/8] Update from feedback --- guides/v2.1/cloud/docker/docker-development-testing.md | 2 +- guides/v2.2/cloud/docker/docker-development-testing.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/guides/v2.1/cloud/docker/docker-development-testing.md b/guides/v2.1/cloud/docker/docker-development-testing.md index 0e83114b439..82c1e7d3b21 100644 --- a/guides/v2.1/cloud/docker/docker-development-testing.md +++ b/guides/v2.1/cloud/docker/docker-development-testing.md @@ -41,7 +41,7 @@ Before you run functional tests, you must prepare your environment with the foll The `codeception.dist.yml` file in the `{{site.data.var.ct}}` root directory contains the global testing configuration. See the [`{{site.data.var.ct}}` repository](https://github.com/magento/ece-tools/blob/develop/codeception.dist.yml). -By default, the functional tests produce a short output. If you need a more detailed output, you can edit the `codeception.dist.yml` file and set the `printOutput:` property to `true`. +By default, functional tests produce a short output. You can receive a more detailed output by editing the `codeception.dist.yml` file to set the `printOutput:` property to `true`. ```yaml modules: diff --git a/guides/v2.2/cloud/docker/docker-development-testing.md b/guides/v2.2/cloud/docker/docker-development-testing.md index ff8e02ee421..82c1e7d3b21 100644 --- a/guides/v2.2/cloud/docker/docker-development-testing.md +++ b/guides/v2.2/cloud/docker/docker-development-testing.md @@ -39,9 +39,9 @@ Before you run functional tests, you must prepare your environment with the foll ## Run tests -The `codeception.dist.yml` file contains the global testing configuration and is located in the `{{site.data.var.ct}}` root directory. See it in the [`{{site.data.var.ct}}` repository](https://github.com/magento/ece-tools/blob/develop/codeception.dist.yml). +The `codeception.dist.yml` file in the `{{site.data.var.ct}}` root directory contains the global testing configuration. See the [`{{site.data.var.ct}}` repository](https://github.com/magento/ece-tools/blob/develop/codeception.dist.yml). -By default, the functional tests produce a short output. If you need a more detailed output, you can edit the `codeception.dist.yml` file and set the `printOutput:` property to `true`. +By default, functional tests produce a short output. You can receive a more detailed output by editing the `codeception.dist.yml` file to set the `printOutput:` property to `true`. ```yaml modules: @@ -54,7 +54,7 @@ modules: ### Run a specific test -Use the following format to run a specific functional test: +Use the following command format to run a specific functional test: ```bash ./vendor/bin/codecept run Acceptance Cest @@ -86,7 +86,7 @@ PostDeployCest: Test post deploy | {"ADMIN_EMAIL":"admin@example.com"} ### Run all tests -There is a different script, or set of scripts, to run all available tests for each version of PHP. +The following list provides the commands to run all available tests for each version of PHP. - **PHP 7.0**