Edit in GitHubLog an issue

Test results

Submissions go through several reviews before being released on the Commerce Marketplace. You can use the following endpoints to get more information about the current status of a submission. See Get package details for details about these endpoints.

Copied to your clipboard
1GET /rest/v1/products/packages/:submission_id/status
2GET /rest/v1/products/packages/sku/:url_encoded_sku/status
3GET /rest/v1/products/packages/item/:item_id/status
4GET /rest/v1/products/packages/:submission_id/status/:tool_name/:tool_run_id

In this example, submission f4eacd72be failed the marketing review. Use this request to get a summary report of the review process:

Copied to your clipboard
1curl -X GET \
2 -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
3 https://developer-stg-api.magento.com/rest/v1/products/packages/f4eacd72be/status

The status field indicates the overall result of the review, which can be pass, fail, error, or needs_review.

Additional details for each review can be found using the status API with the tool name and the tool run ID.

Copied to your clipboard
1curl -X GET \
2 -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
3 https://developer-stg-api.magento.com/rest/v1/f4eacd72be/status/marketing/6
  • The top-level status field contains the final decision made for this test. All status values in the reports array must be PASS in order for the test to pass.
  • The reports array can contain multiple entries. For automated tests, there will be additional information about the environment used for testing.
  • The details array structure will be different for each test.

Test result structures#

The following examples demonstrate failure reports for each test type.

Code Sniffer (PHPCS)#

A code sniffer will be run against every PHP version the extension is compatible with. The reports array contains a separate entry for each environment. The details array contains the output generated by the Code Sniffer tool.

Additional fields:

Field NameTypeValue
php_versionstringPHP version number
Copied to your clipboard
1curl -X GET \
2 -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
3 https://developer-stg-api.magento.com/rest/v1/f4eacd72be/status/phpcs/8

Copy-Paste Detector#

Varnish#

The Varnish test installs the extension into a Magento instance and attempts to access several pages to determine if Varnish caching is working as expected. The test will be run against all combinations of Magento versions, Magento editions, and PHP versions.

Additional fields:

Field NameTypeValue
php_versionstringPHP version number
magento_platformstringM1 or M2
magento_editionstringCE or EE
magento_versionstringMagento version number
Copied to your clipboard
1curl -X GET \
2 -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
3 https://developer-stg-api.magento.com/rest/v1/f4eacd72be/status/varnish/8

The last command/output step in the details section is the command that failed to execute successfully.

Marketing and Manual QA#

The Marketing and Manual QA reviews share the same report structure. There should only be one entry in the reports array for these reviews. The tool names are marketing and manual_qa respectively.

Copied to your clipboard
1curl -X GET \
2 -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
3 https://developer-stg-api.magento.com/rest/v1/f4eacd72be/status/manual_qa/9
  • Privacy
  • Terms of Use
  • Do not sell my personal information
  • AdChoices
Copyright © 2022 Adobe. All rights reserved.