Skip to content

Commit 4b6385b

Browse files
Update Configuration.md
1 parent 26e7950 commit 4b6385b

File tree

1 file changed

+54
-32
lines changed

1 file changed

+54
-32
lines changed

docs/reference/Configuration.md

Lines changed: 54 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -134,52 +134,74 @@ settings:
134134

135135
{% endhighlight %}
136136

137-
## Suite Configuration
137+
## Suite Configuration: `unit.suite.yml`, `functional.suite.yml` etc.
138138

139-
Each generated suite have its own configuration inside directory set by `paths: tests: ` configuration option in `codeception.yml`. Each suite configuration is named like `suitename.suite.yml`. It allows to enable and configure modules, and more.
139+
Each suite has its own configuration inside the directory set by `paths: tests: ` in `codeception.yml`. Alphabetical list of options:
140140

141-
* `actor`: name of the actor class for current suite.
142-
* `modules`: list of enabled modules with their configuration.
141+
### `actor`
143142

144-
{% highlight yaml %}
143+
Name of the "Actor" class of the current suite.
144+
145+
### `bootstrap`
146+
147+
Bootstrap script that will be executed before current suite. A script should be put into suite directory.
148+
149+
### `coverage`
150+
151+
Per suite [CodeCoverage](https://codeception.com/docs/11-Codecoverage#Configuration) settings.
152+
153+
### `env`
154+
155+
Override any configuration per [environment](https://codeception.com/docs/07-AdvancedUsage#Environments).
156+
157+
### `error_level`
158+
159+
[error level](https://codeception.com/docs/04-FunctionalTests#Error-Reporting) for runner in the current suite. Can be specified for unit, integration, functional tests. Passes value to `error_reporting` function.
160+
161+
### `extends`
162+
163+
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.
164+
165+
### `gherkin`
166+
167+
Per suite [Gherkin](https://codeception.com/docs/07-BDD#Configuration) settings.
168+
169+
### `groups`
170+
171+
[groups](https://codeception.com/docs/07-AdvancedUsage#Groups) with the list of tests of for corresponding group.
172+
173+
### `formats`
174+
175+
[formats](https://codeception.com/docs/07-AdvancedUsage#Formats) with the list of extra test format classes.
176+
177+
### `modules`
145178

179+
List of enabled modules with their configuration.
180+
181+
{% highlight yaml %}
146182
modules:
147-
# enabled modules and helpers
148183
enabled:
149-
# built-in modules are listed by their names
150-
- PhpBrowser:
151-
# module configuration
152-
url: http://localhost
153-
# this module is pre-configured in global config
154-
- Db
155-
156-
# helper names are listed by their class names
157-
# by convention their names start with \
158-
- \Helper\Acceptance
159-
160-
# additional modules configuration
161-
# can be used for modules which are not currently enabled
184+
- PhpBrowser: # built-in modules are listed by their names
185+
url: http://localhost # module configuration
186+
- Db # Module without configuration (or inherited from `codeception.yml`)
187+
- \Helper\Acceptance # helper names are listed by their class names, starting with `\`
188+
189+
# Additional modules configuration; can be used for modules which are not currently enabled
162190
config:
163191
WebDriver:
164192
browser: firefox
165193

166-
# list of modules disabled for this suite
167194
disabled:
168-
- WebDriver
195+
- WebDriver # modules disabled for this suite
196+
{% endhighlight %}
169197

198+
### `namespace`
170199

171-
{% endhighlight %}
200+
Default namespace of actor, support classes and tests.
201+
202+
### `suite_namespace`
172203

173-
* `extends`: allows you to specify a file (relative to the `*.suite.yml` file) that holds some already pre-defined values. This can be used to always use the same configuration for modules or whatever.
174-
* `namespace`: default namespace of actor, support classes and tests.
175-
* `suite_namespace`: default namespace for new tests of this suite (ignores `namespace` option)
176-
* `env`: override any configuration per [environment](https://codeception.com/docs/07-AdvancedUsage#Environments).
177-
* `groups`: [groups](https://codeception.com/docs/07-AdvancedUsage#Groups) with the list of tests of for corresponding group.
178-
* `formats`: [formats](https://codeception.com/docs/07-AdvancedUsage#Formats) with the list of extra test format classes.
179-
* `coverage`: per suite [CodeCoverage](https://codeception.com/docs/11-Codecoverage#Configuration) settings.
180-
* `gherkin`: per suite [BDD Gherkin](https://codeception.com/docs/07-BDD#Configuration) settings.
181-
* `error_level`: [error level](https://codeception.com/docs/04-FunctionalTests#Error-Reporting) for runner in current suite. Can be specified for unit, integration, functional tests. Passes value to `error_reporting` function. Suite specific value will override the global value.
182-
* `bootstrap`: bootstrap script that will be executed before current suites. A script should be put into suite directory.
204+
Default namespace for new tests of this suite (ignores `namespace` option)
183205

184206
## Config Templates (dist)
185207

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy