Skip to content

Commit 10fcfcc

Browse files
github-actions[bot]github-actions[bot]
authored andcommitted
updated
1 parent 9bf1fb5 commit 10fcfcc

1 file changed

Lines changed: 149 additions & 149 deletions

File tree

docs/reference/Commands.md

Lines changed: 149 additions & 149 deletions
Original file line numberDiff line numberDiff line change
@@ -14,86 +14,6 @@ Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`.
1414

1515

1616

17-
## DryRun
18-
19-
Shows step-by-step execution process for scenario driven tests without actually running them.
20-
21-
* `codecept dry-run Acceptance`
22-
* `codecept dry-run Acceptance MyCest`
23-
* `codecept dry-run Acceptance checkout.feature`
24-
* `codecept dry-run tests/Acceptance/MyCest.php`
25-
26-
27-
28-
29-
## Clean
30-
31-
Recursively cleans `output` directory and generated code.
32-
33-
* `codecept clean`
34-
35-
36-
37-
38-
## GenerateStepObject
39-
40-
Generates StepObject class. You will be asked for steps you want to implement.
41-
42-
* `codecept g:stepobject Acceptance AdminSteps`
43-
* `codecept g:stepobject Acceptance UserSteps --silent` - skip action questions
44-
45-
46-
47-
48-
## CompletionFallback
49-
50-
51-
52-
## Init
53-
54-
55-
56-
## GenerateFeature
57-
58-
Generates Feature file (in Gherkin):
59-
60-
* `codecept generate:feature suite Login`
61-
* `codecept g:feature suite subdir/subdir/login.feature`
62-
* `codecept g:feature suite login.feature -c path/to/project`
63-
64-
65-
66-
67-
68-
## Console
69-
70-
Try to execute test commands in run-time. You may try commands before writing the test.
71-
72-
* `codecept console Acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands.
73-
74-
75-
76-
## GherkinSteps
77-
78-
Prints all steps from all Gherkin contexts for a specific suite
79-
80-
{% highlight yaml %}
81-
codecept gherkin:steps Acceptance
82-
83-
{% endhighlight %}
84-
85-
86-
87-
## SelfUpdate
88-
89-
Auto-updates phar archive from official site: 'https://codeception.com/codecept.phar' .
90-
91-
* `php codecept.phar self-update`
92-
93-
@author Franck Cassedanne <franck@cassedanne.com>
94-
95-
96-
9717
## GenerateEnvironment
9818

9919
Generates empty environment configuration file into envs dir:
@@ -104,18 +24,6 @@ Required to have `envs` path to be specified in `codeception.yml`
10424

10525

10626

107-
## GenerateCest
108-
109-
Generates Cest (scenario-driven object-oriented test) file:
110-
111-
* `codecept generate:cest suite Login`
112-
* `codecept g:cest suite subdir/subdir/testnameCest.php`
113-
* `codecept g:cest suite LoginCest -c path/to/project`
114-
* `codecept g:cest "App\Login"`
115-
116-
117-
118-
11927
## GeneratePageObject
12028

12129
Generates PageObject. Can be generated either globally, or just for one suite.
@@ -127,29 +35,6 @@ If PageObject is generated globally it will act as UIMap, without any logic in i
12735

12836

12937

130-
## GenerateSnapshot
131-
132-
Generates Snapshot.
133-
Snapshot can be used to test dynamical data.
134-
If suite name is provided, an actor class will be included into placeholder
135-
136-
* `codecept g:snapshot UserEmails`
137-
* `codecept g:snapshot Products`
138-
* `codecept g:snapshot Acceptance UserEmails`
139-
140-
141-
142-
## Build
143-
144-
Generates Actor classes (initially Guy classes) from suite configs.
145-
Starting from Codeception 2.0 actor classes are auto-generated. Use this command to generate them manually.
146-
147-
* `codecept build`
148-
* `codecept build path/to/project`
149-
150-
151-
152-
15338
## GherkinSnippets
15439

