https://github.com/codeception/robo-paracept
Robo tasks for Codeception tests parallel execution
https://github.com/codeception/robo-paracept
Last synced: 5 months ago
JSON representation
Robo tasks for Codeception tests parallel execution
- Host: GitHub
- URL: https://github.com/codeception/robo-paracept
- Owner: Codeception
- License: mit
- Created: 2014-04-30T03:19:30.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-05-20T18:36:34.000Z (over 1 year ago)
- Last Synced: 2025-06-23T01:35:11.990Z (5 months ago)
- Language: PHP
- Size: 278 KB
- Stars: 57
- Watchers: 13
- Forks: 62
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
robo-paracept
=============
[](https://github.com/Codeception/robo-paracept/actions/workflows/php.yml)
[](https://packagist.org/packages/codeception/robo-paracept)
[](https://packagist.org/packages/codeception/robo-paracept)
[](https://packagist.org/packages/codeception/robo-paracept)
Robo tasks for Codeception tests parallel execution. Requires [Robo Task Runner](https://robo.li)
## Install via Composer
```
composer require codeception/robo-paracept --dev
```
Include into your RoboFile
```php
taskSplitTestsByGroups(5)
->testsFrom('tests/acceptance')
->projectRoot('.')
->groupsTo('tests/_data/group_')
->run();
// task returns a result which contains information about processed data:
// optionally check result data
if ($result->wasSuccessful()) {
$groups = $result['groups'];
$tests = $result['tests'];
$filenames = $result['files'];
}
```
> This command **loads Codeception into memory**, loads and parses tests to organize them between group. If you want just split test file and not actual tests (and not load tests into memory) use `taskSplitTestFilesByGroups`:
### SplitTestFilesByGroups
To split tests by suites (files) without loading them into memory use `taskSplitTestFilesByGroups` method:
```php
$result = $this->taskSplitTestFilesByGroups(5)
->testsFrom('tests')
->groupsTo('tests/_data/paratest_')
->run();
// optionally check result data
if ($result->wasSuccessful()) {
$filenames = $result['files'];
}
```
### SplitTestsByTime
Enable extension for collect execution time of you use taskSplitTestsByTime
```
extensions:
enabled:
- Codeception\Task\Extension\TimeReporter
```
Load tests from a folder and distributes them between groups by execution time.
```php
$result = $this->taskSplitTestsByTime(5)
->testsFrom('tests/acceptance')
->projectRoot('.')
->groupsTo('tests/_data/group_')
->run();
// optionally check result data
if ($result->wasSuccessful()) {
$filenames = $result['files'];
}
```
this command need run all tests with `Codeception\Task\TimeReporter` for collect execution time. If you want just split tests between group (and not execute its) you can use SplitTestsByGroups. **Please be aware**: This task will not consider any 'depends' annotation!
### SplitFailedTests
Enable extension for collect failed tests if you use taskSplitFailedTests
The extension saves the report files into \Codeception\Configuration::outputDir()
```
extensions:
enabled:
- Codeception\Task\Extension\FailedTestsReporter
```
Merge the created report files from the FailedTestsReporter into single file
```php
$this->taskMergeFailedTestsReports()
->fromPathWithPattern(\Codeception\Configuration::outputDir(), '/failedTests_\w+\.txt$/')
->into(\Codeception\Configuration::outputDir() . 'failedTests.txt') // absolute path with Filename
->run();
```
Load the failed Tests from a reportfile into the groups:
```php
$result = $this
->taskSplitFailedTests(5)
->setReportPath(\Codeception\Configuration::outputDir() . 'failedTests.txt') // absoulute Path to Reportfile
->groupsTo(\Codeception\Configuration::outputDir() . 'group_')
->run();
// optionally check result data
if ($result->wasSuccessful()) {
$filenames = $result['files'];
}
```
### MergeXmlReports
Mergex several XML reports:
```php
$this->taskMergeXmlReports()
->from('tests/result/result1.xml')
->from('tests/result/result2.xml')
->into('tests/result/merged.xml')
->run();
```
### MergeHtmlReports
Mergex several HTML reports:
```php
$this->taskMergeHtmlReports()
->from('tests/result/result1.html')
->from('tests/result/result2.html')
->into('tests/result/merged.html')
->run();
```
## Filters
You can use a custom filter to select the necessary tests.
Two filters already included: DefaultFilter, GroupFilter
* **DefaultFilter** is enabled by default, takes all tests.
* **GroupFilter** _(Can only be used by taskSplitTestsByGroups)_, allows you to filter the loaded tests by the given groups. You have the possibility to declare groups which you want to include or exclude. If you declare foo and bar as included, only tests with this both group annotations will be matched. The same thing is happend when you add excluded groups. If you combine the included and excluded group the only tests which have exactly the correct group annotations for the included items and none of the excluded items.
You can add as many filters as you want. The FIFO (First In - First Out) principle applies. The next filter will only get the result of the filter before.
### Usage
For example, you want all tests which have in the doc comment the groups 'foo' AND 'bar' but not 'baz' then you can do it like this:
```php
$filter = new GroupFilter();
$filter
->groupIncluded('foo')
->groupIncluded('bar')
->groupExcluded('baz');
$this->taskSplitTestsByGroups(5)
->testsFrom('tests')
->groupsTo('tests/_data/paratest_')
->addFilter($filter)
->run();
```
Now create your own filter class:
```php