◐ Shell
clean mode source ↗

Testing_DocTest

Top Level :: Tools and Utilities :: Testing

Package Information: Testing_DocTest

This package is not maintained, if you would like to take over please go to this page.

» Summary » License
A Unit Test framework for writing tests in your php code docstrings. MIT
» Current Release » Bug Summary
0.6.0 (beta) was released on 2013-01-17 by tobiac (Changelog)
Easy Install

Not sure? Get more info.

pear install Testing_DocTest

Pyrus Install

Try PEAR2's installer, Pyrus.

php pyrus.phar install pear/Testing_DocTest

 No open bugs
Report a new bug to Testing_DocTest
» Description
Testing_DocTest allows the developer to write unit tests directly in the <code></code> blocs of your functions, classes and class methods doc comments.

It comes with a default runner (phpdt) that will parse all your <code></code> blocs and will run the extracted tests.
Running tests is as simple as:

$ phpdt /path/to/your/code

There are several advantages in using Testing_DocTest:
* it makes unit tests writing funnier, easier and quicker (there's no infrastructure to setup, you just install the package, write your code examples tests and you're done !);
* it ensures that doc comments are up-to-date by verifying that all examples work as documented;
* it enforces writing of tutorial documentation, liberally illustrated with input-output examples.
» Maintainers » More Information
  • (lead)
  • (lead)