Skip to content

Commit a6865f9

Browse files
github-actions[bot]github-actions[bot]
github-actions[bot]
authored and
github-actions[bot]
committed
updated
1 parent d409544 commit a6865f9

File tree

1 file changed

+84
-22
lines changed

1 file changed

+84
-22
lines changed

docs/reference/Commands.md

Lines changed: 84 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,29 @@ If PageObject is generated globally it will act as UIMap, without any logic in i
1414
* `codecept g:page Registration`
1515
* `codecept g:page acceptance Login`
1616

17+
18+
1719
## GherkinSnippets
1820

1921
Generates code snippets for matched feature files in a suite.
2022
Code snippets are expected to be implemented in Actor or PageObjects
2123

2224
Usage:
2325

24-
* `codecept gherkin:snippets Acceptance` - snippets from all feature of acceptance tests
25-
* `codecept gherkin:snippets Acceptance/feature/users` - snippets from `feature/users` dir of acceptance tests
26-
* `codecept gherkin:snippets Acceptance user_account.feature` - snippets from a single feature file
27-
* `codecept gherkin:snippets Acceptance/feature/users/user_accout.feature` - snippets from feature file in a dir
26+
* `codecept gherkin:snippets acceptance` - snippets from all feature of acceptance tests
27+
* `codecept gherkin:snippets acceptance/feature/users` - snippets from `feature/users` dir of acceptance tests
28+
* `codecept gherkin:snippets acceptance user_account.feature` - snippets from a single feature file
29+
* `codecept gherkin:snippets acceptance/feature/users/user_accout.feature` - snippets from feature file in a dir
30+
31+
2832

2933
## Console
3034

3135
Try to execute test commands in run-time. You may try commands before writing the test.
3236

33-
* `codecept console Acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands.
37+
* `codecept console acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands.
38+
39+
3440

3541
## GenerateSnapshot
3642

@@ -42,27 +48,34 @@ If suite name is provided, an actor class will be included into placeholder
4248
* `codecept g:snapshot Products`
4349
* `codecept g:snapshot acceptance UserEmails`
4450

51+
52+
4553
## GenerateHelper
4654

4755
Creates empty Helper class.
4856

4957
* `codecept g:helper MyHelper`
5058
* `codecept g:helper "My\Helper"`
5159

60+
61+
62+
5263
## Run
5364

5465
Executes tests.
5566

5667
Usage:
5768

58-
* `codecept run Unit,Functional`: run only unit and functional suites
59-
* `codecept run tests/Acceptance/MyCest.php`: run only MyCest
60-
* `codecept run Acceptance MyCest`: same as above
61-
* `codecept run Acceptance MyCest:myTestInIt`: run one test from a Cest
62-
* `codecept run Acceptance MyCest:myTestInIt#1-3`: run a range of examples or data provider items
63-
* `codecept run Acceptance MyCest:myTestInIt@name.*`: run data provider items with matching names
64-
* `codecept run Acceptance checkout.feature`: run feature-file
65-
* `codecept run Acceptance -g slow`: run tests from group named `slow`
69+
* `codecept run acceptance`: run all acceptance tests
70+
* `codecept run tests/acceptance/MyCest.php`: run only MyCest
71+
* `codecept run acceptance MyCest`: same as above
72+
* `codecept run acceptance MyCest:myTestInIt`: run one test from a Cest
73+
* `codecept run acceptance MyCest:myTestInIt#1`: run one example or data provider item by number
74+
* `codecept run acceptance MyCest:myTestInIt#1-3`: run a range of examples or data provider items
75+
* `codecept run acceptance MyCest:myTestInIt@name.*`: run data provider items with matching names
76+
* `codecept run acceptance checkout.feature`: run feature-file
77+
* `codecept run acceptance -g slow`: run tests from *slow* group
78+
* `codecept run unit,functional`: run only unit and functional suites
6679

6780
Verbosity modes:
6881

@@ -132,6 +145,9 @@ Options:
132145

133146
{% endhighlight %}
134147

148+
149+
150+
135151
## Bootstrap
136152

137153
Creates default config, tests directory and sample suites for current project.
@@ -145,6 +161,9 @@ By default it will create 3 suites **Acceptance**, **Functional**, and **Unit**.
145161
* `codecept bootstrap --actor Wizard` - sets actor as Wizard, to have `TestWizard` actor in tests.
146162
* `codecept bootstrap path/to/the/project` - provide different path to a project, where tests should be placed
147163

164+
165+
166+
148167
## SelfUpdate
149168

150169
Auto-updates phar archive from official site: 'https://codeception.com/codecept.phar' .
@@ -153,12 +172,17 @@ Auto-updates phar archive from official site: 'https://codeception.com/codecept.
153172

