Bitcoin Forum

Bitcoin => Development & Technical Discussion => Topic started by: Steve on April 17, 2011, 12:32:10 AM



Title: unit tests
Post by: Steve on April 17, 2011, 12:32:10 AM
I've added support for boost based unit tests (and the corresponding support in the autotools Makefile.am) to my bitcoin branch.  I've only written a couple of trivial tests, but I'm interested in feedback on the approach that I took (and if you have any unit tests you'd like to contribute, I'd certainly welcome that):  http://github.com/gasteve/bitcoin (http://github.com/gasteve/bitcoin)

Here is src/test/README that explains how it works:
-----------------------------------------------------------

The sources in this directory are unit test cases.  Boost includes a
unit testing framework, and since bitcoin already uses boost, it makes
sense to simply use this framework rather than require developers to
configure some other framework (we want as few impediments to creating
unit tests as possible).

The build system is setup to compile an executable called "bitcoinTest"
that runs all of the unit tests.  The main source file is called
bitcoinTest.cpp, which simply includes other files that contain the
actual unit tests (outside of a couple required preprocessor
directives).  The pattern is to create one test file for each class or
source file for which you want to create unit tests.  The file naming
convention is "<source_filename>_tests.cpp" and such files should wrap
their tests in a test suite called "<source_filename>_tests".  For an
examples of this pattern, examine uint160_tests.cpp and
uint256_tests.cpp.

For further reading, I found the following website to be helpful in
explaining how the boost unit test framework works:

http://www.alittlemadness.com/2009/03/31/c-unit-testing-with-boosttest/


Title: Re: unit tests
Post by: Gavin Andresen on June 21, 2011, 08:27:31 PM
Anybody else already working on tests?

Steve: mind if I pull out just the boost-unit-test bits of your tree?


Title: Re: unit tests
Post by: Steve on June 22, 2011, 04:51:02 AM
Of course!  I've not been doing much (any) work on the main client lately...just because I've been toiling away on another project.  I did little more than create a sample unit test using the boost framework.