toumoro/tm-qa-tools

Ships a list of tools that runs and manages automated functional and acceptance tests from the backend or CLI.

dev-main 2025-09-24 10:50 UTC

Requires

• php: >=8.1
• helmich/typo3-typoscript-lint: ^3.3
• j13k/yaml-lint: ^1.1.6
• php-parallel-lint/php-console-highlighter: ^1.0.0
• php-parallel-lint/php-parallel-lint: ^1.4.0
• sclable/xml-lint: ^0.9.0
• typo3/cms-core: ^12.4.0 || ^13.4.0
• typo3/coding-standards: ^0.8.0
• typo3/testing-framework: ^9.2

Replaces

• typo3-ter/tm-qa-tools: dev-main

GPL-3.0-or-later

• Simon Ouellet
• Mehdi Guermazi
• Michel Schmit
• Haythem Daoud

• migration
• typo3
• Toumoro
• QA Automation

README

tm_qa_tools -- Boîte à outils d’assurance qualité TYPO3

Un ensemble d'outils permettant d'automatiser la phase d'assurance qualité et d'appliquer les standards de codage dans les projets TYPO3.

Prérequis

Assurez-vous que ces variables d’environnement sont définies :

• typo3DatabaseUsername
• typo3DatabasePassword
• typo3DatabaseHost
• typo3DatabaseName

Installation

composer req toumoro/tm-qa-tools --dev

Ensuite, ajoutez ces scripts dans le fichier composer.json de votre projet :

"scripts": {
    "post-autoload-dump": [
        "@qa-tools-scripts"
    ],
    "post-install-cmd": [
        "git init",
        "git config --local core.hooksPath .githooks/"
    ],
    "qa-tools-scripts": [
        "chmod +x vendor/toumoro/tm-qa-tools/services/configure.sh",
        "vendor/toumoro/tm-qa-tools/services/configure.sh"
    ],
    "ci:php": [
        "@ci:php:cs",
        "@ci:php:lint",
        "@ci:php:stan",
        "@ci:php:unit"
    ],
    "fix:php": [
        "@fix:php:rector",
        "@fix:php:cs"
    ],
    "ci:php:cs": "php-cs-fixer fix --config=Build/php-cs-fixer/php-cs-fixer.php -v --dry-run --using-cache no --diff",
    "ci:php:lint": "parallel-lint --show-deprecated --exclude vendor ./packages",
    "ci:php:stan": "phpstan analyse --ansi --no-progress --configuration=Build/phpstan/phpstan.neon",
    "ci:lint:typoscript": "typoscript-lint ./packages --ansi -n --fail-on-warnings",
    "ci:lint:xml": "xmllint packages --pattern '*.xlf,*.svg' --ansi",
    "ci:lint:yaml": "yaml-lint packages/**/Configuration/*.yaml",
    "ci:php:unit": "phpunit -c ./Build/phpunit/UnitTests.xml",
    "fix:php:cs": "php-cs-fixer fix --config=Build/php-cs-fixer/php-cs-fixer.php",
    "fix:php:rector": [
        "rector process --clear-cache"
    ]
}

Puis mettez à jour le fichier .gitignore :

.php-cs-fixer.cache
/Build/phpunit/.phpunit.result.cache

Dépannage

Conflits de dépendances

composer update -W

Erreurs de permissions sur la base de données

Si vous obtenez des erreurs liées aux permissions de la base de données, exécutez la commande suivante dans votre conteneur MySQL/MariaDB :

docker exec -it <container_name> mysql -u root -p

Puis dans le shell MySQL :

GRANT ALL ON `dev_%`.* TO 'dev'@'%';
FLUSH PRIVILEGES;

Exemple d’utilisation

Analyser le code PHP pour détecter les problèmes de style et erreurs

composer ci:lint:typoscript

Corriger le code PHP (appliquer les standards de codage)

composer fix:php

Vérifier le code TypoScript

composer ci:lint:typoscript

Lancer tous les tests avec le script dédié

chmod +x ./Build/Scripts/runTests.sh

