Sylius and Cutting Your Teeth on TDD

This article explores Sylius, a Symfony-based e-commerce application, and its robust approach to Test-Driven Development (TDD), achieving 100% code coverage—a remarkable feat for a PHP application of its scale. We'll guide you through setting up a Sylius test environment, covering database creation and configuration for Behat, PHPUnit, and phpspec.

The article emphasizes the importance of both Behavior Driven Development (BDD) and TDD in Sylius, demonstrating how these methodologies enhance code quality and maintainability. Practical examples illustrate modifying existing features and adding new functionalities using a test-first approach.

Sylius leverages the Symfony framework, and its code resides within a src folder, keeping your custom application code separate in the app folder. To begin TDD, we first configure the test database:

php bin/console doctrine:database:create --env=test
php bin/console doctrine:schema:create --env=test

Sylius offers various testing types:

PHPUnit: Sylius includes numerous PHPUnit functional tests. The configuration (phpunit.xml.dist) is located in the web root, with unit tests in the tests folder. Running tests (e.g., tests/Controller/CountryApiTest.php) involves:

./vendor/phpunit/phpunit/phpunit -c ./phpunit.xml.dist tests/Controller/CountryApiTest

phpspec: For Behavior Driven Development (BDD), Sylius utilizes phpspec. Specifications are written in PHP classes, often grouped into suites. Running phpspec (e.g., src/Sylius/Component/Order/spec/Model/OrderItemSpec.php):

./bin/phpspec run -fpretty --verbose src/Sylius/Component/Order/spec/Model/OrderItemSpec.php

Behat: Behat facilitates StoryBDD, using Gherkin syntax to describe application behavior in feature files. Sylius provides a behat.yml.dist and a features folder. Running a Behat test (e.g., features/order/managing_orders/browsing_orders.feature):

./bin/behat features/order/managing_orders/browsing_orders.feature

TDD in Action: Modifying the Orders List Page

Let's illustrate TDD by changing the Orders list page icon. We'll follow these steps:

1. Add a Feature: Create features/order/managing_orders/browsing_orders_with_visual_display.feature.

2. Add a Page Object: Create src/Sylius/Behat/Page/Admin/Order/OrderPageInterface.php and src/Sylius/Behat/Page/Admin/Order/OrderPage.php. Register the page object in etc/behat/services/pages.xml.

3. Add a Context: Add a Behat context in src/Sylius/Behat/Resources/config/services/contexts/ui.xml and create src/Sylius/Behat/Context/Ui/Admin/ViewingPageIconContext.php.

By writing tests first, then making the code changes to pass those tests, we ensure a reliable and robust application. This article provides a foundation for understanding and implementing TDD within the Sylius e-commerce framework.

The article concludes by emphasizing the effectiveness of TDD for building reliable software and encourages a test-first approach. A FAQ section further clarifies Sylius and TDD concepts.

The above is the detailed content of Sylius and Cutting Your Teeth on TDD. For more information, please follow other related articles on the PHP Chinese website!