From 1e981f8ec583a8548631190999d6d61cd9b60e12 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 2 Aug 2024 03:15:12 +0000 Subject: [PATCH] updated --- docs/reference/Commands.md | 250 ++++++++++++++++++------------------- 1 file changed, 125 insertions(+), 125 deletions(-) diff --git a/docs/reference/Commands.md b/docs/reference/Commands.md index 66291a16..9f84207c 100644 --- a/docs/reference/Commands.md +++ b/docs/reference/Commands.md @@ -5,58 +5,90 @@ title: Commands - Codeception - Documentation # Console Commands -## SelfUpdate +## GenerateCest -Auto-updates phar archive from official site: 'https://codeception.com/codecept.phar' . +Generates Cest (scenario-driven object-oriented test) file: -* `php codecept.phar self-update` +* `codecept generate:cest suite Login` +* `codecept g:cest suite subdir/subdir/testnameCest.php` +* `codecept g:cest suite LoginCest -c path/to/project` +* `codecept g:cest "App\Login"` -@author Franck Cassedanne -## Init +## Clean +Recursively cleans `output` directory and generated code. +* `codecept clean` -## GherkinSnippets -Generates code snippets for matched feature files in a suite. -Code snippets are expected to be implemented in Actor or PageObjects -Usage: -* `codecept gherkin:snippets acceptance` - snippets from all feature of acceptance tests -* `codecept gherkin:snippets acceptance/feature/users` - snippets from `feature/users` dir of acceptance tests -* `codecept gherkin:snippets acceptance user_account.feature` - snippets from a single feature file -* `codecept gherkin:snippets acceptance/feature/users/user_accout.feature` - snippets from feature file in a dir +## Console +Try to execute test commands in run-time. You may try commands before writing the test. +* `codecept console acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands. -## GenerateEnvironment -Generates empty environment configuration file into envs dir: - * `codecept g:env firefox` +## GenerateGroup -Required to have `envs` path to be specified in `codeception.yml` +Creates empty GroupObject - extension which handles all group events. +* `codecept g:group Admin` -## CompletionFallback +## Build +Generates Actor classes (initially Guy classes) from suite configs. +Starting from Codeception 2.0 actor classes are auto-generated. Use this command to generate them manually. -## DryRun +* `codecept build` +* `codecept build path/to/project` -Shows step by step execution process for scenario driven tests without actually running them. -* `codecept dry-run acceptance` -* `codecept dry-run acceptance MyCest` -* `codecept dry-run acceptance checkout.feature` -* `codecept dry-run tests/acceptance/MyCest.php` +## GenerateSuite + +Create new test suite. Requires suite name and actor name + +* `` +* `codecept g:suite api` -> api + ApiTester +* `codecept g:suite integration Code` -> integration + CodeTester +* `codecept g:suite frontend Front` -> frontend + FrontTester + + + + +## GenerateSnapshot + +Generates Snapshot. +Snapshot can be used to test dynamical data. +If suite name is provided, an actor class will be included into placeholder + +* `codecept g:snapshot UserEmails` +* `codecept g:snapshot Products` +* `codecept g:snapshot acceptance UserEmails` + + + +## GenerateScenarios + +Generates user-friendly text scenarios from scenario-driven tests (Cest). + +* `codecept g:scenarios acceptance` - for all acceptance tests +* `codecept g:scenarios acceptance --format html` - in html format +* `codecept g:scenarios acceptance --path doc` - generate scenarios to `doc` dir + + + +## CompletionFallback + ## GenerateHelper @@ -69,76 +101,83 @@ Creates empty Helper class. -## GenerateSuite - -Create new test suite. Requires suite name and actor name +## GenerateTest -* `` -* `codecept g:suite api` -> api + ApiTester -* `codecept g:suite integration Code` -> integration + CodeTester -* `codecept g:suite frontend Front` -> frontend + FrontTester +Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`. +* `codecept g:test unit User` +* `codecept g:test unit "App\User"` -## Build +## GenerateFeature -Generates Actor classes (initially Guy classes) from suite configs. -Starting from Codeception 2.0 actor classes are auto-generated. Use this command to generate them manually. +Generates Feature file (in Gherkin): -* `codecept build` -* `codecept build path/to/project` +* `codecept generate:feature suite Login` +* `codecept g:feature suite subdir/subdir/login.feature` +* `codecept g:feature suite login.feature -c path/to/project` -## GenerateSnapshot +## GeneratePageObject -Generates Snapshot. -Snapshot can be used to test dynamical data. -If suite name is provided, an actor class will be included into placeholder +Generates PageObject. Can be generated either globally, or just for one suite. +If PageObject is generated globally it will act as UIMap, without any logic in it. -* `codecept g:snapshot UserEmails` -* `codecept g:snapshot Products` -* `codecept g:snapshot acceptance UserEmails` +* `codecept g:page Login` +* `codecept g:page Registration` +* `codecept g:page acceptance Login` -## Clean +## Bootstrap -Recursively cleans `output` directory and generated code. +Creates default config, tests directory and sample suites for current project. +Use this command to start building a test suite. -* `codecept clean` +By default it will create 3 suites **Acceptance**, **Functional**, and **Unit**. +* `codecept bootstrap` - creates `tests` dir and `codeception.yml` in current dir. +* `codecept bootstrap --empty` - creates `tests` dir without suites +* `codecept bootstrap --namespace Frontend` - creates tests, and use `Frontend` namespace for actor classes and helpers. +* `codecept bootstrap --actor Wizard` - sets actor as Wizard, to have `TestWizard` actor in tests. +* `codecept bootstrap path/to/the/project` - provide different path to a project, where tests should be placed -## Console -Try to execute test commands in run-time. You may try commands before writing the test. +## GenerateEnvironment -* `codecept console acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands. +Generates empty environment configuration file into envs dir: + * `codecept g:env firefox` +Required to have `envs` path to be specified in `codeception.yml` -## GenerateStepObject -Generates StepObject class. You will be asked for steps you want to implement. -* `codecept g:stepobject acceptance AdminSteps` -* `codecept g:stepobject acceptance UserSteps --silent` - skip action questions +## ConfigValidate +Validates and prints Codeception config. +Use it do debug Yaml configs +Check config: +* `codecept config`: check global config +* `codecept config unit`: check suite config -## GherkinSteps +Load config: -Prints all steps from all Gherkin contexts for a specific suite +* `codecept config:validate -c path/to/another/config`: from another dir +* `codecept config:validate -c another_config.yml`: from another config file -{% highlight yaml %} -codecept gherkin:steps acceptance +Check overriding config values (like in `run` command) -{% endhighlight %} +* `codecept config:validate -o "settings: shuffle: true"`: enable shuffle +* `codecept config:validate -o "settings: lint: false"`: disable linting +* `codecept config:validate -o "reporters: report: \Custom\Reporter" --report`: use custom reporter @@ -231,104 +270,65 @@ Options: -## GeneratePageObject -Generates PageObject. Can be generated either globally, or just for one suite. -If PageObject is generated globally it will act as UIMap, without any logic in it. - -* `codecept g:page Login` -* `codecept g:page Registration` -* `codecept g:page acceptance Login` - - - -## GenerateFeature - -Generates Feature file (in Gherkin): - -* `codecept generate:feature suite Login` -* `codecept g:feature suite subdir/subdir/login.feature` -* `codecept g:feature suite login.feature -c path/to/project` - - - - -## GenerateGroup - -Creates empty GroupObject - extension which handles all group events. - -* `codecept g:group Admin` - - - -## GenerateScenarios - -Generates user-friendly text scenarios from scenario-driven tests (Cest). +## GherkinSnippets -* `codecept g:scenarios acceptance` - for all acceptance tests -* `codecept g:scenarios acceptance --format html` - in html format -* `codecept g:scenarios acceptance --path doc` - generate scenarios to `doc` dir +Generates code snippets for matched feature files in a suite. +Code snippets are expected to be implemented in Actor or PageObjects +Usage: +* `codecept gherkin:snippets acceptance` - snippets from all feature of acceptance tests +* `codecept gherkin:snippets acceptance/feature/users` - snippets from `feature/users` dir of acceptance tests +* `codecept gherkin:snippets acceptance user_account.feature` - snippets from a single feature file +* `codecept gherkin:snippets acceptance/feature/users/user_accout.feature` - snippets from feature file in a dir -## GenerateTest -Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`. +## SelfUpdate -* `codecept g:test unit User` -* `codecept g:test unit "App\User"` +Auto-updates phar archive from official site: 'https://codeception.com/codecept.phar' . +* `php codecept.phar self-update` +@author Franck Cassedanne -## GenerateCest -Generates Cest (scenario-driven object-oriented test) file: -* `codecept generate:cest suite Login` -* `codecept g:cest suite subdir/subdir/testnameCest.php` -* `codecept g:cest suite LoginCest -c path/to/project` -* `codecept g:cest "App\Login"` +## Init +## GherkinSteps -## Bootstrap +Prints all steps from all Gherkin contexts for a specific suite -Creates default config, tests directory and sample suites for current project. -Use this command to start building a test suite. +{% highlight yaml %} +codecept gherkin:steps acceptance -By default it will create 3 suites **Acceptance**, **Functional**, and **Unit**. +{% endhighlight %} -* `codecept bootstrap` - creates `tests` dir and `codeception.yml` in current dir. -* `codecept bootstrap --empty` - creates `tests` dir without suites -* `codecept bootstrap --namespace Frontend` - creates tests, and use `Frontend` namespace for actor classes and helpers. -* `codecept bootstrap --actor Wizard` - sets actor as Wizard, to have `TestWizard` actor in tests. -* `codecept bootstrap path/to/the/project` - provide different path to a project, where tests should be placed +## GenerateStepObject -## ConfigValidate +Generates StepObject class. You will be asked for steps you want to implement. -Validates and prints Codeception config. -Use it do debug Yaml configs +* `codecept g:stepobject acceptance AdminSteps` +* `codecept g:stepobject acceptance UserSteps --silent` - skip action questions -Check config: -* `codecept config`: check global config -* `codecept config unit`: check suite config -Load config: -* `codecept config:validate -c path/to/another/config`: from another dir -* `codecept config:validate -c another_config.yml`: from another config file +## DryRun -Check overriding config values (like in `run` command) +Shows step by step execution process for scenario driven tests without actually running them. -* `codecept config:validate -o "settings: shuffle: true"`: enable shuffle -* `codecept config:validate -o "settings: lint: false"`: disable linting -* `codecept config:validate -o "reporters: report: \Custom\Reporter" --report`: use custom reporter +* `codecept dry-run acceptance` +* `codecept dry-run acceptance MyCest` +* `codecept dry-run acceptance checkout.feature` +* `codecept dry-run tests/acceptance/MyCest.php`