How do I write an acceptance test for a web page in Codeception?

Use the generated AcceptanceTester methods like $I->amOnPage() and $I->click() in a test file, as shown in the sample test. Configure acceptance suites in the YAML setup to use tools like Selenium or PhpBrowser for browser interaction.

Codeception vs PHPUnit: which should I use for unit testing?

Codeception can run PHPUnit tests directly, so you can keep existing unit tests. For new projects, Codeception adds BDD-style syntax and integrates with higher-level tests, but pure PHPUnit might be lighter if you only need unit testing without acceptance or functional layers.

Does Codeception work with Laravel or Symfony?

Yes, Codeception has official modules for Laravel and Symfony, allowing easy integration for functional testing. You can install these modules via Composer and configure them in your suite settings to leverage framework-specific features.

Can Codeception test APIs and databases?

Yes, it supports API testing with modules like REST or SOAP, and database testing with Db module for verifying data states, as implied by the sample test using seeInDatabase for database assertions.

What browsers does Codeception support for acceptance testing?

Codeception uses Selenium WebDriver or similar tools for browser automation, so it supports any browser that Selenium can interact with, such as Chrome, Firefox, and Safari, but requires additional setup for driver configuration.

How do I run only specific test suites in Codeception?

Use the command 'codecept run [suite-name]' to execute tests from a particular suite like acceptance or functional. You can also filter by directory or test name, as detailed in the command-line utility mentioned in the installation section.

Open-Awesome

Codeception

MITPHP5.3.5

A modern full-stack testing framework for PHP that handles acceptance, functional, and unit tests.

Visit Website GitHub

4.9k stars1.3k forks0 contributors

What is Codeception?

Codeception is a modern full-stack testing framework for PHP that enables developers to write and run acceptance, functional, and unit tests using a unified, BDD-inspired approach. It solves the problem of fragmented testing tools by providing a single framework to handle all testing layers, making test creation and execution more efficient and consistent.

Target Audience

PHP developers and teams who need a comprehensive testing solution for web applications, particularly those looking to implement Behavior-Driven Development practices or streamline their testing workflow across different test types.

Value Proposition

Developers choose Codeception because it offers a modern, expressive way to write tests in PHP, supports the entire testing spectrum from UI to unit tests, and integrates seamlessly with existing PHPUnit tests, reducing the learning curve and tooling complexity.

Overview

Full-stack testing PHP framework

Use Cases

Best For

Writing acceptance tests for web application user interfaces
Implementing Behavior-Driven Development practices in PHP projects
Creating functional tests for API and backend logic
Running unit tests alongside higher-level tests in a unified framework
Teams transitioning from PHPUnit seeking more expressive test syntax
Developing comprehensive test suites for full-stack PHP applications

Not Ideal For

Projects built entirely in non-PHP languages where testing frameworks native to those languages are more appropriate
Microservices or polyglot architectures requiring unified testing across multiple programming languages
Teams already using Behat for strict Gherkin-style BDD who don't need an additional PHP-based BDD layer
Very simple PHP scripts or one-off tasks where a full testing framework adds unnecessary complexity and setup time

Pros & Cons

Pros

Full-Stack Testing

Supports acceptance, functional, and unit tests in one framework, eliminating the need to switch tools for different testing layers as highlighted in the README's key features.

BDD-Inspired Syntax

Allows writing descriptive test scenarios in plain PHP, making tests more readable and maintainable, which aligns with the project's philosophy of modernizing PHP testing.

PHPUnit Compatibility

Can run classic PHPUnit tests alongside Codeception tests, easing migration for teams already using PHPUnit, as noted in the key features.

Interactive Debugging Output

Displays actions and results during test execution, providing clearer insights into failures, which is emphasized in the 'At a Glance' section.

Cons

PHP-Only Ecosystem

Tightly coupled to PHP environments, making it less suitable for projects with significant non-PHP components or those requiring cross-language testing integration.

Configuration Overhead

Initial setup with 'codecept bootstrap' and suite configuration can be more involved compared to simpler, single-purpose testing tools, adding to onboarding time.

BDD Syntax Limitation

While inspired by BDD, it uses PHP instead of standard Gherkin, which might not satisfy teams seeking full-fledged BDD with business-readable specifications.

Frequently Asked Questions

Related Projects

PHPUnit

The PHP Unit Testing framework.

Mockery is a simple yet flexible PHP mock object framework for use in unit testing with PHPUnit, PHPSpec or any other testing framework. Its core goal is to offer a test double framework with a succinct API capable of clearly defining all possible object operations and interactions using a human readable Domain Specific Language (DSL).

Stars10,729

Forks462

Last commit24 days ago

Prophecy

Highly opinionated mocking framework for PHP 5.3+

Stars8,488

Forks247

Last commit11 days ago

Faker

Faker is a PHP library that generates fake data for you

Stars3,959

Forks422

Last commit22 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub