.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. ==================================================
.. DEFINE SOME TEXTROLES
.. --------------------------------------------------
.. role::   underline
.. role::   typoscript(code)
.. role::   ts(typoscript)
   :class:  typoscript
.. role::   php(code)


What does it do?
^^^^^^^^^^^^^^^^

PHPUnit is a TYPO3 extension which provides:

#. the `PHPUnit unit-testing framework
   <https://github.com/sebastianbergmann/phpunit/>`_ by Sebastian
   Bergmann

#. a framework for creating database records, faking a front end,
   creating dummy files and many more useful things

#. `vfsStream <http://code.google.com/p/bovigo/wiki/vfsStream>`_ (a
   virtual file system)

#. a back-end module to run unit tests for extensions of a TYPO3
   installation

#. a CLI test runner which can be used to run the tests from the command
   line, in a continuous-integration environment, or from within an IDE like PhpStorm