Skip to content

Commit d651e8d

Browse files
Update Commands.md: Capitalizing suite names
1 parent 87638f9 commit d651e8d

File tree

1 file changed

+24
-84
lines changed

1 file changed

+24
-84
lines changed

docs/reference/Commands.md

Lines changed: 24 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -14,29 +14,23 @@ 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-
1917
## GherkinSnippets
2018

2119
Generates code snippets for matched feature files in a suite.
2220
Code snippets are expected to be implemented in Actor or PageObjects
2321

2422
Usage:
2523

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-
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
3228

3329
## Console
3430

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

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

4135
## GenerateSnapshot
4236

@@ -48,34 +42,29 @@ If suite name is provided, an actor class will be included into placeholder
4842
* `codecept g:snapshot Products`
4943
* `codecept g:snapshot acceptance UserEmails`
5044

51-
52-
5345
## GenerateHelper
5446

5547
Creates empty Helper class.
5648

5749
* `codecept g:helper MyHelper`
5850
* `codecept g:helper "My\Helper"`
5951

60-
61-
62-
6352
## Run
6453

6554
Executes tests.
6655

6756
Usage:
6857

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
58+
* `codecept run Acceptance`: run all acceptance tests
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`: run one example or data provider item by number
63+
* `codecept run Acceptance MyCest:myTestInIt#1-3`: run a range of examples or data provider items
64+
* `codecept run Acceptance MyCest:myTestInIt@name.*`: run data provider items with matching names
65+
* `codecept run Acceptance checkout.feature`: run feature-file
66+
* `codecept run Acceptance -g slow`: run tests from *slow* group
67+
* `codecept run Unit,Functional`: run only unit and functional suites
7968

8069
Verbosity modes:
8170

@@ -145,9 +134,6 @@ Options:
145134

146135
{% endhighlight %}
147136

148-
149-
150-
151137
## Bootstrap
152138

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

164-
165-
166-
167150
## SelfUpdate
168151

169152
Auto-updates phar archive from official site: 'https://codeception.com/codecept.phar' .
@@ -172,17 +155,12 @@ Auto-updates phar archive from official site: 'https://codeception.com/codecept.
172155

173156
@author Franck Cassedanne <[email protected]>
174157

175-
176-
177158
## GenerateGroup
178159

179160
Creates empty GroupObject - extension which handles all group events.
180161

181162
* `codecept g:group Admin`
182163

183-
184-
185-
186164
## GherkinSteps
187165

188166
Prints all steps from all Gherkin contexts for a specific suite
@@ -192,13 +170,8 @@ codecept gherkin:steps acceptance
192170

193171
{% endhighlight %}
194172

195-
196-
197-
198173
## Init
199174

200-
201-
202175
## GenerateEnvironment
203176

204177
Generates empty environment configuration file into envs dir:
@@ -207,27 +180,20 @@ Generates empty environment configuration file into envs dir:
207180

208181
Required to have `envs` path to be specified in `codeception.yml`
209182

210-
211-
212183
## GenerateScenarios
213184

214185
Generates user-friendly text scenarios from scenario-driven tests (Cest).
215186

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-
187+
* `codecept g:scenarios Acceptance` - for all acceptance tests
188+
* `codecept g:scenarios Acceptance --format html` - in html format
189+
* `codecept g:scenarios Acceptance --path doc` - generate scenarios to `doc` dir
221190

222191
## GenerateStepObject
223192

224193
Generates StepObject class. You will be asked for steps you want to implement.
225194

226-
* `codecept g:stepobject acceptance AdminSteps`
227-
* `codecept g:stepobject acceptance UserSteps --silent` - skip action questions
228-
229-
230-
195+
* `codecept g:stepobject Acceptance AdminSteps`
196+
* `codecept g:stepobject Acceptance UserSteps --silent` - skip action questions
231197

232198
## GenerateTest
233199

@@ -236,8 +202,6 @@ Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`.
236202
* `codecept g:test unit User`
237203
* `codecept g:test unit "App\User"`
238204

239-
240-
241205
## ConfigValidate
242206

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

262-
263-
264-
265226
## Build
266227

267228
Generates Actor classes (initially Guy classes) from suite configs.
@@ -270,9 +231,6 @@ Starting from Codeception 2.0 actor classes are auto-generated. Use this command
270231
* `codecept build`
271232
* `codecept build path/to/project`
272233

273-
274-
275-
276234
## GenerateSuite
277235

278236
Create new test suite. Requires suite name and actor name
@@ -282,9 +240,6 @@ Create new test suite. Requires suite name and actor name
282240
* `codecept g:suite integration Code` -> integration + CodeTester
283241
* `codecept g:suite frontend Front` -> frontend + FrontTester
284242

285-
286-
287-
288243
## GenerateFeature
289244

290245
Generates Feature file (in Gherkin):
@@ -293,30 +248,21 @@ Generates Feature file (in Gherkin):
293248
* `codecept g:feature suite subdir/subdir/login.feature`
294249
* `codecept g:feature suite login.feature -c path/to/project`
295250

296-
297-
298-
299251
## DryRun
300252

301253
Shows step by step execution process for scenario driven tests without actually running them.
302254

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-
255+
* `codecept dry-run Acceptance`
256+
* `codecept dry-run Acceptance MyCest`
257+
* `codecept dry-run Acceptance checkout.feature`
258+
* `codecept dry-run tests/Acceptance/MyCest.php`
310259

311260
## Clean
312261

313262
Recursively cleans `output` directory and generated code.
314263

315264
* `codecept clean`
316265

317-
318-
319-
320266
## GenerateCest
321267

322268
Generates Cest (scenario-driven object-oriented test) file:
@@ -326,10 +272,4 @@ Generates Cest (scenario-driven object-oriented test) file:
326272
* `codecept g:cest suite LoginCest -c path/to/project`
327273
* `codecept g:cest "App\Login"`
328274

329-
330-
331-
332275
## CompletionFallback
333-
334-
335-

0 commit comments

Comments
 (0)