Developer Guide

Creating the Makefile

Run perl Makefile.PL to create the Makefile, which you can then use to run tests or create a distribution.

Tests

All the tests are located in the t directory, and are named with a numerical prefix and a *.t suffix, following the convention for Perl modules.

Assuming you've created the Makefile, you can run tests just by doing make test. Some of the tests require that you have the Arabidopsis index installed in a _testing subdirectory. If you have that index installed, make test will run them. If you don't, make test will just skip those tests. You can install the index by doing ./bin/rum_indexes --prefix _testing --install arabidopsis.

To run a single test, for example the 04-common.t test, you can do either perl t/04-common.t or make test TEST_FILES=t/04-common.t. The former will produce verbose output, and the latter will just produce summary output.

Test Coverage

You can easily create a report showing the test coverage of all the *.pm files using Devel::Cover. To get the coverage report for all modules, run

HARNESS_PERL_SWITCHES=-MDevel::Cover make test
cover

The first line will run the tests with Devel::Cover enabled, accumulating coverage data. The cover command then reads the coverage data and produces a nice human-readable report in cover_db/coverage.html.

You can get coverage information for a subset of the test files by running:

HARNESS_PERL_SWITCHES=-MDevel::Cover make test TEST_FILES=<files>
cover