~drizzle-trunk/drizzle/development : contents of unittest/README.txt at revision 27

~drizzle-trunk/drizzle/development : (revision 27)

Unit tests directory structure
------------------------------

This is the current structure of the unit tests.  More directories
will be added over time.

mytap                 Source for the MyTAP library
mysys                 Tests for mysys components
  bitmap-t.c          Unit test for MY_BITMAP
  base64-t.c          Unit test for base64 encoding functions
examples              Example unit tests.
  core-t.c            Example of raising a signal in the middle of the test
		      THIS TEST WILL STOP ALL FURTHER TESTING!
  simple-t.c          Example of a standard TAP unit test
  skip-t.c            Example where some test points are skipped
  skip_all-t.c        Example of a test where the entire test is skipped
  todo-t.c            Example where test contain test points that are TODO
  no_plan-t.c         Example of a test with no plan (avoid this)


Executing unit tests
--------------------

To make and execute all unit tests in the directory:

   make test

Observe that the tests in the examples/ directory are just various
examples of tests and are not expected to pass.


Adding unit tests
-----------------

Add a file with a name of the format "foo-t.c" to the appropriate
directory and add the following to the Makefile.am in that directory
(where ... denotes stuff already there):

  noinst_PROGRAMS = ... foo-t

Note, it's important to have "-t" at the end of the filename, otherwise the
test won't be executed by 'make test' !


Documentation
-------------

The generated documentation is temporarily placed at:

      http://www.kindahl.net/mytap/doc/

I will move it to a better place once I figure out where and how.


1 by brian clean slate	1	Unit tests directory structure
	2	------------------------------
	3
	4	This is the current structure of the unit tests. More directories
	5	will be added over time.
	6
	7	mytap Source for the MyTAP library
	8	mysys Tests for mysys components
	9	bitmap-t.c Unit test for MY_BITMAP
	10	base64-t.c Unit test for base64 encoding functions
	11	examples Example unit tests.
	12	core-t.c Example of raising a signal in the middle of the test
	13	THIS TEST WILL STOP ALL FURTHER TESTING!
	14	simple-t.c Example of a standard TAP unit test
	15	skip-t.c Example where some test points are skipped
	16	skip_all-t.c Example of a test where the entire test is skipped
	17	todo-t.c Example where test contain test points that are TODO
	18	no_plan-t.c Example of a test with no plan (avoid this)
	19
	20
	21	Executing unit tests
	22	--------------------
	23
	24	To make and execute all unit tests in the directory:
	25
	26	make test
	27
	28	Observe that the tests in the examples/ directory are just various
	29	examples of tests and are not expected to pass.
	30
	31
	32	Adding unit tests
	33	-----------------
	34
	35	Add a file with a name of the format "foo-t.c" to the appropriate
	36	directory and add the following to the Makefile.am in that directory
	37	(where ... denotes stuff already there):
	38
	39	noinst_PROGRAMS = ... foo-t
	40
	41	Note, it's important to have "-t" at the end of the filename, otherwise the
	42	test won't be executed by 'make test' !
	43
	44
	45	Documentation
	46	-------------
	47
	48	The generated documentation is temporarily placed at:
	49
	50	http://www.kindahl.net/mytap/doc/
	51
	52	I will move it to a better place once I figure out where and how.
	53