14c3a513c1
We only want to see whether the build for the current default branch is successful, not the status of any other branches or PRs. Also make the alt text for the badge more specific as we now have two CI builds (GitHub and GitLab). |
||
|---|---|---|
| .github/workflows | ||
| .gitlab | ||
| Classes | ||
| Configuration | ||
| Resources | ||
| Tests | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .php_cs.php | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| codeception.yml | ||
| composer.json | ||
| ext_emconf.php | ||
| ext_localconf.php | ||
| ext_tables.sql | ||
| LICENSE | ||
| phpcs.xml | ||
| README.md | ||
Tea example
This TYPO3 extension is an example for writing unit and functional tests for Extbase/Fluid-based extensions for TYPO3 CMS using PHPUnit.
It also is an example for best practices for extbase/fluid.
For information on the different ways to execute the tests, please have a look at the handout to my workshops on test-driven development (TDD).
Running the unit tests from the command line
composer ci:tests:unit
Running the tests in PhpStorm
File > Settings > Languages & Frameworks > PHP > Test Frameworks
- (*) Use Composer autoloader
- Path to script: select
.Build/vendor/autoload.phpin your project folder
In the Run configurations, edit the PHPUnit configuration and use these settings so this configuration can serve as a template:
- Directory: use the
Tests/Unitdirectory in your project - (*) Use alternative configuration file
- use
.Build/vendor/nimut/testing-framework/res/Configuration/UnitTests.xmlin your project folder - add the following environment variables:
- typo3DatabaseUsername
- typo3DatabasePassword
- typo3DatabaseHost
- typo3DatabaseName
Unit tests configuration
In the Run configurations, copy the PHPUnit configuration and use these settings:
- Directory: use the
Tests/Unitdirectory in your project
Functional tests configuration
In the Run configurations, copy the PHPUnit configuration and use these settings:
- Directory: use the
Tests/Functionaldirectory in your project - (x) Use alternative configuration file
- use
.Build/vendor/nimut/testing-framework/res/Configuration/FunctionalTests.xml
Running the acceptance tests
On the command line
- make sure you have Chrome installed on your machine
composer update codeception/codeception(just in case)- download the latest version of ChromeDriver
- unzip it
chromedriver --url-base=wd/hub.Build/vendor/bin/codecept run(in another terminal)
In PhpStorm
- make sure the "Codeception Framework" plugin is activated
- right-click on
Tests/Acceptance/StarterCest.php - Run 'Acceptance (Codeception)'
Creating new extensions with automated tests
For creating new extensions, I recommend taking Helmut Hummel's extension skeleton as a starting point.
Security
Libraries and extensions do not need the security check as they should not have
any restrictions concerning the other libraries they are installed alongside with
(unless those would create breakage), and they also do not have a composer.lock
which usually is the source for security checks.
Instead, the projects (i.e., for TYPO3 installations) need to have the security checks.
More Documentation
- Handout to my workshops on test-driven development (TDD)
- Handout for best practices with extbase and fluid
Other example projects
- Selenium demo for using Selenium with PHPUnit
- Anagram finder is the finished result of a code kata for TDD
- Coffee example is my starting point for demonstrating TDD with TYPO3 CMS
- TDD Seed for starting PHPUnit projects with Composer (without TYPO3 CMS)