4 You probably got this package from:
6 http://simpletest.org/en/download.html
8 If there is no licence agreement with this package please download
9 a version from the location above. You must read and accept that
10 licence to use this software. The file is titled simply LICENSE.
12 What is it? It's a framework for unit testing, web site testing and
13 mock objects for PHP 5.0.5+.
15 If you have used JUnit, you will find this PHP unit testing version very
16 similar. Also included is a mock objects and server stubs generator.
17 The stubs can have return values set for different arguments, can have
18 sequences set also by arguments and can return items by reference.
19 The mocks inherit all of this functionality and can also have
20 expectations set, again in sequences and for different arguments.
22 A web tester similar in concept to JWebUnit is also included. There is no
23 JavaScript or tables support, but forms, authentication, cookies and
26 You can see a release schedule at http://simpletest.org/en/overview.html
27 which is also copied to the documentation folder with this release.
28 A full PHPDocumenter API documentation exists at
29 http://simpletest.org/api/.
31 The user interface is minimal in the extreme, but a lot of information
32 flows from the test suite. After version 1.0 we will release a better
33 web UI, but we are leaving XUL and GTK versions to volunteers as
34 everybody has their own opinion on a good GUI, and we don't want to
35 discourage development by shipping one with the toolkit. You can
36 download an Eclipse plug-in separately.
38 The unit tests for SimpleTest itself can be run here:
42 And tests involving live network connections as well are here:
46 The full tests will typically overrun the 8Mb limit often allowed
47 to a PHP process. A workaround is to run the tests on the command
48 with a custom php.ini file or with the switch -dmemory_limit=-1
49 if you do not have access to your server version.
51 The full tests read some test data from simpletest.org. If the site
52 is down or has been modified for a later version then you will get
53 spurious errors. A unit_tests.php failure on the other hand would be
54 very serious. Please notify us if you find one.
56 Even if all of the tests run please verify that your existing test suites
57 also function as expected. The file:
59 HELP_MY_TESTS_DONT_WORK_ANYMORE
61 ...contains information on interface changes. It also points out
62 deprecated interfaces, so you should read this even if all of
63 your current tests appear to run.
65 There is a documentation folder which contains the core reference information
66 in English and French, although this information is fairly basic.
67 You can find a tutorial on...
69 http://simpletest.org/en/first_test_tutorial.html
71 ...to get you started and this material will eventually become included
72 with the project documentation. A French translation exists at:
74 http://simpletest.org/fr/first_test_tutorial.html
76 If you download and use, and possibly even extend this tool, please let us
77 know. Any feedback, even bad, is always welcome and we will work to get
78 your suggestions into the next release. Ideally please send your
81 simpletest-support@lists.sourceforge.net
83 ...so that others can read them too. We usually try to respond within 48
86 There is no change log except at Sourceforge. You can visit the
87 release notes to see the completed TODO list after each cycle and also the
88 status of any bugs, but if the bug is recent then it will be fixed in SVN only.
89 The SVN check-ins always have all the tests passing and so SVN snapshots should
90 be pretty usable, although the code may not look so good internally.
92 Oh, and one last thing: SimpleTest is called "Simple" because it should
93 be simple to use. We intend to add a complete set of tools for a test
94 first and "test as you code" type of development. "Simple" does not mean
95 "Lite" in this context.
97 Thanks to everyone who has sent comments and offered suggestions. They
98 really are invaluable, but sadly you are too many to mention in full.
99 Thanks to all on the advanced PHP forum on SitePoint, especially Harry
100 Fuecks. Early adopters are always an inspiration.
102 -- Marcus Baker, Jason Sweat, Travis Swicegood, Perrick Penet and Edward Z. Yang.