README

This library is a test framework that works with PHPUnit to provide similar behaviour than hooks within extensions but with the notion of priority to improve their interactions.

Table of content

Test framework

1. Installation

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

composer require richcongress/test-framework

2. Getting started

The first thing to do is adding the PHPUnitExtension in your phpunit.xml.dist like following:

<extensions>
    <extension class="RichCongress\TestFramework\PHPUnitExtension">
        <arguments>
            <string>TestHookClassName</string>
        </arguments>
    </extension>
</extensions>

You need to change add each TestHook as no solution has been found to automatically configure it.

To create a TestHook, simply use the TestHookInterface interface or extends your TestHook with the class AbstractTestHook, and then override the methods you want.

3. Versioning

template-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

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

See LICENSE for details.

richcongress / test-framework

Maintainers

Details