MQE-1776: CICD System Documentation

docs/guides/cicd.md

@@ -0,0 +1,108 @@
+# How to use MFTF in CICD
+
+To integrate MFTF tests into your CICD pipeline, then it is best to start with the conceptual flow of the pipeline code.
+
+## Concept
+
+The overall workflow that tests should follow is:
+
+-  Obtain a Magento instance + install pre-requisites.
+-  Generate the tests.
+    -  Set options for single or parallel running.
+-  Delegate and run tests and gather test-run artifacts.
+    -  Re-run options.
+-  Generate the Allure reports from results.
+
+## Obtain a Magento instance
+
+To start, we need a Magento instance to operate against for test generation and execution.
+
+```bash
+git clone https://github.com/magento/magento2
+```
+
+or
+
+```bash
+composer create-project --repository=https://repo.magento.com/ magento/project-community-edition magento2ce
+```
+
+For more information on installing magento see [Install Magento using Composer][].
+
+After installing the Magento instance, you need to set a couple of configurations to the magento instance:
+
+```bash
+bin/magento config:set general/locale/timezone America/Los_Angeles
+bin/magento config:set admin/security/admin_account_sharing 1
+bin/magento config:set admin/security/use_form_key 0
+bin/magento config:set cms/wysiwyg/enabled disabled
+```
+
+These help set the `default` state of the Magento instance. If you wish to change the default state of the application (and have updated your tests sufficiently to account for it), this is the step in which you would do it.
+
+## Install allure
+
+This will be required to generate the report after your test runs. See [Allure][] for details.
+
+## Generate tests
+
+### Single execution
+
+Generate tests based on what you want to run:
+
+```bash
+vendor/bin/mftf generate:tests
+```
+
+This will generate all tests and a single manifest file under `dev/tests/acceptance/tests/functional/Magento/FunctionalTest/_generated/testManifest.txt`
+
+### Parallel execution
+
+To generate all tests for use in parallel nodes:
+
+```bash
+vendor/bin/mftf generate:tests --config parallel
+```
+
+This will generate a folder under `dev/tests/acceptance/tests/functional/Magento/FunctionalTest/_generated/groups`. This folder contains several `group#.txt` files that can be used later with the `mftf run:manifest` command.
+
+## Delegate and run tests
+
+### Single execution
+
+If you are running on a single node, call:
+
+```bash
+vendor/bin/mftf run:manifest dev/tests/acceptance/tests/functional/Magento/FunctionalTest/_generated/testManifest.txt
+```
+
+### Parallel execution
+
+To run MFTF tests in parallel, clone the contents of the current node and duplicate them depending on how many nodes you have.
+
+- Clone contents of current node as a baseline.
+- For each `groups/group#.txt` file:
+
+    - Set a node's contents to the baseline.
+    - Run `vendor/bin/mftf run:manifest <current_group.txt>`.
+    - Gather artifacts from `dev/tests/acceptance/tests/_output` from current node to master.
+
+#### Rerun options
+
+In either single or parallel execution, to re-run failed tests simply add the `run:failed` command after executing a manifest:
+
+```bash
+vendor/bin/mftf run:failed
+```
+
+### Generate Allure report
+
+In the master node, simply generate using your `<path_to_results>` into a desired output path
+
+```bash
+allure generate <path_to_results> -c -o <path_to_output>
+```
+
+<!-- Link definitions -->
+[Install Magento using Composer]: https://devdocs.magento.com/guides/v2.3/install-gde/composer.html
+[Allure]: https://docs.qameta.io/allure/