qa_automation.md

QA Automation

QA automation is a feature that lets you run QA tools such as code style checks, static analysis, and unit tests required by Spryker.

How to enable QA automation

You can enable the QA automation at the project initialization step as an additional setting. To achieve this, do the following:

1. Run this command:

spryker-sdk sdk:init:project

2. Pick the necessary steps from the list. If none is picked, the default list will be used. You can check the default list in the settings.yaml file, in settings.qa_tasks.values.

After the project initialization, the QA automation tasks are saved to the .ssdk/setting file.

Result example:

qa_tasks:
    - 'validation:php:rector'
    - 'validation:php:codestyle-check'
    - 'validation:php:static'

How to use the QA automation

To execute all of the QA automation tasks, run the following command:

spryker-sdk sdk:qa:run

To customize the list of the executable QA automation tasks, change the qa_tasks block in in the .ssdk/setting file accordingly.

To add a custom QA task, your task ID name should have the validation:* pattern.

Tests execution

QA automation can execute unit tests, but only if it doesn't require the project environment configuration. Otherwise, the result might be unpredictable.