tea/README.md

# Tea example

[![GitHub CI Status](https://github.com/TYPO3-Documentation/tea/workflows/CI/badge.svg?branch=main)](https://github.com/TYPO3-Documentation/tea/actions)
[![Gitlab CI Status](https://gitlab.typo3.org/qa/example-extension/badges/main/pipeline.svg)](https://gitlab.typo3.org/qa/example-extension/-/pipelines)
[![Latest Stable Version](https://poser.pugx.org/ttn/tea/v/stable.svg)](https://packagist.org/packages/ttn/tea)
[![Total Downloads](https://poser.pugx.org/ttn/tea/downloads.svg)](https://packagist.org/packages/ttn/tea)
[![Latest Unstable Version](https://poser.pugx.org/ttn/tea/v/unstable.svg)](https://packagist.org/packages/ttn/tea)
[![License](https://poser.pugx.org/ttn/tea/license.svg)](https://packagist.org/packages/ttn/tea)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](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)'

## Developing locally

In order to work on the extension locally, you can use a local environment (local PHP, server) or use
a widely adopted tool in TYPO3 Community, [ddev](https://github.com/drud/ddev), which we recommend.

## Running Composer commands in the DDEV container

If you use ddev, then you can use the provided command in root of your repository. You don't need to
manually startup containers, you can run commands straight away, and project will automatically boot up.

Example:

```bash
ddev composer ci:ts:lint
```

## Running tests locally via DDEV

### Unit tests

To run unit tests, type:

```bash
composer ci:tests:unit
```

## Running lints in CI
### GitHub
For GitHub, we prepared two ways of running lints:
1. relies on executing composer scripts
2. using exported, prepared GitHub Actions in your workflow.
#### Composer scripts
You can run your lints using composer scripts. An example workflow is defined in
`ci-composer-scripts.yml`.
#### Ready to use GitHub Actions
You can use prepared GitHub Actions. All of ready to use GitHub Actions are in
[TYPO3 Continuous Integration organisation](https://github.com/TYPO3-Continuous-Integration).
An example workflow is defined in `ci.yml`
### GitLab
For GitLab, please use the pipeline that is defined in `.gitlab-ci.yml`.
## 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)