readme

来自「db.* (pronounced dee-be star) is an adva」· 代码 · 共 95 行

db.star Test Suite

db.* includes a test suite primarily for developers who will be editing the
code to db.* itself.  This suite tests the functionality of the d_functions
provided by the db.* API.  Output is presented in a straightforward manner to
STDOUT, listing whether each unit test has passed or failed.  

The main test program runs as a single process and currently requires no file
I/O as to be the most compatible with different kinds of embedded systems.

The main program runs several smaller unit tests defined as C functions,
probing specific functionality of the system.


How to run
==========

To run the test suite after building db.*, use the command:

make check

This command will build and run the test suite. A database file will be created
in the current directory by the test suite.

You can also build and install the test program with the command:

make installcheck

See readme.1st for more information on using the test suites with a
cross-compiler.


Tests
=====

All tests are broken down into related subsets.  A description of each subset
and the d_functions tested, are listed below.

Set01 - Database Modification

This set works with database level modification functions like d_open and
d_close.  These are the first tests to be run, because they are required for
all other database access tasks.

functions tested:
    d_sopen()
    d_opentask()
    d_initialize()
    d_close()
    d_closetask()


Set02 - Data Manipulation

This set tests functions that manipulate the actual data within the database.
This includes adding/updating/deleting records and their fields.

functions tested:
    d_fillnew()
    d_recread()
    d_crwrite()
    d_crread()
    d_delete()


Set03 - Data Retrieval

This set tests different methods of retrieving data from the database
including access via indexed key or via set pointers.

functions tested:
    these tests are not yet implemented


Adding Tests
============

The current suite does not test all d_functions.  Adding new tests is
straightforward, but requires editing the source files.

To Add A New Test:
    1. find the proper set in which the test belongs
    2. add the function definition to set##.c file
    3. add the function prototype to set##.h file
    4. add the function name to set##[] array in set##.c
    5. increase value of set##_length constant in set##.c


To Add A New Test Set:
    1. create a set##.c file
    2. create a set##.h file
    3. include set##.h in the test.c file
    4. call the set##_tests() function within run_tests() in test.c