diff --git a/RoboFile.php b/RoboFile.php index d8cce2d4d..bca066714 100644 --- a/RoboFile.php +++ b/RoboFile.php @@ -277,7 +277,7 @@ public function buildDocsExtensions() protected function documentApiClass($file, $className, $all = false, $repositoryName = null) { if ($repositoryName === null) { - $repositoryUrl = self::REPO_BLOB_URL . "/" . self::BRANCH_5x; + $repositoryUrl = self::REPO_BLOB_URL . "/" . self::BRANCH_MAIN; } else { $repositoryUrl = 'https://github.com/Codeception/' . $repositoryName . '/blob/master'; } diff --git a/_layouts/page.html b/_layouts/page.html index 4a691c34e..b68b50f51 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -32,9 +32,8 @@ Latest stable version Total Downloads + src="https://poser.pugx.org/codeception/codeception/downloads.png" + alt="Total Downloads">

diff --git a/changelog.markdown b/changelog.markdown index 026a83c4f..5313c2585 100644 --- a/changelog.markdown +++ b/changelog.markdown @@ -9,6 +9,135 @@ title: Codeception Changelog +### module-redis 3.2.3: 3.2.3 + +Released by [![](https://avatars.githubusercontent.com/u/20659830?v=4&s=16){:height="16" width="16"} W0rma](https://github.com/W0rma) on 2026/02/18 06:48:20 / [Repository](https://github.com/Codeception/module-redis) / [Releases](https://github.com/Codeception/module-redis/releases) + + + +## What's Changed +* Add support for sebastian/comparator v8 in https://github.com/Codeception/module-redis/pull/25 + + +**Full Changelog**: https://github.com/Codeception/module-redis/compare/3.2.2...3.2.3 + + +### module-webdriver 4.0.5: 4.0.5 + +Released by [![](https://avatars.githubusercontent.com/u/20659830?v=4&s=16){:height="16" width="16"} W0rma](https://github.com/W0rma) on 2026/02/18 06:32:29 / [Repository](https://github.com/Codeception/module-webdriver) / [Releases](https://github.com/Codeception/module-webdriver/releases) + + + +## What's Changed +* Add support for PHPUnit 13 https://github.com/Codeception/module-webdriver/pull/145 + + +**Full Changelog**: https://github.com/Codeception/module-webdriver/compare/4.0.4...4.0.5 + + +### lib-innerbrowser 4.1.0: 4.1.0 + +Released by [![](https://avatars.githubusercontent.com/u/20659830?v=4&s=16){:height="16" width="16"} W0rma](https://github.com/W0rma) on 2026/02/18 06:25:58 / [Repository](https://github.com/Codeception/lib-innerbrowser) / [Releases](https://github.com/Codeception/lib-innerbrowser/releases) + + + +## What's Changed +* chore(deps): add support for phpunit 13 in https://github.com/Codeception/lib-innerbrowser/pull/85 +* chore(ci): remove obsolete workaround for php > 8.5 in https://github.com/Codeception/lib-innerbrowser/pull/86 + + +**Full Changelog**: https://github.com/Codeception/lib-innerbrowser/compare/4.0.8...4.1.0 + + +### Codeception 5.3.5: 5.3.5 + +Released by [![](https://avatars.githubusercontent.com/u/64917965?v=4&s=16){:height="16" width="16"} TavoNiievez](https://github.com/TavoNiievez) on 2026/02/18 06:22:46 / [Repository](https://github.com/Codeception/Codeception) / [Releases](https://github.com/Codeception/Codeception/releases) + + + +## What's Changed +* PHP 8.5: Avoid accessing deprecated $http_response_header by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/Codeception/pull/6924 +* Add support for PHPUnit 13 by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/Codeception/pull/6925 + + +**Full Changelog**: https://github.com/Codeception/Codeception/compare/5.3.4...5.3.5 + + +### lib-web 2.1.0: 2.1.0 + +Released by [![](https://avatars.githubusercontent.com/in/15368?v=4&s=16){:height="16" width="16"} github-actions[bot]](https://github.com/apps/github-actions) on 2026/02/06 15:23:02 / [Repository](https://github.com/Codeception/lib-web) / [Releases](https://github.com/Codeception/lib-web/releases) + + + +# [2.1.0](https://github.com/Codeception/lib-web/compare/2.0.1...2.1.0) (2026-02-06) + + +### Features + +* add support for phpunit 13 ([[#23](https://github.com/Codeception/lib-web/issues/23)](https://github.com/Codeception/lib-web/issues/23)) ([a030a3a](https://github.com/Codeception/lib-web/commit/a030a3a22fc8e856b5957086794ed5403c7992d9)) + + + + + + +### lib-asserts 3.2.0: 3.2.0 + +Released by [![](https://avatars.githubusercontent.com/in/15368?v=4&s=16){:height="16" width="16"} github-actions[bot]](https://github.com/apps/github-actions) on 2026/02/06 15:20:17 / [Repository](https://github.com/Codeception/lib-asserts) / [Releases](https://github.com/Codeception/lib-asserts/releases) + + + +# [3.2.0](https://github.com/Codeception/lib-asserts/compare/3.1.0...3.2.0) (2026-02-06) + + +### Features + +* add support for phpunit 13 ([[#20](https://github.com/Codeception/lib-asserts/issues/20)](https://github.com/Codeception/lib-asserts/issues/20)) ([f161e5d](https://github.com/Codeception/lib-asserts/commit/f161e5d3a9e5ae573ca01cfb3b5601ff5303df03)) + + + + + + +### module-phpbrowser 4.0.0: 4.0.0 + +Released by [![](https://avatars.githubusercontent.com/in/15368?v=4&s=16){:height="16" width="16"} github-actions[bot]](https://github.com/apps/github-actions) on 2026/01/23 13:25:25 / [Repository](https://github.com/Codeception/module-phpbrowser) / [Releases](https://github.com/Codeception/module-phpbrowser/releases) + + + +# [4.0.0](https://github.com/Codeception/module-phpbrowser/compare/3.0.2...4.0.0) (2026-01-23) + + +### Features + +* allow symfony 8 ([0c65e95](https://github.com/Codeception/module-phpbrowser/commit/0c65e956c1b355d0edb5b4c279265255ac4ac3f6)) + + +### BREAKING CHANGES + +* The native object return type was added to the doRequest() method of the Guzzle connector. +That might break code extending from this class. + + + + + + +### Codeception 5.3.4: 5.3.4 + +Released by [![](https://avatars.githubusercontent.com/u/64917965?v=4&s=16){:height="16" width="16"} TavoNiievez](https://github.com/TavoNiievez) on 2026/01/14 12:07:18 / [Repository](https://github.com/Codeception/Codeception) / [Releases](https://github.com/Codeception/Codeception/releases) + + + +## What's Changed +* Use attributes syntax in gherkin:snippets by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/Codeception/pull/6917 +* PHP 8.5: Fix usage of deprecated $http_response_header by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/Codeception/pull/6919 +* Do not expect the register_argc_argv ini setting in cli for php >= 8.5 by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/Codeception/pull/6921 + + +**Full Changelog**: https://github.com/Codeception/Codeception/compare/5.3.3...5.3.4 + + ### module-mongodb 3.1.0: 3.1.0 Released by [![](https://avatars.githubusercontent.com/u/64917965?v=4&s=16){:height="16" width="16"} TavoNiievez](https://github.com/TavoNiievez) on 2026/01/09 15:54:01 / [Repository](https://github.com/Codeception/module-mongodb) / [Releases](https://github.com/Codeception/module-mongodb/releases) @@ -2163,39 +2292,6 @@ Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16){:heigh -### Codeception 5.0.0-RC5: 5.0.0-RC5 - -Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16){:height="16" width="16"} Naktibalda](https://github.com/Naktibalda) on 2022/06/28 06:42:39 / [Repository](https://github.com/Codeception/Codeception) / [Releases](https://github.com/Codeception/Codeception/releases) - - - -* Substitute invalid UTF-8 characters in debug and step output by **[SamoylenkoSU](https://github.com/SamoylenkoSU)** ([#6483](https://github.com/Codeception/Codeception/issues/6483)) - - -### Codeception 5.0.0-RC4: 5.0.0-RC4 - -Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16){:height="16" width="16"} Naktibalda](https://github.com/Naktibalda) on 2022/06/22 07:03:20 / [Repository](https://github.com/Codeception/Codeception) / [Releases](https://github.com/Codeception/Codeception/releases) - - - -* Implemented basic attribute support ([#6449](https://github.com/Codeception/Codeception/issues/6449)) by **[DavertMik](https://github.com/DavertMik)** -* Significantly reduced dependencies on PHPUnit -* Replaced PHPUnit\Framework\TestResult with ResultAggregator -* Added assertionCount method to ResultAggregator -* DotReporter prints standard result summary ([#6441](https://github.com/Codeception/Codeception/issues/6441)) by **[Orchestrator404](https://github.com/Orchestrator404)** -* Fixed DotReporter output format -* Fixed fetching remote code coverage data ([#6448](https://github.com/Codeception/Codeception/issues/6448)) -* Loading .env file must not override existing environment variables ([#6477](https://github.com/Codeception/Codeception/issues/6477)) -* All changes from 4.2.0 and 4.2.1: - * Improved multi-application experience, allow filtering suites by name ([#6435](https://github.com/Codeception/Codeception/issues/6435)) by **[calvinalkan](https://github.com/calvinalkan)** - * Configuration override is passed to included suites ([#5978](https://github.com/Codeception/Codeception/issues/5978)) by **[calvinalkan](https://github.com/calvinalkan)** - * Made dry-run command work with module methods having return types ([#6470](https://github.com/Codeception/Codeception/issues/6470)) - * Support for expectError/Warning/Notice/Deprecation methods in unit tests (Requires PHPUnit 8.4+) - * Implemented new setting `convert_deprecations_to_exceptions` ([#6469](https://github.com/Codeception/Codeception/issues/6469)) - * Action file generator: Do not return when return type is never ([#6462](https://github.com/Codeception/Codeception/issues/6462)) - * Execute setupBeforeClass/tearDownAfterClass only once ([#6481](https://github.com/Codeception/Codeception/issues/6481)) - - ### module-yii2 1.1.6: 1.1.6 Released by [![](https://avatars.githubusercontent.com/u/47294?v=4&s=16){:height="16" width="16"} samdark](https://github.com/samdark) on 2022/06/21 11:05:32 / [Repository](https://github.com/Codeception/module-yii2) / [Releases](https://github.com/Codeception/module-yii2/releases) @@ -4445,15 +4541,6 @@ Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16){:heigh * Introduced switchToFrame method [#9](https://github.com/Codeception/module-webdriver/issues/9) -### module-webdriver 1.0.8: Suppress UnknownErrorException in _closeSession - -Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16){:height="16" width="16"} Naktibalda](https://github.com/Naktibalda) on 2020/04/29 13:52:51 / [Repository](https://github.com/Codeception/module-webdriver) / [Releases](https://github.com/Codeception/module-webdriver/releases) - - - -* Suppress UnknownErrorException in _closeSession [#15](https://github.com/Codeception/module-webdriver/issues/15) - - ### module-asserts 1.2.1: Require lib-asserts 1.12+ Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16){:height="16" width="16"} Naktibalda](https://github.com/Naktibalda) on 2020/04/20 07:28:56 / [Repository](https://github.com/Codeception/module-asserts) / [Releases](https://github.com/Codeception/module-asserts/releases) @@ -4629,15 +4716,6 @@ Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16){:heigh -### lib-innerbrowser 1.3.0: Allow to add or remove server parameters - -Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16){:height="16" width="16"} Naktibalda](https://github.com/Naktibalda) on 2020/01/27 09:33:02 / [Repository](https://github.com/Codeception/lib-innerbrowser) / [Releases](https://github.com/Codeception/lib-innerbrowser/releases) - - - -* [#5](https://github.com/Codeception/lib-innerbrowser/issues/5) by **[svycka](https://github.com/svycka)** - - ### module-zf2 1.0.2: Empty request content can't be null Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16){:height="16" width="16"} Naktibalda](https://github.com/Naktibalda) on 2020/01/23 17:55:51 / [Repository](https://github.com/Codeception/module-zf2) / [Releases](https://github.com/Codeception/module-zf2/releases) diff --git a/docs/APITesting.md b/docs/APITesting.md index 002e49994..dc1950dce 100644 --- a/docs/APITesting.md +++ b/docs/APITesting.md @@ -9,10 +9,10 @@ title: API Testing - Codeception Docs The same way we tested a web site, Codeception allows you to test web services. They are very hard to test manually, so it's a really good idea to automate web service testing. We have SOAP and REST as standards, which are represented in corresponding modules, which we will cover in this chapter. -You should start by creating a new test suite, (which was not provided by the `bootstrap` command). We recommend calling it **api** and using the `ApiTester` class for it. +You should start by creating a new test suite, (which was not provided by the `bootstrap` command). We recommend calling it **Api** and using the `ApiTester` class for it. ```bash -php vendor/bin/codecept generate:suite api +php vendor/bin/codecept generate:suite Api ``` We will put all the api tests there. @@ -23,7 +23,7 @@ We will put all the api tests there. The REST web service is accessed via HTTP with standard methods: `GET`, `POST`, `PUT`, `DELETE`. They allow users to receive and manipulate entities from the service. Accessing a WebService requires an HTTP client, so for using it you need the module `PhpBrowser` or one of framework modules set up. For example, we can use the `Symfony` module for Symfony2 applications in order to ignore web server and test web service internally. -Configure modules in `api.suite.yml`: +Configure modules in `Api.suite.yml`: ```yaml actor: ApiTester @@ -60,7 +60,7 @@ modules: Once we have configured our new testing suite, we can create the first sample test: ```bash -php vendor/bin/codecept generate:cest api CreateUser +php vendor/bin/codecept generate:cest Api CreateUser ``` It will be called `CreateUserCest.php`. @@ -379,7 +379,7 @@ class Api extends \Codeception\Module { ## Conclusion -Codeception has two modules that will help you to test various web services. They need a new `api` suite to be created. Remember, you are not limited to test only response body. By including `Db` module you may check if a user has been created after the `CreateUser` call. You can improve testing scenarios by using REST or SOAP responses in your helper methods. +Codeception has two modules that will help you to test various web services. They need a new `Api` suite to be created. Remember, you are not limited to test only response body. By including `Db` module you may check if a user has been created after the `CreateUser` call. You can improve testing scenarios by using REST or SOAP responses in your helper methods.

Improve this guide
diff --git a/docs/AcceptanceTests.md b/docs/AcceptanceTests.md index 1673dd8b4..6d51b81d9 100644 --- a/docs/AcceptanceTests.md +++ b/docs/AcceptanceTests.md @@ -57,7 +57,7 @@ Common PhpBrowser drawbacks: We need to specify the `url` parameter in the acceptance suite config: ```yaml -# acceptance.suite.yml +# Acceptance.suite.yml actor: AcceptanceTester modules: enabled: @@ -68,7 +68,7 @@ modules: We should start by creating a test with the next command: ``` -php vendor/bin/codecept g:cest acceptance Signin +php vendor/bin/codecept g:cest Acceptance Signin ``` It will be placed into `tests/Acceptance` directory. @@ -268,10 +268,10 @@ Each failed assertion will be shown in the test results, but it won't stop the t Conditional assertions are disabled in bootstrap setup. To enable them you should add corresponding step decorators to suite config: -> If you started project as `codecept init acceptance` they should be already enabled in config +> If you started project as `codecept init Acceptance` they should be already enabled in config ```yaml -# in acceptance.suite.yml +# in Acceptance.suite.yml # or in codeception.yml inside suites section step_decorators: - \Codeception\Step\ConditionalAssertion @@ -390,7 +390,7 @@ Now, you are ready to run WebDriver tests using Codeception. To execute a test in a browser you need to change the suite configuration to use **WebDriver** module. -Modify your `acceptance.suite.yml` file: +Modify your `Acceptance.suite.yml` file: ```yaml actor: AcceptanceTester @@ -503,10 +503,10 @@ $I->retry(4, 400); Retries are disabled by default. To enable them you should add retry step decorators to suite config: -> If you started project as `codecept init acceptance` they should be already enabled in config +> If you started project as `codecept init Acceptance` they should be already enabled in config ```yaml -# in acceptance.suite.yml +# in Acceptance.suite.yml # or in codeception.yml inside suites section step_decorators: - \Codeception\Step\Retry @@ -578,10 +578,10 @@ if ($I->tryToSeeElement('.alert')) { A/B testing is disabled by default. To enable it you should add corresponding step decorators to suite config: -> If you started project as `codecept init acceptance` in Codeception >= 3.0 they should be already enabled in config +> If you started project as `codecept init Acceptance` in Codeception >= 3.0 they should be already enabled in config ```yaml -# in acceptance.suite.yml +# in Acceptance.suite.yml # or in codeception.yml inside suites section step_decorators: - \Codeception\Step\TryTo diff --git a/docs/AdvancedUsage.md b/docs/AdvancedUsage.md index 68c8f0445..16d44070d 100644 --- a/docs/AdvancedUsage.md +++ b/docs/AdvancedUsage.md @@ -192,7 +192,7 @@ public function testNotReadyToday() There are several ways to execute a bunch of tests. You can run tests from a specific directory: ``` -php vendor/bin/codecept run tests/acceptance/admin +php vendor/bin/codecept run tests/Acceptance/admin ``` You can execute one (or several) specific groups of tests: diff --git a/docs/BDD.md b/docs/BDD.md index abf640754..85cbe3d53 100644 --- a/docs/BDD.md +++ b/docs/BDD.md @@ -88,7 +88,7 @@ Feature file is written in Gherkin format. Codeception can generate a feature fi We will assume that we will use scenarios in feature files for acceptance tests, so feature files to be placed in `acceptance` suite directory: ```bash -php vendor/bin/codecept g:feature acceptance checkout +php vendor/bin/codecept g:feature Acceptance checkout ``` Generated template will look like this: @@ -151,13 +151,13 @@ And in the end we are verifying our expectation using **Then** keyword. The acti We can test this scenario by executing it in dry-run mode. In this mode test won't be executed (actually, we didn't define any step for it, so it won't be executed in any case). ```bash -php vendor/bin/codecept dry-run acceptance checkout.feature +php vendor/bin/codecept dry-run Acceptance checkout.feature ``` ```bash checkout: order several products Signature: checkout:order several products -Test: tests/acceptance/checkout.feature:order several products +Test: tests/Acceptance/checkout.feature:order several products Scenario -- In order to buy product As a customer @@ -181,7 +181,7 @@ Besides the scenario steps listed we got the notification that our steps are not We can define them easily by executing `gherkin:snippets` command for the given suite: ```bash -php vendor/bin/codecept gherkin:snippets acceptance +php vendor/bin/codecept gherkin:snippets Acceptance ``` This will produce code templates for all undefined steps in all feature files of this suite. @@ -551,7 +551,7 @@ While Behat is a great tool for Behavior Driven Development, you still may prefe If you decided to run your features with Codeception, we recommend to start with symlinking your `features` directory into one of the test suites: ```bash -ln -s $PWD/features tests/acceptance +ln -s $PWD/features tests/Acceptance ``` Then you will need to implement all step definitions. Run `gherkin:snippets` to generate stubs for them. diff --git a/docs/Codecoverage.md b/docs/Codecoverage.md index c684c4f73..d164cfd1a 100644 --- a/docs/Codecoverage.md +++ b/docs/Codecoverage.md @@ -153,7 +153,7 @@ coverage: ### Remote Server But if you run tests on different server (or your webserver doesn't use code from current directory) a single option `remote` should be added to config. -For example, let's turn on remote coverage for acceptance suite in `acceptance.suite.yml`: +For example, let's turn on remote coverage for acceptance suite in `Acceptance.suite.yml`: ```yaml diff --git a/docs/ContinuousIntegration.md b/docs/ContinuousIntegration.md index 59b77d666..c8c893d7d 100644 --- a/docs/ContinuousIntegration.md +++ b/docs/ContinuousIntegration.md @@ -178,7 +178,7 @@ before_script: # Test test: script: - - vendor/bin/codecept run acceptance --xml --html + - vendor/bin/codecept run Acceptance --xml --html artifacts: when: always expire_in: 1 week diff --git a/docs/Customization.md b/docs/Customization.md index 3060f7836..393897afd 100644 --- a/docs/Customization.md +++ b/docs/Customization.md @@ -35,10 +35,10 @@ and you want to get a single report in JUnit and HTML format. The code coverage If you want to run a specific suite from the application you can execute: ```bash -php vendor/bin/codecept run unit -c frontend +php vendor/bin/codecept run Unit -c frontend ``` -Where `unit` is the name of suite and the `-c` option specifies the path to the `codeception.yml` configuration file to use. +Where `Unit` is the name of suite and the `-c` option specifies the path to the `codeception.yml` configuration file to use. In this example we will assume that there is `frontend/codeception.yml` configuration file and that we will execute the unit tests for only that app. @@ -199,7 +199,7 @@ extensions: ``` -Extensions can also be enabled per suite inside suite configs (like `acceptance.suite.yml`) and for a specific environment. +Extensions can also be enabled per suite inside suite configs (like `Acceptance.suite.yml`) and for a specific environment. To enable extension dynamically, execute the `run` command with `--ext` option. Provide a class name as a parameter: @@ -371,7 +371,7 @@ You can pass the `-c` option to any Codeception command (except `bootstrap`), to ``` php vendor/bin/codecept run -c ~/projects/ecommerce/ php vendor/bin/codecept run -c ~/projects/drupal -php vendor/bin/codecept generate:cest acceptance CreateArticle -c ~/projects/drupal/ +php vendor/bin/codecept generate:cest Acceptance CreateArticle -c ~/projects/drupal/ ``` @@ -393,19 +393,19 @@ Tests for groups can be specified as an array of file names or directories conta ```yaml groups: # add 2 tests to db group - db: [tests/unit/PersistTest.php, tests/unit/DataTest.php] + db: [tests/Unit/PersistTest.php, tests/Unit/DataTest.php] # add all tests from a directory to api group - api: [tests/functional/api] + api: [tests/Functional/api] ``` A list of tests for the group can be passed from a Group file. It should be defined in plain text with test names on separate lines: ``` -tests/unit/DbTest.php -tests/unit/UserTest.php:creat -tests/unit/UserTest.php:update +tests/Unit/DbTest.php +tests/Unit/UserTest.php:creat +tests/Unit/UserTest.php:update ``` A group file can be included by its relative filename: @@ -542,11 +542,11 @@ You should also specify the path to the `log` directory, where the reports and l It is possible to run specific suites from included applications: * `codecept run` ⬅ Execute all tests from all apps and all suites -* `codecept run unit` ⬅ Runs unit suite from the current app -* `codecept run admin::unit` ⬅ Runs unit suite from admin app -* `codecept run *::unit` ⬅ Runs unit suites from all included apps and NOT the root suite -* `codecept run unit,*::unit` ⬅ Runs included unit suites AND root unit suite -* `codecept run functional,*::unit` ⬅ Runs included unit suites and root functional suite +* `codecept run Unit` ⬅ Runs unit suite from the current app +* `codecept run admin::Unit` ⬅ Runs unit suite from admin app +* `codecept run *::Unit` ⬅ Runs unit suites from all included apps and NOT the root suite +* `codecept run Unit,*::Unit` ⬅ Runs included unit suites AND root unit suite +* `codecept run Functional,*::Unit` ⬅ Runs included unit suites and root functional suite
Improve this guide
diff --git a/docs/ParallelExecution.md b/docs/ParallelExecution.md index 8bf25da48..c3c2a15e8 100644 --- a/docs/ParallelExecution.md +++ b/docs/ParallelExecution.md @@ -146,9 +146,9 @@ Codeception can organize tests into [groups](https://codeception.com/docs/Advanc ```bash -tests/functional/LoginCept.php -tests/functional/AdminCest.php:createUser -tests/functional/AdminCest.php:deleteUser +tests/Functional/LoginCept.php +tests/Functional/AdminCest.php:createUser +tests/Functional/AdminCest.php:deleteUser ``` Tasks from `\Codeception\Task\SplitTestsByGroups` will generate non-intersecting group files. You can either split your tests by files or by single tests: @@ -159,7 +159,7 @@ public function parallelSplitTests() // Split your tests by files $this->taskSplitTestFilesByGroups(5) ->projectRoot('.') - ->testsFrom('tests/acceptance') + ->testsFrom('tests/Acceptance') ->groupsTo('tests/Support/Data/paracept_') ->run(); @@ -167,7 +167,7 @@ public function parallelSplitTests() // Split your tests by single tests (alternatively) $this->taskSplitTestsByGroups(5) ->projectRoot('.') - ->testsFrom('tests/acceptance') + ->testsFrom('tests/Acceptance') ->groupsTo('tests/Support/Data/paracept_') ->run(); */ @@ -207,7 +207,7 @@ Let's try to execute tests from the second group: ```bash -php vendor/bin/codecept run acceptance -g paracept_2 +php vendor/bin/codecept run Acceptance -g paracept_2 ``` #### Step 2: Running Tests @@ -228,7 +228,7 @@ public function parallelRun() for ($i = 1; $i <= 5; $i++) { $parallel->process( $this->taskCodecept() // use built-in Codecept task - ->suite('acceptance') // run acceptance tests + ->suite('Acceptance') // run acceptance tests ->group("paracept_$i") // for all paracept_* groups ->xml("tests/_log/result_$i.xml") // save XML results ); diff --git a/docs/ReusingTestCode.md b/docs/ReusingTestCode.md index 078a6b55d..87b89090e 100644 --- a/docs/ReusingTestCode.md +++ b/docs/ReusingTestCode.md @@ -95,7 +95,7 @@ Do not hard-code complex CSS or XPath locators in your tests but rather move the Codeception can generate a PageObject class for you with command: ``` -php vendor/bin/codecept generate:pageobject acceptance Login +php vendor/bin/codecept generate:pageobject Acceptance Login ``` > It is recommended to use page objects for acceptance testing only @@ -197,17 +197,17 @@ We call such a classes StepObjects. Lets create an Admin StepObject with the generator: ``` -php vendor/bin/codecept generate:stepobject acceptance Admin +php vendor/bin/codecept generate:stepobject Acceptance Admin ``` You can supply optional action names. Enter one at a time, followed by a newline. End with an empty line to continue to StepObject creation. ``` -php vendor/bin/codecept generate:stepobject acceptance Admin +php vendor/bin/codecept generate:stepobject Acceptance Admin Add action to StepObject class (ENTER to exit): loginAsAdmin Add action to StepObject class (ENTER to exit): -StepObject was created in /tests/acceptance/_support/Step/Acceptance/Admin.php +StepObject was created in /tests/Acceptance/_support/Step/Acceptance/Admin.php ``` This will generate a class in `/tests/Support/Step/Acceptance/Admin.php` similar to this: diff --git a/docs/UnitTests.md b/docs/UnitTests.md index a25fd79e5..972e26494 100644 --- a/docs/UnitTests.md +++ b/docs/UnitTests.md @@ -19,7 +19,7 @@ Create a test using `generate:test` command with a suite and test names as param php vendor/bin/codecept generate:test Unit Example ``` -It creates a new `ExampleTest` file located in the `tests/unit` directory. +It creates a new `ExampleTest` file located in the `tests/Unit` directory. As always, you can run the newly created test with this command: @@ -255,7 +255,7 @@ function testSavingUser() ``` To enable the database functionality in unit tests, make sure the `Db` module is included -in the `unit.suite.yml` configuration file. +in the `Unit.suite.yml` configuration file. The database will be cleaned and populated after each test, the same way it happens for acceptance and functional tests. If that's not your required behavior, change the settings of the `Db` module for the current suite. See [Db Module](https://codeception.com/docs/modules/Db) diff --git a/docs/modules/Laminas.md b/docs/modules/Laminas.md index c651d57f9..2dbbfcb12 100644 --- a/docs/modules/Laminas.md +++ b/docs/modules/Laminas.md @@ -1115,9 +1115,9 @@ $form = [ 'checkbox1' => true, // ... ]; -$I->submitForm('//form[@id=my-form]', string $form, 'submitButton'); +$I->submitForm('//form[@id=my-form]', $form, 'submitButton'); // $I->amOnPage('/path/to/form-page') may be needed -$I->seeInFormFields('//form[@id=my-form]', string $form); +$I->seeInFormFields('//form[@id=my-form]', $form); {% endhighlight %} diff --git a/docs/modules/Laravel.md b/docs/modules/Laravel.md index d25c52eaf..91f91e54e 100644 --- a/docs/modules/Laravel.md +++ b/docs/modules/Laravel.md @@ -1923,9 +1923,9 @@ $form = [ 'checkbox1' => true, // ... ]; -$I->submitForm('//form[@id=my-form]', string $form, 'submitButton'); +$I->submitForm('//form[@id=my-form]', $form, 'submitButton'); // $I->amOnPage('/path/to/form-page') may be needed -$I->seeInFormFields('//form[@id=my-form]', string $form); +$I->seeInFormFields('//form[@id=my-form]', $form); {% endhighlight %} diff --git a/docs/modules/Lumen.md b/docs/modules/Lumen.md index 099811ad0..89315a443 100644 --- a/docs/modules/Lumen.md +++ b/docs/modules/Lumen.md @@ -1374,9 +1374,9 @@ $form = [ 'checkbox1' => true, // ... ]; -$I->submitForm('//form[@id=my-form]', string $form, 'submitButton'); +$I->submitForm('//form[@id=my-form]', $form, 'submitButton'); // $I->amOnPage('/path/to/form-page') may be needed -$I->seeInFormFields('//form[@id=my-form]', string $form); +$I->seeInFormFields('//form[@id=my-form]', $form); {% endhighlight %} diff --git a/docs/modules/Mezzio.md b/docs/modules/Mezzio.md index 5d250361a..9bb626c5d 100644 --- a/docs/modules/Mezzio.md +++ b/docs/modules/Mezzio.md @@ -1027,9 +1027,9 @@ $form = [ 'checkbox1' => true, // ... ]; -$I->submitForm('//form[@id=my-form]', string $form, 'submitButton'); +$I->submitForm('//form[@id=my-form]', $form, 'submitButton'); // $I->amOnPage('/path/to/form-page') may be needed -$I->seeInFormFields('//form[@id=my-form]', string $form); +$I->seeInFormFields('//form[@id=my-form]', $form); {% endhighlight %} diff --git a/docs/modules/PhpBrowser.md b/docs/modules/PhpBrowser.md index 4d60041c6..e7733db84 100644 --- a/docs/modules/PhpBrowser.md +++ b/docs/modules/PhpBrowser.md @@ -1127,9 +1127,9 @@ $form = [ 'checkbox1' => true, // ... ]; -$I->submitForm('//form[@id=my-form]', string $form, 'submitButton'); +$I->submitForm('//form[@id=my-form]', $form, 'submitButton'); // $I->amOnPage('/path/to/form-page') may be needed -$I->seeInFormFields('//form[@id=my-form]', string $form); +$I->seeInFormFields('//form[@id=my-form]', $form); {% endhighlight %} diff --git a/docs/modules/Symfony.md b/docs/modules/Symfony.md index 2179cea92..78666b6fe 100644 --- a/docs/modules/Symfony.md +++ b/docs/modules/Symfony.md @@ -3016,9 +3016,9 @@ $form = [ 'checkbox1' => true, // ... ]; -$I->submitForm('//form[@id=my-form]', string $form, 'submitButton'); +$I->submitForm('//form[@id=my-form]', $form, 'submitButton'); // $I->amOnPage('/path/to/form-page') may be needed -$I->seeInFormFields('//form[@id=my-form]', string $form); +$I->seeInFormFields('//form[@id=my-form]', $form); {% endhighlight %} diff --git a/docs/modules/WebDriver.md b/docs/modules/WebDriver.md index f9243e410..1641febfd 100644 --- a/docs/modules/WebDriver.md +++ b/docs/modules/WebDriver.md @@ -1943,9 +1943,9 @@ $form = [ 'checkbox1' => true, // ... ]; -$I->submitForm('//form[@id=my-form]', string $form, 'submitButton'); +$I->submitForm('//form[@id=my-form]', $form, 'submitButton'); // $I->amOnPage('/path/to/form-page') may be needed -$I->seeInFormFields('//form[@id=my-form]', string $form); +$I->seeInFormFields('//form[@id=my-form]', $form); {% endhighlight %} diff --git a/docs/modules/Yii2.md b/docs/modules/Yii2.md index e778e2173..b2a0daea7 100644 --- a/docs/modules/Yii2.md +++ b/docs/modules/Yii2.md @@ -1428,9 +1428,9 @@ $form = [ 'checkbox1' => true, // ... ]; -$I->submitForm('//form[@id=my-form]', string $form, 'submitButton'); +$I->submitForm('//form[@id=my-form]', $form, 'submitButton'); // $I->amOnPage('/path/to/form-page') may be needed -$I->seeInFormFields('//form[@id=my-form]', string $form); +$I->seeInFormFields('//form[@id=my-form]', $form); {% endhighlight %} diff --git a/docs/reference/Autoload.md b/docs/reference/Autoload.md index 0f62f400a..3eb14f02a 100644 --- a/docs/reference/Autoload.md +++ b/docs/reference/Autoload.md @@ -40,7 +40,7 @@ Autoload::addNamespace('app\Codeception', '/path/to/controllers'); {% endhighlight %} -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Util/Autoload.php#L57) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Util/Autoload.php#L57) #### load() @@ -50,6 +50,6 @@ Autoload::addNamespace('app\Codeception', '/path/to/controllers'); * `param string` $class * `return string|false` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Util/Autoload.php#L75) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Util/Autoload.php#L75) -

 

Reference is taken from the source code. Help us to improve documentation. Edit module reference
+

 

Reference is taken from the source code. Help us to improve documentation. Edit module reference
diff --git a/docs/reference/Commands.md b/docs/reference/Commands.md index d741d79d3..5960d3e42 100644 --- a/docs/reference/Commands.md +++ b/docs/reference/Commands.md @@ -5,16 +5,37 @@ title: Commands - Codeception - Documentation # Console Commands -## DryRun +## 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. + +* `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` + +## 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. + +## 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 + ## GenerateSnapshot @@ -29,92 +50,81 @@ If suite name is provided, an actor class will be included into placeholder -## Clean - -Recursively cleans `output` directory and generated code. - -* `codecept clean` - +## 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` -## GenerateTest -Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`. -* `codecept g:test Unit User` -* `codecept g:test Unit "App\User"` +## GherkinSteps +Prints all steps from all Gherkin contexts for a specific suite -## GenerateHelper +{% highlight yaml %} +codecept gherkin:steps Acceptance -Creates empty Helper class. +{% endhighlight %} -* `codecept g:helper MyHelper` -* `codecept g:helper "My\Helper"` +## CompletionFallback -## 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"` +## 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 -## CompletionFallback +## GenerateHelper -## ConfigValidate +Creates empty Helper class. -Validates and prints Codeception config. -Use it do debug Yaml configs +* `codecept g:helper MyHelper` +* `codecept g:helper "My\Helper"` -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 +## GenerateEnvironment -Check overriding config values (like in `run` command) +Generates empty environment configuration file into envs dir: -* `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 g:env firefox` +Required to have `envs` path to be specified in `codeception.yml` -## GherkinSteps +## DryRun -Prints all steps from all Gherkin contexts for a specific suite +Shows step-by-step execution process for scenario driven tests without actually running them. -{% highlight yaml %} -codecept gherkin:steps Acceptance +* `codecept dry-run Acceptance` +* `codecept dry-run Acceptance MyCest` +* `codecept dry-run Acceptance checkout.feature` +* `codecept dry-run tests/Acceptance/MyCest.php` -{% endhighlight %} -## GeneratePageObject +## GenerateScenarios -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. +Generates user-friendly text scenarios from scenario-driven tests (Cest). -* `codecept g:page Login` -* `codecept g:page Registration` -* `codecept g:page Acceptance Login` +* `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 @@ -211,51 +221,38 @@ Options: -## Bootstrap - -Creates default config, tests directory and sample suites for current project. -Use this command to start building a test suite. - -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 - - - - -## GenerateScenarios - -Generates user-friendly text scenarios from scenario-driven tests (Cest). +## ConfigValidate -* `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 +Validates and prints Codeception config. +Use it do debug Yaml configs +Check config: +* `codecept config`: check global config +* `codecept config Unit`: check suite config -## GenerateFeature +Load config: -Generates Feature file (in Gherkin): +* `codecept config:validate -c path/to/another/config`: from another dir +* `codecept config:validate -c another_config.yml`: from another config file -* `codecept generate:feature suite Login` -* `codecept g:feature suite subdir/subdir/login.feature` -* `codecept g:feature suite login.feature -c path/to/project` +Check overriding config values (like in `run` command) +* `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 -## 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. +## GeneratePageObject -* `codecept build` -* `codecept build path/to/project` +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` @@ -267,17 +264,23 @@ Creates empty GroupObject - extension which handles all group events. -## Init +## Bootstrap +Creates default config, tests directory and sample suites for current project. +Use this command to start building a test suite. +By default, it will create 3 suites **Acceptance**, **Functional**, and **Unit**. -## GenerateEnvironment +* `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 -Generates empty environment configuration file into envs dir: - * `codecept g:env firefox` -Required to have `envs` path to be specified in `codeception.yml` + +## Init @@ -291,36 +294,24 @@ Auto-updates phar archive from official site: 'https://codeception.com/codecept. -## 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 - - - -## GenerateStepObject - -Generates StepObject class. You will be asked for steps you want to implement. +## GenerateTest -* `codecept g:stepobject Acceptance AdminSteps` -* `codecept g:stepobject Acceptance UserSteps --silent` - skip action questions +Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`. +* `codecept g:test Unit User` +* `codecept g:test Unit "App\User"` +## GenerateCest -## Console +Generates Cest (scenario-driven object-oriented test) file: -Try to execute test commands in run-time. You may try commands before writing the test. +* `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"` -* `codecept console Acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands. @@ -336,3 +327,12 @@ Create new test suite. Requires suite name and actor name +## Clean + +Recursively cleans `output` directory and generated code. + +* `codecept clean` + + + + diff --git a/docs/reference/Configuration.md b/docs/reference/Configuration.md index ce366e19f..109cbd98f 100644 --- a/docs/reference/Configuration.md +++ b/docs/reference/Configuration.md @@ -48,7 +48,7 @@ modules: dsn: '' user: '' password: '' - dump: tests/_data/dump.sql + dump: tests/Support/Data/dump.sql {% endhighlight %} ### `namespace` @@ -65,11 +65,11 @@ Directories used by Codeception. Default values: {% highlight yaml %} paths: - tests : tests # where the tests stored - data : tests/_data # directory for fixture data - support: tests/_support # directory for support code - output : tests/_output # directory for output - envs : tests/_envs # directory for environment configuration + tests : tests # where the tests stored + data : tests/Support/Data # directory for fixture data + support: tests/Support # directory for support code + output : tests/_output # directory for output + envs : tests/_envs # directory for environment configuration {% endhighlight %} ### `reporters` @@ -105,7 +105,7 @@ Possible settings: * `shuffle: true`: Randomize test order * `strict_xml: false`: Generate XML JUnit report using strict schema. Avoid putting additional report fields like steps or scenario names to it. Required for XML reports on Jenkins CI -## Suite Configuration: `unit.suite.yml`, `functional.suite.yml` etc. +## Suite Configuration: `Unit.suite.yml`, `Functional.suite.yml` etc. Each suite has its own configuration inside the directory set by `paths: tests: ` in `codeception.yml`. Alphabetical list of options: @@ -178,12 +178,12 @@ Default namespace for new tests of this suite (ignores `namespace` option) To provide the same configuration template for your development team, you can create a `codeception.dist.yml` config file, which will be loaded before `codeception.yml`. The dist config provides shared options, while local `codeception.yml` files override them on a per-installation basis. Therefore, `codeception.yml` should be ignored by your VCS system. -Config templates can also be used for suite configuration, by creating a `suitename.suite.dist.yml` file. +Config templates can also be used for suite configuration, by creating a `suitename.Suite.dist.yml` file. Configuration loading order: 1. `codeception.dist.yml` 2. `codeception.yml` -3. `acceptance.suite.dist.yml` -4. `acceptance.suite.yml` +3. `Acceptance.suite.dist.yml` +4. `Acceptance.suite.yml` 5. environment config diff --git a/docs/reference/Fixtures.md b/docs/reference/Fixtures.md index a88b78350..ceae62404 100644 --- a/docs/reference/Fixtures.md +++ b/docs/reference/Fixtures.md @@ -29,7 +29,7 @@ Fixtures::exists('user1'); * `param ` $data * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Util/Fixtures.php#L23) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Util/Fixtures.php#L23) #### cleanup() @@ -39,7 +39,7 @@ Fixtures::exists('user1'); * `param string` $name * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Util/Fixtures.php#L37) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Util/Fixtures.php#L37) #### exists() @@ -49,7 +49,7 @@ Fixtures::exists('user1'); * `param string` $name * `return bool` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Util/Fixtures.php#L47) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Util/Fixtures.php#L47) #### get() @@ -58,6 +58,6 @@ Fixtures::exists('user1'); * `param string` $name -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Util/Fixtures.php#L28) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Util/Fixtures.php#L28) -

 

Reference is taken from the source code. Help us to improve documentation. Edit module reference
+

 

Reference is taken from the source code. Help us to improve documentation. Edit module reference
diff --git a/docs/reference/Functions.md b/docs/reference/Functions.md index 490311c68..c0b212b2c 100644 --- a/docs/reference/Functions.md +++ b/docs/reference/Functions.md @@ -21,4 +21,4 @@ Returns absolute path to the root directory (where `codeception.yml` is located) #### codecept_data_dir() -Returns absolute path to data directory (`tests/_data`) \ No newline at end of file +Returns absolute path to data directory (`tests/Support/Data`) \ No newline at end of file diff --git a/docs/reference/InitTemplate.md b/docs/reference/InitTemplate.md index 064e0839a..2b813a9bc 100644 --- a/docs/reference/InitTemplate.md +++ b/docs/reference/InitTemplate.md @@ -38,7 +38,7 @@ This class provides various helper methods for building customized setup * `param \Symfony\Component\Console\Input\InputInterface` $input * `param \Symfony\Component\Console\Output\OutputInterface` $output -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L57) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L57) #### addModulesToComposer() @@ -48,7 +48,7 @@ This class provides various helper methods for building customized setup * `param array` $modules * `return ?int` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L227) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L227) #### addStyles() @@ -58,7 +58,7 @@ This class provides various helper methods for building customized setup * `param \Symfony\Component\Console\Output\OutputInterface` $output * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L12) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L12) #### ask() @@ -83,7 +83,7 @@ $this->ask('do you want to proceed (y/n)', true); {% endhighlight %} -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L97) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L97) #### breakParts() @@ -93,7 +93,7 @@ $this->ask('do you want to proceed (y/n)', true); * `param string` $class * `return string[]` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L19) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L19) #### checkInstalled() @@ -103,7 +103,7 @@ $this->ask('do you want to proceed (y/n)', true); * `param string` $dir * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L195) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L195) #### completeSuffix() @@ -114,7 +114,7 @@ $this->ask('do you want to proceed (y/n)', true); * `param string` $suffix * `return string` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L37) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L37) #### createActor() @@ -130,7 +130,7 @@ Create an Actor class and generate actions for it. Requires a suite config as array in 3rd parameter. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L207) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L207) #### createDirectoryFor() @@ -141,7 +141,7 @@ Requires a suite config as array in 3rd parameter. * `param string` $className * `return string` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L22) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L22) #### createEmptyDirectory() @@ -153,7 +153,7 @@ Requires a suite config as array in 3rd parameter. Create an empty directory and add a placeholder file into it -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L181) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L181) #### createFile() @@ -166,7 +166,7 @@ Create an empty directory and add a placeholder file into it * `param int` $flags * `return bool` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L58) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L58) #### createHelper() @@ -180,7 +180,7 @@ Create an empty directory and add a placeholder file into it Create a helper class inside a directory -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L167) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L167) #### getNamespaceHeader() @@ -190,7 +190,7 @@ Create a helper class inside a directory * `param string` $class * `return string` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L36) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L36) #### getNamespaceString() @@ -200,7 +200,7 @@ Create a helper class inside a directory * `param string` $class * `return string` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L31) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L31) #### getNamespaces() @@ -210,7 +210,7 @@ Create a helper class inside a directory * `param string` $class * `return array` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L42) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L42) #### getShortClassName() @@ -220,7 +220,7 @@ Create a helper class inside a directory * `param string` $class * `return string` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L25) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L25) #### gitIgnore() @@ -230,7 +230,7 @@ Create a helper class inside a directory * `param string` $path * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L187) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L187) #### initDir() @@ -242,7 +242,7 @@ Create a helper class inside a directory Change the directory where Codeception should be installed. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L66) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L66) #### removeSuffix() @@ -253,7 +253,7 @@ Change the directory where Codeception should be installed. * `param string` $suffix * `return string` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L52) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L52) #### say() @@ -272,7 +272,7 @@ $this->say('Welcome to Setup'); {% endhighlight %} -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L127) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L127) #### sayError() @@ -284,7 +284,7 @@ $this->say('Welcome to Setup'); Print error message -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L143) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L143) #### sayInfo() @@ -296,7 +296,7 @@ Print error message Print info message -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L159) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L159) #### saySuccess() @@ -308,7 +308,7 @@ Print info message Print a successful message -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L135) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L135) #### sayWarning() @@ -320,7 +320,7 @@ Print a successful message Print warning message -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L151) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L151) #### setup() @@ -331,7 +331,7 @@ Print warning message Override this class to create customized setup. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L80) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L80) #### updateComposerClassMap() @@ -341,6 +341,6 @@ Override this class to create customized setup. * `param string` $vendorDir * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/InitTemplate.php#L304) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L304) -

 

Reference is taken from the source code. Help us to improve documentation. Edit module reference
+

 

Reference is taken from the source code. Help us to improve documentation. Edit module reference
diff --git a/docs/reference/Locator.md b/docs/reference/Locator.md index 453285b58..b3f2c34e3 100644 --- a/docs/reference/Locator.md +++ b/docs/reference/Locator.md @@ -31,7 +31,7 @@ You can mix up CSS and XPath selectors here. {% highlight php %} see('Title', Locator::combine('h1','h2','h3')); @@ -43,7 +43,7 @@ You can also combine CSS selector with XPath locator: {% highlight php %} fillField(Locator::combine('form input[type=text]','//form/textarea[2]'), 'qwerty'); @@ -121,7 +121,7 @@ Finds element by it's attribute(s) {% highlight php %} seeElement(Locator::find('img', ['title' => 'diagram'])); @@ -167,7 +167,7 @@ Matches the *a* element with given URL {% highlight php %} see('Log In', Locator::href('/login.php')); @@ -342,7 +342,7 @@ You could try to match elements by their tab position using `tabIndex` method of {% highlight php %} fillField(Locator::tabIndex(1), 'davert'); $I->fillField(Locator::tabIndex(2) , 'qwerty'); diff --git a/docs/reference/Mock.md b/docs/reference/Mock.md index e7e7b7d5b..cc45cb3b9 100644 --- a/docs/reference/Mock.md +++ b/docs/reference/Mock.md @@ -292,7 +292,7 @@ exception. {% highlight php %} make('User', [ 'getName' => Expected::never(), @@ -316,7 +316,7 @@ exception. {% highlight php %} make( 'User', @@ -351,7 +351,7 @@ If the number of invocations is 0 it will throw an exception in verify. {% highlight php %} make( 'User', @@ -392,8 +392,8 @@ exception. {% highlight php %} make( 'User', diff --git a/docs/reference/Module.md b/docs/reference/Module.md index fa0264000..8e1fb1ecd 100644 --- a/docs/reference/Module.md +++ b/docs/reference/Module.md @@ -56,7 +56,7 @@ Module constructor. Requires module container (to provide access between modules of suite) and config. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L59) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L59) #### _after() @@ -67,7 +67,7 @@ Requires module container (to provide access between modules of suite) and confi **HOOK** executed after test -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L221) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L221) #### _afterStep() @@ -78,7 +78,7 @@ Requires module container (to provide access between modules of suite) and confi **HOOK** executed after step -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L207) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L207) #### _afterSuite() @@ -87,7 +87,7 @@ Requires module container (to provide access between modules of suite) and confi **HOOK** executed after suite -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L193) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L193) #### _before() @@ -98,7 +98,7 @@ Requires module container (to provide access between modules of suite) and confi **HOOK** executed before test -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L214) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L214) #### _beforeStep() @@ -109,7 +109,7 @@ Requires module container (to provide access between modules of suite) and confi **HOOK** executed before step -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L200) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L200) #### _beforeSuite() @@ -120,7 +120,7 @@ Requires module container (to provide access between modules of suite) and confi **HOOK** executed before suite -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L186) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L186) #### _failed() @@ -132,7 +132,7 @@ Requires module container (to provide access between modules of suite) and confi **HOOK** executed when test fails but before `_after` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L228) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L228) #### _getConfig() @@ -144,7 +144,7 @@ Requires module container (to provide access between modules of suite) and confi Get config values or specific config item. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L299) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L299) #### _getName() @@ -155,7 +155,7 @@ Get config values or specific config item. Returns a module name for a Module, a class name for Helper -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L159) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L159) #### _hasRequiredFields() @@ -166,7 +166,7 @@ Returns a module name for a Module, a class name for Helper Checks if a module has required fields -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L171) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L171) #### _initialize() @@ -175,7 +175,7 @@ Checks if a module has required fields **HOOK** triggered after module is created and configuration is loaded -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L179) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L179) #### _reconfigure() @@ -202,7 +202,7 @@ public function _before(Test $test) { {% endhighlight %} -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L103) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L103) #### _resetConfig() @@ -213,7 +213,7 @@ public function _before(Test $test) { Reverts config changed by `_reconfigure` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L121) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L121) #### _setConfig() @@ -237,7 +237,7 @@ public function _beforeSuite($settings = []) { {% endhighlight %} -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L80) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L80) #### assert() @@ -248,7 +248,7 @@ public function _beforeSuite($settings = []) { * `param bool` $not * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L19) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L19) #### assertArrayHasKey() @@ -262,7 +262,7 @@ public function _beforeSuite($settings = []) { Asserts that an array has a specified key. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L21) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L21) #### assertArrayNotHasKey() @@ -276,7 +276,7 @@ Asserts that an array has a specified key. Asserts that an array does not have a specified key. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L30) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L30) #### assertClassHasAttribute() @@ -290,7 +290,7 @@ Asserts that an array does not have a specified key. Asserts that a class has a specified attribute. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L39) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L39) #### assertClassHasStaticAttribute() @@ -304,7 +304,7 @@ Asserts that a class has a specified attribute. Asserts that a class has a specified static attribute. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L49) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L49) #### assertClassNotHasAttribute() @@ -318,7 +318,7 @@ Asserts that a class has a specified static attribute. Asserts that a class does not have a specified attribute. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L60) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L60) #### assertClassNotHasStaticAttribute() @@ -332,7 +332,7 @@ Asserts that a class does not have a specified attribute. Asserts that a class does not have a specified static attribute. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L70) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L70) #### assertContains() @@ -346,7 +346,7 @@ Asserts that a class does not have a specified static attribute. Asserts that a haystack contains a needle. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L81) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L81) #### assertContainsEquals() @@ -358,7 +358,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L89) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L89) #### assertContainsNotOnlyArray() @@ -369,7 +369,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L105) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L105) #### assertContainsNotOnlyBool() @@ -380,7 +380,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L113) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L113) #### assertContainsNotOnlyCallable() @@ -391,7 +391,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L121) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L121) #### assertContainsNotOnlyClosedResource() @@ -402,7 +402,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L194) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L194) #### assertContainsNotOnlyFloat() @@ -413,7 +413,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L129) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L129) #### assertContainsNotOnlyInstancesOf() @@ -425,7 +425,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L138) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L138) #### assertContainsNotOnlyInt() @@ -436,7 +436,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L146) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L146) #### assertContainsNotOnlyIterable() @@ -447,7 +447,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L154) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L154) #### assertContainsNotOnlyNull() @@ -458,7 +458,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L162) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L162) #### assertContainsNotOnlyNumeric() @@ -469,7 +469,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L170) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L170) #### assertContainsNotOnlyObject() @@ -480,7 +480,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L178) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L178) #### assertContainsNotOnlyResource() @@ -491,7 +491,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L186) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L186) #### assertContainsNotOnlyScalar() @@ -502,7 +502,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L202) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L202) #### assertContainsNotOnlyString() @@ -513,7 +513,7 @@ Asserts that a haystack contains a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L210) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L210) #### assertContainsOnly() @@ -528,7 +528,7 @@ Asserts that a haystack contains a needle. Asserts that a haystack contains only values of a given type. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L220) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L220) #### assertContainsOnlyArray() @@ -539,7 +539,7 @@ Asserts that a haystack contains only values of a given type. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L278) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L278) #### assertContainsOnlyBool() @@ -550,7 +550,7 @@ Asserts that a haystack contains only values of a given type. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L286) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L286) #### assertContainsOnlyCallable() @@ -561,7 +561,7 @@ Asserts that a haystack contains only values of a given type. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L294) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L294) #### assertContainsOnlyClosedResource() @@ -572,7 +572,7 @@ Asserts that a haystack contains only values of a given type. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L358) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L358) #### assertContainsOnlyFloat() @@ -583,7 +583,7 @@ Asserts that a haystack contains only values of a given type. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L302) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L302) #### assertContainsOnlyInstancesOf() @@ -597,7 +597,7 @@ Asserts that a haystack contains only values of a given type. Asserts that a haystack contains only instances of a given class name. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L270) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L270) #### assertContainsOnlyInt() @@ -608,7 +608,7 @@ Asserts that a haystack contains only instances of a given class name. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L310) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L310) #### assertContainsOnlyIterable() @@ -619,7 +619,7 @@ Asserts that a haystack contains only instances of a given class name. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L318) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L318) #### assertContainsOnlyNull() @@ -630,7 +630,7 @@ Asserts that a haystack contains only instances of a given class name. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L326) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L326) #### assertContainsOnlyNumeric() @@ -641,7 +641,7 @@ Asserts that a haystack contains only instances of a given class name. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L334) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L334) #### assertContainsOnlyObject() @@ -652,7 +652,7 @@ Asserts that a haystack contains only instances of a given class name. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L342) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L342) #### assertContainsOnlyResource() @@ -663,7 +663,7 @@ Asserts that a haystack contains only instances of a given class name. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L350) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L350) #### assertContainsOnlyScalar() @@ -674,7 +674,7 @@ Asserts that a haystack contains only instances of a given class name. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L366) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L366) #### assertContainsOnlyString() @@ -685,7 +685,7 @@ Asserts that a haystack contains only instances of a given class name. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L374) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L374) #### assertCount() @@ -699,7 +699,7 @@ Asserts that a haystack contains only instances of a given class name. Asserts the number of elements of an array, Countable or Traversable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L384) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L384) #### assertDirectoryDoesNotExist() @@ -712,7 +712,7 @@ Asserts the number of elements of an array, Countable or Traversable. Asserts that a directory does not exist. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L392) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L392) #### assertDirectoryExists() @@ -725,7 +725,7 @@ Asserts that a directory does not exist. Asserts that a directory exists. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L400) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L400) #### assertDirectoryIsNotReadable() @@ -738,7 +738,7 @@ Asserts that a directory exists. Asserts that a directory exists and is not readable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L408) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L408) #### assertDirectoryIsNotWritable() @@ -751,7 +751,7 @@ Asserts that a directory exists and is not readable. Asserts that a directory exists and is not writable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L416) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L416) #### assertDirectoryIsReadable() @@ -764,7 +764,7 @@ Asserts that a directory exists and is not writable. Asserts that a directory exists and is readable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L424) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L424) #### assertDirectoryIsWritable() @@ -777,7 +777,7 @@ Asserts that a directory exists and is readable. Asserts that a directory exists and is writable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L432) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L432) #### assertDoesNotMatchRegularExpression() @@ -791,7 +791,7 @@ Asserts that a directory exists and is writable. Asserts that a string does not match a given regular expression. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L440) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L440) #### assertEmpty() @@ -805,7 +805,7 @@ Asserts that a string does not match a given regular expression. Asserts that a variable is empty. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L452) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L452) #### assertEquals() @@ -819,7 +819,7 @@ Asserts that a variable is empty. Asserts that two variables are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L463) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L463) #### assertEqualsCanonicalizing() @@ -833,7 +833,7 @@ Asserts that two variables are equal. Asserts that two variables are equal (canonicalizing). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L474) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L474) #### assertEqualsIgnoringCase() @@ -847,7 +847,7 @@ Asserts that two variables are equal (canonicalizing). Asserts that two variables are equal (ignoring case). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L485) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L485) #### assertEqualsWithDelta() @@ -862,7 +862,7 @@ Asserts that two variables are equal (ignoring case). Asserts that two variables are equal (with delta). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L496) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L496) #### assertFalse() @@ -876,7 +876,7 @@ Asserts that two variables are equal (with delta). Asserts that a condition is false. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L508) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L508) #### assertFileDoesNotExist() @@ -889,7 +889,7 @@ Asserts that a condition is false. Asserts that a file does not exist. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L516) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L516) #### assertFileEquals() @@ -903,7 +903,7 @@ Asserts that a file does not exist. Asserts that the contents of one file is equal to the contents of another file. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L524) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L524) #### assertFileEqualsCanonicalizing() @@ -917,7 +917,7 @@ Asserts that the contents of one file is equal to the contents of another file. Asserts that the contents of one file is equal to the contents of another file (canonicalizing). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L532) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L532) #### assertFileEqualsIgnoringCase() @@ -931,7 +931,7 @@ Asserts that the contents of one file is equal to the contents of another file ( Asserts that the contents of one file is equal to the contents of another file (ignoring case). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L540) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L540) #### assertFileExists() @@ -944,7 +944,7 @@ Asserts that the contents of one file is equal to the contents of another file ( Asserts that a file exists. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L548) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L548) #### assertFileIsNotReadable() @@ -957,7 +957,7 @@ Asserts that a file exists. Asserts that a file exists and is not readable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L556) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L556) #### assertFileIsNotWritable() @@ -970,7 +970,7 @@ Asserts that a file exists and is not readable. Asserts that a file exists and is not writable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L564) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L564) #### assertFileIsReadable() @@ -983,7 +983,7 @@ Asserts that a file exists and is not writable. Asserts that a file exists and is readable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L572) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L572) #### assertFileIsWritable() @@ -996,7 +996,7 @@ Asserts that a file exists and is readable. Asserts that a file exists and is writable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L580) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L580) #### assertFileNotEquals() @@ -1010,7 +1010,7 @@ Asserts that a file exists and is writable. Asserts that the contents of one file is not equal to the contents of another file. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L588) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L588) #### assertFileNotEqualsCanonicalizing() @@ -1024,7 +1024,7 @@ Asserts that the contents of one file is not equal to the contents of another fi Asserts that the contents of one file is not equal to the contents of another file (canonicalizing). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L596) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L596) #### assertFileNotEqualsIgnoringCase() @@ -1038,7 +1038,7 @@ Asserts that the contents of one file is not equal to the contents of another fi Asserts that the contents of one file is not equal to the contents of another file (ignoring case). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L604) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L604) #### assertFileNotExists() @@ -1051,7 +1051,7 @@ Asserts that the contents of one file is not equal to the contents of another fi Asserts that a file does not exist. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L55) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L55) #### assertFinite() @@ -1064,7 +1064,7 @@ Asserts that a file does not exist. Asserts that a variable is finite. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L614) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L614) #### assertGreaterOrEquals() @@ -1078,7 +1078,7 @@ Asserts that a variable is finite. Asserts that a value is greater than or equal to another value. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L66) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L66) #### assertGreaterThan() @@ -1092,7 +1092,7 @@ Asserts that a value is greater than or equal to another value. Asserts that a value is greater than another value. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L625) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L625) #### assertGreaterThanOrEqual() @@ -1106,7 +1106,7 @@ Asserts that a value is greater than another value. Asserts that a value is greater than or equal to another value. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L636) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L636) #### assertInfinite() @@ -1119,7 +1119,7 @@ Asserts that a value is greater than or equal to another value. Asserts that a variable is infinite. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L646) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L646) #### assertInstanceOf() @@ -1135,7 +1135,7 @@ Asserts that a variable is infinite. Asserts that a variable is of a given type. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L661) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L661) #### assertIsArray() @@ -1149,7 +1149,7 @@ Asserts that a variable is of a given type. Asserts that a variable is of type array. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L672) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L672) #### assertIsBool() @@ -1163,7 +1163,7 @@ Asserts that a variable is of type array. Asserts that a variable is of type bool. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L684) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L684) #### assertIsCallable() @@ -1177,7 +1177,7 @@ Asserts that a variable is of type bool. Asserts that a variable is of type callable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L696) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L696) #### assertIsClosedResource() @@ -1191,7 +1191,7 @@ Asserts that a variable is of type callable. Asserts that a variable is of type resource and is closed. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L708) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L708) #### assertIsEmpty() @@ -1204,7 +1204,7 @@ Asserts that a variable is of type resource and is closed. Asserts that a variable is empty. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L74) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L74) #### assertIsFloat() @@ -1218,7 +1218,7 @@ Asserts that a variable is empty. Asserts that a variable is of type float. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L720) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L720) #### assertIsInt() @@ -1232,7 +1232,7 @@ Asserts that a variable is of type float. Asserts that a variable is of type int. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L732) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L732) #### assertIsIterable() @@ -1246,7 +1246,7 @@ Asserts that a variable is of type int. Asserts that a variable is of type iterable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L744) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L744) #### assertIsNotArray() @@ -1260,7 +1260,7 @@ Asserts that a variable is of type iterable. Asserts that a variable is not of type array. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L756) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L756) #### assertIsNotBool() @@ -1274,7 +1274,7 @@ Asserts that a variable is not of type array. Asserts that a variable is not of type bool. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L768) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L768) #### assertIsNotCallable() @@ -1288,7 +1288,7 @@ Asserts that a variable is not of type bool. Asserts that a variable is not of type callable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L780) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L780) #### assertIsNotClosedResource() @@ -1302,7 +1302,7 @@ Asserts that a variable is not of type callable. Asserts that a variable is not of type resource. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L792) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L792) #### assertIsNotFloat() @@ -1316,7 +1316,7 @@ Asserts that a variable is not of type resource. Asserts that a variable is not of type float. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L804) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L804) #### assertIsNotInt() @@ -1330,7 +1330,7 @@ Asserts that a variable is not of type float. Asserts that a variable is not of type int. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L816) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L816) #### assertIsNotIterable() @@ -1344,7 +1344,7 @@ Asserts that a variable is not of type int. Asserts that a variable is not of type iterable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L828) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L828) #### assertIsNotNumeric() @@ -1358,7 +1358,7 @@ Asserts that a variable is not of type iterable. Asserts that a variable is not of type numeric. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L840) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L840) #### assertIsNotObject() @@ -1372,7 +1372,7 @@ Asserts that a variable is not of type numeric. Asserts that a variable is not of type object. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L852) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L852) #### assertIsNotReadable() @@ -1385,7 +1385,7 @@ Asserts that a variable is not of type object. Asserts that a file/dir exists and is not readable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L860) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L860) #### assertIsNotResource() @@ -1399,7 +1399,7 @@ Asserts that a file/dir exists and is not readable. Asserts that a variable is not of type resource. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L872) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L872) #### assertIsNotScalar() @@ -1413,7 +1413,7 @@ Asserts that a variable is not of type resource. Asserts that a variable is not of type scalar. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L884) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L884) #### assertIsNotString() @@ -1427,7 +1427,7 @@ Asserts that a variable is not of type scalar. Asserts that a variable is not of type string. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L896) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L896) #### assertIsNotWritable() @@ -1440,7 +1440,7 @@ Asserts that a variable is not of type string. Asserts that a file/dir exists and is not writable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L904) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L904) #### assertIsNumeric() @@ -1454,7 +1454,7 @@ Asserts that a file/dir exists and is not writable. Asserts that a variable is of type numeric. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L916) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L916) #### assertIsObject() @@ -1468,7 +1468,7 @@ Asserts that a variable is of type numeric. Asserts that a variable is of type object. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L928) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L928) #### assertIsReadable() @@ -1481,7 +1481,7 @@ Asserts that a variable is of type object. Asserts that a file/dir is readable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L936) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L936) #### assertIsResource() @@ -1495,7 +1495,7 @@ Asserts that a file/dir is readable. Asserts that a variable is of type resource. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L948) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L948) #### assertIsScalar() @@ -1509,7 +1509,7 @@ Asserts that a variable is of type resource. Asserts that a variable is of type scalar. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L960) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L960) #### assertIsString() @@ -1523,7 +1523,7 @@ Asserts that a variable is of type scalar. Asserts that a variable is of type string. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L972) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L972) #### assertIsWritable() @@ -1536,7 +1536,7 @@ Asserts that a variable is of type string. Asserts that a file/dir exists and is writable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L980) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L980) #### assertJson() @@ -1549,7 +1549,7 @@ Asserts that a file/dir exists and is writable. Asserts that a string is a valid JSON string. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L988) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L988) #### assertJsonFileEqualsJsonFile() @@ -1563,7 +1563,7 @@ Asserts that a string is a valid JSON string. Asserts that two JSON files are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L996) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L996) #### assertJsonFileNotEqualsJsonFile() @@ -1577,7 +1577,7 @@ Asserts that two JSON files are equal. Asserts that two JSON files are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1004) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1004) #### assertJsonStringEqualsJsonFile() @@ -1591,7 +1591,7 @@ Asserts that two JSON files are not equal. Asserts that the generated JSON encoded object and the content of the given file are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1012) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1012) #### assertJsonStringEqualsJsonString() @@ -1605,7 +1605,7 @@ Asserts that the generated JSON encoded object and the content of the given file Asserts that two given JSON encoded objects or arrays are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1020) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1020) #### assertJsonStringNotEqualsJsonFile() @@ -1619,7 +1619,7 @@ Asserts that two given JSON encoded objects or arrays are equal. Asserts that the generated JSON encoded object and the content of the given file are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1028) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1028) #### assertJsonStringNotEqualsJsonString() @@ -1633,7 +1633,7 @@ Asserts that the generated JSON encoded object and the content of the given file Asserts that two given JSON encoded objects or arrays are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1036) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1036) #### assertLessOrEquals() @@ -1647,7 +1647,7 @@ Asserts that two given JSON encoded objects or arrays are not equal. Asserts that a value is smaller than or equal to another value. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L82) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L82) #### assertLessThan() @@ -1661,7 +1661,7 @@ Asserts that a value is smaller than or equal to another value. Asserts that a value is smaller than another value. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1047) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1047) #### assertLessThanOrEqual() @@ -1675,7 +1675,7 @@ Asserts that a value is smaller than another value. Asserts that a value is smaller than or equal to another value. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1058) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1058) #### assertMatchesRegularExpression() @@ -1689,7 +1689,7 @@ Asserts that a value is smaller than or equal to another value. Asserts that a string matches a given regular expression. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1066) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1066) #### assertNan() @@ -1702,7 +1702,7 @@ Asserts that a string matches a given regular expression. Asserts that a variable is nan. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1076) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1076) #### assertNot() @@ -1712,7 +1712,7 @@ Asserts that a variable is nan. * `param array` $arguments * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L47) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L47) #### assertNotContains() @@ -1726,7 +1726,7 @@ Asserts that a variable is nan. Asserts that a haystack does not contain a needle. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1086) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1086) #### assertNotContainsEquals() @@ -1738,7 +1738,7 @@ Asserts that a haystack does not contain a needle. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L97) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L97) #### assertNotContainsOnly() @@ -1753,7 +1753,7 @@ Asserts that a haystack does not contain a needle. Asserts that a haystack does not contain only values of a given type. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1096) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1096) #### assertNotCount() @@ -1767,7 +1767,7 @@ Asserts that a haystack does not contain only values of a given type. Asserts the number of elements of an array, Countable or Traversable. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1146) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1146) #### assertNotEmpty() @@ -1781,7 +1781,7 @@ Asserts the number of elements of an array, Countable or Traversable. Asserts that a variable is not empty. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1158) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1158) #### assertNotEquals() @@ -1795,7 +1795,7 @@ Asserts that a variable is not empty. Asserts that two variables are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1169) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1169) #### assertNotEqualsCanonicalizing() @@ -1809,7 +1809,7 @@ Asserts that two variables are not equal. Asserts that two variables are not equal (canonicalizing). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1180) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1180) #### assertNotEqualsIgnoringCase() @@ -1823,7 +1823,7 @@ Asserts that two variables are not equal (canonicalizing). Asserts that two variables are not equal (ignoring case). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1191) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1191) #### assertNotEqualsWithDelta() @@ -1838,7 +1838,7 @@ Asserts that two variables are not equal (ignoring case). Asserts that two variables are not equal (with delta). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1202) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1202) #### assertNotFalse() @@ -1852,7 +1852,7 @@ Asserts that two variables are not equal (with delta). Asserts that a condition is not false. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1214) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1214) #### assertNotInstanceOf() @@ -1868,7 +1868,7 @@ Asserts that a condition is not false. Asserts that a variable is not of a given type. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1229) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1229) #### assertNotNull() @@ -1882,7 +1882,7 @@ Asserts that a variable is not of a given type. Asserts that a variable is not null. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1241) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1241) #### assertNotRegExp() @@ -1896,7 +1896,7 @@ Asserts that a variable is not null. Asserts that a string does not match a given regular expression. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L90) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L90) #### assertNotSame() @@ -1910,7 +1910,7 @@ Asserts that a string does not match a given regular expression. Asserts that two variables do not have the same type and value. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1252) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1252) #### assertNotSameSize() @@ -1924,7 +1924,7 @@ Asserts that two variables do not have the same type and value. Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1263) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1263) #### assertNotTrue() @@ -1938,7 +1938,7 @@ Assert that the size of two arrays (or `Countable` or `Traversable` objects) is Asserts that a condition is not true. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1275) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1275) #### assertNull() @@ -1952,7 +1952,7 @@ Asserts that a condition is not true. Asserts that a variable is null. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1287) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1287) #### assertObjectHasAttribute() @@ -1966,7 +1966,7 @@ Asserts that a variable is null. Asserts that an object has a specified attribute. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1295) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1295) #### assertObjectNotHasAttribute() @@ -1980,7 +1980,7 @@ Asserts that an object has a specified attribute. Asserts that an object does not have a specified attribute. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1309) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1309) #### assertRegExp() @@ -1994,7 +1994,7 @@ Asserts that an object does not have a specified attribute. Asserts that a string matches a given regular expression. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L98) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L98) #### assertSame() @@ -2013,7 +2013,7 @@ Asserts that two variables have the same type and value. Used on objects, it asserts that two variables reference the same object. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1331) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1331) #### assertSameSize() @@ -2027,7 +2027,7 @@ the same object. Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1341) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1341) #### assertStringContainsString() @@ -2039,7 +2039,7 @@ Assert that the size of two arrays (or `Countable` or `Traversable` objects) is * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1346) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1346) #### assertStringContainsStringIgnoringCase() @@ -2051,7 +2051,7 @@ Assert that the size of two arrays (or `Countable` or `Traversable` objects) is * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1351) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1351) #### assertStringEndsNotWith() @@ -2065,7 +2065,7 @@ Assert that the size of two arrays (or `Countable` or `Traversable` objects) is Asserts that a string ends not with a given suffix. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1360) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1360) #### assertStringEndsWith() @@ -2079,7 +2079,7 @@ Asserts that a string ends not with a given suffix. Asserts that a string ends with a given suffix. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1369) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1369) #### assertStringEqualsFile() @@ -2093,7 +2093,7 @@ Asserts that a string ends with a given suffix. Asserts that the contents of a string is equal to the contents of a file. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1377) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1377) #### assertStringEqualsFileCanonicalizing() @@ -2107,7 +2107,7 @@ Asserts that the contents of a string is equal to the contents of a file. Asserts that the contents of a string is equal to the contents of a file (canonicalizing). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1385) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1385) #### assertStringEqualsFileIgnoringCase() @@ -2121,7 +2121,7 @@ Asserts that the contents of a string is equal to the contents of a file (canoni Asserts that the contents of a string is equal to the contents of a file (ignoring case). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1393) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1393) #### assertStringMatchesFormat() @@ -2135,7 +2135,7 @@ Asserts that the contents of a string is equal to the contents of a file (ignori Asserts that a string matches a given format string. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1401) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1401) #### assertStringMatchesFormatFile() @@ -2149,7 +2149,7 @@ Asserts that a string matches a given format string. Asserts that a string matches a given format file. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1409) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1409) #### assertStringNotContainsString() @@ -2161,7 +2161,7 @@ Asserts that a string matches a given format file. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1414) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1414) #### assertStringNotContainsStringIgnoringCase() @@ -2173,7 +2173,7 @@ Asserts that a string matches a given format file. * `param string` $message * `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1419) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1419) #### assertStringNotEqualsFile() @@ -2187,7 +2187,7 @@ Asserts that a string matches a given format file. Asserts that the contents of a string is not equal to the contents of a file. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1427) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1427) #### assertStringNotEqualsFileCanonicalizing() @@ -2201,7 +2201,7 @@ Asserts that the contents of a string is not equal to the contents of a file. Asserts that the contents of a string is not equal to the contents of a file (canonicalizing). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1435) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1435) #### assertStringNotEqualsFileIgnoringCase() @@ -2215,7 +2215,7 @@ Asserts that the contents of a string is not equal to the contents of a file (ca Asserts that the contents of a string is not equal to the contents of a file (ignoring case). -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1443) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1443) #### assertStringNotMatchesFormat() @@ -2229,7 +2229,7 @@ Asserts that the contents of a string is not equal to the contents of a file (ig Asserts that a string does not match a given format string. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1451) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1451) #### assertStringNotMatchesFormatFile() @@ -2243,7 +2243,7 @@ Asserts that a string does not match a given format string. Asserts that a string does not match a given format string. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1461) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1461) #### assertStringStartsNotWith() @@ -2257,7 +2257,7 @@ Asserts that a string does not match a given format string. Asserts that a string starts not with a given prefix. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1476) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1476) #### assertStringStartsWith() @@ -2271,7 +2271,7 @@ Asserts that a string starts not with a given prefix. Asserts that a string starts with a given prefix. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1485) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1485) #### assertThat() @@ -2285,7 +2285,7 @@ Asserts that a string starts with a given prefix. Evaluates a PHPUnit\Framework\Constraint matcher object. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1495) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1495) #### assertThatItsNot() @@ -2299,7 +2299,7 @@ Evaluates a PHPUnit\Framework\Constraint matcher object. Evaluates a PHPUnit\Framework\Constraint matcher object. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L106) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L106) #### assertTrue() @@ -2313,7 +2313,7 @@ Evaluates a PHPUnit\Framework\Constraint matcher object. Asserts that a condition is true. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1507) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1507) #### assertXmlFileEqualsXmlFile() @@ -2327,7 +2327,7 @@ Asserts that a condition is true. Asserts that two XML files are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1515) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1515) #### assertXmlFileNotEqualsXmlFile() @@ -2341,7 +2341,7 @@ Asserts that two XML files are equal. Asserts that two XML files are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1523) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1523) #### assertXmlStringEqualsXmlFile() @@ -2355,7 +2355,7 @@ Asserts that two XML files are not equal. Asserts that two XML documents are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1531) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1531) #### assertXmlStringEqualsXmlString() @@ -2369,7 +2369,7 @@ Asserts that two XML documents are equal. Asserts that two XML documents are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1545) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1545) #### assertXmlStringNotEqualsXmlFile() @@ -2383,7 +2383,7 @@ Asserts that two XML documents are equal. Asserts that two XML documents are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1567) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1567) #### assertXmlStringNotEqualsXmlString() @@ -2397,7 +2397,7 @@ Asserts that two XML documents are not equal. Asserts that two XML documents are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1584) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1584) #### debug() @@ -2409,7 +2409,7 @@ Asserts that two XML documents are not equal. Print debug message to the screen. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L235) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L235) #### debugSection() @@ -2422,7 +2422,7 @@ Print debug message to the screen. Print debug message with a title -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L243) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L243) #### fail() @@ -2434,7 +2434,7 @@ Print debug message with a title Fails a test with the given message. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1604) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1604) #### getModule() @@ -2454,7 +2454,7 @@ $this->getModule('WebDriver')->_findElements('.items'); {% endhighlight %} -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L285) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L285) #### getModules() @@ -2465,7 +2465,7 @@ $this->getModule('WebDriver')->_findElements('.items'); Get all enabled modules -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L270) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L270) #### hasModule() @@ -2477,7 +2477,7 @@ Get all enabled modules Checks that module is enabled. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L262) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L262) #### hasStaticAttribute() @@ -2489,7 +2489,7 @@ Checks that module is enabled. * `param class-string` $className * `return bool` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1629) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1629) #### markTestIncomplete() @@ -2501,7 +2501,7 @@ Checks that module is enabled. Mark the test as incomplete. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1612) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1612) #### markTestSkipped() @@ -2513,7 +2513,7 @@ Mark the test as incomplete. Mark the test as skipped. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L1620) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1620) #### onReconfigure() @@ -2522,7 +2522,7 @@ Mark the test as skipped. HOOK to be executed when config changes with `_reconfigure`. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L113) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L113) #### scalarizeArray() @@ -2532,7 +2532,7 @@ HOOK to be executed when config changes with `_reconfigure`. * `param array` $array * `return array` -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L304) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L304) #### shortenMessage() @@ -2545,7 +2545,7 @@ HOOK to be executed when config changes with `_reconfigure`. Short text message to an amount of chars -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L254) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L254) #### validateConfig() @@ -2557,6 +2557,6 @@ Short text message to an amount of chars Validates current config for required fields and required packages. -[See source](https://github.com/Codeception/Codeception/blob/5.3/src/Codeception/Module.php#L131) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L131) -

 

Reference is taken from the source code. Help us to improve documentation. Edit module reference
+

 

Reference is taken from the source code. Help us to improve documentation. Edit module reference
diff --git a/for/laravel.md b/for/laravel.md index f96ef4651..3b55cbe70 100644 --- a/for/laravel.md +++ b/for/laravel.md @@ -47,7 +47,7 @@ cp .env .env.testing Functional tests allow test application by simulating user actions, this is done by sending requests to framework kernel and checking HTML as a result. Unilke internal tests of Laravel, Codeception doesn't limit you to testing only one request per test. You can **test complex interactions involving different actions and controllers**. This way you can easily cover your specifictions with functional tests. -To start you need to configure `tests/functional.suite.yml` to use Laravel module: +To start you need to configure `tests/Functional.suite.yml` to use Laravel module: ```yaml class_name: FunctionalTester @@ -77,10 +77,10 @@ php vendor/bin/codecept g:cest functional Login To generate a unit test run: ``` -php vendor/bin/codecept g:test unit "Foo\Bar" +php vendor/bin/codecept g:test Unit "Foo\Bar" ``` This generates `Codeception\Test\Unit` testcase which is inherited from PHPUnit but provides a module access. -Enable Laravel module in `unit.suite.yml` to have its methods inside a testcase. They are available injected into `$this->tester` property of a testcase. +Enable Laravel module in `Unit.suite.yml` to have its methods inside a testcase. They are available injected into `$this->tester` property of a testcase.
@@ -90,7 +90,7 @@ Enable Laravel module in `unit.suite.yml` to have its methods inside a testcase. ### Acceptance Tests -To test an application in a real environment by using its UI you should use a real browser. Codeception uses Selenium Webdriver and corresponding WebDriver module to interact with a browser. You should configure `acceptance.suite.yml` to use WebDriver module and a browser of your choice. +To test an application in a real environment by using its UI you should use a real browser. Codeception uses Selenium Webdriver and corresponding WebDriver module to interact with a browser. You should configure `Acceptance.suite.yml` to use WebDriver module and a browser of your choice. ```yaml class_name: AcceptanceTester @@ -157,13 +157,13 @@ Laravel module actions like `amOnPage` or `see` should not be available for test ### BDD -If you prefer to describe application with feature files, Codeception can turn them to acceptance or functional tests. It is recommended to store feature files in `features` directory (like it does Behat) but symlinking it to `tests/acceptance/features` or `tests/functional/features` so they can be treated as tests too. For using BDD with acceptance tests you need to run: +If you prefer to describe application with feature files, Codeception can turn them to acceptance or functional tests. It is recommended to store feature files in `features` directory (like it does Behat) but symlinking it to `tests/Acceptance/features` or `tests/Functional/features` so they can be treated as tests too. For using BDD with acceptance tests you need to run: ``` -ln -s $PWD/features tests/acceptance +ln -s $PWD/features tests/Acceptance ``` -Codeception allows to combine tests written in different formats. If are about to wirite a regression test it probably should not be described as a product's feature. That's why feature-files is subset of all acceptance tests, and they are stored in subfolder of `tests/acceptance`. +Codeception allows to combine tests written in different formats. If are about to wirite a regression test it probably should not be described as a product's feature. That's why feature-files is subset of all acceptance tests, and they are stored in subfolder of `tests/Acceptance`. There is no standard Gherkin steps built in. By writing your feature files you can get code snippets which should be added to `AcceptanceTester` class. diff --git a/for/phalcon.md b/for/phalcon.md index 875036c48..2be2084c4 100644 --- a/for/phalcon.md +++ b/for/phalcon.md @@ -36,7 +36,7 @@ This will create `tests` directory and configuration file `codeception.yml`. Thi ### Unit Testing -Add Phalcon to your unit test by adding the following to your `unit.suite.yml`: +Add Phalcon to your unit test by adding the following to your `Unit.suite.yml`: ```yaml # Codeception Test Suite Configuration # @@ -57,7 +57,7 @@ modules: To generate a plain PHPUnit test for class `Users`, run: ``` -vendor/bin/codecept g:test unit Users +vendor/bin/codecept g:test Unit Users ``` Actions of the Phalcon module will be accessible from `$this->tester` inside a test of `Codeception\Test\Unit`. @@ -95,7 +95,7 @@ modules: Then use [Cest](https://codeception.com/docs/07-AdvancedUsage) or Cept to create a test. ``` -vendor/bin/codecept g:cest functional Login +vendor/bin/codecept g:cest Functional Login ``` Then add your test case ```php @@ -138,7 +138,7 @@ class LoginCest ### Acceptance Testing -Sample configuration of `tests/acceptance.suite.yml`: +Sample configuration of `tests/Acceptance.suite.yml`: ```yaml class_name: AcceptanceTester @@ -155,10 +155,10 @@ Browser can be specified as `chrome`, `firefox`, `phantomjs`, or others. To create a sample test called, run: ``` -vendor/bin/codecept g:cest acceptance Login +vendor/bin/codecept g:cest Acceptance Login ``` -This will create the file `tests/acceptance/LoginCest.php`. Each method of a class (except `_before` and `_after`) is a test. Tests use `$I` object (instance of `AcceptanceTester` class) to perform actions on a webpage. Methods of `AcceptanceTester` are proxified to corresponding modules, which in current case is `WebDriver`. +This will create the file `tests/Acceptance/LoginCest.php`. Each method of a class (except `_before` and `_after`) is a test. Tests use `$I` object (instance of `AcceptanceTester` class) to perform actions on a webpage. Methods of `AcceptanceTester` are proxified to corresponding modules, which in current case is `WebDriver`.
@@ -168,7 +168,7 @@ This will create the file `tests/acceptance/LoginCest.php`. Each method of a cla To run the tests you will need chrome browser, [selenium server running](https://codeception.com/docs/modules/WebDriver#Selenium). If this requirements met acceptance tests can be executed as ``` -vendor/bin/codecept run acceptance +vendor/bin/codecept run Acceptance ``` ### BDD @@ -176,7 +176,7 @@ vendor/bin/codecept run acceptance If you prefer to describe application with feature files, Codeception can turn them to acceptance tests. It is recommended to store feature files in `features` directory (like Behat does it) but symlinking it to `tests/acceptance/features` so they can be treated as tests too. ``` -ln -s $PWD/features tests/acceptance +ln -s $PWD/features tests/Acceptance ``` Codeception allows to combine tests written in different formats. If you are about to write a regression test it probably should not be described as a product's feature. That's why feature-files are a subset of all acceptance tests, and they are stored in subfolder of `tests/acceptance`. diff --git a/for/yii.md b/for/yii.md index 293078b7f..592e369e2 100644 --- a/for/yii.md +++ b/for/yii.md @@ -35,7 +35,7 @@ Run them by executing in terminal: ### Unit Tests -Unit tests are located in `tests/unit` directory and are supposed to contain all kind of unit and integration testing. +Unit tests are located in `tests/Unit` directory and are supposed to contain all kind of unit and integration testing. Each test case extends `Codeception\Test\Unit` class, which is standard Codeception format for unit testing. It is pretty hard to develop completely isolated unit tests in Yii, so an application is bootstrapped before each test case. Tests are configured in `tests/unit.suite.yml` file with Yii2 module enabled: @@ -152,10 +152,10 @@ Yii2 module actions like `amOnPage` or `see` should not be available for testing From a test perspective acceptance tests do the same as functional tests. They test the user interaction with application but in this case using *real* browser and web server. They are much slower and much more fragile. They should not duplicate functional tests in matter of testing functionality but should be used for testing the UI of your application. If you are unsure which tests should be acceptance and which are functional, write acceptance tests for JavaScript-rich applications, where UI highly depends on a browser processing. You can also use acceptance tests for happy-path scenarios, just to ensure that a real user using a real browser achieve the same results you expect in functional tests. -By default in basic application acceptance tests are disabled (as they require web server, Selenium Server and browser to be running). You can easily enable them by renaming `acceptance.suite.yml.example` to `acceptance.suite.yml` +By default in basic application acceptance tests are disabled (as they require web server, Selenium Server and browser to be running). You can easily enable them by renaming `Acceptance.suite.yml.example` to `Acceptance.suite.yml` ``` -mv tests/acceptance.suite.yml.example tests/acceptance.suite.yml +mv tests/Acceptance.suite.yml.example tests/Acceptance.suite.yml ``` Basic template uses `codeception/base` package which doesn't contain `facebook/webdriver` library required to run acceptance tests. Please change `codeception/base` to `codeception/codeception` in `composer.json` and run the update command. @@ -169,7 +169,7 @@ Then you will need to launch application server in test mode: and start a [Selenium Server](https://codeception.com/docs/modules/WebDriver#Local-Testing). For acceptance WebDriver module is used. Please check its reference to learn how to work with it. Unlike Yii2 module it does know nothing about your application, so if you want to use features of Yii like fixtures for acceptance testing, you should check that enable Yii2 module is enabled as well: ```yml -# config at tests/acceptance.yml +# config at tests/Acceptance.yml modules: enabled: - WebDriver: @@ -186,7 +186,7 @@ As it was said, functional and acceptance tests are similar, so in order to avoi Similar as for functional tests it is recommended to use Cest format for acceptance testing: ``` -./vendor/bin/codecept g:cest acceptance MyNewScenarioCest +./vendor/bin/codecept g:cest Acceptance MyNewScenarioCest ```
@@ -222,10 +222,10 @@ Create basic test suites ./vendor/bin/codecept bootstrap ``` -Enable module Yii2 for functional tests inside `functional.suite.yml`: +Enable module Yii2 for functional tests inside `Functional.suite.yml`: ```yml -# functional.suite.yml +# Functional.suite.yml modules: enabled: - Yii2: