Update some unit test stuff

This commit is contained in:
Duke Leto
2019-12-23 20:01:55 -05:00
parent 20fd7f0ce0
commit 227a26f64f

View File

@@ -1,13 +1,14 @@
# Notes
# Hush Unit tests
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 "test_bitcoin"
The build system is setup to compile an executable called `test_bitcoin`
that runs all of the unit tests. The main source file is called
test_bitcoin.cpp, which simply includes other files that contain the
`test_bitcoin.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
@@ -20,4 +21,5 @@ Add the source files to /src/Makefile.test.include to add them to the build.
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/](http://www.alittlemadness.com/2009/03/31/c-unit-testing-with-boosttest/).
[http://www.alittlemadness.com/2009/03/31/c-unit-testing-with-boosttest/](http://www.alittlemadness.com/2009/03/31/c-unit-testing-with-boosttest/).