@@ -15,69 +15,48 @@ Auto-updates phar archive from official site: 'https://codeception.com/codecept.
15
15
16
16
17
17
18
- ## Init
19
-
20
-
21
-
22
- ## GherkinSnippets
23
-
24
- Generates code snippets for matched feature files in a suite.
25
- Code snippets are expected to be implemented in Actor or PageObjects
26
-
27
- Usage:
28
18
29
- * ` codecept gherkin:snippets acceptance ` - snippets from all feature of acceptance tests
30
- * ` codecept gherkin:snippets acceptance/feature/users ` - snippets from ` feature/users ` dir of acceptance tests
31
- * ` codecept gherkin:snippets acceptance user_account.feature ` - snippets from a single feature file
32
- * ` codecept gherkin:snippets acceptance/feature/users/user_accout.feature ` - snippets from feature file in a dir
33
-
34
-
35
-
36
- ## GenerateEnvironment
37
-
38
- Generates empty environment configuration file into envs dir:
39
-
40
- * ` codecept g:env firefox `
41
-
42
- Required to have ` envs ` path to be specified in ` codeception.yml `
19
+ ## GenerateGroup
43
20
21
+ Creates empty GroupObject - extension which handles all group events.
44
22
23
+ * ` codecept g:group Admin `
45
24
46
- ## CompletionFallback
47
25
48
26
27
+ ## ConfigValidate
49
28
50
- ## DryRun
29
+ Validates and prints Codeception config.
30
+ Use it do debug Yaml configs
51
31
52
- Shows step by step execution process for scenario driven tests without actually running them.
32
+ Check config:
53
33
54
- * ` codecept dry-run acceptance `
55
- * ` codecept dry-run acceptance MyCest `
56
- * ` codecept dry-run acceptance checkout.feature `
57
- * ` codecept dry-run tests/acceptance/MyCest.php `
34
+ * ` codecept config ` : check global config
35
+ * ` codecept config unit ` : check suite config
58
36
37
+ Load config:
59
38
39
+ * ` codecept config:validate -c path/to/another/config ` : from another dir
40
+ * ` codecept config:validate -c another_config.yml ` : from another config file
60
41
42
+ Check overriding config values (like in ` run ` command)
61
43
62
- ## GenerateHelper
44
+ * ` codecept config:validate -o "settings: shuffle: true" ` : enable shuffle
45
+ * ` codecept config:validate -o "settings: lint: false" ` : disable linting
46
+ * ` codecept config:validate -o "reporters: report: \Custom\Reporter" --report ` : use custom reporter
63
47
64
- Creates empty Helper class.
65
48
66
- * ` codecept g:helper MyHelper `
67
- * ` codecept g:helper "My\Helper" `
68
49
69
50
51
+ ## CompletionFallback
70
52
71
53
72
- ## GenerateSuite
73
54
74
- Create new test suite. Requires suite name and actor name
55
+ ## Console
75
56
76
- * ``
77
- * ` codecept g:suite api ` -> api + ApiTester
78
- * ` codecept g:suite integration Code ` -> integration + CodeTester
79
- * ` codecept g:suite frontend Front ` -> frontend + FrontTester
57
+ Try to execute test commands in run-time. You may try commands before writing the test.
80
58
59
+ * ` codecept console acceptance ` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands.
81
60
82
61
83
62
@@ -92,54 +71,35 @@ Starting from Codeception 2.0 actor classes are auto-generated. Use this command
92
71
93
72
94
73
95
- ## GenerateSnapshot
96
-
97
- Generates Snapshot.
98
- Snapshot can be used to test dynamical data.
99
- If suite name is provided, an actor class will be included into placeholder
100
-
101
- * ` codecept g:snapshot UserEmails `
102
- * ` codecept g:snapshot Products `
103
- * ` codecept g:snapshot acceptance UserEmails `
104
-
105
-
106
-
107
- ## Clean
108
-
109
- Recursively cleans ` output ` directory and generated code.
110
-
111
- * ` codecept clean `
112
-
113
-
114
-
115
-
116
- ## Console
74
+ ## GherkinSteps
117
75
118
- Try to execute test commands in run-time. You may try commands before writing the test.
76
+ Prints all steps from all Gherkin contexts for a specific suite
119
77
120
- * ` codecept console acceptance ` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands.
78
+ {% highlight yaml %}
79
+ codecept gherkin: steps acceptance
121
80
81
+ {% endhighlight %}
122
82
123
83
124
- ## GenerateStepObject
125
84
126
- Generates StepObject class. You will be asked for steps you want to implement.
127
85
128
- * ` codecept g:stepobject acceptance AdminSteps `
129
- * ` codecept g:stepobject acceptance UserSteps --silent ` - skip action questions
86
+ ## GenerateFeature
130
87
88
+ Generates Feature file (in Gherkin):
131
89
90
+ * ` codecept generate:feature suite Login `
91
+ * ` codecept g:feature suite subdir/subdir/login.feature `
92
+ * ` codecept g:feature suite login.feature -c path/to/project `
132
93
133
94
134
- ## GherkinSteps
135
95
136
- Prints all steps from all Gherkin contexts for a specific suite
137
96
138
- {% highlight yaml %}
139
- codecept gherkin: steps acceptance
97
+ ## GenerateTest
140
98
141
- {% endhighlight %}
99
+ Generates skeleton for Unit Test that extends ` Codeception\TestCase\Test ` .
142
100
101
+ * ` codecept g:test unit User `
102
+ * ` codecept g:test unit "App\User" `
143
103
144
104
145
105
@@ -242,42 +202,36 @@ If PageObject is generated globally it will act as UIMap, without any logic in i
242
202
243
203
244
204
245
- ## GenerateFeature
246
-
247
- Generates Feature file (in Gherkin):
248
-
249
- * ` codecept generate:feature suite Login `
250
- * ` codecept g:feature suite subdir/subdir/login.feature `
251
- * ` codecept g:feature suite login.feature -c path/to/project `
205
+ ## Clean
252
206
207
+ Recursively cleans ` output ` directory and generated code.
253
208
209
+ * ` codecept clean `
254
210
255
211
256
- ## GenerateGroup
257
212
258
- Creates empty GroupObject - extension which handles all group events.
259
-
260
- * ` codecept g:group Admin `
261
213
214
+ ## GenerateStepObject
262
215
216
+ Generates StepObject class. You will be asked for steps you want to implement.
263
217
264
- ## GenerateScenarios
218
+ * ` codecept g:stepobject acceptance AdminSteps `
219
+ * ` codecept g:stepobject acceptance UserSteps --silent ` - skip action questions
265
220
266
- Generates user-friendly text scenarios from scenario-driven tests (Cest).
267
-
268
- * ` codecept g:scenarios acceptance ` - for all acceptance tests
269
- * ` codecept g:scenarios acceptance --format html ` - in html format
270
- * ` codecept g:scenarios acceptance --path doc ` - generate scenarios to ` doc ` dir
271
221
272
222
273
223
224
+ ## GherkinSnippets
274
225
275
- ## GenerateTest
226
+ Generates code snippets for matched feature files in a suite.
227
+ Code snippets are expected to be implemented in Actor or PageObjects
276
228
277
- Generates skeleton for Unit Test that extends ` Codeception\TestCase\Test ` .
229
+ Usage:
278
230
279
- * ` codecept g:test unit User `
280
- * ` codecept g:test unit "App\User" `
231
+ * ` codecept gherkin:snippets acceptance ` - snippets from all feature of acceptance tests
232
+ * ` codecept gherkin:snippets acceptance/feature/users ` - snippets from ` feature/users ` dir of acceptance tests
233
+ * ` codecept gherkin:snippets acceptance user_account.feature ` - snippets from a single feature file
234
+ * ` codecept gherkin:snippets acceptance/feature/users/user_accout.feature ` - snippets from feature file in a dir
281
235
282
236
283
237
@@ -309,26 +263,72 @@ By default it will create 3 suites **Acceptance**, **Functional**, and **Unit**.
309
263
310
264
311
265
312
- ## ConfigValidate
266
+ ## GenerateScenarios
313
267
314
- Validates and prints Codeception config.
315
- Use it do debug Yaml configs
268
+ Generates user-friendly text scenarios from scenario-driven tests (Cest).
316
269
317
- Check config:
270
+ * ` codecept g:scenarios acceptance ` - for all acceptance tests
271
+ * ` codecept g:scenarios acceptance --format html ` - in html format
272
+ * ` codecept g:scenarios acceptance --path doc ` - generate scenarios to ` doc ` dir
318
273
319
- * ` codecept config ` : check global config
320
- * ` codecept config unit ` : check suite config
321
274
322
- Load config:
323
275
324
- * ` codecept config:validate -c path/to/another/config ` : from another dir
325
- * ` codecept config:validate -c another_config.yml ` : from another config file
276
+ ## GenerateHelper
326
277
327
- Check overriding config values (like in ` run ` command)
278
+ Creates empty Helper class.
328
279
329
- * ` codecept config:validate -o "settings: shuffle: true" ` : enable shuffle
330
- * ` codecept config:validate -o "settings: lint: false" ` : disable linting
331
- * ` codecept config:validate -o "reporters: report: \Custom\Reporter" --report ` : use custom reporter
280
+ * ` codecept g:helper MyHelper `
281
+ * ` codecept g:helper "My\Helper" `
282
+
283
+
284
+
285
+
286
+ ## GenerateSuite
287
+
288
+ Create new test suite. Requires suite name and actor name
289
+
290
+ * ``
291
+ * ` codecept g:suite api ` -> api + ApiTester
292
+ * ` codecept g:suite integration Code ` -> integration + CodeTester
293
+ * ` codecept g:suite frontend Front ` -> frontend + FrontTester
294
+
295
+
296
+
297
+
298
+ ## Init
299
+
300
+
301
+
302
+ ## GenerateEnvironment
303
+
304
+ Generates empty environment configuration file into envs dir:
305
+
306
+ * ` codecept g:env firefox `
307
+
308
+ Required to have ` envs ` path to be specified in ` codeception.yml `
309
+
310
+
311
+
312
+ ## GenerateSnapshot
313
+
314
+ Generates Snapshot.
315
+ Snapshot can be used to test dynamical data.
316
+ If suite name is provided, an actor class will be included into placeholder
317
+
318
+ * ` codecept g:snapshot UserEmails `
319
+ * ` codecept g:snapshot Products `
320
+ * ` codecept g:snapshot acceptance UserEmails `
321
+
322
+
323
+
324
+ ## DryRun
325
+
326
+ Shows step by step execution process for scenario driven tests without actually running them.
327
+
328
+ * ` codecept dry-run acceptance `
329
+ * ` codecept dry-run acceptance MyCest `
330
+ * ` codecept dry-run acceptance checkout.feature `
331
+ * ` codecept dry-run tests/acceptance/MyCest.php `
332
332
333
333
334
334
0 commit comments