aboutsummaryrefslogtreecommitdiff
path: root/src/test/README
diff options
context:
space:
mode:
authorWladimir J. van der Laan <laanwj@gmail.com>2011-07-15 15:12:01 +0200
committerWladimir J. van der Laan <laanwj@gmail.com>2011-07-15 15:12:17 +0200
commit19366be186a9a2efff1e6abfe8db59cd9f5f5843 (patch)
tree3abb4adeab1a4e86a08bb5bfe61dedf8be178a1c /src/test/README
parent249c6818f171b75930736872d61b0cdcda7e9832 (diff)
parenta35ee9633690fbadc001b2d8fe1dd3ebb852dc25 (diff)
Merge remote-tracking branch 'satoshi/qtui'
Conflicts (resolved by copying files from remote branch): .gitignore src/cryptopp/cpu.cpp src/cryptopp/cpu.h src/cryptopp/cryptlib.h src/cryptopp/iterhash.h src/cryptopp/misc.h src/cryptopp/secblock.h src/cryptopp/sha.cpp src/cryptopp/sha.h src/cryptopp/smartptr.h src/json/json_spirit_reader.cpp src/json/json_spirit_value.cpp src/json/json_spirit_writer.cpp
Diffstat (limited to 'src/test/README')
-rw-r--r--src/test/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/src/test/README b/src/test/README
new file mode 100644
index 0000000000..77f7faa815
--- /dev/null
+++ b/src/test/README
@@ -0,0 +1,21 @@
+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"
+that runs all of the unit tests. The main source file is called
+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
+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/