Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eliashaeussler/typo3-codeception-helper
🧪 Helper functions for Codeception tests within TYPO3 extensions
https://github.com/eliashaeussler/typo3-codeception-helper
acceptance-testing codeception testing typo3
Last synced: about 1 month ago
JSON representation
🧪 Helper functions for Codeception tests within TYPO3 extensions
- Host: GitHub
- URL: https://github.com/eliashaeussler/typo3-codeception-helper
- Owner: eliashaeussler
- License: gpl-2.0
- Created: 2023-07-05T06:50:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-16T03:31:45.000Z (about 2 months ago)
- Last Synced: 2024-09-16T05:08:19.863Z (about 2 months ago)
- Topics: acceptance-testing, codeception, testing, typo3
- Language: PHP
- Homepage:
- Size: 573 KB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# TYPO3 Codeception Helper
[](https://coveralls.io/github/eliashaeussler/typo3-codeception-helper)
[](https://codeclimate.com/github/eliashaeussler/typo3-codeception-helper/maintainability)
[](https://github.com/eliashaeussler/typo3-codeception-helper/actions/workflows/cgl.yaml)
[](https://github.com/eliashaeussler/typo3-codeception-helper/actions/workflows/tests.yaml)
[](https://packagist.org/packages/eliashaeussler/typo3-codeception-helper)
This library provides some helper functions for [Codeception](https://codeception.com/)
tests within TYPO3 extensions. In addition, an application entrypoint
modifier extension for coverage collection within acceptance tests
is distributed.
## 🔥 Installation
[](https://packagist.org/packages/eliashaeussler/typo3-codeception-helper)
[](https://packagist.org/packages/eliashaeussler/typo3-codeception-helper)
```bash
composer require --dev eliashaeussler/typo3-codeception-helper
```
## ⚡ Usage
### `ApplicationEntrypointModifier` extension
> Source: [`Codeception\Extension\ApplicationEntrypointModifier`](src/Codeception/Extension/ApplicationEntrypointModifier.php)
A Codeception extension that aims to ease the integration effort
when collecting code coverage with [`codeception/c3`](https://github.com/Codeception/c3).
It replaces an existing entrypoint (e.g. `typo3/index.php`) with
a modified entrypoint that includes the distributed `c3.php` file.
Enable this extension in your `codeception.yml` file:
```yaml
# codeception.yml
extensions:
enabled:
- EliasHaeussler\Typo3CodeceptionHelper\Codeception\Extension\ApplicationEntrypointModifier:
entrypoints:
- web-dir: .Build/web
main-entrypoint: index.php
app-entrypoint: app.php
- web-dir: .Build/web/typo3
main-entrypoint: index.php
app-entrypoint: app.php
```
For each entrypoint, the following config must be provided:
| Config name | Description | Default value |
|-------------------|--------------------------------------------------------------------------------|---------------|
| `web-dir` | Relative path from project root to directory that contains the main entrypoint | – |
| `main-entrypoint` | Name of the entrypoint to replace (the file being accessed by the web server) | `index.php` |
| `app-entrypoint` | Name of the original relocated entrypoint (the renamed main entrypoint) | `app.php` |
#### Example
Given the following directory structure:
```
.Build
└── web
└── index.php # main entrypoint provided by framework/application
```
Once the extension is enabled and properly configured, the following
directory structure exists after the test suite is started:
```
.Build
└── web
├── app.php # contains the original contents from index.php
└── index.php # generated entrypoint that includes c3.php and app.php
```
### `Backend` module
> Source: [`Codeception\Module\Backend`](src/Codeception/Module/Backend.php)
A Codeception module that allows to perform actions within TYPO3
backend. It can for example be used to log into the TYPO3 backend.
> [!NOTE]
> This module requires the [`WebDriver`](https://codeception.com/docs/modules/WebDriver)
> module to be installed and enabled.
Enable this module in your `codeception.yml` file:
```yaml
# codeception.yml
suites:
Acceptance:
actor: AcceptanceTester
modules:
enabled:
- EliasHaeussler\Typo3CodeceptionHelper\Codeception\Module\Backend
```
#### Available methods
**`login($username, $password): void`**
Perform backend login for the given user. The user is identified
by the given username and is authenticated by the given password.
Example:
```php
$I->login('admin', 'password');
```
**`loginAs($username): void`**
Perform backend login for the given user. The user is identified
by the given username which must be configured in the codeception
module config (see [Configure backend users](#configure-backend-users)).
Example:
```php
$I->loginAs('admin');
```
**`openModule($identifier): void`**
Open a backend module by clicking on the module link. The module
link is identified by a given node identifier. Note that the
identifier differs between TYPO3 versions (see example below).
Example:
```php
// TYPO3 11
$I->openModule('#web_list');
// TYPO3 12
$I->openModule('[data-modulemenu-identifier="web_list"]');
```
#### Configure backend users
> [!NOTE]
> Backend users are not automatically created by this module.
> You need to take care of that by your own, e.g. by
> [importing static database fixtures](https://codeception.com/docs/modules/Db#SQL-data-dump)
> before tests are executed.
In order to use the `loginAs()` method, existing backend users
must be configured in the module config section:
```diff
suites:
Acceptance:
actor: AcceptanceTester
modules:
enabled:
- - EliasHaeussler\Typo3CodeceptionHelper\Codeception\Module\Backend
+ - EliasHaeussler\Typo3CodeceptionHelper\Codeception\Module\Backend:
+ userCredentials:
+ admin: password
+ editor: password
```
## 🧑💻 Contributing
Please have a look at [`CONTRIBUTING.md`](CONTRIBUTING.md).
## ⭐ License
This project is licensed under [GNU General Public License 2.0 (or later)](LICENSE).