+ 
+ 
+ 
+ 
+ 
+ ZF2 Module
+Maintainer
+
Gintautas Miselis
+ +naktibalda
Reference is taken from the source code. '
+ . 'Help us to improve documentation. Edit module reference
'
+ )
+ ->processPropertySignature(function ($r) {
+ return "\n#### $" . $r->name . "\n\n";
+ })
+ ->processPropertyDocBlock(function ($r, $text) {
+ $modifiers = implode(' ', \Reflection::getModifierNames($r->getModifiers()));
+ $text = ' *' . $modifiers . '* **$' . $r->name . "**\n" . $text;
+ $text = preg_replace("~@(.*?)\s(.*)~", 'type `$2`', $text);
+ return $text;
+ })
+ ->processClassDocBlock(
+ function (ReflectionClass $r, $text) {
+ return $text . "\n";
+ }
+ )
+ ->processMethodSignature(function ($r, $text) {
+ return "#### {$r->name}()\n\n" . ltrim($text, '#');
+ })
+ ->processMethodDocBlock(
+ function (ReflectionMethod $r, $text) use ($file, $source) {
+ //$file = str_replace(__DIR__, '', $r->getFileName());
+ //$source = self::REPO_BLOB_URL."/".self::STABLE_BRANCH. $file;
+
+ $line = $r->getStartLine();
+ $text = preg_replace("~^\s?@(.*?)\s~m", ' * `$1` $2', $text);
+ $text .= "\n[See source]($source#L$line)";
+ return "\n" . $text . "\n";
+ }
+ )
+ ->reorderMethods('ksort')
+ ->run();
+ }
+
+ public function changelog() {
+ $this->say('building changelog');
+ $this->taskWriteToFile('changelog.markdown')
+ ->line('---')
+ ->line('layout: page')
+ ->line('title: Codeception Changelog')
+ ->line('---')
+ ->line('')
+ ->line(
+ 'Download specific version at builds page
'
+ )
+ ->line('')
+ ->line('# Changelog')
+ ->line('')
+ ->line($this->processChangelog())
+ ->run();
+ }
+
+ protected function oldProcessChangelog()
+ {
+ $sortByVersionDesc = function (\SplFileInfo $a, \SplFileInfo $b) {
+ $pattern = '/^CHANGELOG-(\d+\.(?:x|\d+)).md$/';
+ if (preg_match($pattern, $a->getBasename(), $matches1) && preg_match($pattern, $b->getBasename(), $matches2)) {
+ return version_compare($matches1[1], $matches2[1]) * -1;
+ }
+ return 0;
+ };
+ $changelogFiles = Finder::create()->name('CHANGELOG-*.md')->in('vendor/codeception/codeception')->depth(0)->sort($sortByVersionDesc);
+ $changelog = "\n";
+ foreach ($changelogFiles as $file) {
+ $changelog .= trim($file->getContents(), "\r\n") . "\n\n";
+ }
+ //user
+ $changelog = preg_replace('~\s@([\w-]+)~', ' **[$1](https://github.com/$1)**', $changelog);
+ //issue
+ $changelog = preg_replace(
+ '~#(\d+)~',
+ '[#$1](https://github.com/Codeception/Codeception/issues/$1)',
+ $changelog
+ );
+ //module
+ $changelog = preg_replace('~\s\[(\w+)\]\s~', ' **[$1]** ', $changelog);
+ return $changelog;
+ }
+
+ /**
+ * @param $name
+ * @param $contents
+ * @return mixed|string|string[]|null
+ */
+ private function postProcessStandardElements($name, $contents)
+ {
+ $highlight_languages = implode('|', [
+ 'php',
+ 'html',
+ 'bash',
+ 'yaml',
+ 'json',
+ 'xml',
+ 'sql',
+ 'gherkin'
+ ]);
+ $contents = preg_replace(
+ "~```\s?($highlight_languages)\b(.*?)```~ms",
+ "{% highlight $1 %}\n$2\n{% endhighlight %}",
+ $contents
+ );
+ $contents = str_replace('{% highlight %}', '{% highlight yaml %}', $contents);
+ $contents = preg_replace("~```\s?(.*?)```~ms", "{% highlight yaml %}\n$1\n{% endhighlight %}", $contents);
+ // set default language in order not to leave unparsed code inside '```'
+
+ $title = $name;
+ $contents = "---\nlayout: doc\ntitle: " . ($title != "" ? $title . " - " : "")
+ . "Codeception - Documentation\n---\n\n" . $contents;
+ return $contents;
+ }
+
+ /**
+ * @param $pageName
+ * @param $documentationFile
+ */
+ private function postProcessFile($pageName, $documentationFile)
+ {
+ $contents = $this->postProcessStandardElements($pageName, file_get_contents($documentationFile));
+ file_put_contents($documentationFile, $contents);
+ }
+
+ public function buildPhar82()
+ {
+ $ignoredPlatformReqs = array(
+ 'ext-apcu',
+ 'ext-mongodb',
+ 'ext-phalcon',
+ );
+
+ $version = self::BRANCH_5x . '.' . date('Ymd');
+ $releaseDir = "releases/$version";
+ $this->stopOnFail();
+ $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, 'php82/codecept.version');
+ $versionedFile = "$releaseDir/codecept.phar";
+ $this->taskFilesystemStack()
+ ->stopOnFail()
+ ->mkdir($releaseDir)
+ ->copy($buildFile, $versionedFile)
+ ->remove('php82/codecept.phar')
+ ->symlink("../$versionedFile", 'php82/codecept.phar')
+ ->run();
+ }
+
+ public function release82()
+ {
+ $version = self::BRANCH_5x . '.' . date('Ymd');
+ $releaseDir = "releases/$version";
+ $this->updateBuildsPage();
+
+ $this->taskGitStack()
+ ->stopOnFail()
+ ->checkout('-- package/composer.json')
+ ->add('builds.markdown')
+ ->add('php82/codecept.phar')
+ ->add('php82/codecept.version')
+ ->add($releaseDir)
+ ->run();
+ }
+
+ private function setPlatformVersionTo($version, $ignoredPlatformReqs = array())
+ {
+ $this->taskComposerConfig()->workingDir('package')->set('platform.php', $version)->run();
+ $composerUpdate = $this->taskComposerUpdate();
+ foreach ($ignoredPlatformReqs as $ignoredPlatformReq) {
+ $composerUpdate->option('--ignore-platform-req', $ignoredPlatformReq);
+ }
+ $composerUpdate->preferDist()->optimizeAutoloader()->workingDir('package')->run();
+ }
+
+ private function setCodeceptionVersionTo($version, $ignoredPlatformReqs = array())
+ {
+ $composerRequire = $this->taskComposerRequire()
+ ->dependency('codeception/codeception', $version);
+ foreach ($ignoredPlatformReqs as $ignoredPlatformReq) {
+ $composerRequire->option('--ignore-platform-req', $ignoredPlatformReq);
+ }
+ $composerRequire->workingDir('package')
+ ->run();
+ }
+
+ /**
+ * @desc creates codecept.phar
+ * @throws Exception
+ */
+ public function buildPhar($targetFile)
+ {
+ $this->packPhar($targetFile);
+ $dir = dirname($targetFile);
+ //the file must be named codecept.phar to be executable
+ $this->taskFilesystemStack()->copy($targetFile, $dir . '/codecept.phar')->run();
+ $code = $this->taskExec('php codecept.phar')->dir($dir)->run()->getExitCode();
+ if ($code !== 0) {
+ throw new Exception("There was problem compiling phar");
+ }
+ }
+
+ private function packPhar($pharFileName)
+ {
+ $pharTask = $this->taskPackPhar($pharFileName)
+ ->compress()
+ ->stub('package/stub.php');
+
+ $finder = Finder::create()->files()
+ ->ignoreVCS(true)
+ ->name('*.php')
+ ->name('*.php8')
+ ->name('*.css')
+ ->name('*.png')
+ ->name('*.js')
+ ->name('*.css')
+ ->name('*.eot')
+ ->name('*.svg')
+ ->name('*.ttf')
+ ->name('*.wof')
+ ->name('*.woff')
+ ->name('*.woff2')
+ ->name('*.png')
+ ->name('*.tpl')
+ ->name('*.tpl.dist')
+ ->name('*.html.dist')
+ ->exclude('Tests')
+ ->exclude('tests')
+ ->exclude('benchmark')
+ ->exclude('demo')
+ ->in('package/vendor');
+
+ foreach ($finder as $file) {
+ $relativePathname = $file->getRelativePathname();
+ if (strpos($relativePathname, 'codeception/') === 0) {
+ //don't remove whitespace from Codeception files
+ $pharTask->addFile('vendor/' . $relativePathname, $file->getRealPath());
+ } else {
+ $pharTask->addStripped('vendor/' . $relativePathname, $file->getRealPath());
+ }
+ }
+
+ $pharTask->run();
+ }
+
+ public function processChangelog()
+ {
+ $client = new \Github\Client();
+ $token = getenv('GH_PAT');
+ if ($token) {
+ $client->authenticate(getenv('GH_PAT'), null, \Github\Client::AUTH_ACCESS_TOKEN);
+ }
+ $allReleases = [];
+
+ $repositories = $client->repos()->org('Codeception', ['per_page' => 100]);
+ foreach ($repositories as $repository) {
+ $repositoryName = $repository['name'];
+ if ($repositoryName !== 'Codeception' && !str_starts_with($repositoryName, 'module-') && !str_starts_with($repositoryName, 'lib-')) {
+ continue;
+ }
+ $this->say($repositoryName);
+
+ if ($repository['disabled'] || $repository['archived']) {
+ continue;
+ }
+ try {
+ $releases = $client->repo()->releases()->all('codeception', $repositoryName);
+ foreach ($releases as $k=> $release) {
+ $releases[$k]['repo'] = $repositoryName;
+ }
+ $allReleases = array_merge($allReleases, $releases);
+ } catch (\Exception $err) {
+// $this->say("Repository not available " . $repository['name']);
+// $this->say($err->getMessage());
+ }
+ }
+
+ usort($allReleases, function($r1, $r2) {
+ return -(strtotime($r1['published_at']) <=> strtotime($r2['published_at']));
+ });
+
+ $changelog = "";
+
+ foreach ($allReleases as $release) {
+ $repo = $release['repo'] ?? 'Codeception';
+ $changelog .= sprintf("\n\n### %s %s: %s\n\n", $repo, $release['tag_name'], $release['name']);
+
+ $changelog .= sprintf('Released by [{:height="16" width="16"} %s](%s) on %s',
+ $release['author']['avatar_url'] . '&s=16',
+ $release['author']['login'],
+ $release['author']['html_url'],
+ date_format(date_create($release['published_at']),"Y/m/d H:i:s")
+ );
+
+ $changelog .= " / [Repository](https://github.com/Codeception/$repo) ";
+ $changelog .= " / [Releases](https://github.com/Codeception/$repo/releases)\n\n";
+
+ $body = $release['body'];
+ //user
+
+ $body = preg_replace('~\s@([\w-]+)~', ' **[$1](https://github.com/$1)**', $body);
+ //issue
+ $body = preg_replace(
+ '~#(\d+)~',
+ "[#$1](https://github.com/Codeception/$repo/issues/$1)",
+ $body
+ );
+ $changelog .= "\n\n$body\n";
+ }
+
+ return $changelog;
+ }
+
+ public function updateBuildsPage()
+ {
+ $sortByVersion = function (\SplFileInfo $a, \SplFileInfo $b) {
+ return version_compare($a->getBaseName(), $b->getBaseName());
+ };
+
+ $releases = array_reverse(
+ iterator_to_array(Finder::create()->depth(0)->directories()->sort($sortByVersion)->in('releases'))
+ );
+ $branch = null;
+ $releaseFile = $this->taskWriteToFile('builds.markdown')
+ ->line('---')
+ ->line('layout: page')
+ ->line('title: Codeception Builds')
+ ->line('---')
+ ->line('');
+
+ foreach ($releases as $release) {
+ $releaseName = $release->getBasename();
+ $downloadUrl = "https://codeception.com/releases/$releaseName/codecept.phar";
+
+ list($major, $minor) = explode('.', $releaseName);
+ if ("$major.$minor" != $branch) {
+ $branch = "$major.$minor";
+ $releaseFile->line("\n## $branch");
+ if ($major < 2) {
+ $releaseFile->line("*Requires: PHP 5.3 and higher + CURL*\n");
+ } elseif ($major == 2 && $minor < 4) {
+ $releaseFile->line("*Requires: PHP 5.4 and higher + CURL*\n");
+ } elseif ($major < 5) {
+ $releaseFile->line("*Requires: PHP 5.6 and higher + CURL*\n");
+ } 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)**");
+ }
+
+ if (file_exists("releases/$releaseName/php54/codecept.phar")) {
+ $downloadUrl2 = "https://codeception.com/releases/$releaseName/php54/codecept.phar";
+ if (version_compare($releaseName, '2.4.0', '>=')) {
+ $versionLine = "* [$releaseName for PHP 7]($downloadUrl)";
+ $versionLine .= ", [for PHP 5.6]($downloadUrl2)";
+ } elseif (version_compare($releaseName, '2.3.0', '>=')) {
+ $versionLine = "* [$releaseName for PHP 7]($downloadUrl)";
+ $versionLine .= ", [for PHP 5.4 - 5.6]($downloadUrl2)";
+ } else {
+ $versionLine = "* [$releaseName for PHP 5.6+]($downloadUrl)";
+ $versionLine .= ", [for PHP 5.4 or 5.5]($downloadUrl2)";
+ }
+ } elseif (file_exists("releases/$releaseName/php56/codecept.phar")) {
+ $versionLine = "* [$releaseName for PHP 7.2+]($downloadUrl)";
+ $downloadUrl2 = "https://codeception.com/releases/$releaseName/php56/codecept.phar";
+ $versionLine .= ", [for PHP 5.6 - 7.1]($downloadUrl2)";
+ } else {
+ $versionLine = "* [$releaseName]($downloadUrl)";
+ }
+
+ $releaseFile->line($versionLine);
+ }
+ $releaseFile->run();
+ }
+
+ /**
+ * @param $pharFile
+ * @param $versionFile
+ */
+ private function updateVersionFile($pharFile, $versionFile)
+ {
+ $hash = sha1_file($pharFile);
+ if ($hash === false) {
+ throw new Exception('Failed to write hash to file: ' . $versionFile);
+ }
+ $this->taskWriteToFile($versionFile)->text($hash)->run();
+ }
+
+
+}
diff --git a/_config.yml b/_config.yml
index 16665b3b2..1339b5f28 100644
--- a/_config.yml
+++ b/_config.yml
@@ -4,4 +4,29 @@ kramdown:
input: GFM
auto_ids: true
syntax_highlighting: rouge
-highlighter: rouge
\ No newline at end of file
+highlighter: rouge
+exclude: [vendor]
+sass:
+ sass_dir: _scss
+ style: compressed
+plugins:
+ - jekyll-algolia
+algolia:
+ application_id: 'G160Y1N5OT'
+ index_name: 'codeception'
+ read_only_api_key: 'c264188100c4fb7017c4f5702a7d4b8d'
+ allowed_extensions:
+ - ".markdown"
+ - ".html"
+ excluded_files:
+ - "index.html"
+ - "docs-2.0"
+ - "docs-1.8"
+ - "2012-"
+ - "2013-"
+ - "2014-"
+banner:
+ # disable content to show last blogpost
+ # content: '🎉 Codeception truns 10! Join online celebration on November 30!'
+ # content: 'Codeception is on OpenCollective! Support us 💖'
+ content: '🇺🇦 Help Ukraine!'
diff --git a/_data/extensions.yml b/_data/extensions.yml
new file mode 100644
index 000000000..f5c77f180
--- /dev/null
+++ b/_data/extensions.yml
@@ -0,0 +1,85 @@
+- name: Testomat.io Reporter
+ link: https://github.com/testomatio/php-reporter
+ description: Run reports and analytics via [Testomat.io](https://testomat.io)
+ image: https://testomat.io/wp-content/uploads/2022/03/Real_time_report_test_result-936x573.jpg
+
+- name: Allure Codeception Adapter
+ link: https://github.com/allure-framework/allure-codeception
+ description: This is a Codeception adapter for [Allure Framework](http://allure.qatools.ru)
+
+- name: ReportPortal Agent
+ link: https://github.com/reportportal/agent-php-Codeception
+ description: Integration with [ReportPortal.io](https://reportportal.io/) AI-powered test automation dashboard
+
+- name: Wiremock Extension
+ description: Allows developers and testers to use WireMock to mock external services when running codeception tests. codeception-wiremock-extension connects to an already running instance of WireMock or can also run automatically a local standalone one. And, it is able to download the version of wiremock you preffer and run it too
+ link: https://github.com/mcustiel/codeception-wiremock-extension
+
+- name: Docker Selenium Chrome
+ link: https://github.com/teamneusta/codeception-docker-chrome
+ description: Docker Selenium Chrome for Codeception is a extension to integrate automatic selenium with chrome in your codeception tests.
+
+- name: PhpBuiltinServer
+ link: https://github.com/tiger-seo/PhpBuiltinServer
+ description: Extension for starting and stopping built-in PHP server. Works on Windows, Mac, Linux.
+
+- name: Phantoman
+ link: https://github.com/site5/phantoman
+ description: Extension for automatically starting and stopping PhantomJS when running tests.
+
+- name: Phiremock
+ link: https://github.com/mcustiel/phiremock-codeception-extension
+ description: Extension for automatically starting and stopping Phiremock.
+
+- name: Progress Reporter
+ link: https://github.com/fr05t1k/codeception-progress-reporter
+ description: The reporter with a progress bar
+ image: /images/extensions/codeception-progress-reporter.png
+
+- name: DrushDb
+ link: https://github.com/pfaocle/DrushDb
+ image: https://www.drupal.org/files/druplicon-small.png
+ description: DrushDb is a Codeception extension to populate and cleanup test **Drupal** sites during test runs using Drush aliases and the sql-sync command.
+
+- name: Notifier
+ link: https://github.com/Codeception/Notifier
+ description: Flexible notifications with notificator library.
+
+- name: WPBrowser, WPDatabase, WPLoader
+ link: https://github.com/lucatume/wp-browser
+ image: https://s.w.org/about/images/desktops/wp-light-lo-640x960.png
+ description: WordPress specific extensions of PHPBrowser and Db modules to allow for more streamlined testing of themes and plugins and a WordPress automated testing suite wrapper.
+
+- name: Joomla-Browser
+ link: https://github.com/joomla-projects/joomla-browser
+ description: An extended Webdriver Browser to navigate through Joomla sites with Codeception.
+ image: https://codeception.com/images/frameworks/joomla.png
+
+- name: TestStatistics
+ link: https://github.com/redCOMPONENT-COM/teststatistics#teststatistics
+ description: TestStatistics is a Codeception Extension to measure the performance of your tests. The extension lists your slower steps, probably meaning that the used locator is not performant. Is a smart tool to improve the speed of your Acceptance tests, and serves as example to create your own reporting extensions.
+
+- name: TeamCity
+ link: https://github.com/neronmoon/TeamcityCodeception
+ description: Integration with TeamCity CI server by service-messages
+
+- name: EventsScripting
+ link: https://github.com/oprudkyi/codeception-events-scripting
+ description: Run shell scripts on events - before/after suites/environments/full test run
+
+- name: PauseOnFail
+ link: https://github.com/ipeevski/PauseOnFail
+ description: Pause execution on failure/error - allow debugging from failed point onwardss
+
+- name: SecureShell
+ link: https://github.com/edno/codeception-secureshell
+ description: The Codeception module for SSH commands, SFTP access and SSH tunnels
+
+- name: TestRail
+ link: https://github.com/bookitcom/codeception-testrail
+ image: https://blog.gurock.com/wp-content/themes/gurock/assets/images/blog/bottom-testrail-ad.png
+ description: Integration with [TestRail TestCase Management](https://www.gurock.com/testrail/)
+
+- name: Gherkin-Dependsload
+ link: https://github.com/labbots/codeception-gherkin-dependsload
+ description: The Codeception extension for Gherkin features to load and execute dependent scenarios. This extension provides `@dependsload` annotation which lets adding dependencies to gherkin scenarios.
diff --git a/_data/modules.yml b/_data/modules.yml
new file mode 100644
index 000000000..d36e1192f
--- /dev/null
+++ b/_data/modules.yml
@@ -0,0 +1,175 @@
+- name: Codeception CRAP reporter
+ image: https://user-images.githubusercontent.com/6382002/130051733-5a6f18eb-012c-4ef8-96f0-1a12c5b26407.png
+ link: https://github.com/nebbia-fitness/codecept-coverage-reporter
+ description: Codeception CRAP reporter is an open-source implementation tool to help you detect PHP code C.R.A.P. – which stands for Change Risk Anti-Patterns.
+
+- name: Amazon S3 Filesystem
+ link: https://github.com/polevaultweb/s3-filesystem
+ description: An Amazon S3 Filesystem module.
+
+- name: Appium Driver
+ link: https://github.com/tajawal/codeception-appium
+ description: Appium Driver to interact with appium server - iOS/Android Mobile Testing Automation.
+
+- name: Appium
+ 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.
+
+- name: CakeCeption
+ link: https://github.com/hkzpjt/cakeception
+ description: Integrate Codeception to CakePHP v2.* projects.
+
+- name: CakePHP
+ image: https://pbs.twimg.com/profile_images/736902911993774080/p5C2_6xM.jpg
+ link: https://github.com/cakephp/codeception
+ description: Official CakePHP 3 module for Codeception.
+
+- name: Codecept UnitTest generator
+ image: https://user-images.githubusercontent.com/6382002/33774260-0aaacebc-dc3b-11e7-8a97-34265a4818cc.png
+ link: https://github.com/hyperia-sk/codecept-unittest-generator
+ description: Generate PHPUnit tests from annotations.
+
+- name: Composer Project
+ link: https://github.com/TypistTech/codeception-composer-project-module
+ description: Create throw away composer projects for Codeception tests.
+
+- name: Config
+ link: https://github.com/JustBlackBird/codeception-config-module
+ description: Loads params from Codeception config and pass them to test scenarios.
+
+- name: CSS Regression
+ link: https://github.com/mendicm/css-regression
+ description: CSS / Visual regression tests integrated in Codeception. This module can be used to compare the current representation of a website element with an expected based on a reference image. This module does not require any JavaScript injections in your website and works with viewport screenshots (chromedriver). Compatible with WebDriver and AngularJS modules.
+
+- name: Database Populator
+ link: https://github.com/vjik/codeception-db-populator
+ description: Module for handy populate database. Load only the tables and data that are needed for the current test. This will allow you to create and run tests faster.
+ color: "#86FF8A"
+
+- name: Date/Time
+ link: https://github.com/nathanmac/datetime-codeception-module
+ description: Additional helpers for date and time comparisons, e.g. seeDateIsToday()
+
+- name: Drupal
+ link: https://github.com/guncha25/drupal-codeception
+ description: Sets of codeception modules and utilities to test drupal cms.
+
+- name: FlySystem
+ link: https://github.com/lamoda/codeception-flysystem
+ description: Codeception FlySystem module with several adapters. Provides a set of methods for checking and modifying files on remote storage.
+ color: "#FFF5C4"
+
+- name: GherkinParam
+ link: https://github.com/edno/codeception-gherkin-param
+ description: The Codeception module for supporting parameter notation in Gherkin scenario.
+
+- name: HighlightCeption
+ image: https://user-images.githubusercontent.com/6382002/29250010-0bdb3cf6-803b-11e7-92af-f666caf497e4.png
+ link: https://github.com/hyperia-sk/highlight-ception
+ description: Highlight text or element by codeception.
+ color: "#FFF5C4"
+
+- name: HttpMock
+ link: https://github.com/mcustiel/codeception-http-mock
+ description: Module and extension to use HttpMock to mock external services when running Codeception tests.
+
+- name: IM
+ link: https://github.com/nathanmac/im-codeception-module
+ description: This module allows the testing against external messaging services as well as triggering notifications via your tests, currently supports HipChat messaging service.
+
+- name: MailCare
+ image: https://raw.githubusercontent.com/mailcare/codeception-module-mailcare/master/codeception-addons.png
+ link: https://github.com/mailcare/codeception-module-mailcare
+ 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.
+
+- name: MailSMTP
+ link: https://github.com/AhmedSamy/codeception-smtp-mail
+ description: This module will let you test emails using simple SMTP connection, with any provider that supports IMAP.
+
+- name: MailTrap
+ link: https://github.com/WhatDaFox/Codeception-Mailtrap
+ description: Codeception module to test email using Mailtrap.io.
+
+- name: Markup Validator
+ link: https://github.com/Kolyunya/codeception-markup-validator
+ description: A module which validates the markup (HTML, XHTML, etc.) of web documents. Works out of the box, requires no complex configuration to get started. Yet fully configurable and extendable if something special is needed.
+
+- name: Mockery
+ link: https://github.com/Codeception/MockeryModule
+ description: Integrates Mockery into Codeception tests.
+
+- name: Mountebank
+ link: https://github.com/meare/codeception-mountebank
+ description: Stub and mck external services with mountebank.
+
+- name: Nette
+ link: https://github.com/Arachne/Codeception
+ description: Module for Nette framework.
+
+- name: Percy
+ link: https://github.com/tr33m4n/codeception-module-percy
+ description: Percy https://percy.io integration
+ color: "#9e66bf"
+
+- name: Phiremock
+ link: https://github.com/mcustiel/phiremock-codeception-module
+ description: Module to mock http request to external services using Phiremock.
+
+- name: Private Sniffer
+ link: https://github.com/fkupper/private-sniffer-module/
+ description: Simple module that enables sniffing into private defined elements of an object while running unit tests with Codeception.
+
+- name: PSR3 Logger
+ link: https://github.com/byteout/psr-logger-codeception-module
+ description: Module for validation of messages logged by PSR3 loggers.
+
+- name: Remote File Attachment
+ link: https://github.com/phmLabs/codeception-module-attachfileremote
+ description: This module helps to upload files when using webdriver via remote connection.
+
+- name: Slim
+ description: This module allows you to run functional tests inside Slim 4 Microframework without HTTP calls, so tests will be much faster and debug could be easier.
+ link: https://github.com/DoclerLabs/codeception-slim-module
+
+- name: Slim 3
+ link: https://github.com/herloct/codeception-slim-module
+ description: This module allows you to run tests inside Slim 3 Microframework. Based on ZendExpressive Module.
+
+- name: Stepler
+ link: https://github.com/nicholascus/codeception-stepler
+ description: Enabling step-by-step console execution in bebugging mode.
+
+- name: VisualCeption
+ link: https://github.com/Codeception/VisualCeption
+ description: Visual regression tests integrated in Codeception. This module can be used to compare the current representation of a website element with an expected. It was written on the shoulders of codeception and integrates in a very easy way.
+ color: "#FFF5C4"
+
+- name: WordPress Browser and Database
+ link: https://github.com/lucatume/wp-browser
+ description: An extension of Codeception own PhpBrowser and Db modules to allow for easy and streamlined WordPress themes and plugins testing.
+
+- 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/algolia.html b/_includes/algolia.html
new file mode 100644
index 000000000..415a7dad3
--- /dev/null
+++ b/_includes/algolia.html
@@ -0,0 +1,28 @@
+
+
+
+
+
+
+
+
diff --git a/_includes/cloudways.html b/_includes/cloudways.html
new file mode 100644
index 000000000..b283aee3a
--- /dev/null
+++ b/_includes/cloudways.html
@@ -0,0 +1,4 @@
+
+ 
+
diff --git a/_includes/comment.html b/_includes/comment.html
index 18adad61e..0b52c8748 100644
--- a/_includes/comment.html
+++ b/_includes/comment.html
@@ -1,8 +1,7 @@
-
-
\ No newline at end of file
+
diff --git a/_includes/companies.html b/_includes/companies.html
new file mode 100644
index 000000000..2b796003c
--- /dev/null
+++ b/_includes/companies.html
@@ -0,0 +1,31 @@
+
+ 
+
+
+
+
+ 
+
+
+
+
+ 
+
+
+
+
+ 
+
+
+
+
+ 
+
+
+
+
+ 
+
+
+
+
+ 
+
+
+
+
+ 
+
\ No newline at end of file
diff --git a/_includes/doc_1.8.html b/_includes/doc_1.8.html
deleted file mode 100644
index 69ce923b9..000000000
--- a/_includes/doc_1.8.html
+++ /dev/null
@@ -1 +0,0 @@
-
+You are viewing documentation for Codeception 1.8. Switch to latest stable »
\ No newline at end of file
diff --git a/_includes/doc_2.0.html b/_includes/doc_2.0.html
deleted file mode 100644
index dda632ecf..000000000
--- a/_includes/doc_2.0.html
+++ /dev/null
@@ -1 +0,0 @@
-You are viewing documentation for Codeception 2.0. Switch to latest stable »
\ No newline at end of file
diff --git a/_includes/extensions.md b/_includes/extensions.md
index 57651c89f..0552d693e 100644
--- a/_includes/extensions.md
+++ b/_includes/extensions.md
@@ -1,6 +1,44 @@
# Official Extensions
-## Codeception\Extension\Logger
+## DotReporter
+
+[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 tests and "F" for failures.
+
+
+
+```bash
+ ..........
+ ..........
+ ..........
+ ..........
+ ..........
+ ..........
+ ..........
+ ..........
+
+Time: 2.07 seconds, Memory: 20.00MB
+
+OK (80 tests, 124 assertions)
+```
+
+
+Enable this reporter with `--ext option`
+
+```
+codecept run --ext DotReporter
+```
+
+Failures and Errors are printed by a standard Codeception reporter.
+Use this extension as an example for building custom reporters.
+
+
+
+## Logger
+
+[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.
@@ -9,7 +47,8 @@ Monolog should be installed additionally by Composer.
composer require monolog/monolog
```
-Steps are logged into `tests/_output/codeception.log`
+Codeception's core/internal stuff is logged into `tests/_output/codeception.log`.
+Test suites' steps are logged into `tests/_output/
+
+
+
+
+
+
diff --git a/_includes/guides.html b/_includes/guides.html
index 5db6bd4f3..040143aef 100644
--- a/_includes/guides.html
+++ b/_includes/guides.html
@@ -1 +1,17 @@
-
+
diff --git a/_includes/joomla_hero.html b/_includes/joomla_hero.html
new file mode 100644
index 000000000..efea67de8
--- /dev/null
+++ b/_includes/joomla_hero.html
@@ -0,0 +1,14 @@
+
+
+
+ 
+ PHP Testing for
+
+
+ PHP Testing for
everyone_
+
+ Codeception collects and shares best practices and solutions for testing PHP web applications. With a
+ flexible
+ set of included modules tests are easy to write, easy to use and easy to maintain.
+
+
diff --git a/_includes/js.html b/_includes/js.html
new file mode 100644
index 000000000..8bee78f05
--- /dev/null
+++ b/_includes/js.html
@@ -0,0 +1,7 @@
+
+
+
+
+
\ No newline at end of file
diff --git a/_includes/laravel_hero.html b/_includes/laravel_hero.html
new file mode 100644
index 000000000..fad0bacef
--- /dev/null
+++ b/_includes/laravel_hero.html
@@ -0,0 +1,14 @@
+
+
+
+
+
+
+
+
+ Codeception for
+
+
+
+ Codeception for
+ 
+
+
+
\ No newline at end of file
diff --git a/_includes/modules.html b/_includes/modules.html
index 9337b3798..1a27a238f 100644
--- a/_includes/modules.html
+++ b/_includes/modules.html
@@ -1 +1,26 @@
-
+
+
+
+
+
+
+
+ Codeception for
+
+
+
+ Codeception for
+ 
Laravel
+
+
+
diff --git a/_includes/phar.html b/_includes/phar.html
new file mode 100644
index 000000000..203c45952
--- /dev/null
+++ b/_includes/phar.html
@@ -0,0 +1,110 @@
+
+
+
+
+
+
+
+
+ Codeception for
+
+
+
+ Codeception for
+ 
+
+
\ No newline at end of file
diff --git a/_includes/reference.html b/_includes/reference.html
index c11e33fa6..0e8a7cfc8 100644
--- a/_includes/reference.html
+++ b/_includes/reference.html
@@ -1 +1,11 @@
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + Install Phar Globally + +
+
+
+
+
+
+
+ sudo curl -LsS https://codeception.com/php80/codecept.phar -o /usr/local/bin/codecept+
sudo chmod a+x /usr/local/bin/codecept+
+ Execute it as
+ codecept
+
diff --git a/_includes/switch.html b/_includes/switch.html
index 895988657..723a5d06f 100644
--- a/_includes/switch.html
+++ b/_includes/switch.html
@@ -1,5 +1,5 @@
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Premium Sponsors
+ + +
- current (2.1)
- 2.0
- 1.8
+
diff --git a/_includes/symfony_hero.html b/_includes/symfony_hero.html
new file mode 100644
index 000000000..551560d17
--- /dev/null
+++ b/_includes/symfony_hero.html
@@ -0,0 +1,14 @@
+AMQP Cli Db Dbh Doctrine1 Doctrine2 Filesystem Kohana Memcache MongoDb PhpBrowser REST Redis SOAP Selenium Selenium2 SocialEngine Symfony1 Symfony2 Unit WebDebug XMLRPC ZF1 ZombieJS
\ No newline at end of file
+AMQP
+Cli
+Db
+Dbh
+Doctrine1
+Doctrine2
+Filesystem
+Kohana
+Memcache
+MongoDb
+PhpBrowser
+REST
+Redis
+SOAP
+Selenium
+Selenium2
+SocialEngine
+Symfony1
+Symfony2
+Unit
+WebDebug
+XMLRPC
+ZF1
+ZombieJS
\ No newline at end of file
diff --git a/_includes/tweets.html b/_includes/tweets.html
new file mode 100644
index 000000000..8bb370128
--- /dev/null
+++ b/_includes/tweets.html
@@ -0,0 +1,82 @@
+
{% if page.title %}
{{ page.title }}
{% else %}
- Codeception
+ Codeception - PHP Testing framework - PHP unit testing, PHP e2e testing, database testing
{% endif %}
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-{% capture guides %}{% include guides.html %}{% endcapture %}
- {% capture modules %}{% include modules.html %}{% endcapture %}
- {% capture reference %}{% include reference.html %}{% endcapture %}
-
+
\ No newline at end of file
diff --git a/_includes/toc.html b/_includes/toc.html
index bf38919a5..376f34fc4 100644
--- a/_includes/toc.html
+++ b/_includes/toc.html
@@ -1 +1,24 @@
-
+
+
+
+
+
+
+
+ Codeception for
+
+
+
+ Codeception for
+ 
+
+
+
+++A couple of weeks ago we migrated from Zend + Framework 1 to Symfony 3 and all the functional tests kept working. We basically only needed to replace the + ZF1 + module with the Symfony module. Thanks @codeception + for your awesome work there! +
— + Matthias Noback (@matthiasnoback) + January 29, 2019 +
+
++++ I remember tearing hair out for half a day trying to write a unit test asserting that a route renders a + certain view. + @codeception = 5 min. +
— + Michael Sullivan (@regularmike) + April 7, 2016 +
+
+++Two years ago I decided to make + @codeception + the testing tool of the whole PAYBACK Global web dev. It was + the best decision I ever made.
— Lars Frantzen (@frantzencd) + June 2, 2017 +
+
++++ @codeception + Wow, using pageobject and stepobject with cest test types is awesome. So much flexibility + #testing + #php +
— Mario Bašić (@ShockMario) + December 17, 2015 +
+
+++Spending my life writing tests for + @orderswift + right now. Really impressed with + @codeception + which makes thing a hell of a lot easier. +
— + Rich Martell (@RichMartell) + September 22, 2015 +
+
+++. + @zachwills showing everyone + @codeception + as a great way to do acceptance testing of legacy code. + https://t.co/gWXYbGhbAW + Great tool! + #wctpa +
— + Shawn Hooper (@ShawnHooper) + September 26, 2015 +
+
diff --git a/_includes/twitter.html b/_includes/twitter.html
new file mode 100644
index 000000000..da40a33a0
--- /dev/null
+++ b/_includes/twitter.html
@@ -0,0 +1,15 @@
+++Thank you + @codeception + you just made my life easier + #php + #testing +
— + Rock Lobster (@lorenzoferrara) + August 25, 2015 +
+
+
\ No newline at end of file
diff --git a/_includes/wp_hero.html b/_includes/wp_hero.html
new file mode 100644
index 000000000..504013364
--- /dev/null
+++ b/_includes/wp_hero.html
@@ -0,0 +1,13 @@
+
+
\ No newline at end of file
diff --git a/_includes/yii_hero.html b/_includes/yii_hero.html
new file mode 100644
index 000000000..67f7fbe11
--- /dev/null
+++ b/_includes/yii_hero.html
@@ -0,0 +1,14 @@
+
+
+
+
+
+
+
+
+ Codeception for
+
+
+
+ Codeception for
+ 
+
+
\ No newline at end of file
diff --git a/_includes/zf_hero.html b/_includes/zf_hero.html
new file mode 100644
index 000000000..ef3e26f02
--- /dev/null
+++ b/_includes/zf_hero.html
@@ -0,0 +1,26 @@
+
+
+
+
+
+
+
+
+ Codeception for
+
+
+
+ Codeception for
+ 
+
+
+
\ No newline at end of file
diff --git a/_layouts/bootstrap.html b/_layouts/bootstrap.html
index 596e3f941..299f8ffea 100644
--- a/_layouts/bootstrap.html
+++ b/_layouts/bootstrap.html
@@ -1,212 +1,275 @@
-
+
+
+
+
+
+
+
+
+ Codeception for
+
+
+
+ Codeception for
+ 
+ Zend Framework 2
+
+
+
+
+