mirror of
https://github.com/FriendsOfTYPO3/tea.git
synced 2024-11-23 00:16:12 +01:00
47dd2a71ca
This patch adds a badge for the code of conduct to the readme like suggested at https://www.contributor-covenant.org/
162 lines
5.8 KiB
Markdown
162 lines
5.8 KiB
Markdown
# Tea example
|
|
|
|
[](https://github.com/TYPO3-Documentation/tea/actions)
|
|
[](https://gitlab.typo3.org/qa/example-extension/-/pipelines)
|
|
[](https://packagist.org/packages/ttn/tea)
|
|
[](https://packagist.org/packages/ttn/tea)
|
|
[](https://packagist.org/packages/ttn/tea)
|
|
[](https://packagist.org/packages/ttn/tea)
|
|
[](CODE_OF_CONDUCT.md)
|
|
|
|
This TYPO3 extension is an example of best practices in continuous integration and automated code checks, also
|
|
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](https://github.com/oliverklee/workshop-handouts/tree/main/extbase-best-practices).
|
|
|
|
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)](https://github.com/oliverklee/tdd-reader).
|
|
|
|
This manual is rendered for reading [on docs.typo3.org](https://docs.typo3.org/p/ttn/tea/master/en-us/).
|
|
|
|
## Feature list
|
|
All of those checks are available in Github Actions and in Gitlab CI.
|
|
|
|
### PHP Lint check by php -l
|
|
|
|
`composer ci:php:lint`
|
|
|
|
### PHP code style fixer checks by [php-cs-fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer)
|
|
|
|
`composer ci:php:cs-fixer`
|
|
|
|
### PHP code sniffing by [phpcs](https://github.com/squizlabs/PHP_CodeSniffer)
|
|
|
|
`composer ci:php:sniff`
|
|
|
|
### PHP copy'n'paste check by [phpcpd](https://github.com/sebastianbergmann/phpcpd)
|
|
|
|
`composer ci:php:copypaste`
|
|
|
|
### PHP type checking by [PHPStan](https://github.com/phpstan/phpstan)
|
|
|
|
`composer ci:php:stan`
|
|
|
|
### JSON Lint check by [jsonlint](https://github.com/Seldaek/jsonlint)
|
|
|
|
`composer ci:json:lint`
|
|
|
|
### YAML Lint check by [yaml-lint](https://github.com/j13k/yaml-lint)
|
|
|
|
`composer ci:yaml:lint`
|
|
|
|
### TypoScript Lint by [typoscript-lint](https://github.com/martin-helmich/typo3-typoscript-lint)
|
|
|
|
`composer ci:ts:lint`
|
|
|
|
### Composer Normalize by [composer-normalize](https://github.com/ergebnis/composer-normalize)
|
|
|
|
`composer ci:composer:normalize`
|
|
|
|
### Running unit tests
|
|
|
|
`composer ci:tests:unit`
|
|
|
|
### Running functional tests
|
|
|
|
`composer ci:tests:functional`
|
|
|
|
### Running all tests
|
|
|
|
`composer ci:tests`
|
|
|
|
## Running the tests in PhpStorm
|
|
|
|
File > Settings > Languages & Frameworks > PHP > Test Frameworks
|
|
|
|
- (*) Use Composer autoloader
|
|
- Path to script: select `.Build/vendor/autoload.php` in 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/Unit` directory in your project
|
|
- (*) Use alternative configuration file
|
|
- use `.Build/vendor/nimut/testing-framework/res/Configuration/UnitTests.xml`
|
|
in 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/Unit` directory in your project
|
|
|
|
### Functional tests configuration
|
|
|
|
In the Run configurations, copy the PHPUnit configuration and use these settings:
|
|
|
|
- Directory: use the `Tests/Functional` directory 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
|
|
|
|
1. make sure you have Chrome installed on your machine
|
|
2. `composer update codeception/codeception` (just in case)
|
|
3. [download the latest version of ChromeDriver](http://chromedriver.chromium.org/downloads)
|
|
4. unzip it
|
|
5. `chromedriver --url-base=wd/hub`
|
|
6. `.Build/vendor/bin/codecept run` (in another terminal)
|
|
|
|
#### In PhpStorm
|
|
|
|
1. make sure the "Codeception Framework" plugin is activated
|
|
2. right-click on `Tests/Acceptance/StarterCest.php`
|
|
3. Run 'Acceptance (Codeception)'
|
|
|
|
## 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.
|
|
|
|
## Documentation rendering
|
|
|
|
In order to render documentation, first of all, clone repository
|
|
|
|
```bash
|
|
git clone https://github.com/TYPO3-Documentation/tea.git
|
|
```
|
|
then go to extension root
|
|
|
|
```bash
|
|
cd tea
|
|
```
|
|
|
|
and follow [the TYPO3 documentation quickstart guide](https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/RenderingDocs/Quickstart.html).
|
|
|
|
## More Documentation
|
|
|
|
* [Handout to my workshops on test-driven development (TDD)](https://github.com/oliverklee/tdd-reader)
|
|
* [Handout for best practices with extbase and fluid](https://github.com/oliverklee/workshop-handouts/blob/main/extbase-best-practices/extbase-best-practices.pdf)
|
|
|
|
## Other example projects
|
|
|
|
* [Selenium demo](https://github.com/oliverklee/selenium-demo)
|
|
for using Selenium with PHPUnit
|
|
* [Anagram finder](https://github.com/oliverklee/anagram-finder)
|
|
is the finished result of a code kata for TDD
|
|
* [Coffee example](https://github.com/oliverklee/coffee)
|
|
is my starting point for demonstrating TDD with TYPO3 CMS
|
|
* [TDD Seed](https://github.com/oliverklee/tdd-seed)
|
|
for starting PHPUnit projects with Composer (without TYPO3 CMS)
|