| 1 |
Swishetest version 0.05 |
|---|
| 2 |
======================= |
|---|
| 3 |
|
|---|
| 4 |
This is a module for testing Swish-e. Includes data and tests. |
|---|
| 5 |
|
|---|
| 6 |
The tests are performed by first installing Swish-e and SWISH::API, then: |
|---|
| 7 |
* untarring the Swishetest.x.xx.tar.gz tarball |
|---|
| 8 |
* perl Makefile.PL |
|---|
| 9 |
* make && make test |
|---|
| 10 |
(this module is not intended to be installed at this point) |
|---|
| 11 |
|
|---|
| 12 |
Swishetest.pm implements two functions which are simple interfaces |
|---|
| 13 |
to build and search on swishe indices : build_index() and do_search(). |
|---|
| 14 |
See perldoc Swishetest.pm for more. |
|---|
| 15 |
|
|---|
| 16 |
In the t/ directory are the perl scripts that perform tests using Swishetest. |
|---|
| 17 |
They're typically run via 'make test' |
|---|
| 18 |
'make test TEST_VERBOSE=1' will give you more debug output, |
|---|
| 19 |
'make test TEST_VERBOSE=2' will give you even more debug output (try it). |
|---|
| 20 |
|
|---|
| 21 |
'make test MAX_INDEX_FILES=1000' will use only 1000 files in the test index |
|---|
| 22 |
|
|---|
| 23 |
The tests in the t/ directory are named like |
|---|
| 24 |
010-C010-trivial-txt.t , that is |
|---|
| 25 |
[Test#]-[CollectionNumber]-[Description]-[type].t |
|---|
| 26 |
(Don't put hyphens ('-'s) in your Description.) |
|---|
| 27 |
|
|---|
| 28 |
In the conf/ directory are swish-e configuration files used for the testing. |
|---|
| 29 |
The basic configurations so far are |
|---|
| 30 |
basic-libxml2.conf and |
|---|
| 31 |
basic-nolibxml2.conf |
|---|
| 32 |
which each set .html, .xml, and .txt files to the appropriate parsers. |
|---|
| 33 |
More can be added. (It would be good if users could specify all options from |
|---|
| 34 |
the command line and not have to use config files, perhaps through a |
|---|
| 35 |
-O switch that would act as if the text had been found in the config file: |
|---|
| 36 |
would be used like % swish-e -O'IndexOnly .html' -i htmldir/ -f swish.index ) |
|---|
| 37 |
|
|---|
| 38 |
The blib/index/ directory is where the test indexes are deposited. This way |
|---|
| 39 |
they get cleaned up when you type 'make clean' |
|---|
| 40 |
|
|---|
| 41 |
INSTALLATION |
|---|
| 42 |
|
|---|
| 43 |
This package is not currently intended to be 'install'ed. To use this module |
|---|
| 44 |
type the following: |
|---|
| 45 |
|
|---|
| 46 |
perl Makefile.PL |
|---|
| 47 |
make |
|---|
| 48 |
make test |
|---|
| 49 |
(this package is not intended to be installed... at this point) |
|---|
| 50 |
|
|---|
| 51 |
DEPENDENCIES |
|---|
| 52 |
|
|---|
| 53 |
This module requires these other modules and libraries: |
|---|
| 54 |
|
|---|
| 55 |
SWISH::API |
|---|
| 56 |
|
|---|
| 57 |
COPYRIGHT AND LICENCE |
|---|
| 58 |
|
|---|
| 59 |
Copyright (C) 2004-2007 Josh Rabinowitz |
|---|
| 60 |
|
|---|
| 61 |
This library is free software; you can redistribute it and/or modify |
|---|
| 62 |
it under the same terms as Perl itself. |
|---|
| 63 |
|
|---|
