Skip to content

Commit 134734b

Browse files
committed
Added new option --disable-coverage-php to skip coverage.serialized report
1 parent 6d3522c commit 134734b

File tree

2 files changed

+38
-34
lines changed

2 files changed

+38
-34
lines changed

docs/Codecoverage.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,13 @@ All you need is to execute codeception with `--coverage` option.
9292
To generate a clover xml report or a tasty html report append also `--coverage-xml` and `--coverage-html` options.
9393

9494

95-
```yaml
95+
```bash
9696
php vendor/bin/codecept run --coverage --coverage-xml --coverage-html
9797
```
9898

99+
> note: If you don't need to generate default PHP coverage report (coverage.serialized) you can call `--disable-coverage-php` option.
100+
This option can help you reduce memory usage and fix problems with memory leak on the huge projects.
101+
99102
XML and HTML reports are stored to the `_output` directory. The best way to review report is to open `index.html` from `tests/_output/coverage` in your browser.
100103
XML clover reports are used by IDEs (like PHPStorm) or Continuous Integration servers (like Jenkins).
101104

docs/reference/Commands.md

Lines changed: 34 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -54,39 +54,40 @@ Arguments:
5454

5555
Options:
5656
-o, --override=OVERRIDE Override config values (multiple values allowed)
57-
--config (-c) Use custom path for config
58-
--report Show output in compact style
59-
--html Generate html with results (default: "report.html")
60-
--xml Generate JUnit XML Log (default: "report.xml")
61-
--phpunit-xml Generate PhpUnit XML Log (default: "phpunit-report.xml")
62-
--no-redirect Do not redirect to Composer-installed version in vendor/codeception
63-
--colors Use colors in output
64-
--no-colors Force no colors in output (useful to override config file)
65-
--silent Only outputs suite names and final results. Almost the same as `--quiet`
66-
--steps Show steps in output
67-
--debug (-d) Alias for `-vv`
68-
--bootstrap Execute bootstrap script before the test
69-
--coverage Run with code coverage (default: "coverage.serialized")
70-
--coverage-html Generate CodeCoverage HTML report in path (default: "coverage")
71-
--coverage-xml Generate CodeCoverage XML report in file (default: "coverage.xml")
72-
--coverage-text Generate CodeCoverage text report in file (default: "coverage.txt")
73-
--coverage-phpunit Generate CodeCoverage PHPUnit report in file (default: "coverage-phpunit")
74-
--coverage-cobertura Generate CodeCoverage Cobertura report in file (default: "coverage-cobertura")
75-
--no-exit Don't finish with exit code
76-
--group (-g) Groups of tests to be executed (multiple values allowed)
77-
--skip (-s) Skip selected suites (multiple values allowed)
78-
--skip-group (-x) Skip selected groups (multiple values allowed)
79-
--env Run tests in selected environments. (multiple values allowed, environments can be merged with ',')
80-
--fail-fast (-f) Stop after nth failure (defaults to 1)
81-
--no-rebuild Do not rebuild actor classes on start
82-
--help (-h) Display this help message.
83-
--quiet (-q) Do not output any message. Almost the same as `--silent`
84-
--verbose (-v|vv|vvv) Increase the verbosity of messages: `v` for normal output, `vv` for steps and debug, `vvv` for Codeception-internal debug
85-
--version (-V) Display this application version.
86-
--ansi Force ANSI output.
87-
--no-ansi Disable ANSI output.
88-
--no-interaction (-n) Do not ask any interactive question.
89-
--seed Use the given seed for shuffling tests
57+
--config (-c) Use custom path for config
58+
--report Show output in compact style
59+
--html Generate html with results (default: "report.html")
60+
--xml Generate JUnit XML Log (default: "report.xml")
61+
--phpunit-xml Generate PhpUnit XML Log (default: "phpunit-report.xml")
62+
--no-redirect Do not redirect to Composer-installed version in vendor/codeception
63+
--colors Use colors in output
64+
--no-colors Force no colors in output (useful to override config file)
65+
--silent Only outputs suite names and final results. Almost the same as `--quiet`
66+
--steps Show steps in output
67+
--debug (-d) Alias for `-vv`
68+
--bootstrap Execute bootstrap script before the test
69+
--coverage Run with code coverage (default: "coverage.serialized")
70+
--disable-coverage-php Don't generate CodeCoverage report in raw PHP serialized format
71+
--coverage-html Generate CodeCoverage HTML report in path (default: "coverage")
72+
--coverage-xml Generate CodeCoverage XML report in file (default: "coverage.xml")
73+
--coverage-text Generate CodeCoverage text report in file (default: "coverage.txt")
74+
--coverage-phpunit Generate CodeCoverage PHPUnit report in file (default: "coverage-phpunit")
75+
--coverage-cobertura Generate CodeCoverage Cobertura report in file (default: "coverage-cobertura")
76+
--no-exit Don't finish with exit code
77+
--group (-g) Groups of tests to be executed (multiple values allowed)
78+
--skip (-s) Skip selected suites (multiple values allowed)
79+
--skip-group (-x) Skip selected groups (multiple values allowed)
80+
--env Run tests in selected environments. (multiple values allowed, environments can be merged with ',')
81+
--fail-fast (-f) Stop after nth failure (defaults to 1)
82+
--no-rebuild Do not rebuild actor classes on start
83+
--help (-h) Display this help message.
84+
--quiet (-q) Do not output any message. Almost the same as `--silent`
85+
--verbose (-v|vv|vvv) Increase the verbosity of messages: `v` for normal output, `vv` for steps and debug, `vvv` for Codeception-internal debug
86+
--version (-V) Display this application version.
87+
--ansi Force ANSI output.
88+
--no-ansi Disable ANSI output.
89+
--no-interaction (-n) Do not ask any interactive question.
90+
--seed Use the given seed for shuffling tests
9091

9192
{% endhighlight %}
9293

0 commit comments

Comments
 (0)