From d3081fa2314ac064c1054b58f4b11c332af6fe09 Mon Sep 17 00:00:00 2001 From: super3 Date: Tue, 22 Apr 2014 00:24:09 -0400 Subject: Removed LevelDB changes Syntax Highlighting --- qa/rpc-tests/README.md | 29 ++++++++++++++++++----------- src/test/README | 21 --------------------- src/test/README.md | 21 +++++++++++++++++++++ 3 files changed, 39 insertions(+), 32 deletions(-) delete mode 100644 src/test/README create mode 100644 src/test/README.md diff --git a/qa/rpc-tests/README.md b/qa/rpc-tests/README.md index 835ff11057..616c0525f4 100644 --- a/qa/rpc-tests/README.md +++ b/qa/rpc-tests/README.md @@ -1,22 +1,26 @@ Regression tests of RPC interface ================================= -python-bitcoinrpc: git subtree of https://github.com/jgarzik/python-bitcoinrpc +### [python-bitcoinrpc](https://github.com/jgarzik/python-bitcoinrpc) +Git subtree of [https://github.com/jgarzik/python-bitcoinrpc](https://github.com/jgarzik/python-bitcoinrpc). Changes to python-bitcoinrpc should be made upstream, and then -pulled here using git subtree +pulled here using git subtree. -skeleton.py : Copy this to create new regression tests. +### [skeleton.py](skeleton.py) +Copy this to create new regression tests. -listtransactions.py : Tests for the listtransactions RPC call +### [listtransactions.py](listtransactions.py) +Tests for the listtransactions RPC call. -util.py : generally useful functions +### [util.py](util.sh) +Generally useful functions. Bash-based tests, to be ported to Python: ----------------------------------------- -wallet.sh : Exercise wallet send/receive code. -walletbackup.sh : Exercise wallet backup / dump / import -txnmall.sh : Test proper accounting of malleable transactions -conflictedbalance.sh : More testing of malleable transaction handling +- wallet.sh : Exercise wallet send/receive code. +- walletbackup.sh : Exercise wallet backup / dump / import +- txnmall.sh : Test proper accounting of malleable transactions +- conflictedbalance.sh : More testing of malleable transaction handling Notes ===== @@ -32,5 +36,8 @@ test state. If you get into a bad state, you should be able to recover with: - rm -rf cache - killall bitcoind + +```bash +rm -rf cache +killall bitcoind +``` diff --git a/src/test/README b/src/test/README deleted file mode 100644 index 77f7faa815..0000000000 --- a/src/test/README +++ /dev/null @@ -1,21 +0,0 @@ -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 "_tests.cpp" and such files should wrap -their tests in a test suite called "_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/ diff --git a/src/test/README.md b/src/test/README.md new file mode 100644 index 0000000000..7efce6f052 --- /dev/null +++ b/src/test/README.md @@ -0,0 +1,21 @@ +# Notes +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 "_tests.cpp" and such files should wrap +their tests in a test suite called "_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/](http://www.alittlemadness.com/2009/03/31/c-unit-testing-with-boosttest/). \ No newline at end of file -- cgit v1.2.3