# Lancer tous les tests
./Build/Scripts/runTests.sh functional:all

# Lancer un test spécifique
./Build/Scripts/runTests.sh functional:single PageActionsTest

Tests UI avec Playwright

Les tests Playwright sont disponibles sous le domaine :
playwright-${YOUR_DOMAIN}

Extensibilité

Pour les tests fonctionnels, vous pouvez ajouter un chemin personnalisé vers un fichier de fixtures et le configurer via l’option d’extension fixturesPath.

Pour les tests Playwright, vous pouvez ajouter vos tests personnalisés dans une extension existante ou dans une nouvelle.
Il est essentiel d’ajouter le chemin du dossier de tests à votre fichier docker-compose-cloud.yml afin de garantir leur bonne exécution.

EN

tm_qa_tools -- TYPO3 Quality Assurance Toolkit

A set of tools to automate quality checks and enforce coding standards for TYPO3 projects.

Requirements

Make sure these environment variables are set:

• typo3DatabaseUsername
• typo3DatabasePassword
• typo3DatabaseHost
• typo3DatabaseName

Installation

composer req toumoro/tm-qa-tools --dev

Then add these scripts to your project's composer.json file:

"scripts": {
    "post-autoload-dump": [
        "@qa-tools-scripts"
    ],
    "post-install-cmd": [
        "git init",
        "git config --local core.hooksPath .githooks/"
    ],
    "qa-tools-scripts": [
        "chmod +x vendor/toumoro/tm-qa-tools/services/configure.sh",
        "vendor/toumoro/tm-qa-tools/services/configure.sh"
    ],
    "ci:php": [
        "@ci:php:cs",
        "@ci:php:lint",
        "@ci:php:stan",
        "@ci:php:unit"
    ],
    "fix:php": [
        "@fix:php:rector",
        "@fix:php:cs"
    ],
    "ci:php:cs": "php-cs-fixer fix --config=Build/php-cs-fixer/php-cs-fixer.php -v --dry-run --using-cache no --diff",
    "ci:php:lint": "parallel-lint --show-deprecated --exclude vendor ./packages",
    "ci:php:stan": "phpstan analyse --ansi --no-progress --configuration=Build/phpstan/phpstan.neon",
    "ci:lint:typoscript": "typoscript-lint ./packages --ansi -n --fail-on-warnings",
    "ci:lint:xml": "xmllint packages --pattern '*.xlf,*.svg' --ansi",
    "ci:lint:yaml": "yaml-lint packages/**/Configuration/*.yaml",
    "ci:php:unit": "phpunit -c ./Build/phpunit/UnitTests.xml",
    "fix:php:cs": "php-cs-fixer fix --config=Build/php-cs-fixer/php-cs-fixer.php",
    "fix:php:rector": [
        "rector process --clear-cache"
    ]
}

Then update .gitignore file:

# ....

.php-cs-fixer.cache
/Build/phpunit/.phpunit.result.cache

Troubleshooting

Dependency conflicts:

composer update -W

Database permission errors

If you get database permission errors, run the following inside your MySQL/MariaDB container:

docker exec -it <container_name> mysql -u root -p

Then in the MySQL shell:

GRANT ALL ON `dev_%`.* TO 'dev'@'%';
FLUSH PRIVILEGES;

Example Usage

Analyze PHP code for style issues and errors

composer ci:lint:typoscript

Fix PHP code (Apply coding standards)

composer fix:php

Check TypoScript code for errors

composer ci:lint:typoscript

Run all tests using the command:

chmod +x ./Build/Scripts/runTests.sh

# Run all
./Build/Scripts/runTests.sh functional:all

# Run a specific test
./Build/Scripts/runTests.sh functional:single PageActionsTest

Tests UI avec Playwright

Playwright tests are available under playwright-${YOUR_DOMAIN}.

Extensibility

For functional tests, you can add a custom fixtures file path and then configure it under the extension configuration setting fixturesPath.

For Playwright tests, you can add your custom tests in an existing extension or in a new one. It's essential to add the tests folder path to your docker-compose-cloud.yml file to ensure they are properly executed.