This topic contains information for developers who work closely with the Adobe Commerce code and want to learn detailed information about the Upgrade Compatibility Tool. You can use this knowledge to customize the tool’s components.
Adobe Commerce API index integration is an internal integration solution that encompasses a set of tools to explore Adobe Commerce extensions developed by Adobe, Adobe Commerce Partners, and third-party vendors based on static code analysis.
The integration with the Adobe Commerce API index is done through:
It is implemented through the
config/services.yaml file. Its value decides where the response of methods
modules() comes from.
Edit this file to customize the response according to your installation. Replace the value assigned to
sut\Domain\MRay\MRayInterface : "@sut_mray_mock"
In the previous example, the Upgrade Compatibility Tool uses
@sut_mray_mock as the
MRayInterface implementation. The responses from the
modules() methods come from the following files:
When you change the
services.yaml file, delete the
var/cache/ folder to correctly apply the changes.
To run the unit tests, execute one of the following commands:
vendor/bin/phpunit -c tests/unit/phpunit.xml.dist tests/unit
vendor/bin/phpunit -c tests/unit/phpunit.xml.dist --testsuite=unit-tests
To run the integration tests, execute one of the following commands:
vendor/bin/phpunit -c tests/integration/phpunit.xml.dist tests/integration
vendor/bin/phpunit -c tests/integration/phpunit.xml.dist --testsuite=integration-tests
Before executing acceptance tests, you must set the Adobe Commerce URL in the
phpunit configuration file.
Copy the default
tests/acceptance/phpunit.xml file (without the .dist suffix).
TESTS_BASE_URL value to point to the Adobe Commerce URL that you want to test.
To run the acceptance tests, execute one of the following commands:
vendor/bin/phpunit -c tests/acceptance/phpunit.xml tests/acceptance
vendor/bin/phpunit -c tests/acceptance/phpunit.xml --testsuite=acceptance-tests
You must have Node.js on your system, see the Node.js documentation.
The following instructions are for MacOS systems:
Open a terminal and navigate to the root directory of the project.
Install project dependencies:
The Jest framework was used to create these JS unit tests:
The tests are inside
The string schemas for testing are inside
Run unit tests or
jest as follows:
./node_modules/.bin/jest --verbose --rootDir=dev/tests/Js/
eslint code analysis as follows:
./node_modules/.bin/eslint -c dev/tests/Static/.eslintrc --rulesdir vendor/magento/magento-coding-standard/eslint/rules path/to/analyse
The complexity score is a figure that indicates how difficult an upgrade from the current version to the new one might be. Lower numbers indicate easier upgrades.
Complexity scores range between 0 and ∞.
This score is based on the results extracted from the analysis:
The Upgrade Compatibility Tool calculates this score according to the complexity score formula below.
Complexity Score = (Critical issues * 3) + (Errors *2) + Warnings
These are absolute values.