Testomatio - Test Management for Codeception
The global configuration file
codeception.yml is generated by the
codecept bootstrap command. Alphabetical list of options:
Sets the suffix for “Actor” classes. Default:
Tester. If you set it to
Ninja and generate a new
api test suite, you will get an
ApiNinja actor class.
Bootstrap script that will be executed before all suites. A script should be put into
Allows you to specify a file (relative to the
codeception.yml file) that holds some already pre-defined values. This can be used to always use the same configuration for modules or whatever.
Allows to enable and configure Codeception extensions, Group Objects, and Custom Commands.
Include additional Codeception configurations for multiple applications setup.
Allows to create shared module configuration for all included suites.
Sets the namespace under which all new tests and support classes will be generated. Allows to configure multiple test setups for one runner.
Allows to pass external parameters into module configuration.
Directories used by Codeception. Default values:
Allows to change default reporters of Codeception
Provide additional options for the test runner. They may dramatically change the way Codeception is executed. For instance, take a note of
shuffle option which allows to randomize tests execution order and
lint option that toggles parsing a test file (using
php -l) before loading it.
backup_globals: true: Controls whether PHPUnit attempts to backup global variables, see https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.backupGlobals
be_strict_about_changes_to_global_state: false: PHPUnit can be strict about tests that manipulate global state, see https://phpunit.de/manual/current/en/risky-tests.html#risky-tests.global-state-manipulation
colors: true: By default this is false on Windows. Use ANSICON to colorize output.
convert_deprecations_to_exceptions: falseConverts E_DEPRECATED and E_USER_DEPRECATED events to exceptions. Introduced in Codeception 4.2.0
disallow_test_output: false: PHPUnit can be strict about output during tests, see https://phpunit.de/manual/current/en/risky-tests.html#risky-tests.output-during-test-execution
editor_url: 'atom://core/open/file?filename=%%file%%&line=%%line%%': In the console output, the test runner will replace all references to files with “clickable” URL’s, allowing you to open the file directly in your IDE. Depending on your operating system, you may have to set up an appropriate uri handler. Syntax for some common editors (same as in PHPStan):
error_level: E_ALL & ~E_STRICT & ~E_DEPRECATED: Set the error_reporting level. You can specify either a predefined constant or an integer value, see https://www.php.net/manual/en/function.error-reporting.php and https://www.php.net/manual/en/errorfunc.constants.php
memory_limit: 1024M: Tests (especially functional) can take a lot of memory. We set a high limit for them by default.
lint: true: Enable/disable syntax of test files before loading. For PHP < 7
exec('php -l')is used. Disable if you need to speed up tests execution.
log_incomplete_skipped: false: Log the incomplete and skipped tests into junit report ,see https://phpunit.de/manual/current/en/appendixes.configuration.html Section logging > junit
report_useless_tests: false: PHPUnit can be strict about tests that do not test anything, see https://phpunit.de/manual/current/en/risky-tests.html#risky-tests.useless-tests
shuffle: true: Randomize test order
strict_xml: false: Generate XML JUnit report using strict schema. Avoid putting additional report fields like steps or scenario names to it. Required for XML reports on Jenkins CI
Each suite has its own configuration inside the directory set by
paths: tests: in
codeception.yml. Alphabetical list of options:
Name of the “Actor” class of the current suite.
Bootstrap script that will be executed before current suite. A script should be put into suite directory.
Per suite CodeCoverage settings.
Override any configuration per environment.
error level for runner in the current suite. Can be specified for unit, integration, functional tests. Passes value to
Allows you to specify a file (relative to
*.suite.yml) that holds some already pre-defined values. This can be used to always use the same configuration for modules or whatever.
Per suite Gherkin settings.
groups with the list of tests of for corresponding group.
formats with the list of extra test format classes.
List of enabled modules with their configuration.
Default namespace of actor, support classes and tests.
Default namespace for new tests of this suite (ignores
To provide the same configuration template for your development team, you can create a
codeception.dist.yml config file, which will be loaded before
codeception.yml. The dist config provides shared options, while local
codeception.yml files override them on a per-installation basis. Therefore,
codeception.yml should be ignored by your VCS system.
Config templates can also be used for suite configuration, by creating a
Configuration loading order: