You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Git vs Composer Installation of Magento with MFTF
1
+
# Git vs Composer installation of Magento with MFTF
2
2
3
+
Depending on how you plan to use Magnto code, there are different options for installing Magento.
3
4
4
-
###GitHub Installation
5
+
## GitHub Installation
5
6
6
-
If you are planning on contributing a PR to the Magento 2 codebase, you can download Magento 2 from GitHub. Contribution to the codebase is done using the 'fork and pull' model where contributors maintain their own fork of the repo. This repo is then used to submit a pull request to the base repo.
7
+
If you are contributing a pull request to the Magento 2 codebase, download Magento 2 from our GitHub repository. Contribution to the codebase is done using the 'fork and pull' model where contributors maintain their own fork of the repo. This repo is then used to submit a pull request to the base repo.
A Composer install downloads released packages of Magento 2 from the composer repo [https://repo.magento.com](https://repo.magento.com).
12
14
13
-
Composer install downloads released packages of Magento 2 from the composer repo [https://repo.magento.com](https://repo.magento.com).
15
+
All Magento modules and their MFTF tests are put under `<vendor>` directory, for convenience of 3rd party developers. With this setup, you can keep your custom modules separate from core modules. You can also develop modules in a separate VCS repository and add them to your `composer.json` which installs them into the `vendor` directory.
14
16
15
-
All Magento modules and their MFTF tests are put under `<vendor>` directory for convenience of 3rd party developers. With this setup, you can keep your custom modules separate from the core. You can also develop modules in a separate VCS repository and add them to your `composer.json` which will allow them to be installed into the `vendor` directory.
17
+
Install guide: [Composer based Installation][]
16
18
17
-
Install guide: [Composer based Installation](https://devdocs.magento.com/guides/v2.3/install-gde/composer.html)
19
+
## MFTF Installation
18
20
21
+
After installing your Magento project in either of the above ways, the composer dependency `magento/magento2-functional-testing-framework` downloads and installs MFTF. MFTF is embedded in your Magento 2 installation and will cover your project with functional tests.
19
22
20
-
### MFTF Installation
23
+
If you want to contribute a pull request into MFTF codebase, you will need to install MFTF in the [Standalone][] mode.
21
24
22
-
After installing your Magento project in either of the above ways, the composer dependency `magento/magento2-functional-testing-framework` allows you to download and install MFTF. MFTF will be embedded in your Magento 2 installation and will cover your project with functional tests.
25
+
## Managing modules - Composer vs GitHub
23
26
24
-
If you want to contribute a PR into MFTF codebase, you will need to install MFTF in the [Standalone] mode.
27
+
### Via GitHub
25
28
29
+
Cloning the Magento 2 git repository is a way of installing where you do not have to worry about matching your codebase with production. Your version control system generally holds and manages your `app/code` folder and you can do manual, ad-hoc development here.
26
30
27
-
### Managing modules - Composer vs GitHub
31
+
### Via Composer
28
32
29
-
#### Via GitHub:
33
+
Magento advocates the use of composer for managing modules. When you install a module through composer, it is added to `vendor/<vendor-name>/<module>`.
30
34
31
-
Cloning Magento 2 git repository is a way of installing when you don't have to worry frequently about matching the codebase with production. Your version control system generally holds and manages your `app/code` folder and you can do manual ad-hoc development here.
35
+
When developing your own module or adding MFTF tests to a module, you should not edit in `vendor` because a composer update could overwrite your changes. Instead, overwrite a module under `vendor` by adding files or cloning your module-specific Git repo to `app/code/<vendor-name>/<module>`.
32
36
33
-
#### Via composer:
37
+
To distribute the module and its tests, you can initialize a git repo and create a [composer package][]. In this way others will be able to download and install your module and access your tests as a composer package, in their `<vendor>` folder.
34
38
35
-
Magento 2 advocates the use of composer for managing modules. When you install a module through composer, it is added to `vendor/<vendor-name>/<module>`
39
+
## MFTF test materials location
36
40
37
-
If you are developing your own module or adding MFTF tests to the module, you should not edit `vendor` because a composer update could clobber your changes. Instead, you can override a module under `vendor`, by adding files or cloning your module specific git repo to `app/code/<vendor-name>/<module>`.
41
+
- For GitHub installations, MFTF test materials are located in `<magento_root>/app/code/<vendor_name>/<module_name>/Test/Mftf/`. This is the directory for new tests or to maintain existing ones.
42
+
- For Composer-based installations, MFTF test materials are located at `<magento_root>/vendor/<vendor_name>/<module_name>/Test/Mftf/`. This is the directory to run tests fetched by Composer.
38
43
39
-
If you want to distribute the module and its tests, you can initialize a git repo and create a [composer package](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/package/package_module.html). In this way others will be able to download and install your module and access your tests as a composer package, in their `<vendor>` folder.
40
-
41
-
42
-
### MFTF test materials location
43
-
44
-
- For GitHub installation, MFTF test materials are located at `<magento_root>/app/code/<vendor_name>/<module_name>/Test/Mftf/`. This is the directory to create new tests or maintain existing ones.
45
-
46
-
- For Composer based installation, MFTF test materials are located at `<magento_root>/vendor/<vendor_name>/<module_name>/Test/Mftf/`. This is the directory to run tests fetched by Composer.
47
-
48
-
The file structure under both paths is the same as below:
44
+
The file structure under both paths is the same:
49
45
50
46
```tree
51
47
<Path>
@@ -63,22 +59,22 @@ The file structure under both paths is the same as below:
63
59
└── ...
64
60
```
65
61
62
+
## How ModuleResolver reads modules
66
63
67
-
### How ModuleResolver reads modules
68
-
69
-
In either of the installations, all tests and test data are read and merged by MFTF's ModuleResolver in the order indicated below:
64
+
With either type of installation, all tests and test data are read and merged by MFTF's ModuleResolver in this order:
There are no differences from MFTF's perspective between having the test materials in `app/code` or in `/vendor`. It works the same. Composer based install may benefit teams when there's a need to match file systems in dev and production.
71
+
There is no difference between having the test materials in `app/code` or in `/vendor`: it works the same. Composer-based installs may benefit teams when there is a need to match file systems in `development` and `production`.
78
72
79
73
If you are a contributing developer with an understanding of Git and Composer commands, you can choose the GitHub installation method instead.
80
74
81
-
82
75
<!-- Link definitions -->
83
76
77
+
[Composer based Installation]: https://devdocs.magento.com/guides/v2.3/install-gde/composer.html
0 commit comments