15540
Generates code snippets for matched feature files in a suite.
@@ -164,70 +49,70 @@ Usage:
16449

16550

16651

167-
## GenerateGroup
52+
## ConfigValidate
16853

169-
Creates empty GroupObject - extension which handles all group events.
54+
Validates and prints Codeception config.
55+
Use it do debug Yaml configs
17056

171-
* `codecept g:group Admin`
57+
Check config:
17258

59+
* `codecept config`: check global config
60+
* `codecept config Unit`: check suite config
17361

62+
Load config:
17463

175-
## Bootstrap
64+
* `codecept config:validate -c path/to/another/config`: from another dir
65+
* `codecept config:validate -c another_config.yml`: from another config file
17666

177-
Creates default config, tests directory and sample suites for current project.
178-
Use this command to start building a test suite.
67+
Check overriding config values (like in `run` command)
17968

180-
By default, it will create 3 suites **Acceptance**, **Functional**, and **Unit**.
69+
* `codecept config:validate -o "settings: shuffle: true"`: enable shuffle
70+
* `codecept config:validate -o "settings: lint: false"`: disable linting
71+
* `codecept config:validate -o "reporters: report: \Custom\Reporter" --report`: use custom reporter
18172

182-
* `codecept bootstrap` - creates `tests` dir and `codeception.yml` in current dir.
183-
* `codecept bootstrap --empty` - creates `tests` dir without suites
184-
* `codecept bootstrap --namespace Frontend` - creates tests, and use `Frontend` namespace for actor classes and helpers.
185-
* `codecept bootstrap --actor Wizard` - sets actor as Wizard, to have `TestWizard` actor in tests.
186-
* `codecept bootstrap path/to/the/project` - provide different path to a project, where tests should be placed
18773

18874

18975

76+
## GherkinSteps
19077

191-
## GenerateScenarios
78+
Prints all steps from all Gherkin contexts for a specific suite
19279

193-
Generates user-friendly text scenarios from scenario-driven tests (Cest).
80+
{% highlight yaml %}
81+
codecept gherkin:steps Acceptance
19482

195-
* `codecept g:scenarios Acceptance` - for all acceptance tests
196-
* `codecept g:scenarios Acceptance --format html` - in html format
197-
* `codecept g:scenarios Acceptance --path doc` - generate scenarios to `doc` dir
83+
{% endhighlight %}
19884

19985

20086

201-
## GenerateHelper
87+
## GenerateScenarios
20288

203-
Creates empty Helper class.
89+
Generates user-friendly text scenarios from scenario-driven tests (Cest).
20490

205-
* `codecept g:helper MyHelper`
206-
* `codecept g:helper "My\Helper"`
91+
* `codecept g:scenarios Acceptance` - for all acceptance tests
92+
* `codecept g:scenarios Acceptance --format html` - in html format
93+
* `codecept g:scenarios Acceptance --path doc` - generate scenarios to `doc` dir
20794

20895

20996

210-
## ConfigValidate
97+
## GenerateStepObject
21198

212-
Validates and prints Codeception config.
213-
Use it do debug Yaml configs
99+
Generates StepObject class. You will be asked for steps you want to implement.
214100

215-
Check config:
101+
* `codecept g:stepobject Acceptance AdminSteps`
102+
* `codecept g:stepobject Acceptance UserSteps --silent` - skip action questions
216103

217-
* `codecept config`: check global config
218-
* `codecept config Unit`: check suite config
219104

220-
Load config:
221105

222-
* `codecept config:validate -c path/to/another/config`: from another dir
223-
* `codecept config:validate -c another_config.yml`: from another config file
224106

225-
Check overriding config values (like in `run` command)
107+
## GenerateSnapshot
226108

