Magento Testing Guide
Magento actively leverages various testing strategies to ensure product and code quality.
Product quality matters to the end-users working with the Magento storefront, admin panel, web APIs and CLI. Product quality tests verify that the user gets expected results while interacting with the Magento system.
Code quality is important to developers working with Magento codebase including:
- System integrators
- Extension developers
- Magento core team
- Community contributors
Code quality matters for:
- Extensibility - It should be straightforward to extend or modify existing behavior.
Good extensibility allows for:
- Customizations and extensions using modularity of the platform.
- Evolution of the platform with new releases.
- Maintainability - It should be straightforward for developers to work within the Magento system.
It can be improved with:
- Complexity management - Reduce the learning curve and risk of adding new bugs.
- Automatic bug detection - Reduces total cost of ownership.
- Coding standards - Ensures consistency and readability.
Automated tests are required by Magento definition of done for any code changes.
Product Quality Tests
- Magento Functional Testing Framework - Tests the storefront and admin panel UI.
- Web API Functional - Tests the REST, SOAP, and GraphQL areas.
- Integration - Ensures that all the parts work together seamlessly.
- Performance - Tracks changes in CPU, Memory and other metrics. Executed nightly for develop branches. Custom builds can be configured using performance toolkit.
- Client-side performance - Measures total page load times in the browser.
- Load - Tracks the trends of system behavior under the load. Executed internally for each release using scenarios defined in the performance toolkit
- Upgrade - Ensures that a seamless upgrade is possible from previously released product versions to the new one. Executed internally for each release.
Code Quality Tests
- PhpCs - Warns developers about coding standard violations. It can be integrated into an IDE to analyze the code as soon as you write it.
- PhpMd - Used for monitoring code complexity and potential bugs. Can be integrated with an IDE for instant feedback.
- Dependency - Prevents incorrect dependencies between modules.
- Legacy code - Prevents usage of the legacy functionality.
- Unit - Used for testing of isolated algorithms or discreet pieces of code.
- Backward-compatibility - Enforces Magento backward compatibility policy at all levels including source code, database, message queue, and web API.
Functional tests are mainly used for system tests at a very high level by remote controlling a browser. Magento is treated as a black box, and tests happen from a user perspective.
The Magento Functional Testing Framework (MFTF) is the main way to do functional testing. It uses XML files to run browser testing.
The Functional Testing Framework (FTF) is the original framework used for testing Magento. This uses PHP scripts to run browser testing. This framework is no longer in development and all FTF tests are in the process of being ported over to the MFTF. Until the porting to MFTF is finished, the FTF can still be run to ensure complete functional testing coverage.
For more information, see the Web API functional testing.
Integration tests run Magento PHP code in varying degrees of isolation. They tend to be a lot more low-level then functional tests. Because they do not utilize a browser to execute the tests, they can be a lot more granular in what they test. They also tend to run a lot quicker then functional tests.
For more information, see Running Integration Tests.
Static code analysis checks that PHP code follows the Magento 2 coding standards and best practices.
They are executed during continuous integration using the
Please see the
magento dev:tests:run documentation for more information, using the test type
Unit tests are used to check a single unit of PHP code in isolation. They are usually written during development using test-driven development (TDD).
Because they do not require the full Magento application stack to be initialized, they run an order of magnitude faster then integration tests.
For more information, see Running Unit Tests.
Please refer to the article Writing testable code for more information on what to keep in mind when starting with TDD.
bin/magento tool provides a common entry point to execute any of the tests, which can be useful for continuous integration.
Please see the System Administrators Guide on Running Tests for more information.
Where to find the tests in the file system
Each test type described above corresponds to a subdirectory in
<magento2 root dir>/dev/tests, as shown here:
<repo_root> <dev/tests/> acceptance (since v2.2.4) api-functional functional integration js/jasmine setup-integration static unit
Each of these test types must satisfy different requirements before the MFTF can execute them.
MFTF tests are kept within its respective Module folder:
<extension_repo_root> ├── <Module1> │ ├── ... │ ├── Test │ │ ├── Unit │ │ ├── Integration │ │ └── Mftf │ │ ├── TestSuite │ │ └── composer.json │ └── ... ├── <Module2> ├── <Module1SampleData> └── <Module2SampleData>