Author: bernhard Date: Wed Dec 28 02:19:37 2005 New Revision: 10719 Modified: trunk/docs/tests.pod trunk/t/README (contents, props changed) Log: docs: Going over docs/tests.pod. Mention SKIP and add one line descriptions of the subdirs in 't'.
Modified: trunk/docs/tests.pod ============================================================================== --- trunk/docs/tests.pod (original) +++ trunk/docs/tests.pod Wed Dec 28 02:19:37 2005 @@ -7,9 +7,10 @@ docs/tests.pod - Testing Parrot =head1 A basic guide to writing and running tests for Parrot -This is quick and dirty pointer to how tests for Parrot should be written. The -testing system is liable to change in the future, but tests written following -the guidelines below should be easy to port into a new test suite. +This is quick and dirty pointer to how the Parrot test suite is executed and +to how new tests for Parrot should be written. +The testing system is liable to change in the future, but tests written +following the guidelines below should be easy to port into a new test suite. =head1 How to test parrot @@ -38,12 +39,19 @@ C<make smokej>. C<make languages-smoke> does smoke testing for most language implementations in the languages directory. -=head1 How to write a test +=head1 Location of the test files + +The parrot test files, the F<*.t> files, can be found in the F<t> directory. +A quick overview over the subdirs in F<t> can be found in F<t/README>. -New tests should be added to F<*.t> files. These test files can be found in the -directories F<t>, F<imcc/t> and F<languages/*/t>. If a new feature is tested, +The language implementations usually have their test files in F<languages/*/t>. + +New tests should be added to an existing F<*.t> file. +If a previously untested feature is tested, it might also make sense to create a new F<*.t> file. +=head1 How to write a test + The testing framework needs to know how many tests it should expect. So the number of planned tests needs to be incremented when adding a new test. This is done near the top of a test file, in a line that looks like: @@ -159,7 +167,14 @@ Are a chunk of assembler and a chunk of In test driven development, tests are implemented first. So the tests are initially expected to fail. This can be expressed by marking the tests as -TODO. See L<Test::More> on how to do that. +TODO. See L<Test::More> on how to do that. + +=head1 SKIP tests + +TODO test actually executed, so that unexpected success can be detected. +In the case of missing requirements and in the case of serious breakdowns +the execution of tests can be skipped. +See L<Test::More> on how to do that. =head1 SEE ALSO Modified: trunk/t/README ============================================================================== --- trunk/t/README (original) +++ trunk/t/README Wed Dec 28 02:19:37 2005 @@ -1,5 +1,35 @@ # Copyright: 2005 The Perl Foundation. All Rights Reserved. # $Id$ -The directory contains part of the Parrot test suite. +This directory contains the Parrot test suite. For details see the documentation in 'docs/tests.pod'. + +compilers: Mini languages distributed with Parrot + +configure: Configuration subsystem + +distro: Contains currently only a check for sanity of MANIFEST.SKIP + +doc: Completeness and sanity of the documentations + +dynclass: Dynamic PMCs + +examples: Check whether the examples are still working + +library: Parrot modules + +native_pbc: Parrot Byte Code + +op: Try to cover all ops + +perl: Tests written in Perl5. XXX Is this a meaningful category? + +pmc: Try to cover all builtin PMCs + +run: Mostly command line options of the 'parrot' executable + +src: Tests written in C. XXX Is this a meaningful category? + +stress: Stress testing + +tools: Executables besides 'parrot'