227-
* `codecept config:validate -o "settings: shuffle: true"`: enable shuffle
228-
* `codecept config:validate -o "settings: lint: false"`: disable linting
229-
* `codecept config:validate -o "reporters: report: \Custom\Reporter" --report`: use custom reporter
109+
Generates Snapshot.
110+
Snapshot can be used to test dynamical data.
111+
If suite name is provided, an actor class will be included into placeholder
230112

113+
* `codecept g:snapshot UserEmails`
114+
* `codecept g:snapshot Products`
115+
* `codecept g:snapshot Acceptance UserEmails`
231116

232117

233118

@@ -243,6 +128,19 @@ Create new test suite. Requires suite name and actor name
243128

244129

245130

131+
## Init
132+
133+
134+
135+
## GenerateHelper
136+
137+
Creates empty Helper class.
138+
139+
* `codecept g:helper MyHelper`
140+
* `codecept g:helper "My\Helper"`
141+
142+
143+
246144
## Run
247145

248146
Executes tests.
@@ -336,3 +234,105 @@ Options:
336234

337235

338236

237+
## GenerateCest
238+
239+
Generates Cest (scenario-driven object-oriented test) file:
240+
241+
* `codecept generate:cest suite Login`
242+
* `codecept g:cest suite subdir/subdir/testnameCest.php`
243+
* `codecept g:cest suite LoginCest -c path/to/project`
244+
* `codecept g:cest "App\Login"`
245+
246+
247+
248+
249+
## Console
250+
251+
Try to execute test commands in run-time. You may try commands before writing the test.
252+
253+
* `codecept console Acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands.
254+
255+
256+
257+
## GenerateGroup
258+
259+
Creates empty GroupObject - extension which handles all group events.
260+
261+
* `codecept g:group Admin`
262+
263+
264+
265+
266+
## CompletionFallback
267+
268+
269+
270+
## Bootstrap
271+
272+
Creates default config, tests directory and sample suites for current project.
273+
Use this command to start building a test suite.
274+
275+
By default, it will create 3 suites **Acceptance**, **Functional**, and **Unit**.
276+
277+
* `codecept bootstrap` - creates `tests` dir and `codeception.yml` in current dir.
278+
* `codecept bootstrap --empty` - creates `tests` dir without suites
279+
* `codecept bootstrap --namespace Frontend` - creates tests, and use `Frontend` namespace for actor classes and helpers.
280+
* `codecept bootstrap --actor Wizard` - sets actor as Wizard, to have `TestWizard` actor in tests.
281+
* `codecept bootstrap path/to/the/project` - provide different path to a project, where tests should be placed
282+
283+
284+
285+
286+
## DryRun
287+
288+
Shows step-by-step execution process for scenario driven tests without actually running them.
289+
290+
* `codecept dry-run Acceptance`
291+
* `codecept dry-run Acceptance MyCest`
292+
* `codecept dry-run Acceptance checkout.feature`
293+
* `codecept dry-run tests/Acceptance/MyCest.php`
294+
295+
296+
297+
298+
## Build
299+
300+
Generates Actor classes (initially Guy classes) from suite configs.
301+
Starting from Codeception 2.0 actor classes are auto-generated. Use this command to generate them manually.
302+
303+
* `codecept build`
304+
* `codecept build path/to/project`
305+
306+
307+
308+
309+
## GenerateFeature
310+
311+
Generates Feature file (in Gherkin):
312+
313+
* `codecept generate:feature suite Login`
314+
* `codecept g:feature suite subdir/subdir/login.feature`
315+
* `codecept g:feature suite login.feature -c path/to/project`
316+
317+
318+
319+
320+
## SelfUpdate
321+
322+
Auto-updates phar archive from official site: 'https://codeception.com/codecept.phar' .
323+
324+
* `php codecept.phar self-update`
325+
326+
@author Franck Cassedanne <franck@cassedanne.com>
327+
328+
329+
330+
## Clean
331+
332+
Recursively cleans `output` directory and generated code.
333+
334+
* `codecept clean`
335+
336+
337+
338+

0 commit comments

Comments
 (0)