oliverklee/oelib

Useful stuff for TYPO3 extension development: helper functions for unit testing, templating and automatic configuration checks.

v6.0.2 2024-09-24 10:31 UTC

Requires

• php: ^7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0
• ext-dom: *
• ext-json: *
• ext-libxml: *
• ext-zip: *
• doctrine/dbal: ^2.13.8 || ^3.9
• psr/log: ^1.0 || ^2.0 || ^3.0
• symfony/polyfill-php80: ^1.31.0
• typo3/cms-core: ^11.5.37 || ^12.4.15
• typo3/cms-extbase: ^11.5.37 || ^12.4.15
• typo3/cms-fluid: ^11.5.37 || ^12.4.15
• typo3/cms-frontend: ^11.5.37 || ^12.4.15
• typo3fluid/fluid: ^2.7.4

Requires (Dev)

• ergebnis/composer-normalize: 2.43.0
• friendsofphp/php-cs-fixer: 3.64.0
• phpstan/extension-installer: 1.4.3
• phpstan/phpstan: 1.12.4
• phpstan/phpstan-phpunit: 1.4.0
• phpstan/phpstan-strict-rules: 1.6.1
• phpunit/phpunit: 9.6.21
• saschaegerer/phpstan-typo3: 1.10.2
• sjbr/static-info-tables: ^11.5.5 || ^12.4.3
• squizlabs/php_codesniffer: 3.10.3
• ssch/typo3-rector: 2.6.5
• ssch/typo3-rector-testing-framework: 2.0.1
• symfony/console: ^5.4.44 || ^6.4.12 || ^7.1.5
• symfony/translation: ^5.4.44 || ^6.4.12 || ^7.1.5
• symfony/yaml: ^5.4.44 || ^6.4.12 || ^7.1.5
• typo3/coding-standards: 0.6.1
• typo3/testing-framework: 7.1.0
• webmozart/assert: ^1.11.0

Replaces

• typo3-ter/oelib: v6.0.2

GPL-2.0-or-later

• Oliver Klee

• templating
• library
• extension

README

This extension provides useful stuff for extension development: helper functions for unit testing, templating and automatic configuration checks.

Most of the documentation is in ReST format in the Documentation/ folder and is rendered as part of the TYPO3 documentation.

Running the tests locally

You will need to have a Git clone of the extension for this with the Composer dependencies installed.

Running the unit tests

On the command line

To run all unit tests on the command line:

composer ci:tests:unit

To run all unit tests in a directory or file (using the directory Tests/Unit/Model/ as an example):

.Build/vendor/bin/phpunit -c .Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTests.xml Tests/Unit/Model/

In PhpStorm

First, you need to configure the path to PHPUnit in the settings:

Languages & Frameworks > PHP > Test Frameworks

In this section, configure PhpStorm to use the Composer autoload and the script path .Build/vendor/autoload.php within your project.

In the Run/Debug configurations for PHPUnit, use an alternative configuration file:

.Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTests.xml

Running the functional tests

You will need a local MySQL user that has the permissions to create new databases.

In the examples, the following credentials are used:

• user name: typo3
• password: typo3pass
• DB name prefix: typo3_test (optional)
• DB host: localhost (omitted as this is the default)

You will need to provide those credentials as environment variables when running the functional tests:

• typo3DatabaseUsername
• typo3DatabasePassword
• typo3DatabaseName

On the command line

To run all functional tests on the command line:

typo3DatabaseUsername=typo3 typo3DatabasePassword=typo3pass typo3DatabaseName=typo3_test composer ci:tests:functional

To run all functional tests in a directory or file (using the directory Tests/Functional/Authentication/ as an example):

typo3DatabaseUsername=typo3 typo3DatabasePassword=typo3pass typo3DatabaseName=typo3_test .Build/vendor/bin/phpunit -c .Build/vendor/typo3/testing-framework/Resources/Core/Build/FunctionalTests.xml Tests/Functional/Authentication/

In PhpStorm

First, you need to configure the path to PHPUnit in the settings:

Languages & Frameworks > PHP > Test Frameworks

In this section, configure PhpStorm to use the Composer autoload and the script path .Build/vendor/autoload.php within your project.

In the Run/Debug configurations for PHPUnit, use an alternative configuration file:

.Build/vendor/typo3/testing-framework/Resources/Core/Build/FunctionalTests.xml

Also set the following environment variables in your runner configuration:

• typo3DatabaseUsername
• typo3DatabasePassword
• typo3DatabaseName