Skip to content

Commit

Permalink
Update CHANGELOG, README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick Sinopoli authored and Nick Sinopoli committed Feb 17, 2012
1 parent 8ad55ec commit 7192df2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
9 changes: 8 additions & 1 deletion CHANGELOG.rst
@@ -1,6 +1,13 @@
Changelog
=========

v1.5.5
------

* Change require -> require_once to avoid errors (GH-34)
* Don't require files to share the same name as the test classes (GH-33)
* Fix output buffering (GH-23)

v1.5.4
------

Expand Down Expand Up @@ -42,7 +49,7 @@ v1.4
----

* Overhaul the UI
* Fix issues with namespaced tests
* Fix issues with namespaced tests
* Implement a better check for archived files


Expand Down
16 changes: 8 additions & 8 deletions README.rst
@@ -1,7 +1,7 @@
VisualPHPUnit
=============

VisualPHPUnit is a visual front-end for PHPUnit. Written in PHP, it aims to make unit testing more appealing.
VisualPHPUnit is a visual front-end for PHPUnit. Written in PHP, it aims to make unit testing more appealing.

Features
--------
Expand All @@ -10,13 +10,13 @@ VisualPHPUnit provides the following features:

* A stunning front-end which organizes test and suite results
* The ability to view unit testing progress via graphs
* An option to maintain a history of unit test results through the use of visual logs
* An option to maintain a history of unit test results through the use of visual logs
* Enumeration of PHPUnit statistics and messages
* Convenient display of any debug messages written within unit tests
* Sandboxing of PHP errors/exceptions

Screenshots
----------
-----------

.. image:: http://echodrop.net/code/vpu/ss7.png
.. image:: http://echodrop.net/code/vpu/ss8.png
Expand All @@ -38,30 +38,30 @@ Installation
Configuration (optional)
------------------------

If you wish to set the default options for each test run, you can do so by modifying a few more lines in config.php.
If you wish to set the default options for each test run, you can do so by modifying a few more lines in config.php.

1. Change CREATE_SNAPSHOTS to *true* if you'd like to enable logging. Logs are stored in the 'history' directory, though you can modify SNAPSHOT_DIRECTORY to point somewhere else if you please. Please make note of the following:
- You will have to give the directory specified in SNAPSHOT_DIRECTORY the appropriate permissions in order to allow PHP to write to it.
- The dropdown list under the 'Archives' section on the homepage will only display the files found within SNAPSHOT_DIRECTORY.
2. Change SANDBOX_ERRORS to *true* if you'd like VPU to display any PHP errors after the test results. If so, please make note of the following:
- The file specified in SANDBOX_FILENAME will always be empty (VPU wipes it at the end of each test run). However, PHP still needs to be able to write to it, so ensure that the filename specified with SANDBOX_FILENAME has the appropriate permissions.
- The file specified in SANDBOX_FILENAME will always be empty (VPU wipes it at the end of each test run). However, PHP still needs to be able to write to it, so ensure that the filename specified with SANDBOX_FILENAME has the appropriate permissions.
- Specific error types can be ignored using the SANDBOX_IGNORE setting. Separate multiple error types with a '|' (e.g. 'E_STRICT|E_NOTICE').
3. If you'd like to enable graph generation, you will have to do the following:
- Change STORE_STATISTICS to *true*. If you'd like, you can keep this set as 'false', though you will have to change the 'Store Statistics' option to 'Yes' on the UI if you want the test statistics to be used in graph generation.
- Run the migration 01_CREATE_SCHEMA (found in the 'migrations' directory) against a MySQL database. Note that this will automatically create a database named 'vpu' with the tables needed to save your test statistics.
- Update each of the DATABASE_* constants to reflect your database settings. Note that if you're using the migration described above, DATABASE_NAME should remain set to 'vpu'.
- Update each of the DATABASE_* constants to reflect your database settings. Note that if you're using the migration described above, DATABASE_NAME should remain set to 'vpu'.
4. If your unit tests require any bootstraps, you can define them at the bottom of config.php in the appropriate '$bootstraps' array.

Version Information
-------------------

Current stable release is v1.5.4, last updated on 14 November 2011.
Current stable release is v1.5.5, last updated on 17 February 2012.

Feedback
--------

Feel free to send any feedback you may have regarding this project to NSinopoli@gmail.com.
Feel free to send any feedback you may have regarding this project to NSinopoli@gmail.com.

Credits
-------
Expand Down

0 comments on commit 7192df2

Please sign in to comment.