diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 0bc45d58c..fc8539063 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -33,7 +33,7 @@ jobs: env: COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: - php-version: 8.1 + php-version: 8.2 - name: Install dependencies run: composer install --prefer-dist --no-progress diff --git a/RoboFile.php b/RoboFile.php index 8382cd5c5..bca066714 100644 --- a/RoboFile.php +++ b/RoboFile.php @@ -10,8 +10,8 @@ class RoboFile extends \Robo\Tasks use DocumentationHelpers; const REPO_BLOB_URL = 'https://github.com/Codeception/Codeception/blob'; - const BRANCH_4x = '4.2'; - const BRANCH_5x = '5.1'; + const BRANCH_5x = '5.3'; + const BRANCH_MAIN = 'main'; function post() { @@ -263,7 +263,7 @@ public function buildDocsExtensions() ->prepend("# Official Extensions\n") ->processClassSignature(function (ReflectionClass $r, $text) { $name = $r->getShortName(); - return "## $name\n\n[See Source](" . self::REPO_BLOB_URL . "/" . self::BRANCH_5x . "/ext/$name.php)"; + return "## $name\n\n[See Source](" . self::REPO_BLOB_URL . "/" . self::BRANCH_MAIN . "/ext/$name.php)"; }) ->filterMethods(function (ReflectionMethod $r) { return false; @@ -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'; } @@ -412,102 +412,34 @@ private function postProcessFile($pageName, $documentationFile) file_put_contents($documentationFile, $contents); } - public function buildPhar80() + public function buildPhar82() { - $version = self::BRANCH_5x . '.' . date('Ymd'); - $releaseDir = "releases/$version"; - $this->stopOnFail(); - - $this->taskFilesystemStack()->mkdir('build/80')->run(); - $this->setCodeceptionVersionTo('^' . self::BRANCH_5x); - $this->setPlatformVersionTo('8.0.2'); - $buildFile = 'build/80/codecept.phar'; - $this->buildPhar($buildFile); - $this->updateVersionFile($buildFile, 'php80/codecept.version'); - $versionedFile = "$releaseDir/codecept.phar"; - $this->taskFilesystemStack() - ->stopOnFail() - ->mkdir($releaseDir) - ->copy($buildFile, $versionedFile) - ->remove('php80/codecept.phar') - ->symlink("../$versionedFile", 'php80/codecept.phar') - ->run(); - } + $ignoredPlatformReqs = array( + 'ext-apcu', + 'ext-mongodb', + 'ext-phalcon', + ); - public function buildPhar72() - { - $version = self::BRANCH_4x . '.' . date('Ymd'); + $version = self::BRANCH_5x . '.' . date('Ymd'); $releaseDir = "releases/$version"; $this->stopOnFail(); - - $this->taskFilesystemStack()->mkdir('build/72')->run(); - $this->setCodeceptionVersionTo('^4.1'); - $this->setPlatformVersionTo('7.2.0'); - $this->requireHoaConsole(); - $buildFile = 'build/72/codecept.phar'; + $this->taskFilesystemStack()->mkdir('build/82')->run(); + $this->setCodeceptionVersionTo('^' . self::BRANCH_5x, $ignoredPlatformReqs); + $this->setPlatformVersionTo('8.2.0', $ignoredPlatformReqs); + $buildFile = 'build/82/codecept.phar'; $this->buildPhar($buildFile); - $this->updateVersionFile($buildFile, 'codecept.version'); + $this->updateVersionFile($buildFile, 'php82/codecept.version'); $versionedFile = "$releaseDir/codecept.phar"; $this->taskFilesystemStack() ->stopOnFail() ->mkdir($releaseDir) ->copy($buildFile, $versionedFile) - ->remove('codecept.phar') - ->symlink($versionedFile, 'codecept.phar') + ->remove('php82/codecept.phar') + ->symlink("../$versionedFile", 'php82/codecept.phar') ->run(); } - public function buildPhar56() - { - $version = self::BRANCH_4x . '.' . date('Ymd'); - $releaseDir = "releases/$version"; - $this->stopOnFail(); - - $this->taskFilesystemStack()->mkdir('build/56')->run(); - $this->setCodeceptionVersionTo('^4.1'); - $this->setPlatformVersionTo('5.6.4'); - $this->requireHoaConsole(); - //filenames must be different, because Phar refuses to build second file with the same name - $buildFile = 'build/56/codecept.phar'; - $this->buildPhar($buildFile); - $this->updateVersionFile($buildFile, 'php56/codecept.version'); - $versionedFile = "$releaseDir/php56/codecept.phar"; - $this->taskFilesystemStack() - ->stopOnFail() - ->mkdir("$releaseDir/php56") - ->copy($buildFile, $versionedFile) - ->remove('php56/codecept.phar') - ->symlink("../$versionedFile", 'php56/codecept.phar') - ->run(); - } - - private function requireHoaConsole(): void - { - $this->taskComposerRequire() - ->dependency('hoa/console') - ->workingDir('package') - ->run(); - } - - public function release() - { - $version = self::BRANCH_4x . '.' . date('Ymd'); - $releaseDir = "releases/$version"; - $this->updateBuildsPage(); - - $this->taskGitStack() - ->stopOnFail() - ->checkout('-- package/composer.json') - ->add('builds.markdown') - ->add('codecept.phar') - ->add('codecept.version') - ->add('php56/codecept.phar') - ->add('php56/codecept.version') - ->add($releaseDir) - ->run(); - } - - public function release80() + public function release82() { $version = self::BRANCH_5x . '.' . date('Ymd'); $releaseDir = "releases/$version"; @@ -517,23 +449,30 @@ public function release80() ->stopOnFail() ->checkout('-- package/composer.json') ->add('builds.markdown') - ->add('php80/codecept.phar') - ->add('php80/codecept.version') + ->add('php82/codecept.phar') + ->add('php82/codecept.version') ->add($releaseDir) ->run(); } - private function setPlatformVersionTo($version) + private function setPlatformVersionTo($version, $ignoredPlatformReqs = array()) { $this->taskComposerConfig()->workingDir('package')->set('platform.php', $version)->run(); - $this->taskComposerUpdate()->preferDist()->optimizeAutoloader()->workingDir('package')->run(); + $composerUpdate = $this->taskComposerUpdate(); + foreach ($ignoredPlatformReqs as $ignoredPlatformReq) { + $composerUpdate->option('--ignore-platform-req', $ignoredPlatformReq); + } + $composerUpdate->preferDist()->optimizeAutoloader()->workingDir('package')->run(); } - private function setCodeceptionVersionTo($version) + private function setCodeceptionVersionTo($version, $ignoredPlatformReqs = array()) { - $this->taskComposerRequire() - ->dependency('codeception/codeception', $version) - ->workingDir('package') + $composerRequire = $this->taskComposerRequire() + ->dependency('codeception/codeception', $version); + foreach ($ignoredPlatformReqs as $ignoredPlatformReq) { + $composerRequire->option('--ignore-platform-req', $ignoredPlatformReq); + } + $composerRequire->workingDir('package') ->run(); } @@ -638,7 +577,7 @@ public function processChangelog() $repo = $release['repo'] ?? 'Codeception'; $changelog .= sprintf("\n\n### %s %s: %s\n\n", $repo, $release['tag_name'], $release['name']); - $changelog .= sprintf("Released by [![](%s) %s](%s) on %s", + $changelog .= sprintf('Released by [![](%s){:height="16" width="16"} %s](%s) on %s', $release['author']['avatar_url'] . '&s=16', $release['author']['login'], $release['author']['html_url'], @@ -695,8 +634,10 @@ public function updateBuildsPage() $releaseFile->line("*Requires: PHP 5.4 and higher + CURL*\n"); } elseif ($major < 5) { $releaseFile->line("*Requires: PHP 5.6 and higher + CURL*\n"); - } else { + } elseif ($minor < 3) { $releaseFile->line("*Requires: PHP 8.0 and higher + CURL*\n"); + } else { + $releaseFile->line("*Requires: PHP 8.2 and higher + CURL*\n"); } $releaseFile->line("* **[Download Latest $branch Release]($downloadUrl)**"); } diff --git a/_data/modules.yml b/_data/modules.yml index 6b8b770e3..d36e1192f 100644 --- a/_data/modules.yml +++ b/_data/modules.yml @@ -15,6 +15,10 @@ link: https://github.com/walterwhites/Appium-codeception-module description: Easy Appium integration, iOS Automation +- name: Axeception + link: https://github.com/flowdgmbh/codeception-axeception + description: Run axe-core acceptance tests in codeception + - name: BrowserMob link: https://github.com/edno/codeception-browsermob description: Codeception module for BrowserMob Proxy. @@ -87,10 +91,14 @@ description: Codeception module to test email using MailCare.io (Free, Open Source or paid services). color: "#e65722" +- name: Mailpit + image: ../images/mailpit.svg + link: https://github.com/koehnlein/codeception-email-mailpit + description: Mailpit is a standalone local SMTP server to test email deliveries. The Codeception module provides assertions such as `$I->haveUnreadEmails();` or `$I->seeInOpenedEmailHtmlBody()`. + - name: MailCatcher link: https://github.com/captbaritone/codeception-mailcatcher-module description: MailCatcher is a standalone software which can be configured to catch *any* email sent by your development server, and display it on a webpage. The MailCatcher Module allows you to test the contents of those emails in an acceptance test. - color: "#FFF5C4" - name: MailSMTP link: https://github.com/AhmedSamy/codeception-smtp-mail @@ -161,3 +169,7 @@ - name: Yandex link: https://github.com/portrino/codeception-yandex-module description: Validation of structured data via yandex API. + +- name: Grpc + link: https://github.com/MercerMorning/codeception-grpc-module + description: Validation of grpc server. diff --git a/_includes/extensions.md b/_includes/extensions.md index 742c0b9a2..0552d693e 100644 --- a/_includes/extensions.md +++ b/_includes/extensions.md @@ -2,10 +2,10 @@ ## DotReporter -[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/DotReporter.php) +[See Source](https://github.com/Codeception/Codeception/blob/main/ext/DotReporter.php) DotReporter provides less verbose output for test execution. -Like PHPUnit printer it prints dots "." for successful testes and "F" for failures. +Like PHPUnit printer it prints dots "." for successful tests and "F" for failures. ![](https://cloud.githubusercontent.com/assets/220264/26132800/4d23f336-3aab-11e7-81ba-2896a4c623d2.png) @@ -38,7 +38,7 @@ Use this extension as an example for building custom reporters. ## Logger -[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/Logger.php) +[See Source](https://github.com/Codeception/Codeception/blob/main/ext/Logger.php) Log suites/tests/steps using Monolog library. Monolog should be installed additionally by Composer. @@ -66,16 +66,16 @@ extensions: ## Recorder -[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/Recorder.php) +[See Source](https://github.com/Codeception/Codeception/blob/main/ext/Recorder.php) -Saves a screenshot of each step in acceptance tests and shows them as a slideshow on one HTML page (here's an [example](https://codeception.com/images/recorder.gif)) -Activated only for suites with WebDriver module enabled. +Saves a screenshot of each step in acceptance tests and shows them as a slideshow on one HTML page (here's an [example](https://codeception.com/images/recorder.gif)). +Works only for suites with WebDriver module enabled. The screenshots are saved to `tests/_output/record_*` directories, open `index.html` to see them as a slideshow. #### Installation -Add this to the list of enabled extensions in `codeception.yml` or `acceptance.suite.yml`: +Add this to the list of enabled extensions in `codeception.yml` or `Acceptance.suite.yml`: ``` yaml extensions: @@ -106,7 +106,7 @@ extensions: ``` #### Skipping recording of steps with annotations -It is also possible to skip recording of steps for specified tests by using the @skipRecording annotation. +It is also possible to skip recording of steps for specified tests by using the `@skipRecording` annotation. ```php /** @@ -122,10 +122,9 @@ public function testLogin(AcceptanceTester $I) - ## RunBefore -[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/RunBefore.php) +[See Source](https://github.com/Codeception/Codeception/blob/main/ext/RunBefore.php) Extension for execution of some processes before running tests. @@ -156,9 +155,9 @@ HINT: you can use different configurations per environment. ## RunFailed -[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/RunFailed.php) +[See Source](https://github.com/Codeception/Codeception/blob/main/ext/RunFailed.php) -Saves failed tests into tests/_output/failed in order to rerun failed tests. +Saves failed tests into `tests/_output/failed` in order to rerun failed tests. To rerun failed tests just run the `failed` group: @@ -170,9 +169,9 @@ To change failed group name add: ``` --override "extensions: config: Codeception\Extension\RunFailed: fail-group: another_group1" ``` -Remember: if you run tests and they generated custom-named fail group, to run this group, you should add override too +Remember: If you run tests and they generated custom-named fail group, to run this group, you should add override too -Starting from Codeception 2.1 **this extension is enabled by default**. +**This extension is enabled by default.** ``` yaml extensions: @@ -185,15 +184,16 @@ On each execution failed tests are logged and saved into `tests/_output/failed` ## RunProcess -[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/RunProcess.php) +[See Source](https://github.com/Codeception/Codeception/blob/main/ext/RunProcess.php) Extension to start and stop processes per suite. -Can be used to start/stop selenium server, chromedriver, mailcatcher, etc. +Can be used to start/stop selenium server, chromedriver, etc. +Each command is executed only once, at the beginning of the test suite. To execute a command before each test, see [Before/After Attributes](https://codeception.com/docs/AdvancedUsage#BeforeAfter-Attributes). -Can be configured in suite config: +Can be enabled in suite config: ```yaml -# acceptance.suite.yml +# Acceptance.suite.yml extensions: enabled: - Codeception\Extension\RunProcess: @@ -203,8 +203,7 @@ extensions: Multiple parameters can be passed as array: ```yaml -# acceptance.suite.yml - +# Acceptance.suite.yml extensions: enabled: - Codeception\Extension\RunProcess: @@ -214,28 +213,33 @@ extensions: In the end of a suite all launched processes will be stopped. -To wait for the process to be launched use `sleep` option. -In this case you need configuration to be specified as object: +To wait for the process to be launched use the `sleep` option. In this case you need configuration to be specified as object: ```yaml extensions: enabled: - Codeception\Extension\RunProcess: - 0: java -jar ~/selenium-server.jar - 1: mailcatcher - sleep: 5 # wait 5 seconds for processes to boot + 0: php -S 127.0.0.1:8000 -t tests/data/app + 1: java -jar ~/selenium-server.jar + sleep: 5 # wait 5 seconds for the processes to boot ``` -HINT: you can use different configurations per environment. +HINT: You can use different configurations per environment. ## SimpleReporter -[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/SimpleReporter.php) +[See Source](https://github.com/Codeception/Codeception/blob/main/ext/SimpleReporter.php) This extension demonstrates how you can implement console output of your own. Recommended to be used for development purposes only. +## SuiteInitSubscriberTrait + +[See Source](https://github.com/Codeception/Codeception/blob/main/ext/SuiteInitSubscriberTrait.php) + + + diff --git a/_layouts/bootstrap.html b/_layouts/bootstrap.html index 4b62edd6b..299f8ffea 100644 --- a/_layouts/bootstrap.html +++ b/_layouts/bootstrap.html @@ -90,7 +90,7 @@

  • Guides

    • {{ guides }} -
  • Video
    • +
  • Videos
    • @@ -122,10 +122,6 @@

    Modules

    Blog
  • - - Frameworks - -
    • diff --git a/docs/AcceptanceTests.md b/docs/AcceptanceTests.md index 67cc3f682..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,10 +68,10 @@ 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. +It will be placed into `tests/Acceptance` directory. ```php class SigninCest @@ -209,7 +209,7 @@ If you need to fill in sensitive data (like passwords) and hide it in logs, you can pass instance `\Codeception\Step\Argument\PasswordArgument` with the data which needs to be hidden. ```php -use \Codeception\Step\Argument\PasswordArgument; +use Codeception\Step\Argument\PasswordArgument; $I->amOnPage('/form/password_argument'); $I->fillField('password', new PasswordArgument('thisissecret')); @@ -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 13bcc1265..16d44070d 100644 --- a/docs/AdvancedUsage.md +++ b/docs/AdvancedUsage.md @@ -54,7 +54,7 @@ As you see, we are passing the Actor object into `tryToTest` method. This allows sendGet($example['url']); + $I->seeResponseCodeIs($example['expectedReponseCode']); + } +} + +``` + ## Example Annotation As well as the `\Codeception\Attribute\Examples` attribute, available for Cest tests, the `@example` attribute allows you to @@ -291,8 +317,8 @@ You can also use the `@dataProvider` annotation for creating dynamic examples fo amOnPage('/login'); $I->fillField('Username', 'miles'); @@ -341,21 +366,26 @@ class ModeratorCest { } #[Before('login')] - public function banUser(AcceptanceTester $I) + public function banUser(FunctionalTester $I): void { $I->amOnPage('/users/charlie-parker'); $I->see('Ban', '.button'); $I->click('Ban'); } - // you can specify multiple before and after methods: + // Multiple `#[Before]` or `#[After]` attributes are invoked in order from top to bottom: + #[Before('login')] + #[Before('cleanup')] + public function addUser(FunctionalTester $I): void + { + // ... + } + + // But you can also pass multiple methods in each attribute: #[Before('login', 'cleanup')] - #[After('logout', 'close')] - public function addUser(AcceptanceTester $I) + public function addUser(FunctionalTester $I): void { - $I->amOnPage('/users/charlie-parker'); - $I->see('Ban', '.button'); - $I->click('Ban'); + // ... } } ``` @@ -372,8 +402,8 @@ namespace Tests\Acceptance; use Codeception\Attribute\Depends; -class ModeratorCest { - +class ModeratorCest +{ public function login(AcceptanceTester $I) { // logs moderator in @@ -399,7 +429,6 @@ Signature: ModeratorCest:login` Codeception reorders tests so dependent tests will always be executed before the tests that rely on them. - ## Environments For cases where you need to run tests with different configurations, you can define different config environments. diff --git a/docs/BDD.md b/docs/BDD.md index 94b2fd182..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. @@ -403,7 +403,7 @@ Inside a step definition data is stored in argument passed as `\Behat\Gherkin\No public function iHaveProductsInCart(\Behat\Gherkin\Node\TableNode $products) { // iterate over all rows - foreach ($node->getRows() as $index => $row) { + foreach ($products->getRows() as $index => $row) { if ($index === 0) { // first row to define fields $keys = $row; continue; @@ -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 a7c781502..c8c893d7d 100644 --- a/docs/ContinuousIntegration.md +++ b/docs/ContinuousIntegration.md @@ -89,39 +89,36 @@ Jenkins should locate `report.html` at `tests/_output/`. Now Jenkins will displa GitHub Actions CI can be used to launch tests. Install PHP and Composer and execute tests: ```yaml -on: - pull_request: - branches-ignore: gh-pages - push: - branches-ignore: gh-pages - name: Codeception Tests - +on: + pull_request: + branches-ignore: gh-pages + push: + branches-ignore: gh-pages + jobs: - build: - runs-on: ubuntu-latest - - steps: - - name: Checkout - uses: actions/checkout@v2 - - - name: Install PHP - uses: shivammathur/setup-php@v2 - with: - php-version: ${{ matrix.php }} - extensions: curl, mbstring, openssl, pdo, pdo_sqlite - ini-values: memory_limit=-1, date.timezone='UTC' - coverage: xdebug - tools: composer:v2 - - - name: Validate composer.json and composer.lock - run: composer validate - - - name: Install dependencies - run: composer install --prefer-dist --no-progress --no-interaction --no-suggest - - - name: Run tests - run: php vendor/bin/codecept run + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Install PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + extensions: curl, mbstring, openssl, pdo, pdo_sqlite + ini-values: memory_limit=-1, date.timezone='UTC' + coverage: xdebug + tools: composer:v2 + + - name: Validate composer.json and composer.lock + run: composer validate + + - name: Install dependencies + run: composer install --prefer-dist --no-progress --no-interaction --no-suggest + + - name: Run tests + run: php vendor/bin/codecept run ``` ## GitLab CI @@ -181,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 5a4632135..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. @@ -147,7 +147,7 @@ The extension class itself is inherited from `Codeception\Extension`: ```php Improve this guide diff --git a/docs/FunctionalTests.md b/docs/FunctionalTests.md index 8708a8e85..f1e065637 100644 --- a/docs/FunctionalTests.md +++ b/docs/FunctionalTests.md @@ -25,7 +25,7 @@ This is a sample functional test: namespace Tests\Functional; -use \Tests\Support\FunctionalTester; +use Tests\Support\FunctionalTester; class LoginCest { diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index a468f6bed..c5cf46406 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -119,25 +119,6 @@ final class SigninCest } ``` -This scenario can probably be read by everybody, even non-developers. If you just remove all special characters, -this test transforms into plain english text: - -```yaml -I amOnPage '/login' -I fillField 'Username', 'davert' -I fillField 'Password', 'qwerty' -I click 'Login' -I see 'Hello, davert' -``` - -Codeception generates this text representation from PHP code by executing: - -```bash -php vendor/bin/codecept generate:scenarios Acceptance -``` - -These generated scenarios will be stored in your `tests/Support/Data/scenarios/Functional` directory in `*.txt` files. - Before we execute this test, we should make sure that the website is running on a local web server. Let's open the `tests/Acceptance.suite.yml` file and fill in the URL of your web application: @@ -302,7 +283,6 @@ There are plenty of useful Codeception commands: * `generate:test` *suite* *filename* - Generates a sample PHPUnit Test with Codeception hooks * `generate:feature` *suite* *filename* - Generates Gherkin feature file * `generate:suite` *suite* *actor* - Generates a new suite with the given Actor class name -* `generate:scenarios` *suite* - Generates text files containing scenarios from tests * `generate:helper` *filename* - Generates a sample Helper File * `generate:pageobject` *suite* *filename* - Generates a sample Page object * `generate:stepobject` *suite* *filename* - Generates a sample Step object 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 18ef9559a..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 @@ -167,8 +167,8 @@ In the case of a PageObject you should declare a class as a parameter for a test namespace Tests\Acceptance; -use \Tests\Support\AcceptanceTester; -use \Tests\Support\Page\Acceptance\Login; +use Tests\Support\AcceptanceTester; +use Tests\Support\Page\Acceptance\Login; class UserCest { @@ -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 d4d088212..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: @@ -40,7 +40,7 @@ A test created by the `generate:test` command will look like this: namespace Tests\Unit; -use \Tests\Support\UnitTester; +use Tests\Support\UnitTester; class ExampleTest extends \Codeception\Test\Unit { @@ -76,7 +76,7 @@ A typical unit test may look like this: namespace Tests\Unit; -use \Tests\Support\UnitTester; +use Tests\Support\UnitTester; class UserTest extends \Codeception\Test\Unit { @@ -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) @@ -355,8 +355,8 @@ $em = $this->getModule('Doctrine')->em; If you use the `Symfony` module, here is how you can access the Symfony container: ```php -/** @var Symfony\Component\DependencyInjection\Container */ -$container = $this->getModule('Symfony')->container; +/** @var Symfony\Component\DependencyInjection\ContainerInterface */ +$container = $this->getModule('Symfony')->_getContainer(); ``` The same can be done for all public properties of an enabled module. Accessible properties are listed in the module reference. @@ -403,7 +403,7 @@ For this case we have a stand-alone project [Specify](https://github.com/Codecep namespace Tests\Unit; -use \Tests\Support\UnitTester; +use Tests\Support\UnitTester; class UserTest extends \Codeception\Test\Unit { diff --git a/docs/modules/AMQP.md b/docs/modules/AMQP.md index 887e83965..c53997267 100644 --- a/docs/modules/AMQP.md +++ b/docs/modules/AMQP.md @@ -35,6 +35,7 @@ To use this module with Composer you need "php-amqplib/php-amqplib": "~2.4"< * cleanup: true - defined queues will be purged before running every test. * queues: [mail, twitter] - queues to cleanup * single_channel - create and use only one channel during test execution +* reconnect - reconnects before each test to drop unused open channels #### Example @@ -48,6 +49,7 @@ To use this module with Composer you need "php-amqplib/php-amqplib": "~2.4"< vhost: '/' queues: [queue1, queue2] single_channel: false + reconnect: false ### Public Properties diff --git a/docs/modules/Asserts.md b/docs/modules/Asserts.md index 792c7a220..125aa4c4b 100644 --- a/docs/modules/Asserts.md +++ b/docs/modules/Asserts.md @@ -25,18 +25,20 @@ Special module for using asserts in your tests. #### assertArrayHasKey -* `param int|string` $key -* `param array|\ArrayAccess` $array +* `param string|int` $key +* `param \ArrayAccess|array` $array * `param string` $message +* `return void` Asserts that an array has a specified key. #### assertArrayNotHasKey -* `param int|string` $key -* `param array|\ArrayAccess` $array +* `param string|int` $key +* `param \ArrayAccess|array` $array * `param string` $message +* `return void` Asserts that an array does not have a specified key. @@ -44,8 +46,9 @@ Asserts that an array does not have a specified key. #### assertClassHasAttribute * `param string` $attributeName -* `param string` $className +* `param class-string` $className * `param string` $message +* `return void` Asserts that a class has a specified attribute. @@ -53,8 +56,9 @@ Asserts that a class has a specified attribute. #### assertClassHasStaticAttribute * `param string` $attributeName -* `param string` $className +* `param class-string` $className * `param string` $message +* `return void` Asserts that a class has a specified static attribute. @@ -62,8 +66,9 @@ Asserts that a class has a specified static attribute. #### assertClassNotHasAttribute * `param string` $attributeName -* `param string` $className +* `param class-string` $className * `param string` $message +* `return void` Asserts that a class does not have a specified attribute. @@ -71,8 +76,9 @@ Asserts that a class does not have a specified attribute. #### assertClassNotHasStaticAttribute * `param string` $attributeName -* `param string` $className +* `param class-string` $className * `param string` $message +* `return void` Asserts that a class does not have a specified static attribute. @@ -80,8 +86,9 @@ Asserts that a class does not have a specified static attribute. #### assertContains * `param mixed` $needle -* `param iterable` $haystack +* `param iterable` $haystack * `param string` $message +* `return void` Asserts that a haystack contains a needle. @@ -89,34 +96,228 @@ Asserts that a haystack contains a needle. #### assertContainsEquals * `param mixed` $needle -* `param iterable` $haystack +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyArray + +* `param iterable` $haystack * `param string` $message +* `return void` + + +#### assertContainsNotOnlyBool + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyCallable + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyClosedResource + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyFloat + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyInstancesOf + +* `param class-string` $className +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyInt + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyIterable + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyNull + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyNumeric + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyObject + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyResource + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyScalar + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsNotOnlyString + +* `param iterable` $haystack +* `param string` $message +* `return void` #### assertContainsOnly * `param string` $type -* `param iterable` $haystack +* `param iterable` $haystack * `param ?bool` $isNativeType * `param string` $message +* `return void` Asserts that a haystack contains only values of a given type. +#### assertContainsOnlyArray + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsOnlyBool + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsOnlyCallable + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsOnlyClosedResource + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsOnlyFloat + +* `param iterable` $haystack +* `param string` $message +* `return void` + + #### assertContainsOnlyInstancesOf -* `param string` $className -* `param iterable` $haystack +* `param class-string` $className +* `param iterable` $haystack * `param string` $message +* `return void` Asserts that a haystack contains only instances of a given class name. +#### assertContainsOnlyInt + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsOnlyIterable + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsOnlyNull + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsOnlyNumeric + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsOnlyObject + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsOnlyResource + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsOnlyScalar + +* `param iterable` $haystack +* `param string` $message +* `return void` + + +#### assertContainsOnlyString + +* `param iterable` $haystack +* `param string` $message +* `return void` + + #### assertCount * `param int` $expectedCount -* `param \Countable|iterable` $haystack +* `param \Countable|iterable` $haystack * `param string` $message +* `return void` Asserts the number of elements of an array, Countable or Traversable. @@ -125,6 +326,7 @@ Asserts the number of elements of an array, Countable or Traversable. * `param string` $directory * `param string` $message +* `return void` Asserts that a directory does not exist. @@ -133,6 +335,7 @@ Asserts that a directory does not exist. * `param string` $directory * `param string` $message +* `return void` Asserts that a directory exists. @@ -141,6 +344,7 @@ Asserts that a directory exists. * `param string` $directory * `param string` $message +* `return void` Asserts that a directory exists and is not readable. @@ -149,6 +353,7 @@ Asserts that a directory exists and is not readable. * `param string` $directory * `param string` $message +* `return void` Asserts that a directory exists and is not writable. @@ -157,6 +362,7 @@ Asserts that a directory exists and is not writable. * `param string` $directory * `param string` $message +* `return void` Asserts that a directory exists and is readable. @@ -165,6 +371,7 @@ Asserts that a directory exists and is readable. * `param string` $directory * `param string` $message +* `return void` Asserts that a directory exists and is writable. @@ -174,14 +381,17 @@ Asserts that a directory exists and is writable. * `param string` $pattern * `param string` $string * `param string` $message +* `return void` Asserts that a string does not match a given regular expression. #### assertEmpty +* `phpstan-assert` empty $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is empty. @@ -191,6 +401,7 @@ Asserts that a variable is empty. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables are equal. @@ -200,6 +411,7 @@ Asserts that two variables are equal. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables are equal (canonicalizing). @@ -209,6 +421,7 @@ Asserts that two variables are equal (canonicalizing). * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables are equal (ignoring case). @@ -219,14 +432,17 @@ Asserts that two variables are equal (ignoring case). * `param mixed` $actual * `param float` $delta * `param string` $message +* `return void` Asserts that two variables are equal (with delta). #### assertFalse +* `phpstan-assert` false $condition * `param mixed` $condition * `param string` $message +* `return void` Asserts that a condition is false. @@ -235,6 +451,7 @@ Asserts that a condition is false. * `param string` $filename * `param string` $message +* `return void` Asserts that a file does not exist. @@ -244,6 +461,7 @@ Asserts that a file does not exist. * `param string` $expected * `param string` $actual * `param string` $message +* `return void` Asserts that the contents of one file is equal to the contents of another file. @@ -253,6 +471,7 @@ Asserts that the contents of one file is equal to the contents of another file. * `param string` $expected * `param string` $actual * `param string` $message +* `return void` Asserts that the contents of one file is equal to the contents of another file (canonicalizing). @@ -262,6 +481,7 @@ Asserts that the contents of one file is equal to the contents of another file ( * `param string` $expected * `param string` $actual * `param string` $message +* `return void` Asserts that the contents of one file is equal to the contents of another file (ignoring case). @@ -270,6 +490,7 @@ Asserts that the contents of one file is equal to the contents of another file ( * `param string` $filename * `param string` $message +* `return void` Asserts that a file exists. @@ -278,6 +499,7 @@ Asserts that a file exists. * `param string` $file * `param string` $message +* `return void` Asserts that a file exists and is not readable. @@ -286,6 +508,7 @@ Asserts that a file exists and is not readable. * `param string` $file * `param string` $message +* `return void` Asserts that a file exists and is not writable. @@ -294,6 +517,7 @@ Asserts that a file exists and is not writable. * `param string` $file * `param string` $message +* `return void` Asserts that a file exists and is readable. @@ -302,6 +526,7 @@ Asserts that a file exists and is readable. * `param string` $file * `param string` $message +* `return void` Asserts that a file exists and is writable. @@ -311,6 +536,7 @@ Asserts that a file exists and is writable. * `param string` $expected * `param string` $actual * `param string` $message +* `return void` Asserts that the contents of one file is not equal to the contents of another file. @@ -320,6 +546,7 @@ Asserts that the contents of one file is not equal to the contents of another fi * `param string` $expected * `param string` $actual * `param string` $message +* `return void` Asserts that the contents of one file is not equal to the contents of another file (canonicalizing). @@ -329,6 +556,7 @@ Asserts that the contents of one file is not equal to the contents of another fi * `param string` $expected * `param string` $actual * `param string` $message +* `return void` Asserts that the contents of one file is not equal to the contents of another file (ignoring case). @@ -337,6 +565,7 @@ Asserts that the contents of one file is not equal to the contents of another fi * `param string` $filename * `param string` $message +* `return void` Asserts that a file does not exist. @@ -345,6 +574,7 @@ Asserts that a file does not exist. * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is finite. @@ -354,6 +584,7 @@ Asserts that a variable is finite. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a value is greater than or equal to another value. @@ -363,6 +594,7 @@ Asserts that a value is greater than or equal to another value. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a value is greater than another value. @@ -372,6 +604,7 @@ Asserts that a value is greater than another value. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a value is greater than or equal to another value. @@ -380,47 +613,59 @@ Asserts that a value is greater than or equal to another value. * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is infinite. #### assertInstanceOf -* `param string` $expected +* `template` ExpectedType of object +* `phpstan-assert` =ExpectedType $actual +* `param class-string` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of a given type. #### assertIsArray +* `phpstan-assert` array $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type array. #### assertIsBool +* `phpstan-assert` bool $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type bool. #### assertIsCallable +* `phpstan-assert` callable $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type callable. #### assertIsClosedResource +* `phpstan-assert` resource $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type resource and is closed. @@ -429,102 +674,127 @@ Asserts that a variable is of type resource and is closed. * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is empty. #### assertIsFloat +* `phpstan-assert` float $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type float. #### assertIsInt +* `phpstan-assert` int $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type int. #### assertIsIterable +* `phpstan-assert` iterable $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type iterable. #### assertIsNotArray +* `phpstan-assert` !array $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type array. #### assertIsNotBool +* `phpstan-assert` !bool $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type bool. #### assertIsNotCallable +* `phpstan-assert` !callable $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type callable. #### assertIsNotClosedResource +* `phpstan-assert` !resource $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type resource. #### assertIsNotFloat +* `phpstan-assert` !float $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type float. #### assertIsNotInt +* `phpstan-assert` !int $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type int. #### assertIsNotIterable +* `phpstan-assert` !iterable $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type iterable. #### assertIsNotNumeric +* `phpstan-assert` !numeric $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type numeric. #### assertIsNotObject +* `phpstan-assert` !object $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type object. @@ -533,30 +803,37 @@ Asserts that a variable is not of type object. * `param string` $filename * `param string` $message +* `return void` Asserts that a file/dir exists and is not readable. #### assertIsNotResource +* `phpstan-assert` !resource $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type resource. #### assertIsNotScalar +* `psalm-assert` !scalar $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type scalar. #### assertIsNotString +* `phpstan-assert` !string $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type string. @@ -565,22 +842,27 @@ Asserts that a variable is not of type string. * `param string` $filename * `param string` $message +* `return void` Asserts that a file/dir exists and is not writable. #### assertIsNumeric +* `phpstan-assert` numeric $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type numeric. #### assertIsObject +* `phpstan-assert` object $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type object. @@ -589,30 +871,37 @@ Asserts that a variable is of type object. * `param string` $filename * `param string` $message +* `return void` Asserts that a file/dir is readable. #### assertIsResource +* `phpstan-assert` resource $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type resource. #### assertIsScalar +* `phpstan-assert` scalar $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type scalar. #### assertIsString +* `phpstan-assert` string $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type string. @@ -621,6 +910,7 @@ Asserts that a variable is of type string. * `param string` $filename * `param string` $message +* `return void` Asserts that a file/dir exists and is writable. @@ -629,6 +919,7 @@ Asserts that a file/dir exists and is writable. * `param string` $actualJson * `param string` $message +* `return void` Asserts that a string is a valid JSON string. @@ -638,6 +929,7 @@ Asserts that a string is a valid JSON string. * `param string` $expectedFile * `param string` $actualFile * `param string` $message +* `return void` Asserts that two JSON files are equal. @@ -647,6 +939,7 @@ Asserts that two JSON files are equal. * `param string` $expectedFile * `param string` $actualFile * `param string` $message +* `return void` Asserts that two JSON files are not equal. @@ -656,6 +949,7 @@ Asserts that two JSON files are not equal. * `param string` $expectedFile * `param string` $actualJson * `param string` $message +* `return void` Asserts that the generated JSON encoded object and the content of the given file are equal. @@ -665,6 +959,7 @@ Asserts that the generated JSON encoded object and the content of the given file * `param string` $expectedJson * `param string` $actualJson * `param string` $message +* `return void` Asserts that two given JSON encoded objects or arrays are equal. @@ -674,6 +969,7 @@ Asserts that two given JSON encoded objects or arrays are equal. * `param string` $expectedFile * `param string` $actualJson * `param string` $message +* `return void` Asserts that the generated JSON encoded object and the content of the given file are not equal. @@ -683,6 +979,7 @@ Asserts that the generated JSON encoded object and the content of the given file * `param string` $expectedJson * `param string` $actualJson * `param string` $message +* `return void` Asserts that two given JSON encoded objects or arrays are not equal. @@ -692,6 +989,7 @@ Asserts that two given JSON encoded objects or arrays are not equal. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a value is smaller than or equal to another value. @@ -701,6 +999,7 @@ Asserts that a value is smaller than or equal to another value. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a value is smaller than another value. @@ -710,6 +1009,7 @@ Asserts that a value is smaller than another value. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a value is smaller than or equal to another value. @@ -719,6 +1019,7 @@ Asserts that a value is smaller than or equal to another value. * `param string` $pattern * `param string` $string * `param string` $message +* `return void` Asserts that a string matches a given regular expression. @@ -727,6 +1028,7 @@ Asserts that a string matches a given regular expression. * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is nan. @@ -734,25 +1036,28 @@ Asserts that a variable is nan. #### assertNotContains * `param mixed` $needle -* `param iterable` $haystack +* `param iterable` $haystack * `param string` $message +* `return void` Asserts that a haystack does not contain a needle. #### assertNotContainsEquals -* `param ` $needle -* `param iterable` $haystack +* `param mixed` $needle +* `param iterable` $haystack * `param string` $message +* `return void` #### assertNotContainsOnly * `param string` $type -* `param iterable` $haystack +* `param iterable` $haystack * `param ?bool` $isNativeType * `param string` $message +* `return void` Asserts that a haystack does not contain only values of a given type. @@ -760,16 +1065,19 @@ Asserts that a haystack does not contain only values of a given type. #### assertNotCount * `param int` $expectedCount -* `param \Countable|iterable` $haystack +* `param \Countable|iterable` $haystack * `param string` $message +* `return void` Asserts the number of elements of an array, Countable or Traversable. #### assertNotEmpty +* `phpstan-assert` !empty $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not empty. @@ -779,6 +1087,7 @@ Asserts that a variable is not empty. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables are not equal. @@ -788,6 +1097,7 @@ Asserts that two variables are not equal. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables are not equal (canonicalizing). @@ -797,6 +1107,7 @@ Asserts that two variables are not equal (canonicalizing). * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables are not equal (ignoring case). @@ -807,31 +1118,39 @@ Asserts that two variables are not equal (ignoring case). * `param mixed` $actual * `param float` $delta * `param string` $message +* `return void` Asserts that two variables are not equal (with delta). #### assertNotFalse +* `phpstan-assert` !false $condition * `param mixed` $condition * `param string` $message +* `return void` Asserts that a condition is not false. #### assertNotInstanceOf -* `param string` $expected +* `template` ExpectedType of object +* `phpstan-assert` !ExpectedType $actual +* `param class-string` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of a given type. #### assertNotNull +* `phpstan-assert` !null $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not null. @@ -841,6 +1160,7 @@ Asserts that a variable is not null. * `param string` $pattern * `param string` $string * `param string` $message +* `return void` Asserts that a string does not match a given regular expression. @@ -850,31 +1170,37 @@ Asserts that a string does not match a given regular expression. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables do not have the same type and value. #### assertNotSameSize -* `param \Countable|iterable` $expected -* `param \Countable|iterable` $actual +* `param \Countable|iterable` $expected +* `param \Countable|iterable` $actual * `param string` $message +* `return void` Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same. #### assertNotTrue +* `phpstan-assert` !true $condition * `param mixed` $condition * `param string` $message +* `return void` Asserts that a condition is not true. #### assertNull +* `phpstan-assert` null $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is null. @@ -884,6 +1210,7 @@ Asserts that a variable is null. * `param string` $attributeName * `param object` $object * `param string` $message +* `return void` Asserts that an object has a specified attribute. @@ -893,6 +1220,7 @@ Asserts that an object has a specified attribute. * `param string` $attributeName * `param object` $object * `param string` $message +* `return void` Asserts that an object does not have a specified attribute. @@ -902,24 +1230,32 @@ Asserts that an object does not have a specified attribute. * `param string` $pattern * `param string` $string * `param string` $message +* `return void` Asserts that a string matches a given regular expression. #### assertSame -* `param mixed` $expected +* `template` ExpectedType +* `phpstan-assert` =ExpectedType $actual +* `param ExpectedType` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables have the same type and value. +Used on objects, it asserts that two variables reference +the same object. + #### assertSameSize -* `param \Countable|iterable` $expected -* `param \Countable|iterable` $actual +* `param \Countable|iterable` $expected +* `param \Countable|iterable` $actual * `param string` $message +* `return void` Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same. @@ -929,6 +1265,7 @@ Assert that the size of two arrays (or `Countable` or `Traversable` objects) is * `param string` $needle * `param string` $haystack * `param string` $message +* `return void` #### assertStringContainsStringIgnoringCase @@ -936,22 +1273,25 @@ Assert that the size of two arrays (or `Countable` or `Traversable` objects) is * `param string` $needle * `param string` $haystack * `param string` $message +* `return void` #### assertStringEndsNotWith -* `param string` $suffix +* `param non-empty-string` $suffix * `param string` $string * `param string` $message +* `return void` Asserts that a string ends not with a given suffix. #### assertStringEndsWith -* `param string` $suffix +* `param non-empty-string` $suffix * `param string` $string * `param string` $message +* `return void` Asserts that a string ends with a given suffix. @@ -961,6 +1301,7 @@ Asserts that a string ends with a given suffix. * `param string` $expectedFile * `param string` $actualString * `param string` $message +* `return void` Asserts that the contents of a string is equal to the contents of a file. @@ -970,6 +1311,7 @@ Asserts that the contents of a string is equal to the contents of a file. * `param string` $expectedFile * `param string` $actualString * `param string` $message +* `return void` Asserts that the contents of a string is equal to the contents of a file (canonicalizing). @@ -979,6 +1321,7 @@ Asserts that the contents of a string is equal to the contents of a file (canoni * `param string` $expectedFile * `param string` $actualString * `param string` $message +* `return void` Asserts that the contents of a string is equal to the contents of a file (ignoring case). @@ -988,6 +1331,7 @@ Asserts that the contents of a string is equal to the contents of a file (ignori * `param string` $format * `param string` $string * `param string` $message +* `return void` Asserts that a string matches a given format string. @@ -997,6 +1341,7 @@ Asserts that a string matches a given format string. * `param string` $formatFile * `param string` $string * `param string` $message +* `return void` Asserts that a string matches a given format file. @@ -1006,6 +1351,7 @@ Asserts that a string matches a given format file. * `param string` $needle * `param string` $haystack * `param string` $message +* `return void` #### assertStringNotContainsStringIgnoringCase @@ -1013,6 +1359,7 @@ Asserts that a string matches a given format file. * `param string` $needle * `param string` $haystack * `param string` $message +* `return void` #### assertStringNotEqualsFile @@ -1020,6 +1367,7 @@ Asserts that a string matches a given format file. * `param string` $expectedFile * `param string` $actualString * `param string` $message +* `return void` Asserts that the contents of a string is not equal to the contents of a file. @@ -1029,6 +1377,7 @@ Asserts that the contents of a string is not equal to the contents of a file. * `param string` $expectedFile * `param string` $actualString * `param string` $message +* `return void` Asserts that the contents of a string is not equal to the contents of a file (canonicalizing). @@ -1038,6 +1387,7 @@ Asserts that the contents of a string is not equal to the contents of a file (ca * `param string` $expectedFile * `param string` $actualString * `param string` $message +* `return void` Asserts that the contents of a string is not equal to the contents of a file (ignoring case). @@ -1047,6 +1397,7 @@ Asserts that the contents of a string is not equal to the contents of a file (ig * `param string` $format * `param string` $string * `param string` $message +* `return void` Asserts that a string does not match a given format string. @@ -1056,24 +1407,27 @@ Asserts that a string does not match a given format string. * `param string` $formatFile * `param string` $string * `param string` $message +* `return void` Asserts that a string does not match a given format string. #### assertStringStartsNotWith -* `param string` $prefix +* `param non-empty-string` $prefix * `param string` $string * `param string` $message +* `return void` Asserts that a string starts not with a given prefix. #### assertStringStartsWith -* `param string` $prefix +* `param non-empty-string` $prefix * `param string` $string * `param string` $message +* `return void` Asserts that a string starts with a given prefix. @@ -1083,6 +1437,7 @@ Asserts that a string starts with a given prefix. * `param mixed` $value * `param \PHPUnit\Framework\Constraint\Constraint` $constraint * `param string` $message +* `return void` Evaluates a PHPUnit\Framework\Constraint matcher object. @@ -1092,14 +1447,17 @@ Evaluates a PHPUnit\Framework\Constraint matcher object. * `param mixed` $value * `param \PHPUnit\Framework\Constraint\Constraint` $constraint * `param string` $message +* `return void` Evaluates a PHPUnit\Framework\Constraint matcher object. #### assertTrue +* `phpstan-assert` true $condition * `param mixed` $condition * `param string` $message +* `return void` Asserts that a condition is true. @@ -1109,6 +1467,7 @@ Asserts that a condition is true. * `param string` $expectedFile * `param string` $actualFile * `param string` $message +* `return void` Asserts that two XML files are equal. @@ -1118,6 +1477,7 @@ Asserts that two XML files are equal. * `param string` $expectedFile * `param string` $actualFile * `param string` $message +* `return void` Asserts that two XML files are not equal. @@ -1127,6 +1487,7 @@ Asserts that two XML files are not equal. * `param string` $expectedFile * `param \DOMDocument|string` $actualXml * `param string` $message +* `return void` Asserts that two XML documents are equal. @@ -1136,6 +1497,7 @@ Asserts that two XML documents are equal. * `param \DOMDocument|string` $expectedXml * `param \DOMDocument|string` $actualXml * `param string` $message +* `return void` Asserts that two XML documents are equal. @@ -1145,6 +1507,7 @@ Asserts that two XML documents are equal. * `param string` $expectedFile * `param \DOMDocument|string` $actualXml * `param string` $message +* `return void` Asserts that two XML documents are not equal. @@ -1154,6 +1517,7 @@ Asserts that two XML documents are not equal. * `param \DOMDocument|string` $expectedXml * `param \DOMDocument|string` $actualXml * `param string` $message +* `return void` Asserts that two XML documents are not equal. @@ -1180,6 +1544,7 @@ $I->expectThrowable(new MyException(), function() { }); {% endhighlight %} + If you want to check message or throwable code, you can pass them with throwable instance: {% highlight php %} @@ -1195,6 +1560,7 @@ $I->expectThrowable(new MyError("Don't do bad things"), function() { #### fail * `param string` $message +* `return never` Fails a test with the given message. @@ -1202,6 +1568,7 @@ Fails a test with the given message. #### markTestIncomplete * `param string` $message +* `return never` Mark the test as incomplete. @@ -1209,6 +1576,7 @@ Mark the test as incomplete. #### markTestSkipped * `param string` $message +* `return never` Mark the test as skipped. diff --git a/docs/modules/Db.md b/docs/modules/Db.md index 9f203be0a..b017c643e 100644 --- a/docs/modules/Db.md +++ b/docs/modules/Db.md @@ -25,7 +25,7 @@ The most important function of this module is to clean a database before each te This module also provides actions to perform checks in a database, e.g. [seeInDatabase()](https://codeception.com/docs/modules/Db#seeInDatabase) In order to have your database populated with data you need a raw SQL dump. -Simply put the dump in the `tests/_data` directory (by default) and specify the path in the config. +Simply put the dump in the `tests/Support/Data` directory (by default) and specify the path in the config. The next time after the database is cleared, all your data will be restored from the dump. Don't forget to include `CREATE TABLE` statements in the dump. @@ -40,85 +40,80 @@ Also available: * MS SQL * Oracle -Connection is done by database Drivers, which are stored in the `Codeception\Lib\Driver` namespace. -[Check out the drivers](https://github.com/Codeception/Codeception/tree/2.4/src/Codeception/Lib/Driver) -if you run into problems loading dumps and cleaning databases. - -### Config - -* dsn *required* - PDO DSN -* user *required* - username to access database -* password *required* - password -* dump - path to database dump -* populate: false - whether the the dump should be loaded before the test suite is started -* cleanup: false - whether the dump should be reloaded before each test -* reconnect: false - whether the module should reconnect to the database before each test -* waitlock: 0 - wait lock (in seconds) that the database session should use for DDL statements -* ssl_key - path to the SSL key (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-key) -* ssl_cert - path to the SSL certificate (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-cert) -* ssl_ca - path to the SSL certificate authority (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-ca) -* ssl_verify_server_cert - disables certificate CN verification (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php) -* ssl_cipher - list of one or more permissible ciphers to use for SSL encryption (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-cipher) -* databases - include more database configs and switch between them in tests. -* initial_queries - list of queries to be executed right after connection to the database has been initiated, i.e. creating the database if it does not exist or preparing the database collation -* skip_cleanup_if_failed - Do not perform the cleanup if the tests failed. If this is used, manual cleanup might be required when re-running -### Example - - modules: - enabled: - - Db: - dsn: 'mysql:host=localhost;dbname=testdb' - user: 'root' - password: '' - dump: 'tests/_data/dump.sql' - populate: true - cleanup: true - reconnect: true - waitlock: 10 - skip_cleanup_if_failed: true - ssl_key: '/path/to/client-key.pem' - ssl_cert: '/path/to/client-cert.pem' - ssl_ca: '/path/to/ca-cert.pem' - ssl_verify_server_cert: false - ssl_cipher: 'AES256-SHA' - initial_queries: - - 'CREATE DATABASE IF NOT EXISTS temp_db;' - - 'USE temp_db;' - - 'SET NAMES utf8;' +Connection is done by database drivers, which are stored in the `Codeception\Lib\Driver` namespace. +Check out the drivers if you run into problems loading dumps and cleaning databases. + +### Example `Functional.suite.yml` +{% highlight yaml %} + +modules: + enabled: + - Db: + dsn: 'mysql:host=localhost;dbname=testdb' + user: 'root' + password: '' + dump: 'tests/Support/Data/dump.sql' + populate: true # whether the dump should be loaded before the test suite is started + cleanup: true # whether the dump should be reloaded before each test + reconnect: true # whether the module should reconnect to the database before each test + waitlock: 10 # wait lock (in seconds) that the database session should use for DDL statements + databases: # include more database configs and switch between them in tests. + skip_cleanup_if_failed: true # Do not perform the cleanup if the tests failed. If this is used, manual cleanup might be required when re-running + ssl_key: '/path/to/client-key.pem' # path to the SSL key (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-key) + ssl_cert: '/path/to/client-cert.pem' # path to the SSL certificate (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-cert) + ssl_ca: '/path/to/ca-cert.pem' # path to the SSL certificate authority (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-ca) + ssl_verify_server_cert: false # disables certificate CN verification (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php) + ssl_cipher: 'AES256-SHA' # list of one or more permissible ciphers to use for SSL encryption (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-cipher) + initial_queries: # list of queries to be executed right after connection to the database has been initiated, i.e. creating the database if it does not exist or preparing the database collation + - 'CREATE DATABASE IF NOT EXISTS temp_db;' + - 'USE temp_db;' + - 'SET NAMES utf8;' + +{% endhighlight %} ### Example with multi-dumps - modules: - enabled: - - Db: - dsn: 'mysql:host=localhost;dbname=testdb' - user: 'root' - password: '' - dump: - - 'tests/_data/dump.sql' - - 'tests/_data/dump-2.sql' +{% highlight yaml %} + +modules: + enabled: + - Db: + dsn: 'mysql:host=localhost;dbname=testdb' + user: 'root' + password: '' + dump: + - 'tests/Support/Data/dump.sql' + - 'tests/Support/Data/dump-2.sql' + +{% endhighlight %} ### Example with multi-databases +{% highlight yaml %} - modules: - enabled: - - Db: - dsn: 'mysql:host=localhost;dbname=testdb' - user: 'root' - password: '' - databases: +modules: + enabled: + - Db: + dsn: 'mysql:host=localhost;dbname=testdb' + user: 'root' + password: '' + databases: db2: - dsn: 'mysql:host=localhost;dbname=testdb2' - user: 'userdb2' - password: '' + dsn: 'mysql:host=localhost;dbname=testdb2' + user: 'userdb2' + password: '' + +{% endhighlight %} -### Example with Sqlite +### Example with SQLite +{% highlight yaml %} + +modules: + enabled: + - Db: + dsn: 'sqlite:relative/path/to/sqlite-database.db' + user: '' + password: '' - modules: - enabled: - - Db: - dsn: 'sqlite:relative/path/to/sqlite-database.db' - user: '' - password: '' +{% endhighlight %} ### SQL data dump @@ -134,31 +129,32 @@ For MySQL: {% highlight yaml %} modules: - enabled: - - Db: - dsn: 'mysql:host=localhost;dbname=testdb' - user: 'root' - password: '' - dump: 'tests/_data/dump.sql' - populate: true # run populator before all tests - cleanup: true # run populator before each test - populator: 'mysql -u $user -h $host $dbname < $dump' + enabled: + - Db: + dsn: 'mysql:host=localhost;dbname=testdb' + user: 'root' + password: '' + dump: 'tests/Support/Data/dump.sql' + populate: true # run populator before all tests + cleanup: true # run populator before each test + populator: 'mysql -u $user -h $host $dbname < $dump' {% endhighlight %} -For PostgreSQL (using pg_restore) +For PostgreSQL (using `pg_restore`) {% highlight yaml %} + modules: - enabled: - - Db: - dsn: 'pgsql:host=localhost;dbname=testdb' - user: 'root' - password: '' - dump: 'tests/_data/db_backup.dump' - populate: true # run populator before all tests - cleanup: true # run populator before each test - populator: 'pg_restore -u $user -h $host -D $dbname < $dump' + enabled: + - Db: + dsn: 'pgsql:host=localhost;dbname=testdb' + user: 'root' + password: '' + dump: 'tests/Support/Data/db_backup.dump' + populate: true # run populator before all tests + cleanup: true # run populator before each test + populator: 'pg_restore -u $user -h $host -D $dbname < $dump' {% endhighlight %} @@ -334,7 +330,7 @@ Provide table name, desired column and criteria. {% highlight php %} grabColumnFromDatabase('users', 'email', array('name' => 'RebOOter')); +$mails = $I->grabColumnFromDatabase('users', 'email', ['name' => 'RebOOter']); {% endhighlight %} @@ -353,7 +349,7 @@ Provide table name and criteria. {% highlight php %} grabEntriesFromDatabase('users', array('name' => 'Davert')); +$mail = $I->grabEntriesFromDatabase('users', ['name' => 'Davert']); {% endhighlight %} Comparison expressions can be used as well: @@ -384,7 +380,7 @@ Provide table name, desired column and criteria. {% highlight php %} grabEntryFromDatabase('users', array('name' => 'Davert')); +$mail = $I->grabEntryFromDatabase('users', ['name' => 'Davert']); {% endhighlight %} Comparison expressions can be used as well: @@ -414,7 +410,7 @@ Provide table name, desired column and criteria. {% highlight php %} grabFromDatabase('users', 'email', array('name' => 'Davert')); +$mail = $I->grabFromDatabase('users', 'email', ['name' => 'Davert']); {% endhighlight %} Comparison expressions can be used as well: @@ -451,7 +447,7 @@ unless you've configured "skip_cleanup_if_failed", and the test fails. {% highlight php %} haveInDatabase('users', array('name' => 'miles', 'email' => 'miles@davis.com')); +$I->haveInDatabase('users', ['name' => 'miles', 'email' => 'miles@davis.com']); {% endhighlight %} @@ -559,7 +555,7 @@ Update an SQL record into a database. {% highlight php %} updateInDatabase('users', array('isAdmin' => true), array('email' => 'miles@davis.com')); +$I->updateInDatabase('users', ['isAdmin' => true], ['email' => 'miles@davis.com']); {% endhighlight %} diff --git a/docs/modules/Doctrine.md b/docs/modules/Doctrine.md index 8a72d069a..9c2a46e1a 100644 --- a/docs/modules/Doctrine.md +++ b/docs/modules/Doctrine.md @@ -19,10 +19,15 @@ composer require --dev codeception/module-doctrine +Upgrading from Module "Doctrine2": +* In your `composer.json`: Replace `"codeception/module-doctrine2"` with `"codeception/module-doctrine"` +* In your `Acceptance.suite.yml`, `Functional.suite.yml`, and `Unit.suite.yml`: Replace `- Doctrine2:` with `- Doctrine:` +* In any file in `Support/Helper/`: Change `$this->getModule('Doctrine2')` to `$this->getModule('Doctrine')` + Access the database using [Doctrine ORM](https://docs.doctrine-project.org/projects/doctrine-orm/en/latest/). When used with Symfony or Zend Framework 2, Doctrine's Entity Manager is automatically retrieved from Service Locator. -Set up your `functional.suite.yml` like this: +Set up your `Functional.suite.yml` like this: {% highlight yaml %} @@ -354,7 +359,7 @@ Note that `$em->persist()`, `$em->refresh()`, and `$em->flush()` are called ever * `throws ModuleRequireException` * `return void` -Loads fixtures. Fixture can be specified as a fully qualified class name, +Loads fixtures. The fixture class can be specified as a fully qualified class name, an instance, or an array of class names/instances. {% highlight php %} diff --git a/docs/modules/Laminas.md b/docs/modules/Laminas.md index 9da86c782..2dbbfcb12 100644 --- a/docs/modules/Laminas.md +++ b/docs/modules/Laminas.md @@ -400,7 +400,7 @@ You can set additional cookie params like `domain`, `path` as array passed in la * `param string` $uri * `return void` -Checks that the current URL doesn't equal the given string. +Checks that the current URL (path) doesn't equal the given string. Unlike `dontSeeInCurrentUrl`, this only matches the full URL. @@ -418,13 +418,13 @@ $I->dontSeeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that current url doesn't match the given regular expression. +Checks that current URL (path) doesn't match the given regular expression. {% highlight php %} dontSeeCurrentUrlMatches('~^/users/(\d+)~'); +$I->dontSeeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -455,7 +455,7 @@ $I->dontSeeElement('input', ['value' => '123456']); * `param string` $uri * `return void` -Checks that the current URI doesn't contain the given string. +Checks that the current URI (path) doesn't contain the given string. {% highlight php %} @@ -962,14 +962,12 @@ $I->seeCurrentRouteIs('posts.show', ['id' => 8])); * `param string` $uri * `return void` -Checks that the current URL is equal to the given string. - -Unlike `seeInCurrentUrl`, this only matches the full URL. +Checks that the current URL (path) is equal to the given string. {% highlight php %} seeCurrentUrlEquals('/'); {% endhighlight %} @@ -980,13 +978,12 @@ $I->seeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that the current URL matches the given regular expression. +Checks that the current URL (path) matches the given regular expression. {% highlight php %} seeCurrentUrlMatches('~^/users/(\d+)~'); +$I->seeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -1118,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 7628ef7f6..91f91e54e 100644 --- a/docs/modules/Laravel.md +++ b/docs/modules/Laravel.md @@ -660,7 +660,7 @@ You can set additional cookie params like `domain`, `path` as array passed in la * `param string` $uri * `return void` -Checks that the current URL doesn't equal the given string. +Checks that the current URL (path) doesn't equal the given string. Unlike `dontSeeInCurrentUrl`, this only matches the full URL. @@ -678,13 +678,13 @@ $I->dontSeeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that current url doesn't match the given regular expression. +Checks that current URL (path) doesn't match the given regular expression. {% highlight php %} dontSeeCurrentUrlMatches('~^/users/(\d+)~'); +$I->dontSeeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -746,7 +746,7 @@ $I->dontSeeFormErrors(); * `param string` $uri * `return void` -Checks that the current URI doesn't contain the given string. +Checks that the current URI (path) doesn't contain the given string. {% highlight php %} @@ -1679,14 +1679,12 @@ $I->seeCurrentRouteIs('posts.index'); * `param string` $uri * `return void` -Checks that the current URL is equal to the given string. - -Unlike `seeInCurrentUrl`, this only matches the full URL. +Checks that the current URL (path) is equal to the given string. {% highlight php %} seeCurrentUrlEquals('/'); {% endhighlight %} @@ -1697,13 +1695,12 @@ $I->seeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that the current URL matches the given regular expression. +Checks that the current URL (path) matches the given regular expression. {% highlight php %} seeCurrentUrlMatches('~^/users/(\d+)~'); +$I->seeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -1926,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 158bedeaa..89315a443 100644 --- a/docs/modules/Lumen.md +++ b/docs/modules/Lumen.md @@ -409,7 +409,7 @@ You can set additional cookie params like `domain`, `path` as array passed in la * `param string` $uri * `return void` -Checks that the current URL doesn't equal the given string. +Checks that the current URL (path) doesn't equal the given string. Unlike `dontSeeInCurrentUrl`, this only matches the full URL. @@ -427,13 +427,13 @@ $I->dontSeeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that current url doesn't match the given regular expression. +Checks that current URL (path) doesn't match the given regular expression. {% highlight php %} dontSeeCurrentUrlMatches('~^/users/(\d+)~'); +$I->dontSeeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -464,7 +464,7 @@ $I->dontSeeElement('input', ['value' => '123456']); * `param string` $uri * `return void` -Checks that the current URI doesn't contain the given string. +Checks that the current URI (path) doesn't contain the given string. {% highlight php %} @@ -1221,14 +1221,12 @@ $I->seeCookie('PHPSESSID'); * `param string` $uri * `return void` -Checks that the current URL is equal to the given string. - -Unlike `seeInCurrentUrl`, this only matches the full URL. +Checks that the current URL (path) is equal to the given string. {% highlight php %} seeCurrentUrlEquals('/'); {% endhighlight %} @@ -1239,13 +1237,12 @@ $I->seeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that the current URL matches the given regular expression. +Checks that the current URL (path) matches the given regular expression. {% highlight php %} seeCurrentUrlMatches('~^/users/(\d+)~'); +$I->seeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -1377,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 a6d8f6e64..9bb626c5d 100644 --- a/docs/modules/Mezzio.md +++ b/docs/modules/Mezzio.md @@ -346,7 +346,7 @@ You can set additional cookie params like `domain`, `path` as array passed in la * `param string` $uri * `return void` -Checks that the current URL doesn't equal the given string. +Checks that the current URL (path) doesn't equal the given string. Unlike `dontSeeInCurrentUrl`, this only matches the full URL. @@ -364,13 +364,13 @@ $I->dontSeeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that current url doesn't match the given regular expression. +Checks that current URL (path) doesn't match the given regular expression. {% highlight php %} dontSeeCurrentUrlMatches('~^/users/(\d+)~'); +$I->dontSeeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -401,7 +401,7 @@ $I->dontSeeElement('input', ['value' => '123456']); * `param string` $uri * `return void` -Checks that the current URI doesn't contain the given string. +Checks that the current URI (path) doesn't contain the given string. {% highlight php %} @@ -874,14 +874,12 @@ $I->seeCookie('PHPSESSID'); * `param string` $uri * `return void` -Checks that the current URL is equal to the given string. - -Unlike `seeInCurrentUrl`, this only matches the full URL. +Checks that the current URL (path) is equal to the given string. {% highlight php %} seeCurrentUrlEquals('/'); {% endhighlight %} @@ -892,13 +890,12 @@ $I->seeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that the current URL matches the given regular expression. +Checks that the current URL (path) matches the given regular expression. {% highlight php %} seeCurrentUrlMatches('~^/users/(\d+)~'); +$I->seeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -1030,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 f72e65c6f..e7733db84 100644 --- a/docs/modules/PhpBrowser.md +++ b/docs/modules/PhpBrowser.md @@ -26,13 +26,6 @@ Use to perform web acceptance tests with non-javascript browser. If test fails stores last shown page in 'output' dir. -### Status - -* Maintainer: **davert** -* Stability: **stable** -* Contact: codeception@codeception.com - - ### Configuration * url *required* - start url of your app @@ -46,28 +39,31 @@ If test fails stores last shown page in 'output' dir. * .. those and other [Guzzle Request options](https://docs.guzzlephp.org/en/latest/request-options.html) -#### Example (`acceptance.suite.yml`) - - modules: - enabled: - - PhpBrowser: - url: 'http://localhost' - auth: ['admin', '123345'] - curl: - CURLOPT_RETURNTRANSFER: true - cookies: - cookie-1: - Name: userName - Value: john.doe - cookie-2: - Name: authToken - Value: 1abcd2345 - Domain: subdomain.domain.com - Path: /admin/ - Expires: 1292177455 - Secure: true - HttpOnly: false +#### Example (`Acceptance.suite.yml`) +{% highlight yaml %} + +modules: + enabled: + - PhpBrowser: + url: 'http://localhost' # Internationalized domain names (IDN) need to be passed in punycode + auth: ['admin', '123345'] + curl: + CURLOPT_RETURNTRANSFER: true + cookies: + cookie-1: + Name: userName + Value: john.doe + cookie-2: + Name: authToken + Value: 1abcd2345 + Domain: subdomain.domain.com + Path: /admin/ + Expires: 1292177455 + Secure: true + HttpOnly: false + +{% endhighlight %} All SSL certification checks are disabled by default. Use Guzzle request options to configure certifications and others. @@ -220,8 +216,8 @@ $this->getModule('PhpBrowser')->_savePageSource(codecept_output_dir().'page.html #### amHttpAuthenticated -* `param ` $username -* `param ` $password +* `param string` $username +* `param string` $password * `return void` Authenticates user for HTTP_AUTH @@ -247,7 +243,7 @@ $I->amOnPage('/register'); #### amOnSubdomain -* `param ` $subdomain +* `param string` $subdomain * `return void` Changes the subdomain for the 'url' configuration parameter. @@ -270,7 +266,7 @@ $I->amOnPage('/'); #### amOnUrl -* `param ` $url +* `param string` $url * `return void` Open web page at the given absolute URL and sets its hostname as the base host. @@ -426,7 +422,7 @@ You can set additional cookie params like `domain`, `path` as array passed in la * `param string` $uri * `return void` -Checks that the current URL doesn't equal the given string. +Checks that the current URL (path) doesn't equal the given string. Unlike `dontSeeInCurrentUrl`, this only matches the full URL. @@ -444,13 +440,13 @@ $I->dontSeeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that current url doesn't match the given regular expression. +Checks that current URL (path) doesn't match the given regular expression. {% highlight php %} dontSeeCurrentUrlMatches('~^/users/(\d+)~'); +$I->dontSeeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -481,7 +477,7 @@ $I->dontSeeElement('input', ['value' => '123456']); * `param string` $uri * `return void` -Checks that the current URI doesn't contain the given string. +Checks that the current URI (path) doesn't contain the given string. {% highlight php %} @@ -978,14 +974,12 @@ $I->seeCookie('PHPSESSID'); * `param string` $uri * `return void` -Checks that the current URL is equal to the given string. - -Unlike `seeInCurrentUrl`, this only matches the full URL. +Checks that the current URL (path) is equal to the given string. {% highlight php %} seeCurrentUrlEquals('/'); {% endhighlight %} @@ -996,13 +990,12 @@ $I->seeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that the current URL matches the given regular expression. +Checks that the current URL (path) matches the given regular expression. {% highlight php %} seeCurrentUrlMatches('~^/users/(\d+)~'); +$I->seeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -1134,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 86c8f8d8f..78666b6fe 100644 --- a/docs/modules/Symfony.md +++ b/docs/modules/Symfony.md @@ -41,7 +41,7 @@ and [HttpKernel Component](https://symfony.com/doc/current/components/http_kerne * `kernel_class`: 'App\Kernel' - Kernel class name * `em_service`: 'doctrine.orm.entity_manager' - Use the stated EntityManager to pair with Doctrine Module. * `debug`: true - Turn on/off [debug mode](https://codeception.com/docs/Debugging) -* `cache_router`: 'false' - Enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire) +* `cache_router`: 'false' - Enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire) (can have an impact on ajax requests sending via '$I->sendAjaxPostRequest()') * `rebootable_client`: 'true' - Reboot client's kernel before each request * `guard`: 'false' - Enable custom authentication system with guard (only for Symfony 5.4) * `bootstrap`: 'false' - Enable the test environment setup with the tests/bootstrap.php file if it exists or with Symfony DotEnv otherwise. If false, it does nothing. @@ -92,7 +92,6 @@ modules: If you're using Symfony with Eloquent ORM (instead of Doctrine), you can load the [`ORM` part of Laravel module](https://codeception.com/docs/modules/Laravel#Parts) in addition to Symfony module. - ### Actions #### _findElements @@ -322,6 +321,97 @@ $I->amOnRoute('posts.show', ['id' => 34]); {% endhighlight %} +#### assertBrowserCookieValueSame + +* `param string` $name +* `param string` $expectedValue +* `param bool` $raw +* `param string` $path +* `param ?string` $domain +* `param string` $message +* `return void` + +Asserts that the given cookie in the test client is set to the expected value. + +{% highlight php %} + +assertBrowserCookieValueSame('cookie_name', 'expected_value'); + +{% endhighlight %} + + +#### assertBrowserHasCookie + +* `param string` $name +* `param string` $path +* `param ?string` $domain +* `param string` $message +* `return void` + +Asserts that the test client has the specified cookie set. + +This indicates that the cookie was set by any response during the test. + +{% highlight yaml %} +assertBrowserHasCookie('cookie_name'); + +{% endhighlight %} + + +#### assertBrowserNotHasCookie + +* `param string` $name +* `param string` $path +* `param ?string` $domain +* `param string` $message +* `return void` + +Asserts that the test client does not have the specified cookie set. + +This indicates that the cookie was not set by any response during the test. + +{% highlight php %} + +assertBrowserNotHasCookie('cookie_name'); + +{% endhighlight %} + + +#### assertCheckboxChecked + +* `param string` $fieldName +* `param string` $message +* `return void` + +Asserts that the checkbox with the given name is checked. + +{% highlight php %} + +assertCheckboxChecked('agree_terms'); + +{% endhighlight %} + + +#### assertCheckboxNotChecked + +* `param string` $fieldName +* `param string` $message +* `return void` + +Asserts that the checkbox with the given name is not checked. + +{% highlight php %} + +assertCheckboxNotChecked('subscribe'); + +{% endhighlight %} + + #### assertEmailAddressContains * `param string` $headerName @@ -360,6 +450,23 @@ $I->assertEmailAttachmentCount(1); {% endhighlight %} +#### assertEmailCount + +* `param int` $count +* `param ?string` $transport +* `param string` $message +* `return void` + +Asserts that the expected number of emails was sent. + +{% highlight php %} + +assertEmailCount(2, 'smtp'); + +{% endhighlight %} + + #### assertEmailHasHeader * `param string` $headerName @@ -385,125 +492,827 @@ $I->assertEmailHasHeader('Bcc'); * `param ?\Symfony\Component\Mime\Email` $email * `return void` -Verify that the [header](https://datatracker.ietf.org/doc/html/rfc4021) -`$headerName` of an email is not the expected one `$expectedValue`. +Verify that the [header](https://datatracker.ietf.org/doc/html/rfc4021) +`$headerName` of an email is not the expected one `$expectedValue`. + +If the Email object is not specified, the last email sent is used instead. + +{% highlight php %} + +assertEmailHeaderNotSame('To', 'john_doe@gmail.com'); + +{% endhighlight %} + + +#### assertEmailHeaderSame + +* `param string` $headerName +* `param string` $expectedValue +* `param ?\Symfony\Component\Mime\Email` $email +* `return void` + +Verify that the [header](https://datatracker.ietf.org/doc/html/rfc4021) +`$headerName` of an email is the same as expected `$expectedValue`. + +If the Email object is not specified, the last email sent is used instead. + +{% highlight php %} + +assertEmailHeaderSame('To', 'jane_doe@gmail.com'); + +{% endhighlight %} + + +#### assertEmailHtmlBodyContains + +* `param string` $text +* `param ?\Symfony\Component\Mime\Email` $email +* `return void` + +Verify that the HTML body of an email contains `$text`. + +If the Email object is not specified, the last email sent is used instead. + +{% highlight php %} + +assertEmailHtmlBodyContains('Successful registration'); + +{% endhighlight %} + + +#### assertEmailHtmlBodyNotContains + +* `param string` $text +* `param ?\Symfony\Component\Mime\Email` $email +* `return void` + +Verify that the HTML body of an email does not contain a text `$text`. + +If the Email object is not specified, the last email sent is used instead. + +{% highlight php %} + +assertEmailHtmlBodyNotContains('userpassword'); + +{% endhighlight %} + + +#### assertEmailIsNotQueued + +* `param \Symfony\Component\Mailer\Event\MessageEvent` $event +* `param string` $message +* `return void` + +Asserts that the given mailer event is not queued. + +Use `getMailerEvent(int $index = 0, ?string $transport = null)` to retrieve a mailer event by index. + +{% highlight php %} + +getMailerEvent(); +$I->assertEmailIsNotQueued($event); + +{% endhighlight %} + + +#### assertEmailIsQueued + +* `param \Symfony\Component\Mailer\Event\MessageEvent` $event +* `param string` $message +* `return void` + +Asserts that the given mailer event is queued. + +Use `getMailerEvent(int $index = 0, ?string $transport = null)` to retrieve a mailer event by index. + +{% highlight php %} + +getMailerEvent(); +$I->assertEmailIsQueued($event); + +{% endhighlight %} + + +#### assertEmailNotHasHeader + +* `param string` $headerName +* `param ?\Symfony\Component\Mime\Email` $email +* `return void` + +Verify that an email does not have a [header](https://datatracker.ietf.org/doc/html/rfc4021) `$headerName`. + +If the Email object is not specified, the last email sent is used instead. + +{% highlight php %} + +assertEmailNotHasHeader('Bcc'); + +{% endhighlight %} + + +#### assertEmailTextBodyContains + +* `param string` $text +* `param ?\Symfony\Component\Mime\Email` $email +* `return void` + +Verify the text body of an email contains a `$text`. + +If the Email object is not specified, the last email sent is used instead. + +{% highlight php %} + +assertEmailTextBodyContains('Example text body'); + +{% endhighlight %} + + +#### assertEmailTextBodyNotContains + +* `param string` $text +* `param ?\Symfony\Component\Mime\Email` $email +* `return void` + +Verify that the text body of an email does not contain a `$text`. + +If the Email object is not specified, the last email sent is used instead. + +{% highlight php %} + +assertEmailTextBodyNotContains('My secret text body'); + +{% endhighlight %} + + +#### assertFormValue + +* `param string` $formSelector +* `param string` $fieldName +* `param string` $value +* `param string` $message +* `return void` + +Asserts that value of the field of the first form matching the given selector does equal the expected value. + +{% highlight php %} + +assertFormValue('#loginForm', 'username', 'john_doe'); + +{% endhighlight %} + + +#### assertHttpClientRequest + +* `param string` $expectedUrl +* `param string` $expectedMethod +* `param string|array|null` $expectedBody +* `param array` $expectedHeaders +* `param string` $httpClientId +* `return void` + +Asserts that the given URL has been called using, if specified, the given method, body and/or headers. + +By default, it will inspect the default Symfony HttpClient; you may check a different one by passing its +service-id in $httpClientId. +It succeeds even if the request was executed multiple times. + +{% highlight php %} + +assertHttpClientRequest( + 'https://example.com/api', + 'POST', + '{"data": "value"}', + ['Authorization' => 'Bearer token'] +); + +{% endhighlight %} + + +#### assertHttpClientRequestCount + +* `param int` $count +* `param string` $httpClientId +* `return void` + +Asserts that exactly $count requests have been executed by the given HttpClient. + +By default, it will inspect the default Symfony HttpClient; you may check a different one by passing its +service-id in $httpClientId. + +{% highlight php %} + +$I->assertHttpClientRequestCount(3); + +{% endhighlight %} + + +#### assertInputValueNotSame + +* `param string` $fieldName +* `param string` $expectedValue +* `param string` $message +* `return void` + +Asserts that the value of the form input with the given name does not equal the expected value. + +{% highlight php %} + +assertInputValueNotSame('username', 'admin'); + +{% endhighlight %} + + +#### assertInputValueSame + +* `param string` $fieldName +* `param string` $expectedValue +* `param string` $message +* `return void` + +Asserts that the value of the form input with the given name equals the expected value. + +{% highlight php %} + +assertInputValueSame('username', 'johndoe'); + +{% endhighlight %} + + +#### assertNoFormValue + +* `param string` $formSelector +* `param string` $fieldName +* `param string` $message +* `return void` + +Asserts that the field of the first form matching the given selector does not have a value. + +{% highlight php %} + +assertNoFormValue('#registrationForm', 'middle_name'); + +{% endhighlight %} + + +#### assertNotHttpClientRequest + +* `param string` $unexpectedUrl +* `param string` $unexpectedMethod +* `param string` $httpClientId +* `return void` + +Asserts that the given URL *has not* been requested with the supplied HTTP method. + +By default, it will inspect the default Symfony HttpClient; you may check a different one by passing its +service-id in $httpClientId. +{% highlight php %} + +$I->assertNotHttpClientRequest('https://example.com/unexpected', 'GET'); + +{% endhighlight %} + + +#### assertNotificationCount + +* `param int` $count +* `param ?string` $transportName +* `param string` $message +* `return void` + +Asserts that the expected number of notifications was sent. + +{% highlight php %} + +assertNotificationCount(2, 'smtp'); + +{% endhighlight %} + + +#### assertNotificationIsNotQueued + +* `param \Symfony\Component\Notifier\Event\MessageEvent` $event +* `param string` $message +* `return void` + +Asserts that the given notifier event is not queued. + +Use `getNotifierEvent(int $index = 0, ?string $transportName = null)` to retrieve a notifier event by index. + +{% highlight php %} + +getNotifierEvent(); +$I->asserNotificationIsNotQueued($event); + +{% endhighlight %} + + +#### assertNotificationIsQueued + +* `param \Symfony\Component\Notifier\Event\MessageEvent` $event +* `param string` $message +* `return void` + +Asserts that the given notifier event is queued. + +Use `getNotifierEvent(int $index = 0, ?string $transportName = null)` to retrieve a notifier event by index. + +{% highlight php %} + +getNotifierEvent(); +$I->assertNotificationlIsQueued($event); + +{% endhighlight %} + + +#### assertNotificationSubjectContains + +* `param \Symfony\Component\Notifier\Message\MessageInterface` $notification +* `param string` $text +* `param string` $message +* `return void` + +Asserts that the given notification contains given subject. + +Use `getNotifierMessage(int $index = 0, ?string $transportName = null)` to retrieve a notification by index. + +{% highlight php %} + +getNotifierMessage(); +$I->assertNotificationSubjectContains($notification, 'Subject'); + +{% endhighlight %} + + +#### assertNotificationSubjectNotContains + +* `param \Symfony\Component\Notifier\Message\MessageInterface` $notification +* `param string` $text +* `param string` $message +* `return void` + +Asserts that the given notification does not contain given subject. + +Use `getNotifierMessage(int $index = 0, ?string $transportName = null)` to retrieve a notification by index. + +{% highlight php %} + +getNotifierMessage(); +$I->assertNotificationSubjectNotContains($notification, 'Subject'); + +{% endhighlight %} + + +#### assertNotificationTransportIsEqual + +* `param \Symfony\Component\Notifier\Message\MessageInterface` $notification +* `param ?string` $transportName +* `param string` $message +* `return void` + +Asserts that the given notification uses given transport. + +Use `getNotifierMessage(int $index = 0, ?string $transportName = null)` to retrieve a notification by index. + +{% highlight php %} + +getNotifierMessage(); +$I->assertNotificationTransportIsEqual($notification, 'chat'); + +{% endhighlight %} + + +#### assertNotificationTransportIsNotEqual + +* `param \Symfony\Component\Notifier\Message\MessageInterface` $notification +* `param ?string` $transportName +* `param string` $message +* `return void` + +Asserts that the given notification does not use given transport. + +Use `getNotifierMessage(int $index = 0, ?string $transportName = null)` to retrieve a notification by index. + +{% highlight php %} + +getNotifierMessage(); +$I->assertNotificationTransportIsNotEqual($notification, 'transport'); + +{% endhighlight %} + + +#### assertPageTitleContains + +* `param string` $expectedTitle +* `param string` $message +* `return void` + +Asserts that the `` element contains the given title. + +{% highlight php %} + +<?php +$I->assertPageTitleContains('Welcome'); + +{% endhighlight %} + + +#### assertPageTitleSame + +* `param string` $expectedTitle +* `param string` $message +* `return void` + +Asserts that the `<title>` element equals the given title. + +{% highlight php %} + +<?php +$I->assertPageTitleSame('Home Page'); + +{% endhighlight %} + + +#### assertQueuedEmailCount + +* `param int` $count +* `param ?string` $transport +* `param string` $message +* `return void` + +Asserts that the expected number of emails was queued (e.g. using the Messenger component). + +{% highlight php %} + +<?php +$I->assertQueuedEmailCount(1, 'smtp'); + +{% endhighlight %} + + +#### assertQueuedNotificationCount + +* `param int` $count +* `param ?string` $transportName +* `param string` $message +* `return void` + +Asserts that the expected number of notifications was queued (e.g. using the Notifier component). + +{% highlight php %} + +<?php +$I->assertQueuedNotificationCount(1, 'smtp'); + +{% endhighlight %} + + +#### assertRequestAttributeValueSame + +* `param string` $name +* `param string` $expectedValue +* `param string` $message +* `return void` + +Asserts that the specified request attribute matches the expected value. + +{% highlight php %} + +<?php +$I->assertRequestAttributeValueSame('attribute_name', 'expected_value'); + +{% endhighlight %} + + +#### assertResponseCookieValueSame + +* `param string` $name +* `param string` $expectedValue +* `param string` $path +* `param ?string` $domain +* `param string` $message +* `return void` + +Asserts that the specified response cookie is present and matches the expected value. + +{% highlight php %} + +<?php +$I->assertResponseCookieValueSame('cookie_name', 'expected_value'); + +{% endhighlight %} + + +#### assertResponseFormatSame + +* `param ?string` $expectedFormat +* `param string` $message +* `return void` + +Asserts that the response format matches the expected format. This checks the format returned by the `Response::getFormat()` method. + +{% highlight php %} + +<?php +$I->assertResponseFormatSame('json'); + +{% endhighlight %} + + +#### assertResponseHasCookie + +* `param string` $name +* `param string` $path +* `param ?string` $domain +* `param string` $message +* `return void` + +Asserts that the specified cookie is present in the response. Optionally, it can check for a specific cookie path or domain. + +{% highlight php %} + +<?php +$I->assertResponseHasCookie('cookie_name'); + +{% endhighlight %} + + +#### assertResponseHasHeader + +* `param string` $headerName +* `param string` $message +* `return void` + +Asserts that the specified header is available in the response. + +For example, use `assertResponseHasHeader('content-type');`. + +{% highlight php %} + +<?php +$I->assertResponseHasHeader('content-type'); + +{% endhighlight %} + + +#### assertResponseHeaderNotSame + +* `param string` $headerName +* `param string` $expectedValue +* `param string` $message +* `return void` + +Asserts that the specified header does not contain the expected value in the response. + +For example, use `assertResponseHeaderNotSame('content-type', 'application/octet-stream');`. + +{% highlight php %} + +<?php +$I->assertResponseHeaderNotSame('content-type', 'application/json'); + +{% endhighlight %} + + +#### assertResponseHeaderSame + +* `param string` $headerName +* `param string` $expectedValue +* `param string` $message +* `return void` + +Asserts that the specified header contains the expected value in the response. + +For example, use `assertResponseHeaderSame('content-type', 'application/octet-stream');`. + +{% highlight php %} + +<?php +$I->assertResponseHeaderSame('content-type', 'application/json'); + +{% endhighlight %} + + +#### assertResponseIsSuccessful + +* `param string` $message +* `param bool` $verbose +* `return void` + +Asserts that the response was successful (HTTP status code is in the 2xx range). + +{% highlight php %} + +<?php +$I->assertResponseIsSuccessful(); + +{% endhighlight %} + + +#### assertResponseIsUnprocessable + +* `param string` $message +* `param bool` $verbose +* `return void` + +Asserts that the response is unprocessable (HTTP status code is 422). + +{% highlight php %} + +<?php +$I->assertResponseIsUnprocessable(); + +{% endhighlight %} + + +#### assertResponseNotHasCookie + +* `param string` $name +* `param string` $path +* `param ?string` $domain +* `param string` $message +* `return void` + +Asserts that the specified cookie is not present in the response. Optionally, it can check for a specific cookie path or domain. + +{% highlight php %} + +<?php +$I->assertResponseNotHasCookie('cookie_name'); + +{% endhighlight %} + + +#### assertResponseNotHasHeader + +* `param string` $headerName +* `param string` $message +* `return void` + +Asserts that the specified header is not available in the response. + +{% highlight php %} + +<?php +$I->assertResponseNotHasHeader('content-type'); + +{% endhighlight %} + + +#### assertResponseRedirects + +* `param ?string` $expectedLocation +* `param ?int` $expectedCode +* `param string` $message +* `param bool` $verbose +* `return void` + +Asserts that the response is a redirect. Optionally, you can check the target location and status code. + +The expected location can be either an absolute or a relative path. + +{% highlight php %} + +<?php +// Check that '/admin' redirects to '/login' with status code 302 +$I->assertResponseRedirects('/login', 302); + +{% endhighlight %} + -If the Email object is not specified, the last email sent is used instead. +#### assertResponseStatusCodeSame + +* `param int` $expectedCode +* `param string` $message +* `param bool` $verbose +* `return void` + +Asserts that the response status code matches the expected code. {% highlight php %} <?php -$I->assertEmailHeaderNotSame('To', 'john_doe@gmail.com'); +$I->assertResponseStatusCodeSame(200); {% endhighlight %} -#### assertEmailHeaderSame +#### assertRouteSame -* `param string` $headerName -* `param string` $expectedValue -* `param ?\Symfony\Component\Mime\Email` $email +* `param string` $expectedRoute +* `param array` $parameters +* `param string` $message * `return void` -Verify that the [header](https://datatracker.ietf.org/doc/html/rfc4021) -`$headerName` of an email is the same as expected `$expectedValue`. - -If the Email object is not specified, the last email sent is used instead. +Asserts the request matches the given route and optionally route parameters. {% highlight php %} <?php -$I->assertEmailHeaderSame('To', 'jane_doe@gmail.com'); +$I->assertRouteSame('profile', ['id' => 123]); {% endhighlight %} -#### assertEmailHtmlBodyContains +#### assertSelectorExists -* `param string` $text -* `param ?\Symfony\Component\Mime\Email` $email +* `param string` $selector +* `param string` $message * `return void` -Verify that the HTML body of an email contains `$text`. - -If the Email object is not specified, the last email sent is used instead. +Asserts that the given selector matches at least one element in the response. {% highlight php %} <?php -$I->assertEmailHtmlBodyContains('Successful registration'); +$I->assertSelectorExists('.main-content'); {% endhighlight %} -#### assertEmailHtmlBodyNotContains +#### assertSelectorNotExists -* `param string` $text -* `param ?\Symfony\Component\Mime\Email` $email +* `param string` $selector +* `param string` $message * `return void` -Verify that the HTML body of an email does not contain a text `$text`. - -If the Email object is not specified, the last email sent is used instead. +Asserts that the given selector does not match at least one element in the response. {% highlight php %} <?php -$I->assertEmailHtmlBodyNotContains('userpassword'); +$I->assertSelectorNotExists('.error'); {% endhighlight %} -#### assertEmailNotHasHeader +#### assertSelectorTextContains -* `param string` $headerName -* `param ?\Symfony\Component\Mime\Email` $email +* `param string` $selector +* `param string` $text +* `param string` $message * `return void` -Verify that an email does not have a [header](https://datatracker.ietf.org/doc/html/rfc4021) `$headerName`. - -If the Email object is not specified, the last email sent is used instead. +Asserts that the first element matching the given selector contains the expected text. {% highlight php %} <?php -$I->assertEmailNotHasHeader('Bcc'); +$I->assertSelectorTextContains('h1', 'Dashboard'); {% endhighlight %} -#### assertEmailTextBodyContains +#### assertSelectorTextNotContains +* `param string` $selector * `param string` $text -* `param ?\Symfony\Component\Mime\Email` $email +* `param string` $message * `return void` -Verify the text body of an email contains a `$text`. - -If the Email object is not specified, the last email sent is used instead. +Asserts that the first element matching the given selector does not contain the expected text. {% highlight php %} <?php -$I->assertEmailTextBodyContains('Example text body'); +$I->assertSelectorTextNotContains('p', 'error'); {% endhighlight %} -#### assertEmailTextBodyNotContains +#### assertSelectorTextSame +* `param string` $selector * `param string` $text -* `param ?\Symfony\Component\Mime\Email` $email +* `param string` $message * `return void` -Verify that the text body of an email does not contain a `$text`. - -If the Email object is not specified, the last email sent is used instead. +Asserts that the text of the first element matching the given selector equals the expected text. {% highlight php %} <?php -$I->assertEmailTextBodyNotContains('My secret text body'); +$I->assertSelectorTextSame('h1', 'Dashboard'); {% endhighlight %} @@ -664,7 +1473,7 @@ You can set additional cookie params like `domain`, `path` as array passed in la * `param string` $uri * `return void` -Checks that the current URL doesn't equal the given string. +Checks that the current URL (path) doesn't equal the given string. Unlike `dontSeeInCurrentUrl`, this only matches the full URL. @@ -682,13 +1491,29 @@ $I->dontSeeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that current url doesn't match the given regular expression. +Checks that current URL (path) doesn't match the given regular expression. {% highlight php %} <?php // to match root url -$I->dontSeeCurrentUrlMatches('~^/users/(\d+)~'); +$I->dontSeeCurrentUrlMatches('~^/users/\d+$~'); + +{% endhighlight %} + + +#### dontSeeDeprecations + +* `param string` $message Optional custom failure message. +* `return void` + +Asserts that there are no deprecation messages in Symfony's log. + +{% highlight php %} + +<?php +$I->amOnPage('/home'); +$I->dontSeeDeprecations(); {% endhighlight %} @@ -721,42 +1546,47 @@ $I->dontSeeElement('input', ['value' => '123456']); Checks that no email was sent. The check is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means: -If your app performs an HTTP redirect, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first; otherwise this check will *always* pass. +If your app performs an HTTP redirect, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first; otherwise this check will *always* pass. + +{% highlight php %} + +<?php +$I->dontSeeEmailIsSent(); + +{% endhighlight %} #### dontSeeEvent -* `param string|string[]|null` $expected +* `param class-string|list<class-string>|null` $expected Fully-qualified event class(es) that must **not** appear. * `return void` -Verifies that there were no events during the test. - -Both regular and orphan events are checked. +Verifies that **no** events (regular **or** orphan) were dispatched during the test. {% highlight php %} - <?php - $I->dontSeeEvent(); - $I->dontSeeEvent('App\MyEvent'); - $I->dontSeeEvent(['App\MyEvent', 'App\MyOtherEvent']); - +<?php +$I->dontSeeEvent(); +$I->dontSeeEvent('App\MyEvent'); +$I->dontSeeEvent(['App\MyEvent', 'App\MyOtherEvent']); + {% endhighlight %} #### dontSeeEventListenerIsCalled -* `param class-string|class-string[]` $expected -* `param string|string[]` $events +* `param class-string|object|list<class-string|object>` $expected Listeners (class-strings or object instances). +* `param string|list<string>` $events Event name(s) (empty = any). * `return void` -Verifies that one or more event listeners were not called during the test. +Verifies that one or more **listeners** were **not** called during the test. {% highlight php %} <?php $I->dontSeeEventListenerIsCalled('App\MyEventListener'); $I->dontSeeEventListenerIsCalled(['App\MyEventListener', 'App\MyOtherEventListener']); -$I->dontSeeEventListenerIsCalled('App\MyEventListener', 'my.event); +$I->dontSeeEventListenerIsCalled('App\MyEventListener', 'my.event'); $I->dontSeeEventListenerIsCalled('App\MyEventListener', ['my.event', 'my.other.event']); {% endhighlight %} @@ -765,7 +1595,7 @@ $I->dontSeeEventListenerIsCalled('App\MyEventListener', ['my.event', 'my.other.e #### dontSeeEventTriggered @deprecated -* `param object|string|string[]` $expected +* `param class-string|object|list<class-string|object>` $expected * `return void` Verifies that one or more event listeners were not called during the test. @@ -780,6 +1610,20 @@ $I->dontSeeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']); {% endhighlight %} +#### dontSeeFallbackTranslations + +* `return void` + +Asserts that no fallback translations were found. + +{% highlight php %} + +<?php +$I->dontSeeFallbackTranslations(); + +{% endhighlight %} + + #### dontSeeFormErrors * `return void` @@ -799,7 +1643,7 @@ $I->dontSeeFormErrors(); * `param string` $uri * `return void` -Checks that the current URI doesn't contain the given string. +Checks that the current URI (path) doesn't contain the given string. {% highlight php %} @@ -939,6 +1783,37 @@ $I->dontSeeLink('Checkout now', '/store/cart.php'); {% endhighlight %} +#### dontSeeMissingTranslations + +* `return void` + +Asserts that no missing translations were found. + +{% highlight php %} + +<?php +$I->dontSeeMissingTranslations(); + +{% endhighlight %} + + +#### dontSeeNotificationIsSent + +* `return void` + +Checks that no notification was sent. + +The check is based on `\Symfony\Component\Notifier\EventListener\NotificationLoggerListener`, which means: +If your app performs an HTTP redirect, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first; otherwise this check will *always* pass. + +{% highlight php %} + +<?php +$I->dontSeeNotificationIsSent(); + +{% endhighlight %} + + #### dontSeeOptionIsSelected * `param ` $selector @@ -957,14 +1832,14 @@ $I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa'); #### dontSeeOrphanEvent -* `param string|string[]` $expected +* `param class-string|list<class-string>|null` $expected Event class(es) that must **not** appear as orphan. * `return void` Verifies that there were no orphan events during the test. An orphan event is an event that was triggered by manually executing the -[`dispatch()`](https://symfony.com/doc/current/components/event_dispatcher.html#dispatch-the-event) method -of the EventDispatcher but was not handled by any listener after it was dispatched. +{@link https://symfony.com/doc/current/components/event_dispatcher.html#dispatch-the-event dispatch()} +method of the EventDispatcher but was not handled by any listener after it was dispatched. {% highlight php %} @@ -1025,7 +1900,7 @@ $I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK); #### dontSeeViolatedConstraint -* `param mixed` $subject +* `param object` $subject * `param ?string` $propertyPath * `param ?string` $constraint * `return void` @@ -1075,6 +1950,66 @@ $I->followRedirect(); {% endhighlight %} +#### getMailerEvent + +* `param int` $index +* `param ?string` $transport +* `return ?\Symfony\Component\Mailer\Event\MessageEvent` + +Returns the mailer event at the specified index. + +{% highlight php %} + +<?php +$event = $I->getMailerEvent(); + +{% endhighlight %} + + +#### getNotifierEvent + +* `param int` $index +* `param ?string` $transportName +* `return ?\Symfony\Component\Notifier\Event\MessageEvent` + +Returns the notifier event at the specified index. + +{% highlight php %} + +<?php +$event = $I->getNotifierEvent(); + +{% endhighlight %} + + +#### getNotifierEvents + +* `param ?string` $transportName +* `return MessageEvent[]` + + +#### getNotifierMessage + +* `param int` $index +* `param ?string` $transportName +* `return ?\Symfony\Component\Notifier\Message\MessageInterface` + +Returns the notifier message at the specified index. + +{% highlight php %} + +<?php +$message = $I->getNotifierMessage(); + +{% endhighlight %} + + +#### getNotifierMessages + +* `param ?string` $transportName +* `return MessageInterface[]` + + #### goToLogoutPath * `return void` @@ -1116,6 +2051,20 @@ You can set additional cookie params like `domain`, `path` in array passed as la If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`. +#### grabDefinedTranslationsCount + +* `return int` The count of defined translations. + +Grabs the count of defined translations. + +{% highlight php %} + +<?php +$count = $I->grabDefinedTranslations(); + +{% endhighlight %} + + #### grabFromCurrentUrl * `param ?string` $uri @@ -1141,7 +2090,7 @@ $uri = $I->grabFromCurrentUrl(); Returns the last sent email. The function is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means: -If your app performs an HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first. +If your app performs an HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first. See also: [grabSentEmails()](https://codeception.com/docs/modules/Symfony#grabSentEmails) {% highlight php %} @@ -1154,6 +2103,25 @@ $I->assertSame('john_doe@example.com', $address->getAddress()); {% endhighlight %} +#### grabLastSentNotification + +* `return ?\Symfony\Component\Notifier\Message\MessageInterface` + +Returns the last sent notification. + +The check is based on `\Symfony\Component\Notifier\EventListener\NotificationLoggerListener`, which means: +If your app performs an HTTP redirect after sending the notification, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first. +See also: [grabSentNotifications()](https://codeception.com/docs/modules/Symfony#grabSentNotifications) + +{% highlight php %} + +<?php +$message = $I->grabLastSentNotification(); +$I->assertSame('Subject', $message->getSubject()); + +{% endhighlight %} + + #### grabMultiple * `param ` $cssOrXpath @@ -1185,17 +2153,17 @@ $aLinks = $I->grabMultiple('a', 'href'); #### grabNumRecords -* `param string` $entityClass The entity class -* `param array` $criteria Optional query criteria +* `param class-string<object>` $entityClass Fully-qualified entity class name +* `param array` $criteria * `return int` -Retrieves number of records from database -'id' is the default search parameter. +Returns the number of rows that match the given criteria for the +specified Doctrine entity. {% highlight php %} <?php -$I->grabNumRecords('User::class', ['name' => 'davert']); +$I->grabNumRecords(User::class, ['status' => 'active']); {% endhighlight %} @@ -1211,7 +2179,7 @@ Grabs current page source code. #### grabParameter * `param string` $parameterName -* `return \UnitEnum|array|string|int|float|bool|null` +* `return array<array-key,` mixed>|bool|string|int|float|UnitEnum|null Grabs a Symfony parameter @@ -1226,32 +2194,31 @@ This only works for explicitly set parameters (just using `bind` for Symfony's d #### grabRepository -* `param object|string` $mixed -* `return ?\Doctrine\ORM\EntityRepository` +* `param object|class-string` $mixed +* `return EntityRepository<object>` -Grab a Doctrine entity repository. - -Works with objects, entities, repositories, and repository interfaces. +Obtains the Doctrine entity repository {@see EntityRepository} +for a given entity, repository class or interface. {% highlight php %} <?php -$I->grabRepository($user); -$I->grabRepository(User::class); -$I->grabRepository(UserRepository::class); -$I->grabRepository(UserRepositoryInterface::class); +$I->grabRepository($user); // entity object +$I->grabRepository(User::class); // entity class +$I->grabRepository(UserRepository::class); // concrete repo +$I->grabRepository(UserRepositoryInterface::class); // interface {% endhighlight %} #### grabSentEmails -* `return \Symfony\Component\Mime\Email[]` +* `return \Symfony\Component\Mime\RawMessage[]` Returns an array of all sent emails. The function is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means: -If your app performs an HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first. +If your app performs an HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first. See also: [grabLastSentEmail()](https://codeception.com/docs/modules/Symfony#grabLastSentEmail) {% highlight php %} @@ -1262,17 +2229,35 @@ $emails = $I->grabSentEmails(); {% endhighlight %} +#### grabSentNotifications + +* `return MessageInterface[]` + +Returns an array of all sent notifications. + +The check is based on `\Symfony\Component\Notifier\EventListener\NotificationLoggerListener`, which means: +If your app performs an HTTP redirect after sending the notification, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first. +See also: [grabLastSentNotification()](https://codeception.com/docs/modules/Symfony#grabLastSentNotification) + +{% highlight php %} + +<?php +$notifications = $I->grabSentNotifications(); + +{% endhighlight %} + + #### grabService * `part` services -* `param string` $serviceId +* `param non-empty-string` $serviceId * `return object` Grabs a service from the Symfony dependency injection container (DIC). -In "test" environment, Symfony uses a special `test.service_container`. +In the "test" environment, Symfony uses a special `test.service_container`. See the "[Public Versus Private Services](https://symfony.com/doc/current/service_container/alias_private.html#marking-services-as-public-private)" documentation. -Services that aren't injected somewhere into your app, need to be defined as `public` to be accessible by Codeception. +Services that aren't injected anywhere in your app, need to be defined as `public` to be accessible by Codeception. {% highlight php %} @@ -1435,7 +2420,7 @@ Moves back in history. #### persistPermanentService * `part` services -* `param string` $serviceName +* `param non-empty-string` $serviceName * `return void` Get service $serviceName and add it to the lists of persistent services, @@ -1445,7 +2430,7 @@ making that service persistent between tests. #### persistService * `part` services -* `param string` $serviceName +* `param non-empty-string` $serviceName * `return void` Get service $serviceName and add it to the lists of persistent services. @@ -1455,9 +2440,9 @@ Get service $serviceName and add it to the lists of persistent services. * `return void` -Reboot client's kernel. +Reboots the client's kernel. -Can be used to manually reboot kernel when 'rebootable_client' => false +Can be used to manually reboot the kernel when 'rebootable_client' is set to false. {% highlight php %} @@ -1486,11 +2471,11 @@ You can set additional cookie params like `domain`, `path` in array passed as la #### runSymfonyConsoleCommand -* `param string` $command The console command to execute -* `param array` $parameters Parameters (arguments and options) to pass to the command -* `param array` $consoleInputs Console inputs (e.g. used for interactive questions) -* `param int` $expectedExitCode The expected exit code of the command -* `return string` Returns the console output of the command +* `param string` $command The console command to execute. +* `param array` $parameters +* `param list<string>` $consoleInputs Inputs for interactive questions. +* `param int` $expectedExitCode Expected exit code. +* `return string` Console output (stdout). Run Symfony console command, grab response and return as string. @@ -1540,6 +2525,20 @@ But will *not* be true for strings like: For checking the raw source code, use `seeInSource()`. +#### seeAllTranslationsDefined + +* `return void` + +Asserts that there are no missing translations and no fallback translations. + +{% highlight php %} + +<?php +$I->seeAllTranslationsDefined(); + +{% endhighlight %} + + #### seeAuthentication * `return void` @@ -1642,14 +2641,12 @@ $I->seeCurrentTemplateIs('home.html.twig'); * `param string` $uri * `return void` -Checks that the current URL is equal to the given string. - -Unlike `seeInCurrentUrl`, this only matches the full URL. +Checks that the current URL (path) is equal to the given string. {% highlight php %} <?php -// to match root url +// to match the home page $I->seeCurrentUrlEquals('/'); {% endhighlight %} @@ -1660,13 +2657,27 @@ $I->seeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that the current URL matches the given regular expression. +Checks that the current URL (path) matches the given regular expression. {% highlight php %} <?php -// to match root url -$I->seeCurrentUrlMatches('~^/users/(\d+)~'); +$I->seeCurrentUrlMatches('~^/users/\d+$~'); + +{% endhighlight %} + + +#### seeDefaultLocaleIs + +* `param string` $expectedLocale The expected default locale +* `return void` + +Asserts that the default locale is the expected one. + +{% highlight php %} + +<?php +$I->seeDefaultLocaleIs('en'); {% endhighlight %} @@ -1704,7 +2715,12 @@ $I->seeElement(['css' => 'form input'], ['name' => 'login']); Checks if the given number of emails was sent (default `$expectedCount`: 1). The check is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means: -If your app performs an HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first. +If your app performs an HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first. + +Limitation: +If your mail is sent in a Symfony console command and you start that command in your test with [$I->runShellCommand()](https://codeception.com/docs/modules/Cli#runShellCommand), +Codeception will not notice it. +As a more professional alternative, we recommend Mailpit (see [Addons](https://codeception.com/addons)), which also lets you test the content of the mail. {% highlight php %} @@ -1716,39 +2732,34 @@ $I->seeEmailIsSent(2); #### seeEvent -* `param string|string[]` $expected +* `param class-string|list<class-string>` $expected Fully-qualified class-name(s) of the expected event(s). * `return void` -Verifies that one or more events were dispatched during the test. - -Both regular and orphan events are checked. - -If you need to verify that expected event is not orphan, -add `dontSeeOrphanEvent` call. +Verifies that at least one of the given events **was** dispatched (regular **or** orphan). {% highlight php %} - <?php - $I->seeEvent('App\MyEvent'); - $I->seeEvent(['App\MyEvent', 'App\MyOtherEvent']); - +<?php +$I->seeEvent('App\MyEvent'); +$I->seeEvent(['App\MyEvent', 'App\MyOtherEvent']); + {% endhighlight %} #### seeEventListenerIsCalled -* `param class-string|class-string[]` $expected -* `param string|string[]` $events +* `param class-string|object|list<class-string|object>` $expected Listeners (class-strings or object instances). +* `param string|list<string>` $events Event name(s) (empty = any). * `return void` -Verifies that one or more event listeners were called during the test. +Verifies that one or more **listeners** were called during the test. {% highlight php %} <?php $I->seeEventListenerIsCalled('App\MyEventListener'); $I->seeEventListenerIsCalled(['App\MyEventListener', 'App\MyOtherEventListener']); -$I->seeEventListenerIsCalled('App\MyEventListener', 'my.event); +$I->seeEventListenerIsCalled('App\MyEventListener', 'my.event'); $I->seeEventListenerIsCalled('App\MyEventListener', ['my.event', 'my.other.event']); {% endhighlight %} @@ -1757,7 +2768,7 @@ $I->seeEventListenerIsCalled('App\MyEventListener', ['my.event', 'my.other.event #### seeEventTriggered @deprecated -* `param object|string|string[]` $expected +* `param class-string|object|list<class-string|object>` $expected * `return void` Verifies that one or more event listeners were called during the test. @@ -1772,10 +2783,40 @@ $I->seeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']); {% endhighlight %} +#### seeFallbackLocalesAre + +* `param string[]` $expectedLocales The expected fallback locales +* `return void` + +Asserts that the fallback locales match the expected ones. + +{% highlight php %} + +<?php +$I->seeFallbackLocalesAre(['es', 'fr']); + +{% endhighlight %} + + +#### seeFallbackTranslationsCountLessThan + +* `param int` $limit Maximum count of fallback translations +* `return void` + +Asserts that the count of fallback translations is less than the given limit. + +{% highlight php %} + +<?php +$I->seeFallbackTranslationsCountLessThan(10); + +{% endhighlight %} + + #### seeFormErrorMessage * `param string` $field -* `param string|null` $message +* `param ?string` $message * `return void` Verifies that a form field has an error. @@ -1793,7 +2834,7 @@ $I->seeFormErrorMessage('username', 'Username is empty'); #### seeFormErrorMessages -* `param string[]` $expectedErrors +* `param array` $expectedErrors * `return void` Verifies that multiple fields on a form have errors. @@ -1811,7 +2852,6 @@ $I->seeFormErrorMessages(['telephone', 'address']); If you want to specify the error messages, you can do so by sending an associative array instead, with the key being the name of the field and the error message the value. - This method will validate that the expected error message is contained in the actual error message, that is, you can specify either the entire error message or just a part of it: @@ -1820,7 +2860,7 @@ you can specify either the entire error message or just a part of it: <?php $I->seeFormErrorMessages([ - 'address' => 'The address is too long' + 'address' => 'The address is too long', 'telephone' => 'too short', // the full error message is 'The telephone is too short' ]); @@ -1864,7 +2904,7 @@ $I->seeFormHasErrors(); Checks that current url matches route. -Unlike seeCurrentRouteIs, this can matches without exact route parameters +Unlike seeCurrentRouteIs, this can match without exact route parameters {% highlight php %} @@ -1976,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 %} @@ -2050,14 +3090,47 @@ $I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a> {% endhighlight %} +#### seeMissingTranslationsCountLessThan + +* `param int` $limit Maximum count of missing translations +* `return void` + +Asserts that the count of missing translations is less than the given limit. + +{% highlight php %} + +<?php +$I->seeMissingTranslationsCountLessThan(5); + +{% endhighlight %} + + +#### seeNotificationIsSent + +* `param int` $expectedCount The expected number of notifications sent +* `return void` + +Checks if the given number of notifications was sent (default `$expectedCount`: 1). + +The check is based on `\Symfony\Component\Notifier\EventListener\NotificationLoggerListener`, which means: +If your app performs an HTTP redirect after sending the notification, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first. + +{% highlight php %} + +<?php +$I->seeNotificatoinIsSent(2); + +{% endhighlight %} + + #### seeNumRecords -* `param int` $expectedNum Expected number of records -* `param string` $className A doctrine entity -* `param array` $criteria Optional query criteria +* `param int` $expectedNum Expected count +* `param class-string<object>` $className Entity class +* `param array` $criteria * `return void` -Checks that number of given records were found in database. +Asserts that a given number of records exists for the entity. 'id' is the default search parameter. @@ -2105,14 +3178,14 @@ $I->seeOptionIsSelected('#form input[name=payment]', 'Visa'); #### seeOrphanEvent -* `param string|string[]` $expected +* `param class-string|list<class-string>` $expected Event class-name(s) expected to be orphan. * `return void` -Verifies that one or more orphan events were dispatched during the test. +Verifies that one or more orphan events **were** dispatched during the test. An orphan event is an event that was triggered by manually executing the -[`dispatch()`](https://symfony.com/doc/current/components/event_dispatcher.html#dispatch-the-event) method -of the EventDispatcher but was not handled by any listener after it was dispatched. +{@link https://symfony.com/doc/current/components/event_dispatcher.html#dispatch-the-event dispatch()} +method of the EventDispatcher but was not handled by any listener after it was dispatched. {% highlight php %} @@ -2125,12 +3198,12 @@ $I->seeOrphanEvent(['App\MyEvent', 'App\MyOtherEvent']); #### seePageIsAvailable -* `param string|null` $url +* `param string|null` $url The URL of the page to check. If null, the current page is checked. * `return void` Verifies that a page is available. -By default, it checks the current page, specify the `$url` parameter to change it. +By default, it checks the current page. Specify the `$url` parameter to change the page being checked. {% highlight php %} @@ -2156,7 +3229,7 @@ Asserts that current page has 404 response status code. * `param string` $redirectsTo * `return void` -Goes to a page and check that it redirects to another. +Navigates to a page and verifies that it redirects to another page. {% highlight php %} @@ -2323,7 +3396,7 @@ $I->seeUserHasRoles(['ROLE_USER', 'ROLE_ADMIN']); Checks that the user's password would not benefit from rehashing. -If the user is not provided it is taken from the current session. +If the user is not provided, it is taken from the current session. You might use this function after performing tasks like registering a user or submitting a password update form. @@ -2338,7 +3411,7 @@ $I->seeUserPasswordDoesNotNeedRehash($user); #### seeViolatedConstraint -* `param mixed` $subject +* `param object` $subject * `param ?string` $propertyPath * `param ?string` $constraint * `return void` @@ -2360,7 +3433,7 @@ $I->seeViolatedConstraint($subject, 'propertyName', 'Symfony\Validator\Constrain #### seeViolatedConstraintMessage * `param string` $expected -* `param mixed` $subject +* `param object` $subject * `param string` $propertyPath * `return void` @@ -2377,7 +3450,7 @@ $I->seeViolatedConstraintMessage('too short', $user, 'address'); #### seeViolatedConstraintsCount * `param int` $expected -* `param mixed` $subject +* `param object` $subject * `param ?string` $propertyPath * `param ?string` $constraint * `return void` @@ -2766,14 +3839,14 @@ $I->submitForm('#my-form', [ #### submitSymfonyForm -* `param string` $name The `name` attribute of the `<form>` (you cannot use an array as selector here) -* `param string[]` $fields +* `param string` $name The `name` attribute of the `<form>`. You cannot use an array as a selector here. +* `param array` $fields * `return void` -Submit a form specifying the form name only once. +Submits a form by specifying the form name only once. Use this function instead of [`$I->submitForm()`](#submitForm) to avoid repeating the form name in the field selectors. -If you customized the names of the field selectors use `$I->submitForm()` for full control. +If you have customized the names of the field selectors, use `$I->submitForm()` for full control. {% highlight php %} diff --git a/docs/modules/WebDriver.md b/docs/modules/WebDriver.md index 6c227098a..1641febfd 100644 --- a/docs/modules/WebDriver.md +++ b/docs/modules/WebDriver.md @@ -83,7 +83,7 @@ Tests can be executed directly through ChromeDriver or GeckoDriver (for Firefox) #### ChromeDriver -* Download and install [ChromeDriver](https://sites.google.com/chromium.org/driver/downloads?authuser=0) +* Download and install [ChromeDriver](https://sites.google.com/chromium.org/driver/downloads) * Launch ChromeDriver in a separate console window: `chromedriver --url-base=/wd/hub`. Configuration in `Acceptance.suite.yml`: @@ -104,7 +104,7 @@ modules: download.default_directory: "..." {% endhighlight %} -See here for additional [Chrome options](https://sites.google.com/a/chromium.org/chromedriver/capabilities) +See here for additional [Chrome options](https://sites.google.com/chromium.org/driver/capabilities) #### GeckoDriver @@ -250,7 +250,7 @@ modules: * `ssl_proxy` - sets ssl(https) proxy server url for testing a remote server. * `ssl_proxy_port` - sets ssl(https) proxy server port * `debug_log_entries` - how many selenium entries to print with `debugWebDriverLogs` or on fail (0 by default). -* `log_js_errors` - Set to true to include possible JavaScript to HTML report, or set to false (default) to deactivate. +* `log_js_errors` - Set to true to include possible JavaScript to HTML report, or set to false (default) to deactivate. This will only work if `debug_log_entries` is set and its value is > 0. Also this will display JS errors as comments only if test fails. * `webdriver_proxy` - sets http proxy to tunnel requests to the remote Selenium WebDriver through * `webdriver_proxy_port` - sets http proxy server port to tunnel requests to the remote Selenium WebDriver through @@ -942,7 +942,7 @@ You can set additional cookie params like `domain`, `path` as array passed in la * `param string` $uri * `return void` -Checks that the current URL doesn't equal the given string. +Checks that the current URL (path) doesn't equal the given string. Unlike `dontSeeInCurrentUrl`, this only matches the full URL. @@ -960,13 +960,13 @@ $I->dontSeeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that current url doesn't match the given regular expression. +Checks that current URL (path) doesn't match the given regular expression. {% highlight php %} <?php // to match root url -$I->dontSeeCurrentUrlMatches('~^/users/(\d+)~'); +$I->dontSeeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -1006,7 +1006,7 @@ Opposite of `seeElementInDOM`. * `param string` $uri * `return void` -Checks that the current URI doesn't contain the given string. +Checks that the current URI (path) doesn't contain the given string. {% highlight php %} @@ -1584,25 +1584,25 @@ In 3rd argument you can set number a seconds to wait for element to appear #### pressKey * `param string|array|WebDriverBy` $element -* `param ` $chars +* `param string|list<string>` $chars Can be char or array with modifier. You can provide several chars. * `throws ElementNotFound` * `return void` Presses the given key on the given element. -To specify a character and modifier (e.g. <kbd>Ctrl</kbd>, Alt, Shift, Meta), pass an array for `$char` with +To specify a character and modifier (e.g. <kbd>Ctrl</kbd>, <kbd>Alt</kbd>, <kbd>Shift</kbd>, <kbd>Meta</kbd>), pass an array for `$char` with the modifier as the first element and the character as the second. -For special keys, use the constants from [`Facebook\WebDriver\WebDriverKeys`](https://github.com/php-webdriver/php-webdriver/blob/main/lib/WebDriverKeys.php). +For special keys, use the constants from [Facebook\WebDriver\WebDriverKeys](https://github.com/php-webdriver/php-webdriver/blob/main/lib/WebDriverKeys.php). {% highlight php %} <?php // <input id="page" value="old"> $I->pressKey('#page', 'a'); // => olda -$I->pressKey('#page', ['ctrl', 'a'],'new'); //=> new -$I->pressKey('#page', ['shift', '111'],'1','x'); //=> old!!!1x -$I->pressKey('descendant-or-self::*[@id='page']','u'); //=> oldu -$I->pressKey('#name', ['ctrl', 'a'], \Facebook\WebDriver\WebDriverKeys::DELETE); //=>'' +$I->pressKey('#page', ['ctrl', 'a'],'new'); // => new +$I->pressKey('#page', ['shift', '111'], '1', 'x'); // => old!!!1x +$I->pressKey('descendant-or-self::*[@id='page']', 'u'); // => oldu +$I->pressKey('#name', ['ctrl', 'a'], \Facebook\WebDriver\WebDriverKeys::DELETE); // =>'' {% endhighlight %} @@ -1611,7 +1611,7 @@ $I->pressKey('#name', ['ctrl', 'a'], \Facebook\WebDriver\WebDriverKeys::DELETE); * `return void` -Reloads the current page. +Reloads the current page. All forms will be reset, so the outcome is as if the user would press <kbd>Ctrl</kbd>+<kbd>F5</kbd>. #### resetCookie @@ -1774,14 +1774,12 @@ $I->seeCookie('PHPSESSID'); * `param string` $uri * `return void` -Checks that the current URL is equal to the given string. - -Unlike `seeInCurrentUrl`, this only matches the full URL. +Checks that the current URL (path) is equal to the given string. {% highlight php %} <?php -// to match root url +// to match the home page $I->seeCurrentUrlEquals('/'); {% endhighlight %} @@ -1792,13 +1790,12 @@ $I->seeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that the current URL matches the given regular expression. +Checks that the current URL (path) matches the given regular expression. {% highlight php %} <?php -// to match root url -$I->seeCurrentUrlMatches('~^/users/(\d+)~'); +$I->seeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -1946,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 96f91770a..b2a0daea7 100644 --- a/docs/modules/Yii2.md +++ b/docs/modules/Yii2.md @@ -160,8 +160,8 @@ commands that expect a URL: {% highlight php %} <?php -$I->amOnPage('index-test.php?site/index'); -$I->amOnPage('http://localhost/index-test.php?site/index'); +$I->amOnPage('index-test.php?r=site/index'); +$I->amOnPage('http://localhost/index-test.php?r=site/index'); $I->sendAjaxPostRequest(['/user/update', 'id' => 1], ['UserForm[name]' => 'G.Hopper']); {% endhighlight %} @@ -171,7 +171,6 @@ $I->sendAjaxPostRequest(['/user/update', 'id' => 1], ['UserForm[name]' => 'G.Hop Maintainer: **samdark** Stability: **stable** -@property \Codeception\Lib\Connector\Yii2 $client ### Actions @@ -320,8 +319,9 @@ Authenticates user for HTTP_AUTH #### amLoggedInAs -* `param ` $user +* `param \yii\web\IdentityInterface|string|int` $user * `throws \Codeception\Exception\ModuleException` +* `return void` Authenticates a user on a site without submitting a login form. @@ -343,10 +343,10 @@ Requires the `user` component to be enabled and configured. #### amOnPage -* `param string` $page the page URI +* `param string` $page * `return void` -Opens the page for the given relative URI or route. +Opens the page for the given relative URI. {% highlight php %} @@ -523,7 +523,7 @@ You can set additional cookie params like `domain`, `path` as array passed in la * `param string` $uri * `return void` -Checks that the current URL doesn't equal the given string. +Checks that the current URL (path) doesn't equal the given string. Unlike `dontSeeInCurrentUrl`, this only matches the full URL. @@ -541,13 +541,13 @@ $I->dontSeeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that current url doesn't match the given regular expression. +Checks that current URL (path) doesn't match the given regular expression. {% highlight php %} <?php // to match root url -$I->dontSeeCurrentUrlMatches('~^/users/(\d+)~'); +$I->dontSeeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -586,7 +586,7 @@ Checks that no email was sent * `param string` $uri * `return void` -Checks that the current URI doesn't contain the given string. +Checks that the current URI (path) doesn't contain the given string. {% highlight php %} @@ -728,7 +728,7 @@ $I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa'); #### dontSeeRecord * `part` orm -* `param ` $model +* `param class-string<\yii\db\ActiveRecord>` $model * `param array` $attributes * `return void` @@ -818,9 +818,9 @@ $I->grabAttributeFrom('#tooltip', 'title'); #### grabComponent @deprecated -* `param ` $component +* `param string` $component * `throws \Codeception\Exception\ModuleException` -* `return mixed` +* `return ?object` Gets a component from the Yii container. Throws an exception if the component is not available @@ -957,9 +957,9 @@ Grabs current page source code. #### grabRecord * `part` orm -* `param ` $model +* `param class-string<\yii\db\ActiveRecord>` $model * `param array` $attributes -* `return mixed` +* `return \yii\db\ActiveRecord|array|null` Retrieves a record from the database @@ -1035,6 +1035,7 @@ $name = $I->grabValueFrom(['name' => 'username']); * `part` fixtures * `param ` $fixtures +* `return void` Creates and loads fixtures from a config. @@ -1108,9 +1109,10 @@ $I->haveHttpHeader('Client_Id', 'Codeception'); #### haveRecord +* `template` T of \yii\db\ActiveRecord * `part` orm -* `param ` $model -* `param array` $attributes +* `param class-string<T>` $model +* `param ` $attributes * `return mixed` Inserts a record into the database. @@ -1252,14 +1254,12 @@ $I->seeCookie('PHPSESSID'); * `param string` $uri * `return void` -Checks that the current URL is equal to the given string. - -Unlike `seeInCurrentUrl`, this only matches the full URL. +Checks that the current URL (path) is equal to the given string. {% highlight php %} <?php -// to match root url +// to match the home page $I->seeCurrentUrlEquals('/'); {% endhighlight %} @@ -1270,13 +1270,12 @@ $I->seeCurrentUrlEquals('/'); * `param string` $uri * `return void` -Checks that the current URL matches the given regular expression. +Checks that the current URL (path) matches the given regular expression. {% highlight php %} <?php -// to match root url -$I->seeCurrentUrlMatches('~^/users/(\d+)~'); +$I->seeCurrentUrlMatches('~^/users/\d+$~'); {% endhighlight %} @@ -1309,7 +1308,7 @@ $I->seeElement(['css' => 'form input'], ['name' => 'login']); #### seeEmailIsSent * `part` email -* `param int` $num +* `param int|null` $num * `throws \Codeception\Exception\ModuleException` * `return void` @@ -1429,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 %} @@ -1529,7 +1528,7 @@ Asserts that current page has 404 response status code. #### seeRecord * `part` orm -* `param ` $model +* `param class-string<\yii\db\ActiveRecord>` $model * `param array` $attributes * `return void` diff --git a/docs/reference/Autoload.md b/docs/reference/Autoload.md index 6cef6bad9..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.1/src/Codeception/Util/Autoload.php#L53) +[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.1/src/Codeception/Util/Autoload.php#L80) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Util/Autoload.php#L75) -<p> </p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Util/Autoload.php">Help us to improve documentation. Edit module reference</a></div> +<p> </p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/main/src/Codeception/Util/Autoload.php">Help us to improve documentation. Edit module reference</a></div> diff --git a/docs/reference/Commands.md b/docs/reference/Commands.md index f8bf508fd..5960d3e42 100644 --- a/docs/reference/Commands.md +++ b/docs/reference/Commands.md @@ -5,19 +5,6 @@ title: Commands - Codeception - Documentation # Console Commands -## GenerateTest - -Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`. - -* `codecept g:test unit User` -* `codecept g:test unit "App\User"` - - - -## Init - - - ## Build Generates Actor classes (initially Guy classes) from suite configs. @@ -29,13 +16,11 @@ Starting from Codeception 2.0 actor classes are auto-generated. Use this command -## SelfUpdate - -Auto-updates phar archive from official site: 'https://codeception.com/codecept.phar' . +## Console -* `php codecept.phar self-update` +Try to execute test commands in run-time. You may try commands before writing the test. -@author Franck Cassedanne <franck@cassedanne.com> +* `codecept console Acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands. @@ -46,80 +31,101 @@ 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 +* `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 -## GenerateScenarios +## GenerateSnapshot -Generates user-friendly text scenarios from scenario-driven tests (Cest). +Generates Snapshot. +Snapshot can be used to test dynamical data. +If suite name is provided, an actor class will be included into placeholder -* `codecept g: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 +* `codecept g:snapshot UserEmails` +* `codecept g:snapshot Products` +* `codecept g:snapshot Acceptance UserEmails` -## GenerateCest +## GenerateFeature -Generates Cest (scenario-driven object-oriented test) file: +Generates Feature file (in Gherkin): -* `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 generate:feature suite Login` +* `codecept g:feature suite subdir/subdir/login.feature` +* `codecept g:feature suite login.feature -c path/to/project` -## GenerateSnapshot +## GherkinSteps -Generates Snapshot. -Snapshot can be used to test dynamical data. -If suite name is provided, an actor class will be included into placeholder +Prints all steps from all Gherkin contexts for a specific suite -* `codecept g:snapshot UserEmails` -* `codecept g:snapshot Products` -* `codecept g:snapshot acceptance UserEmails` +{% highlight yaml %} +codecept gherkin:steps Acceptance +{% endhighlight %} -## GeneratePageObject -Generates PageObject. Can be generated either globally, or just for one suite. -If PageObject is generated globally it will act as UIMap, without any logic in it. +## CompletionFallback -* `codecept g:page Login` -* `codecept g:page Registration` -* `codecept g:page acceptance Login` +## GenerateStepObject -## GherkinSteps +Generates StepObject class. You will be asked for steps you want to implement. -Prints all steps from all Gherkin contexts for a specific suite +* `codecept g:stepobject Acceptance AdminSteps` +* `codecept g:stepobject Acceptance UserSteps --silent` - skip action questions -{% highlight yaml %} -codecept gherkin:steps acceptance -{% endhighlight %} +## GenerateHelper +Creates empty Helper class. -## GenerateSuite +* `codecept g:helper MyHelper` +* `codecept g:helper "My\Helper"` -Create new test suite. Requires suite name and actor name -* `` -* `codecept g:suite api` -> api + ApiTester -* `codecept g:suite integration Code` -> integration + CodeTester -* `codecept g:suite frontend Front` -> frontend + FrontTester +## GenerateEnvironment + +Generates empty environment configuration file into envs dir: + + * `codecept g:env firefox` + +Required to have `envs` path to be specified in `codeception.yml` + + + +## DryRun + +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` + + + + +## GenerateScenarios + +Generates user-friendly text scenarios from scenario-driven tests (Cest). + +* `codecept g:scenarios Acceptance` - for all acceptance tests +* `codecept g:scenarios Acceptance --format html` - in html format +* `codecept g:scenarios Acceptance --path doc` - generate scenarios to `doc` dir + ## Run @@ -128,16 +134,16 @@ Executes tests. Usage: -* `codecept run acceptance`: run all acceptance tests -* `codecept run tests/acceptance/MyCest.php`: run only MyCest -* `codecept run acceptance MyCest`: same as above -* `codecept run acceptance MyCest:myTestInIt`: run one test from a Cest -* `codecept run acceptance MyCest:myTestInIt#1`: run one example or data provider item by number -* `codecept run acceptance MyCest:myTestInIt#1-3`: run a range of examples or data provider items -* `codecept run acceptance MyCest:myTestInIt@name.*`: run data provider items with matching names -* `codecept run acceptance checkout.feature`: run feature-file -* `codecept run acceptance -g slow`: run tests from *slow* group -* `codecept run unit,functional`: run only unit and functional suites +* `codecept run Acceptance`: run all acceptance tests +* `codecept run tests/Acceptance/MyCest.php`: run only MyCest +* `codecept run Acceptance MyCest`: same as above +* `codecept run Acceptance MyCest:myTestInIt`: run one test from a Cest +* `codecept run Acceptance MyCest:myTestInIt#1`: run one example or data provider item by number +* `codecept run Acceptance MyCest:myTestInIt#1-3`: run a range of examples or data provider items +* `codecept run Acceptance MyCest:myTestInIt@name.*`: run data provider items with matching names +* `codecept run Acceptance checkout.feature`: run feature-file +* `codecept run Acceptance -g slow`: run tests from *slow* group +* `codecept run Unit,Functional`: run only unit and functional suites Verbosity modes: @@ -163,6 +169,10 @@ Run with specific extension * `codecept run --ext DotReporter` run with DotReporter printer * `codecept run --ext "My\Custom\Extension"` run with an extension loaded by class name +Re-Run failed tests + +* `codecept run -g failed` + Full reference: {% highlight yaml %} Arguments: @@ -171,78 +181,46 @@ Arguments: Options: -o, --override=OVERRIDE Override config values (multiple values allowed) - --config (-c) Use custom path for config - --report Show output in compact style - --html Generate html with results (default: "report.html") - --xml Generate JUnit XML Log (default: "report.xml") - --phpunit-xml Generate PhpUnit XML Log (default: "phpunit-report.xml") - --no-redirect Do not redirect to Composer-installed version in vendor/codeception - --colors Use colors in output - --no-colors Force no colors in output (useful to override config file) - --silent Only outputs suite names and final results. Almost the same as `--quiet` - --steps Show steps in output - --debug (-d) Alias for `-vv` - --bootstrap Execute bootstrap script before the test - --coverage Run with code coverage (default: "coverage.serialized") - --coverage-html Generate CodeCoverage HTML report in path (default: "coverage") - --coverage-xml Generate CodeCoverage XML report in file (default: "coverage.xml") - --coverage-text Generate CodeCoverage text report in file (default: "coverage.txt") - --coverage-phpunit Generate CodeCoverage PHPUnit report in file (default: "coverage-phpunit") - --coverage-cobertura Generate CodeCoverage Cobertura report in file (default: "coverage-cobertura") - --no-exit Don't finish with exit code - --group (-g) Groups of tests to be executed (multiple values allowed) - --skip (-s) Skip selected suites (multiple values allowed) - --skip-group (-x) Skip selected groups (multiple values allowed) - --env Run tests in selected environments. (multiple values allowed, environments can be merged with ',') - --fail-fast (-f) Stop after nth failure (defaults to 1) - --no-rebuild Do not rebuild actor classes on start - --help (-h) Display this help message. - --quiet (-q) Do not output any message. Almost the same as `--silent` - --verbose (-v|vv|vvv) Increase the verbosity of messages: `v` for normal output, `vv` for steps and debug, `vvv` for Codeception-internal debug - --version (-V) Display this application version. - --ansi Force ANSI output. - --no-ansi Disable ANSI output. - --no-interaction (-n) Do not ask any interactive question. - --seed Use the given seed for shuffling tests + --config (-c) Use custom path for config + --report Show output in compact style + --html Generate html with results (default: "report.html") + --xml Generate JUnit XML Log (default: "report.xml") + --phpunit-xml Generate PhpUnit XML Log (default: "phpunit-report.xml") + --no-redirect Do not redirect to Composer-installed version in vendor/codeception + --colors Use colors in output + --no-colors Force no colors in output (useful to override config file) + --silent Only outputs suite names and final results. Almost the same as `--quiet` + --steps Show steps in output + --debug (-d) Alias for `-vv` + --bootstrap Execute bootstrap script before the test + --coverage Run with code coverage (default: "coverage.serialized") + --disable-coverage-php Don't generate CodeCoverage report in raw PHP serialized format + --coverage-html Generate CodeCoverage HTML report in path (default: "coverage") + --coverage-xml Generate CodeCoverage XML report in file (default: "coverage.xml") + --coverage-text Generate CodeCoverage text report in file (default: "coverage.txt") + --coverage-phpunit Generate CodeCoverage PHPUnit report in file (default: "coverage-phpunit") + --coverage-cobertura Generate CodeCoverage Cobertura report in file (default: "coverage-cobertura") + --no-exit Don't finish with exit code + --group (-g) Groups of tests to be executed (multiple values allowed) + --skip (-s) Skip selected suites (multiple values allowed) + --skip-group (-x) Skip selected groups (multiple values allowed) + --env Run tests in selected environments. (multiple values allowed, environments can be merged with ',') + --fail-fast (-f) Stop after nth failure (defaults to 1) + --no-rebuild Do not rebuild actor classes on start + --help (-h) Display this help message. + --quiet (-q) Do not output any message. Almost the same as `--silent` + --verbose (-v|vv|vvv) Increase the verbosity of messages: `v` for normal output, `vv` for steps and debug, `vvv` for Codeception-internal debug + --version (-V) Display this application version. + --ansi Force ANSI output. + --no-ansi Disable ANSI output. + --no-interaction (-n) Do not ask any interactive question. + --seed Use the given seed for shuffling tests {% endhighlight %} -## 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 - - - - -## Clean - -Recursively cleans `output` directory and generated code. - -* `codecept clean` - - - - -## GenerateGroup - -Creates empty GroupObject - extension which handles all group events. - -* `codecept g:group Admin` - - - ## ConfigValidate Validates and prints Codeception config. @@ -251,7 +229,7 @@ Use it do debug Yaml configs Check config: * `codecept config`: check global config -* `codecept config unit`: check suite config +* `codecept config Unit`: check suite config Load config: @@ -267,68 +245,93 @@ Check overriding config values (like in `run` command) -## Console +## GeneratePageObject -Try to execute test commands in run-time. You may try commands before writing the test. +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 console acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands. +* `codecept g:page Login` +* `codecept g:page Registration` +* `codecept g:page Acceptance Login` +## GenerateGroup -## GenerateHelper +Creates empty GroupObject - extension which handles all group events. -Creates empty Helper class. +* `codecept g:group Admin` -* `codecept g:helper MyHelper` -* `codecept g:helper "My\Helper"` +## Bootstrap +Creates default config, tests directory and sample suites for current project. +Use this command to start building a test suite. -## GenerateEnvironment +By default, it will create 3 suites **Acceptance**, **Functional**, and **Unit**. -Generates empty environment configuration file into envs dir: +* `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 - * `codecept g:env firefox` -Required to have `envs` path to be specified in `codeception.yml` +## Init -## DryRun -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` +## SelfUpdate +Auto-updates phar archive from official site: 'https://codeception.com/codecept.phar' . +* `php codecept.phar self-update` +@author Franck Cassedanne <franck@cassedanne.com> -## CompletionFallback +## GenerateTest -## GenerateFeature +Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`. + +* `codecept g:test Unit User` +* `codecept g:test Unit "App\User"` -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` +## 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. +## GenerateSuite -* `codecept g:stepobject acceptance AdminSteps` -* `codecept g:stepobject acceptance UserSteps --silent` - skip action questions +Create new test suite. Requires suite name and actor name + +* `` +* `codecept g:suite Api` -> api + ApiTester +* `codecept g:suite Integration Code` -> integration + CodeTester +* `codecept g:suite Frontend Front` -> frontend + FrontTester + + + + +## 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 50d6e4c07..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.1/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.1/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.1/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.1/src/Codeception/Util/Fixtures.php#L28) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Util/Fixtures.php#L28) -<p> </p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Util/Fixtures.php">Help us to improve documentation. Edit module reference</a></div> +<p> </p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/main/src/Codeception/Util/Fixtures.php">Help us to improve documentation. Edit module reference</a></div> 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/HttpCode.md b/docs/reference/HttpCode.md index e015c371a..337b1aefb 100644 --- a/docs/reference/HttpCode.md +++ b/docs/reference/HttpCode.md @@ -16,7 +16,7 @@ Usage: {% highlight php %} <?php -use \Codeception\Util\HttpCode; +use Codeception\Util\HttpCode; // using REST, PhpBrowser, or any Framework module $I->seeResponseCodeIs(HttpCode::OK); diff --git a/docs/reference/InitTemplate.md b/docs/reference/InitTemplate.md index 4582276b0..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.1/src/Codeception/InitTemplate.php#L60) +[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.1/src/Codeception/InitTemplate.php#L237) +[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.1/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.1/src/Codeception/InitTemplate.php#L100) +[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.1/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.1/src/Codeception/InitTemplate.php#L198) +[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.1/src/Codeception/InitTemplate.php#L37) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L37) #### createActor() @@ -123,14 +123,14 @@ $this->ask('do you want to proceed (y/n)', true); * `param string` $name * `param string` $directory -* `param array` $suiteConfig +* `param array<string,mixed>` $suiteConfig * `return void` 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.1/src/Codeception/InitTemplate.php#L210) +[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.1/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.1/src/Codeception/InitTemplate.php#L187) +[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.1/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.1/src/Codeception/InitTemplate.php#L166) +[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.1/src/Codeception/InitTemplate.php#L38) +[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.1/src/Codeception/InitTemplate.php#L32) +[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.1/src/Codeception/InitTemplate.php#L47) +[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.1/src/Codeception/InitTemplate.php#L26) +[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.1/src/Codeception/InitTemplate.php#L193) +[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.1/src/Codeception/InitTemplate.php#L69) +[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.1/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.1/src/Codeception/InitTemplate.php#L126) +[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.1/src/Codeception/InitTemplate.php#L142) +[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.1/src/Codeception/InitTemplate.php#L158) +[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.1/src/Codeception/InitTemplate.php#L134) +[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.1/src/Codeception/InitTemplate.php#L150) +[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.1/src/Codeception/InitTemplate.php#L83) +[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.1/src/Codeception/InitTemplate.php#L309) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php#L304) -<p> </p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/InitTemplate.php">Help us to improve documentation. Edit module reference</a></div> +<p> </p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/main/src/Codeception/InitTemplate.php">Help us to improve documentation. Edit module reference</a></div> 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 %} <?php -use \Codeception\Util\Locator; +use Codeception\Util\Locator; $I->see('Title', Locator::combine('h1','h2','h3')); @@ -43,7 +43,7 @@ You can also combine CSS selector with XPath locator: {% highlight php %} <?php -use \Codeception\Util\Locator; +use Codeception\Util\Locator; $I->fillField(Locator::combine('form input[type=text]','//form/textarea[2]'), 'qwerty'); @@ -121,7 +121,7 @@ Finds element by it's attribute(s) {% highlight php %} <?php -use \Codeception\Util\Locator; +use Codeception\Util\Locator; $I->seeElement(Locator::find('img', ['title' => 'diagram'])); @@ -167,7 +167,7 @@ Matches the *a* element with given URL {% highlight php %} <?php -use \Codeception\Util\Locator; +use Codeception\Util\Locator; $I->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 %} <?php -use \Codeception\Util\Locator; +use Codeception\Util\Locator; $I->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 %} <?php -use \Codeception\Stub\Expected; +use Codeception\Stub\Expected; $user = $this->make('User', [ 'getName' => Expected::never(), @@ -316,7 +316,7 @@ exception. {% highlight php %} <?php -use \Codeception\Stub\Expected; +use Codeception\Stub\Expected; $user = $this->make( 'User', @@ -351,7 +351,7 @@ If the number of invocations is 0 it will throw an exception in verify. {% highlight php %} <?php -use \Codeception\Stub\Expected; +use Codeception\Stub\Expected; $user = $this->make( 'User', @@ -392,8 +392,8 @@ exception. {% highlight php %} <?php -use \Codeception\Stub; -use \Codeception\Stub\Expected; +use Codeception\Stub; +use Codeception\Stub\Expected; $user = $this->make( 'User', diff --git a/docs/reference/Module.md b/docs/reference/Module.md index 0def25231..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.1/src/Codeception/Module.php#L60) +[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.1/src/Codeception/Module.php#L223) +[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.1/src/Codeception/Module.php#L209) +[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.1/src/Codeception/Module.php#L195) +[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.1/src/Codeception/Module.php#L216) +[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.1/src/Codeception/Module.php#L202) +[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.1/src/Codeception/Module.php#L188) +[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.1/src/Codeception/Module.php#L230) +[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.1/src/Codeception/Module.php#L301) +[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.1/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.1/src/Codeception/Module.php#L173) +[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.1/src/Codeception/Module.php#L181) +[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.1/src/Codeception/Module.php#L104) +[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.1/src/Codeception/Module.php#L122) +[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.1/src/Codeception/Module.php#L81) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L80) #### assert() @@ -246,34 +246,37 @@ public function _beforeSuite($settings = []) { * `param array` $arguments * `param bool` $not +* `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L16) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L19) #### assertArrayHasKey() *protected* assertArrayHasKey($key, $array, $message = '') -* `param int|string` $key -* `param array|\ArrayAccess` $array +* `param string|int` $key +* `param \ArrayAccess|array` $array * `param string` $message +* `return void` Asserts that an array has a specified key. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L19) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L21) #### assertArrayNotHasKey() *protected* assertArrayNotHasKey($key, $array, $message = '') -* `param int|string` $key -* `param array|\ArrayAccess` $array +* `param string|int` $key +* `param \ArrayAccess|array` $array * `param string` $message +* `return void` Asserts that an array does not have a specified key. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L30) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L30) #### assertClassHasAttribute() @@ -281,12 +284,13 @@ Asserts that an array does not have a specified key. * `param string` $attributeName -* `param string` $className +* `param class-string` $className * `param string` $message +* `return void` Asserts that a class has a specified attribute. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L38) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L39) #### assertClassHasStaticAttribute() @@ -294,12 +298,13 @@ Asserts that a class has a specified attribute. * `param string` $attributeName -* `param string` $className +* `param class-string` $className * `param string` $message +* `return void` Asserts that a class has a specified static attribute. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L52) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L49) #### assertClassNotHasAttribute() @@ -307,12 +312,13 @@ Asserts that a class has a specified static attribute. * `param string` $attributeName -* `param string` $className +* `param class-string` $className * `param string` $message +* `return void` Asserts that a class does not have a specified attribute. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L60) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L60) #### assertClassNotHasStaticAttribute() @@ -320,12 +326,13 @@ Asserts that a class does not have a specified attribute. * `param string` $attributeName -* `param string` $className +* `param class-string` $className * `param string` $message +* `return void` Asserts that a class does not have a specified static attribute. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L74) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L70) #### assertContains() @@ -333,12 +340,13 @@ Asserts that a class does not have a specified static attribute. * `param mixed` $needle -* `param iterable` $haystack +* `param iterable<mixed>` $haystack * `param string` $message +* `return void` Asserts that a haystack contains a needle. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L86) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L81) #### assertContainsEquals() @@ -346,10 +354,166 @@ Asserts that a haystack contains a needle. * `param mixed` $needle -* `param iterable` $haystack +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L89) + +#### assertContainsNotOnlyArray() + + *protected* assertContainsNotOnlyArray($haystack, $message = '') + + +* `param iterable<mixed>` $haystack * `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L105) -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L94) +#### assertContainsNotOnlyBool() + + *protected* assertContainsNotOnlyBool($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L113) + +#### assertContainsNotOnlyCallable() + + *protected* assertContainsNotOnlyCallable($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L121) + +#### assertContainsNotOnlyClosedResource() + + *protected* assertContainsNotOnlyClosedResource($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L194) + +#### assertContainsNotOnlyFloat() + + *protected* assertContainsNotOnlyFloat($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L129) + +#### assertContainsNotOnlyInstancesOf() + + *protected* assertContainsNotOnlyInstancesOf($className, $haystack, $message = '') + + +* `param class-string` $className +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L138) + +#### assertContainsNotOnlyInt() + + *protected* assertContainsNotOnlyInt($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L146) + +#### assertContainsNotOnlyIterable() + + *protected* assertContainsNotOnlyIterable($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L154) + +#### assertContainsNotOnlyNull() + + *protected* assertContainsNotOnlyNull($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L162) + +#### assertContainsNotOnlyNumeric() + + *protected* assertContainsNotOnlyNumeric($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L170) + +#### assertContainsNotOnlyObject() + + *protected* assertContainsNotOnlyObject($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L178) + +#### assertContainsNotOnlyResource() + + *protected* assertContainsNotOnlyResource($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L186) + +#### assertContainsNotOnlyScalar() + + *protected* assertContainsNotOnlyScalar($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L202) + +#### assertContainsNotOnlyString() + + *protected* assertContainsNotOnlyString($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L210) #### assertContainsOnly() @@ -357,26 +521,171 @@ Asserts that a haystack contains a needle. * `param string` $type -* `param iterable` $haystack +* `param iterable<mixed>` $haystack * `param ?bool` $isNativeType * `param string` $message +* `return void` Asserts that a haystack contains only values of a given type. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L102) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L220) + +#### assertContainsOnlyArray() + + *protected* assertContainsOnlyArray($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L278) + +#### assertContainsOnlyBool() + + *protected* assertContainsOnlyBool($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L286) + +#### assertContainsOnlyCallable() + + *protected* assertContainsOnlyCallable($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L294) + +#### assertContainsOnlyClosedResource() + + *protected* assertContainsOnlyClosedResource($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L358) + +#### assertContainsOnlyFloat() + + *protected* assertContainsOnlyFloat($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L302) #### assertContainsOnlyInstancesOf() *protected* assertContainsOnlyInstancesOf($className, $haystack, $message = '') -* `param string` $className -* `param iterable` $haystack +* `param class-string` $className +* `param iterable<mixed>` $haystack * `param string` $message +* `return void` Asserts that a haystack contains only instances of a given class name. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L110) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L270) + +#### assertContainsOnlyInt() + + *protected* assertContainsOnlyInt($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L310) + +#### assertContainsOnlyIterable() + + *protected* assertContainsOnlyIterable($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L318) + +#### assertContainsOnlyNull() + + *protected* assertContainsOnlyNull($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L326) + +#### assertContainsOnlyNumeric() + + *protected* assertContainsOnlyNumeric($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L334) + +#### assertContainsOnlyObject() + + *protected* assertContainsOnlyObject($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L342) + +#### assertContainsOnlyResource() + + *protected* assertContainsOnlyResource($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L350) + +#### assertContainsOnlyScalar() + + *protected* assertContainsOnlyScalar($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L366) + +#### assertContainsOnlyString() + + *protected* assertContainsOnlyString($haystack, $message = '') + + +* `param iterable<mixed>` $haystack +* `param string` $message +* `return void` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L374) #### assertCount() @@ -384,12 +693,13 @@ Asserts that a haystack contains only instances of a given class name. * `param int` $expectedCount -* `param \Countable|iterable` $haystack +* `param \Countable|iterable<mixed>` $haystack * `param string` $message +* `return void` Asserts the number of elements of an array, Countable or Traversable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L120) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L384) #### assertDirectoryDoesNotExist() @@ -398,10 +708,11 @@ Asserts the number of elements of an array, Countable or Traversable. * `param string` $directory * `param string` $message +* `return void` Asserts that a directory does not exist. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L128) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L392) #### assertDirectoryExists() @@ -410,10 +721,11 @@ Asserts that a directory does not exist. * `param string` $directory * `param string` $message +* `return void` Asserts that a directory exists. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L136) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L400) #### assertDirectoryIsNotReadable() @@ -422,10 +734,11 @@ Asserts that a directory exists. * `param string` $directory * `param string` $message +* `return void` Asserts that a directory exists and is not readable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L144) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L408) #### assertDirectoryIsNotWritable() @@ -434,10 +747,11 @@ Asserts that a directory exists and is not readable. * `param string` $directory * `param string` $message +* `return void` Asserts that a directory exists and is not writable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L152) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L416) #### assertDirectoryIsReadable() @@ -446,10 +760,11 @@ Asserts that a directory exists and is not writable. * `param string` $directory * `param string` $message +* `return void` Asserts that a directory exists and is readable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L160) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L424) #### assertDirectoryIsWritable() @@ -458,10 +773,11 @@ Asserts that a directory exists and is readable. * `param string` $directory * `param string` $message +* `return void` Asserts that a directory exists and is writable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L168) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L432) #### assertDoesNotMatchRegularExpression() @@ -471,22 +787,25 @@ Asserts that a directory exists and is writable. * `param string` $pattern * `param string` $string * `param string` $message +* `return void` Asserts that a string does not match a given regular expression. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L176) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L440) #### assertEmpty() *protected* assertEmpty($actual, $message = '') +* `phpstan-assert` empty $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is empty. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L186) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L452) #### assertEquals() @@ -496,10 +815,11 @@ Asserts that a variable is empty. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L197) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L463) #### assertEqualsCanonicalizing() @@ -509,10 +829,11 @@ Asserts that two variables are equal. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables are equal (canonicalizing). -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L208) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L474) #### assertEqualsIgnoringCase() @@ -522,10 +843,11 @@ Asserts that two variables are equal (canonicalizing). * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables are equal (ignoring case). -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L219) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L485) #### assertEqualsWithDelta() @@ -536,22 +858,25 @@ Asserts that two variables are equal (ignoring case). * `param mixed` $actual * `param float` $delta * `param string` $message +* `return void` Asserts that two variables are equal (with delta). -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L230) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L496) #### assertFalse() *protected* assertFalse($condition, $message = '') +* `phpstan-assert` false $condition * `param mixed` $condition * `param string` $message +* `return void` Asserts that a condition is false. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L240) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L508) #### assertFileDoesNotExist() @@ -560,10 +885,11 @@ Asserts that a condition is false. * `param string` $filename * `param string` $message +* `return void` Asserts that a file does not exist. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L248) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L516) #### assertFileEquals() @@ -573,10 +899,11 @@ Asserts that a file does not exist. * `param string` $expected * `param string` $actual * `param string` $message +* `return void` Asserts that the contents of one file is equal to the contents of another file. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L256) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L524) #### assertFileEqualsCanonicalizing() @@ -586,10 +913,11 @@ Asserts that the contents of one file is equal to the contents of another file. * `param string` $expected * `param string` $actual * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L264) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L532) #### assertFileEqualsIgnoringCase() @@ -599,10 +927,11 @@ Asserts that the contents of one file is equal to the contents of another file ( * `param string` $expected * `param string` $actual * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L272) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L540) #### assertFileExists() @@ -611,10 +940,11 @@ Asserts that the contents of one file is equal to the contents of another file ( * `param string` $filename * `param string` $message +* `return void` Asserts that a file exists. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L280) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L548) #### assertFileIsNotReadable() @@ -623,10 +953,11 @@ Asserts that a file exists. * `param string` $file * `param string` $message +* `return void` Asserts that a file exists and is not readable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L288) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L556) #### assertFileIsNotWritable() @@ -635,10 +966,11 @@ Asserts that a file exists and is not readable. * `param string` $file * `param string` $message +* `return void` Asserts that a file exists and is not writable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L296) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L564) #### assertFileIsReadable() @@ -647,10 +979,11 @@ Asserts that a file exists and is not writable. * `param string` $file * `param string` $message +* `return void` Asserts that a file exists and is readable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L304) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L572) #### assertFileIsWritable() @@ -659,10 +992,11 @@ Asserts that a file exists and is readable. * `param string` $file * `param string` $message +* `return void` Asserts that a file exists and is writable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L312) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L580) #### assertFileNotEquals() @@ -672,10 +1006,11 @@ Asserts that a file exists and is writable. * `param string` $expected * `param string` $actual * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L320) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L588) #### assertFileNotEqualsCanonicalizing() @@ -685,10 +1020,11 @@ Asserts that the contents of one file is not equal to the contents of another fi * `param string` $expected * `param string` $actual * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L328) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L596) #### assertFileNotEqualsIgnoringCase() @@ -698,10 +1034,11 @@ Asserts that the contents of one file is not equal to the contents of another fi * `param string` $expected * `param string` $actual * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L336) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L604) #### assertFileNotExists() @@ -710,10 +1047,11 @@ Asserts that the contents of one file is not equal to the contents of another fi * `param string` $filename * `param string` $message +* `return void` Asserts that a file does not exist. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L41) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L55) #### assertFinite() @@ -722,10 +1060,11 @@ Asserts that a file does not exist. * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is finite. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L346) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L614) #### assertGreaterOrEquals() @@ -735,10 +1074,11 @@ Asserts that a variable is finite. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a value is greater than or equal to another value. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L52) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L66) #### assertGreaterThan() @@ -748,10 +1088,11 @@ Asserts that a value is greater than or equal to another value. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a value is greater than another value. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L357) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L625) #### assertGreaterThanOrEqual() @@ -761,10 +1102,11 @@ Asserts that a value is greater than another value. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a value is greater than or equal to another value. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L368) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L636) #### assertInfinite() @@ -773,71 +1115,83 @@ Asserts that a value is greater than or equal to another value. * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is infinite. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L378) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L646) #### assertInstanceOf() *protected* assertInstanceOf($expected, $actual, $message = '') -* `param string` $expected +* `template` ExpectedType of object +* `phpstan-assert` =ExpectedType $actual +* `param class-string<ExpectedType>` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of a given type. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L388) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L661) #### assertIsArray() *protected* assertIsArray($actual, $message = '') +* `phpstan-assert` array<mixed> $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type array. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L398) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L672) #### assertIsBool() *protected* assertIsBool($actual, $message = '') +* `phpstan-assert` bool $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type bool. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L408) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L684) #### assertIsCallable() *protected* assertIsCallable($actual, $message = '') +* `phpstan-assert` callable $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type callable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L418) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L696) #### assertIsClosedResource() *protected* assertIsClosedResource($actual, $message = '') +* `phpstan-assert` resource $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type resource and is closed. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L428) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L708) #### assertIsEmpty() @@ -846,154 +1200,179 @@ Asserts that a variable is of type resource and is closed. * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is empty. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L62) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L74) #### assertIsFloat() *protected* assertIsFloat($actual, $message = '') +* `phpstan-assert` float $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type float. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L438) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L720) #### assertIsInt() *protected* assertIsInt($actual, $message = '') +* `phpstan-assert` int $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type int. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L448) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L732) #### assertIsIterable() *protected* assertIsIterable($actual, $message = '') +* `phpstan-assert` iterable<mixed> $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type iterable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L458) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L744) #### assertIsNotArray() *protected* assertIsNotArray($actual, $message = '') +* `phpstan-assert` !array<mixed> $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type array. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L468) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L756) #### assertIsNotBool() *protected* assertIsNotBool($actual, $message = '') +* `phpstan-assert` !bool $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type bool. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L478) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L768) #### assertIsNotCallable() *protected* assertIsNotCallable($actual, $message = '') +* `phpstan-assert` !callable $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type callable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L488) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L780) #### assertIsNotClosedResource() *protected* assertIsNotClosedResource($actual, $message = '') +* `phpstan-assert` !resource $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type resource. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L498) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L792) #### assertIsNotFloat() *protected* assertIsNotFloat($actual, $message = '') +* `phpstan-assert` !float $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type float. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L508) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L804) #### assertIsNotInt() *protected* assertIsNotInt($actual, $message = '') +* `phpstan-assert` !int $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type int. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L518) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L816) #### assertIsNotIterable() *protected* assertIsNotIterable($actual, $message = '') +* `phpstan-assert` !iterable<mixed> $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type iterable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L528) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L828) #### assertIsNotNumeric() *protected* assertIsNotNumeric($actual, $message = '') +* `phpstan-assert` !numeric $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type numeric. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L538) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L840) #### assertIsNotObject() *protected* assertIsNotObject($actual, $message = '') +* `phpstan-assert` !object $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type object. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L548) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L852) #### assertIsNotReadable() @@ -1002,46 +1381,53 @@ Asserts that a variable is not of type object. * `param string` $filename * `param string` $message +* `return void` Asserts that a file/dir exists and is not readable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L556) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L860) #### assertIsNotResource() *protected* assertIsNotResource($actual, $message = '') +* `phpstan-assert` !resource $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type resource. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L566) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L872) #### assertIsNotScalar() *protected* assertIsNotScalar($actual, $message = '') +* `psalm-assert` !scalar $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type scalar. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L576) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L884) #### assertIsNotString() *protected* assertIsNotString($actual, $message = '') +* `phpstan-assert` !string $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of type string. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L586) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L896) #### assertIsNotWritable() @@ -1050,34 +1436,39 @@ Asserts that a variable is not of type string. * `param string` $filename * `param string` $message +* `return void` Asserts that a file/dir exists and is not writable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L594) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L904) #### assertIsNumeric() *protected* assertIsNumeric($actual, $message = '') +* `phpstan-assert` numeric $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type numeric. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L604) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L916) #### assertIsObject() *protected* assertIsObject($actual, $message = '') +* `phpstan-assert` object $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type object. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L614) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L928) #### assertIsReadable() @@ -1086,46 +1477,53 @@ Asserts that a variable is of type object. * `param string` $filename * `param string` $message +* `return void` Asserts that a file/dir is readable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L622) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L936) #### assertIsResource() *protected* assertIsResource($actual, $message = '') +* `phpstan-assert` resource $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type resource. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L632) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L948) #### assertIsScalar() *protected* assertIsScalar($actual, $message = '') +* `phpstan-assert` scalar $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type scalar. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L642) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L960) #### assertIsString() *protected* assertIsString($actual, $message = '') +* `phpstan-assert` string $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is of type string. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L652) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L972) #### assertIsWritable() @@ -1134,10 +1532,11 @@ Asserts that a variable is of type string. * `param string` $filename * `param string` $message +* `return void` Asserts that a file/dir exists and is writable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L660) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L980) #### assertJson() @@ -1146,10 +1545,11 @@ Asserts that a file/dir exists and is writable. * `param string` $actualJson * `param string` $message +* `return void` Asserts that a string is a valid JSON string. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L668) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L988) #### assertJsonFileEqualsJsonFile() @@ -1159,10 +1559,11 @@ Asserts that a string is a valid JSON string. * `param string` $expectedFile * `param string` $actualFile * `param string` $message +* `return void` Asserts that two JSON files are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L676) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L996) #### assertJsonFileNotEqualsJsonFile() @@ -1172,10 +1573,11 @@ Asserts that two JSON files are equal. * `param string` $expectedFile * `param string` $actualFile * `param string` $message +* `return void` Asserts that two JSON files are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L684) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1004) #### assertJsonStringEqualsJsonFile() @@ -1185,10 +1587,11 @@ Asserts that two JSON files are not equal. * `param string` $expectedFile * `param string` $actualJson * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L692) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1012) #### assertJsonStringEqualsJsonString() @@ -1198,10 +1601,11 @@ Asserts that the generated JSON encoded object and the content of the given file * `param string` $expectedJson * `param string` $actualJson * `param string` $message +* `return void` Asserts that two given JSON encoded objects or arrays are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L700) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1020) #### assertJsonStringNotEqualsJsonFile() @@ -1211,10 +1615,11 @@ Asserts that two given JSON encoded objects or arrays are equal. * `param string` $expectedFile * `param string` $actualJson * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L708) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1028) #### assertJsonStringNotEqualsJsonString() @@ -1224,10 +1629,11 @@ Asserts that the generated JSON encoded object and the content of the given file * `param string` $expectedJson * `param string` $actualJson * `param string` $message +* `return void` Asserts that two given JSON encoded objects or arrays are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L716) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1036) #### assertLessOrEquals() @@ -1237,10 +1643,11 @@ Asserts that two given JSON encoded objects or arrays are not equal. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a value is smaller than or equal to another value. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L73) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L82) #### assertLessThan() @@ -1250,10 +1657,11 @@ Asserts that a value is smaller than or equal to another value. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a value is smaller than another value. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L727) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1047) #### assertLessThanOrEqual() @@ -1263,10 +1671,11 @@ Asserts that a value is smaller than another value. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a value is smaller than or equal to another value. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L738) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1058) #### assertMatchesRegularExpression() @@ -1276,10 +1685,11 @@ Asserts that a value is smaller than or equal to another value. * `param string` $pattern * `param string` $string * `param string` $message +* `return void` Asserts that a string matches a given regular expression. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L746) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1066) #### assertNan() @@ -1288,19 +1698,21 @@ Asserts that a string matches a given regular expression. * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is nan. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L756) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1076) #### assertNot() - *protected* assertNot($arguments) + *protected* assertNot(array $arguments) -* `param ` $arguments +* `param array` $arguments +* `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L33) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L47) #### assertNotContains() @@ -1308,23 +1720,25 @@ Asserts that a variable is nan. * `param mixed` $needle -* `param iterable` $haystack +* `param iterable<mixed>` $haystack * `param string` $message +* `return void` Asserts that a haystack does not contain a needle. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L766) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1086) #### assertNotContainsEquals() *protected* assertNotContainsEquals($needle, $haystack, $message = '') -* `param ` $needle -* `param iterable` $haystack +* `param mixed` $needle +* `param iterable<mixed>` $haystack * `param string` $message +* `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L771) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L97) #### assertNotContainsOnly() @@ -1332,13 +1746,14 @@ Asserts that a haystack does not contain a needle. * `param string` $type -* `param iterable` $haystack +* `param iterable<mixed>` $haystack * `param ?bool` $isNativeType * `param string` $message +* `return void` Asserts that a haystack does not contain only values of a given type. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L779) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1096) #### assertNotCount() @@ -1346,24 +1761,27 @@ Asserts that a haystack does not contain only values of a given type. * `param int` $expectedCount -* `param \Countable|iterable` $haystack +* `param \Countable|iterable<mixed>` $haystack * `param string` $message +* `return void` Asserts the number of elements of an array, Countable or Traversable. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L789) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1146) #### assertNotEmpty() *protected* assertNotEmpty($actual, $message = '') +* `phpstan-assert` !empty $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not empty. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L799) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1158) #### assertNotEquals() @@ -1373,10 +1791,11 @@ Asserts that a variable is not empty. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L810) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1169) #### assertNotEqualsCanonicalizing() @@ -1386,10 +1805,11 @@ Asserts that two variables are not equal. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables are not equal (canonicalizing). -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L821) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1180) #### assertNotEqualsIgnoringCase() @@ -1399,10 +1819,11 @@ Asserts that two variables are not equal (canonicalizing). * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables are not equal (ignoring case). -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L832) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1191) #### assertNotEqualsWithDelta() @@ -1413,47 +1834,55 @@ Asserts that two variables are not equal (ignoring case). * `param mixed` $actual * `param float` $delta * `param string` $message +* `return void` Asserts that two variables are not equal (with delta). -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L843) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1202) #### assertNotFalse() *protected* assertNotFalse($condition, $message = '') +* `phpstan-assert` !false $condition * `param mixed` $condition * `param string` $message +* `return void` Asserts that a condition is not false. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L853) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1214) #### assertNotInstanceOf() *protected* assertNotInstanceOf($expected, $actual, $message = '') -* `param string` $expected +* `template` ExpectedType of object +* `phpstan-assert` !ExpectedType $actual +* `param class-string<ExpectedType>` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not of a given type. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L863) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1229) #### assertNotNull() *protected* assertNotNull($actual, $message = '') +* `phpstan-assert` !null $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is not null. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L873) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1241) #### assertNotRegExp() @@ -1463,10 +1892,11 @@ Asserts that a variable is not null. * `param string` $pattern * `param string` $string * `param string` $message +* `return void` Asserts that a string does not match a given regular expression. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L81) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L90) #### assertNotSame() @@ -1476,47 +1906,53 @@ Asserts that a string does not match a given regular expression. * `param mixed` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables do not have the same type and value. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L884) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1252) #### assertNotSameSize() *protected* assertNotSameSize($expected, $actual, $message = '') -* `param \Countable|iterable` $expected -* `param \Countable|iterable` $actual +* `param \Countable|iterable<mixed>` $expected +* `param \Countable|iterable<mixed>` $actual * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L895) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1263) #### assertNotTrue() *protected* assertNotTrue($condition, $message = '') +* `phpstan-assert` !true $condition * `param mixed` $condition * `param string` $message +* `return void` Asserts that a condition is not true. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L905) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1275) #### assertNull() *protected* assertNull($actual, $message = '') +* `phpstan-assert` null $actual * `param mixed` $actual * `param string` $message +* `return void` Asserts that a variable is null. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L915) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1287) #### assertObjectHasAttribute() @@ -1526,10 +1962,11 @@ Asserts that a variable is null. * `param string` $attributeName * `param object` $object * `param string` $message +* `return void` Asserts that an object has a specified attribute. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L923) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1295) #### assertObjectNotHasAttribute() @@ -1539,10 +1976,11 @@ Asserts that an object has a specified attribute. * `param string` $attributeName * `param object` $object * `param string` $message +* `return void` Asserts that an object does not have a specified attribute. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L937) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1309) #### assertRegExp() @@ -1552,36 +1990,44 @@ Asserts that an object does not have a specified attribute. * `param string` $pattern * `param string` $string * `param string` $message +* `return void` Asserts that a string matches a given regular expression. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L89) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L98) #### assertSame() *protected* assertSame($expected, $actual, $message = '') -* `param mixed` $expected +* `template` ExpectedType +* `phpstan-assert` =ExpectedType $actual +* `param ExpectedType` $expected * `param mixed` $actual * `param string` $message +* `return void` Asserts that two variables have the same type and value. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L954) +Used on objects, it asserts that two variables reference +the same object. + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1331) #### assertSameSize() *protected* assertSameSize($expected, $actual, $message = '') -* `param \Countable|iterable` $expected -* `param \Countable|iterable` $actual +* `param \Countable|iterable<mixed>` $expected +* `param \Countable|iterable<mixed>` $actual * `param string` $message +* `return void` Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L965) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1341) #### assertStringContainsString() @@ -1591,8 +2037,9 @@ Assert that the size of two arrays (or `Countable` or `Traversable` objects) is * `param string` $needle * `param string` $haystack * `param string` $message +* `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L970) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1346) #### assertStringContainsStringIgnoringCase() @@ -1602,34 +2049,37 @@ Assert that the size of two arrays (or `Countable` or `Traversable` objects) is * `param string` $needle * `param string` $haystack * `param string` $message +* `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L975) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1351) #### assertStringEndsNotWith() *protected* assertStringEndsNotWith($suffix, $string, $message = '') -* `param string` $suffix +* `param non-empty-string` $suffix * `param string` $string * `param string` $message +* `return void` Asserts that a string ends not with a given suffix. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L983) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1360) #### assertStringEndsWith() *protected* assertStringEndsWith($suffix, $string, $message = '') -* `param string` $suffix +* `param non-empty-string` $suffix * `param string` $string * `param string` $message +* `return void` Asserts that a string ends with a given suffix. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L991) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1369) #### assertStringEqualsFile() @@ -1639,10 +2089,11 @@ Asserts that a string ends with a given suffix. * `param string` $expectedFile * `param string` $actualString * `param string` $message +* `return void` Asserts that the contents of a string is equal to the contents of a file. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L999) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1377) #### assertStringEqualsFileCanonicalizing() @@ -1652,10 +2103,11 @@ Asserts that the contents of a string is equal to the contents of a file. * `param string` $expectedFile * `param string` $actualString * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L1007) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1385) #### assertStringEqualsFileIgnoringCase() @@ -1665,10 +2117,11 @@ Asserts that the contents of a string is equal to the contents of a file (canoni * `param string` $expectedFile * `param string` $actualString * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L1015) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1393) #### assertStringMatchesFormat() @@ -1678,10 +2131,11 @@ Asserts that the contents of a string is equal to the contents of a file (ignori * `param string` $format * `param string` $string * `param string` $message +* `return void` Asserts that a string matches a given format string. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1023) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1401) #### assertStringMatchesFormatFile() @@ -1691,10 +2145,11 @@ Asserts that a string matches a given format string. * `param string` $formatFile * `param string` $string * `param string` $message +* `return void` Asserts that a string matches a given format file. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1031) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1409) #### assertStringNotContainsString() @@ -1704,8 +2159,9 @@ Asserts that a string matches a given format file. * `param string` $needle * `param string` $haystack * `param string` $message +* `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1036) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1414) #### assertStringNotContainsStringIgnoringCase() @@ -1715,8 +2171,9 @@ Asserts that a string matches a given format file. * `param string` $needle * `param string` $haystack * `param string` $message +* `return void` -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1041) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1419) #### assertStringNotEqualsFile() @@ -1726,10 +2183,11 @@ Asserts that a string matches a given format file. * `param string` $expectedFile * `param string` $actualString * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L1049) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1427) #### assertStringNotEqualsFileCanonicalizing() @@ -1739,10 +2197,11 @@ Asserts that the contents of a string is not equal to the contents of a file. * `param string` $expectedFile * `param string` $actualString * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L1057) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1435) #### assertStringNotEqualsFileIgnoringCase() @@ -1752,10 +2211,11 @@ Asserts that the contents of a string is not equal to the contents of a file (ca * `param string` $expectedFile * `param string` $actualString * `param string` $message +* `return void` 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.1/src/Codeception/Module.php#L1065) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1443) #### assertStringNotMatchesFormat() @@ -1765,10 +2225,11 @@ Asserts that the contents of a string is not equal to the contents of a file (ig * `param string` $format * `param string` $string * `param string` $message +* `return void` Asserts that a string does not match a given format string. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1073) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1451) #### assertStringNotMatchesFormatFile() @@ -1778,36 +2239,39 @@ Asserts that a string does not match a given format string. * `param string` $formatFile * `param string` $string * `param string` $message +* `return void` Asserts that a string does not match a given format string. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1081) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1461) #### assertStringStartsNotWith() *protected* assertStringStartsNotWith($prefix, $string, $message = '') -* `param string` $prefix +* `param non-empty-string` $prefix * `param string` $string * `param string` $message +* `return void` Asserts that a string starts not with a given prefix. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1089) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1476) #### assertStringStartsWith() *protected* assertStringStartsWith($prefix, $string, $message = '') -* `param string` $prefix +* `param non-empty-string` $prefix * `param string` $string * `param string` $message +* `return void` Asserts that a string starts with a given prefix. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1097) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1485) #### assertThat() @@ -1817,10 +2281,11 @@ Asserts that a string starts with a given prefix. * `param mixed` $value * `param \PHPUnit\Framework\Constraint\Constraint` $constraint * `param string` $message +* `return void` Evaluates a PHPUnit\Framework\Constraint matcher object. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1107) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1495) #### assertThatItsNot() @@ -1830,22 +2295,25 @@ Evaluates a PHPUnit\Framework\Constraint matcher object. * `param mixed` $value * `param \PHPUnit\Framework\Constraint\Constraint` $constraint * `param string` $message +* `return void` Evaluates a PHPUnit\Framework\Constraint matcher object. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L99) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L106) #### assertTrue() *protected* assertTrue($condition, $message = '') +* `phpstan-assert` true $condition * `param mixed` $condition * `param string` $message +* `return void` Asserts that a condition is true. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1117) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1507) #### assertXmlFileEqualsXmlFile() @@ -1855,10 +2323,11 @@ Asserts that a condition is true. * `param string` $expectedFile * `param string` $actualFile * `param string` $message +* `return void` Asserts that two XML files are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1125) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1515) #### assertXmlFileNotEqualsXmlFile() @@ -1868,10 +2337,11 @@ Asserts that two XML files are equal. * `param string` $expectedFile * `param string` $actualFile * `param string` $message +* `return void` Asserts that two XML files are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1133) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1523) #### assertXmlStringEqualsXmlFile() @@ -1881,10 +2351,11 @@ Asserts that two XML files are not equal. * `param string` $expectedFile * `param \DOMDocument|string` $actualXml * `param string` $message +* `return void` Asserts that two XML documents are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1143) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1531) #### assertXmlStringEqualsXmlString() @@ -1894,10 +2365,11 @@ Asserts that two XML documents are equal. * `param \DOMDocument|string` $expectedXml * `param \DOMDocument|string` $actualXml * `param string` $message +* `return void` Asserts that two XML documents are equal. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1154) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1545) #### assertXmlStringNotEqualsXmlFile() @@ -1907,10 +2379,11 @@ Asserts that two XML documents are equal. * `param string` $expectedFile * `param \DOMDocument|string` $actualXml * `param string` $message +* `return void` Asserts that two XML documents are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1164) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1567) #### assertXmlStringNotEqualsXmlString() @@ -1920,10 +2393,11 @@ Asserts that two XML documents are not equal. * `param \DOMDocument|string` $expectedXml * `param \DOMDocument|string` $actualXml * `param string` $message +* `return void` Asserts that two XML documents are not equal. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1175) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1584) #### debug() @@ -1935,20 +2409,20 @@ Asserts that two XML documents are not equal. Print debug message to the screen. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L237) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L235) #### debugSection() - *protected* debugSection($title, $message) + *protected* debugSection($title, $msg) * `param string` $title -* `param mixed` $message +* `param mixed` $msg * `return void` Print debug message with a title -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L245) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L243) #### fail() @@ -1956,10 +2430,11 @@ Print debug message with a title * `param string` $message +* `return never` Fails a test with the given message. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1183) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1604) #### getModule() @@ -1979,7 +2454,7 @@ $this->getModule('WebDriver')->_findElements('.items'); {% endhighlight %} -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L287) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L285) #### getModules() @@ -1990,7 +2465,7 @@ $this->getModule('WebDriver')->_findElements('.items'); Get all enabled modules -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L272) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L270) #### hasModule() @@ -2002,7 +2477,19 @@ Get all enabled modules Checks that module is enabled. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L264) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L262) + +#### hasStaticAttribute() + + *private static* hasStaticAttribute($attributeName, $className) + + +* `see` https://github.com/sebastianbergmann/phpunit/blob/9.6/src/Framework/Constraint/Object/ClassHasStaticAttribute.php +* `param string` $attributeName +* `param class-string` $className +* `return bool` + +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1629) #### markTestIncomplete() @@ -2010,10 +2497,11 @@ Checks that module is enabled. * `param string` $message +* `return never` Mark the test as incomplete. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1191) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1612) #### markTestSkipped() @@ -2021,10 +2509,11 @@ Mark the test as incomplete. * `param string` $message +* `return never` Mark the test as skipped. -[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L1199) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L1620) #### onReconfigure() @@ -2033,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.1/src/Codeception/Module.php#L114) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L113) #### scalarizeArray() @@ -2043,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.1/src/Codeception/Module.php#L312) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L304) #### shortenMessage() @@ -2056,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.1/src/Codeception/Module.php#L256) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L254) #### validateConfig() @@ -2068,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.1/src/Codeception/Module.php#L132) +[See source](https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php#L131) -<p> </p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php">Help us to improve documentation. Edit module reference</a></div> +<p> </p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/main/src/Codeception/Module.php">Help us to improve documentation. Edit module reference</a></div> 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. <div class="alert alert-warning"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> @@ -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`. <div class="alert alert-warning"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> @@ -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 ``` <div class="alert alert-warning"> @@ -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: diff --git a/images/mailpit.svg b/images/mailpit.svg new file mode 100644 index 000000000..41fd0b1a7 --- /dev/null +++ b/images/mailpit.svg @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg width="350" height="190" viewBox="0 0 264.584 243.416" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"> + <defs id="defs10"/> + <rect width="100%" height="100%" fill="#2C3E50" /> + <g transform="translate(65, 65)"> + <path d="M12.321 0l53.861 53.918L120.365 0zM5.155 9.025l60.842 59.673 61.211-59.489-.185 36.835L66.921 70.54l15.164 12.616-8.137 5.986-41.609.184c-4.838-.022-25.877-18.34-27.185-41.255z" fill-opacity=".941" fill="#2d4a5f" id="path2" style="fill:#ffffff;fill-opacity:1"/> + <path d="M78.385 72.049l53.907-21.679-8.031 57.318-11.845-9.132c-21.727 23.171-45.255 26.289-67.997 20.837S12.281 98.39 5.155 83.8-.67 53.116 2.843 38.769c1.13 10.511-1.313 16.316 6.38 33.612 6.31 11.399 14.413 20.417 25.89 24.956 13.9 6.195 32.247 3.357 41.701-3.039l14.24-12.156z" fill="#00b786" id="path4"/> + </g> +</svg> diff --git a/package/README.md b/package/README.md index dcaa60786..07bac74b2 100644 --- a/package/README.md +++ b/package/README.md @@ -2,8 +2,8 @@ This directory contains files necessary for building Phar file Modules excluded from phar file: * datafactory -* doctrine2 -* laravel5 +* doctrine +* laravel * lumen * phalcon * symfony @@ -17,13 +17,7 @@ Additional dependency compared with codeception/codecepion: ### Build instructions 1. Install dependencies by running `composer install` in parent directory. 2. Disable phar.readonly in your php.ini file, it must be `phar.readonly = Off` -3. Build Codeception 4 phar file: - 1. Run `./vendor/bin/robo build:phar72` - 2. Run `./vendor/bin/robo build:phar56` - 3. Run `./vendor/bin/robo release` -4. Build Codeception 5 phar file: - 1. Run `./vendor/bin/robo build:phar80` - 2. Run `./vendor/bin/robo release80` -5. Commit added files and push - -Note: it is necessary to delete package/composer.lock and package/vendor between Codeception 4 and 5 builds. \ No newline at end of file +3. Build Codeception 5.3 phar file + 1. Run `./vendor/bin/robo build:phar82` + 2. Run `./vendor/bin/robo release82` +4. Commit added files and push \ No newline at end of file