Getting Started With RichCongressUnitBundle

This version of the bundle requires Symfony 4.4+ and PHP 7.3+.

The unit-bundle provides is suite for application testing. It provides wrappers to isolate tests, various test cases to avoid code redundancy and a easy fixtures management.

This bundle is a fork of the chaplean/unit-bundle.

Quick start

The unit-bundle requires almost no configuration but provides useful tools to test your code. Here is an basic example:

class MainControllerTest extends ControllerTestCase
{
    /**
     * @WithFixtures
     * 
     * @return void
     */
    public function testIndex(): void
    {
        $client = self::createClient();
        $client->request('GET', '/');
    
        self::assertStatusCode(Response::HTTP_OK, $client);
    }

    /**
     * @WithFixtures
     * 
     * @return void
     */
    public function testUserEdition(): void
    {
        $client = $this->createClientWith('user-1');
        $client->request('PUT', '/rest/users/self', ['name' => 'Karl']);
    
        self::assertStatusCode(Response::HTTP_OK, $client);
    
        $content = self::getJsonContent($client);
        self::assertArrayKeyExists('name', $content);
        self::assertSame('Karl', $content['name']);
    }
}

Table of content

1. Installation
2. Getting started
   • Configuration
   • Available test cases
     • CommandTestCase
     • ConstraintTestCase
     • ControllerTestCase
     • RepositoryTestCase
     • VoterTestCase
   • Using the annotations
   • Creating fixtures
   • Overriding services with stub services
   • Use dynamic mocks (legacy)
   • Available default service stubs
   • Role provider
3. Versioning
4. Contributing
5. Hacking
6. License

1. Installation

This version of the bundle requires Symfony 4.4+ and PHP 7.3+.

1.1 Composer

composer require richcongress/unit-bundle

1.2 Bundles declaration

After the installation, make sure that those 4 bundles are declared correctly within the Kernel's bundles list.

new Doctrine\Bundle\FixturesBundle\DoctrineFixturesBundle::class => ['test' => true],
new Liip\FunctionalTestBundle\LiipFunctionalTestBundle::class    => ['test' => true],
new Liip\TestFixturesBundle\LiipTestFixturesBundle::class        => ['test' => true],
new RichCongress\Bundle\UnitBundle\RichCongressUnitBundle::class => ['test' => true],

1.3 Declare the PHP Extension

First and foremost, declare the PHPUnitExtension in the phpunit.xml.dist:

...

<extensions>
    <extension class="RichCongress\Bundle\UnitBundle\PHPUnit\PHPUnitExtension" />
</extensions>

...

1.4 Mandatory configuration

By default, the bundle configures everything on its own but if the config has been overriden somewhere, you can override it back to the default by importing the configuration:

imports:
    - { resource: '@RichCongressUnitBundle/Resources/config/config.yml' }

Or configure manually doctrine with something like this:

parameters:
    doctrine.dbal.connection_factory.class: Liip\TestFixturesBundle\Factory\ConnectionFactory

doctrine:
    dbal:
        driver: pdo_sqlite
        user: test
        path: '%kernel.cache_dir%/test.db'
        url: null
        memory: false

2. Getting started

• Configuration
• Available test cases
  • CommandTestCase
  • ConstraintTestCase
  • ControllerTestCase
  • RepositoryTestCase
  • VoterTestCase
• Using the annotations
• Creating fixtures
• Overriding services with stub services
• Use dynamic mocks (legacy)
• Available default service stubs
• Role provider

3. Versioning

unit-bundle follows semantic versioning. In short the scheme is MAJOR.MINOR.PATCH where

1. MAJOR is bumped when there is a breaking change,
2. MINOR is bumped when a new feature is added in a backward-compatible way,
3. PATCH is bumped when a bug is fixed in a backward-compatible way.

Versions bellow 1.0.0 are considered experimental and breaking changes may occur at any time.

4. Contributing

Contributions are welcomed! There are many ways to contribute, and we appreciate all of them. Here are some of the major ones:

• Bug Reports: While we strive for quality software, bugs can happen and we can't fix issues we're not aware of. So please report even if you're not sure about it or just want to ask a question. If anything the issue might indicate that the documentation can still be improved!
• Feature Request: You have a use case not covered by the current api? Want to suggest a change or add something? We'd be glad to read about it and start a discussion to try to find the best possible solution.
• Pull Request: Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as documentation on pull requests. We use the "fork and pull model" were contributors push changes to their personnal fork and then create pull requests to the main repository. Please make your pull requests against the master branch.

As a reminder, all contributors are expected to follow our Code of Conduct.

5. Hacking

You might use Docker and docker-compose to hack the project. Check out the following commands.

# Start the project
docker-compose up -d

# Install dependencies
docker-compose exec application composer install

# Run tests
docker-compose exec application bin/phpunit

# Run a bash within the container
docker-compose exec application bash

6. License

unit-bundle is distributed under the terms of the MIT license.

See LICENSE for details.