154173
@author Franck Cassedanne <[email protected]>
155174

175+
176+
156177
## GenerateGroup
157178

158179
Creates empty GroupObject - extension which handles all group events.
159180

160181
* `codecept g:group Admin`
161182

183+
184+
185+
162186
## GherkinSteps
163187

164188
Prints all steps from all Gherkin contexts for a specific suite
@@ -168,8 +192,13 @@ codecept gherkin:steps acceptance
168192

169193
{% endhighlight %}
170194

195+
196+
197+
171198
## Init
172199

200+
201+
173202
## GenerateEnvironment
174203

175204
Generates empty environment configuration file into envs dir:
@@ -178,20 +207,27 @@ Generates empty environment configuration file into envs dir:
178207

179208
Required to have `envs` path to be specified in `codeception.yml`
180209

210+
211+
181212
## GenerateScenarios
182213

183214
Generates user-friendly text scenarios from scenario-driven tests (Cest).
184215

185-
* `codecept g:scenarios Acceptance` - for all acceptance tests
186-
* `codecept g:scenarios Acceptance --format html` - in html format
187-
* `codecept g:scenarios Acceptance --path doc` - generate scenarios to `doc` dir
216+
* `codecept g:scenarios acceptance` - for all acceptance tests
217+
* `codecept g:scenarios acceptance --format html` - in html format
218+
* `codecept g:scenarios acceptance --path doc` - generate scenarios to `doc` dir
219+
220+
188221

189222
## GenerateStepObject
190223

191224
Generates StepObject class. You will be asked for steps you want to implement.
192225

193-
* `codecept g:stepobject Acceptance AdminSteps`
194-
* `codecept g:stepobject Acceptance UserSteps --silent` - skip action questions
226+
* `codecept g:stepobject acceptance AdminSteps`
227+
* `codecept g:stepobject acceptance UserSteps --silent` - skip action questions
228+
229+
230+
195231

196232
## GenerateTest
197233

@@ -200,6 +236,8 @@ Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`.
200236
* `codecept g:test unit User`
201237
* `codecept g:test unit "App\User"`
202238

239+
240+
203241
## ConfigValidate
204242

205243
Validates and prints Codeception config.
@@ -221,6 +259,9 @@ Check overriding config values (like in `run` command)
221259
* `codecept config:validate -o "settings: lint: false"`: disable linting
222260
* `codecept config:validate -o "reporters: report: \Custom\Reporter" --report`: use custom reporter
223261

262+
263+
264+
224265
## Build
225266

226267
Generates Actor classes (initially Guy classes) from suite configs.
@@ -229,6 +270,9 @@ Starting from Codeception 2.0 actor classes are auto-generated. Use this command
229270
* `codecept build`
230271
* `codecept build path/to/project`
231272

273+
274+
275+
232276
## GenerateSuite
233277

234278
Create new test suite. Requires suite name and actor name
@@ -238,6 +282,9 @@ Create new test suite. Requires suite name and actor name
238282
* `codecept g:suite integration Code` -> integration + CodeTester
239283
* `codecept g:suite frontend Front` -> frontend + FrontTester
240284

285+
286+
287+
241288
## GenerateFeature
242289

243290
Generates Feature file (in Gherkin):
@@ -246,21 +293,30 @@ Generates Feature file (in Gherkin):
246293
* `codecept g:feature suite subdir/subdir/login.feature`
247294
* `codecept g:feature suite login.feature -c path/to/project`
248295

296+
297+
298+
249299
## DryRun
250300

251301
Shows step by step execution process for scenario driven tests without actually running them.
252302

253-
* `codecept dry-run Acceptance`
254-
* `codecept dry-run Acceptance MyCest`
255-
* `codecept dry-run Acceptance checkout.feature`
256-
* `codecept dry-run tests/Acceptance/MyCest.php`
303+
* `codecept dry-run acceptance`
304+
* `codecept dry-run acceptance MyCest`
305+
* `codecept dry-run acceptance checkout.feature`
306+
* `codecept dry-run tests/acceptance/MyCest.php`
307+
308+
309+
257310

258311
## Clean
259312

260313
Recursively cleans `output` directory and generated code.
261314

262315
* `codecept clean`
263316

317+
318+
319+
264320
## GenerateCest
265321

266322
Generates Cest (scenario-driven object-oriented test) file:
@@ -270,4 +326,10 @@ Generates Cest (scenario-driven object-oriented test) file:
270326
* `codecept g:cest suite LoginCest -c path/to/project`
271327
* `codecept g:cest "App\Login"`
272328

329+
330+
331+
273332
## CompletionFallback
333+
334+
335+

0 commit comments

Comments
 (0)