src/test/README.md

   1 ### Compiling/running unit tests
   2
   3 Unit tests will be automatically compiled if dependencies were met in `./configure`
   4 and tests weren't explicitly disabled.
   5
   6 After configuring, they can be run with `make check`.
   7
   8 To run the bitcoind tests manually, launch `src/test/test_bitcoin`. To recompile
   9 after a test file was modified, run `make` and then run the test again. If you
  10 modify a non-test file, use `make -C src/test` to recompile only what's needed
  11 to run the bitcoind tests.
  12
  13 To add more bitcoind tests, add `BOOST_AUTO_TEST_CASE` functions to the existing
  14 .cpp files in the `test/` directory or add new .cpp files that
  15 implement new BOOST_AUTO_TEST_SUITE sections.
  16
  17 To run the bitcoin-qt tests manually, launch `src/qt/test/test_bitcoin-qt`
  18
  19 To add more bitcoin-qt tests, add them to the `src/qt/test/` directory and
  20 the `src/qt/test/test_main.cpp` file.
  21
  22 ### Running individual tests
  23
  24 test_bitcoin has some built-in command-line arguments; for
  25 example, to run just the getarg_tests verbosely:
  26
  27     test_bitcoin --log_level=all --run_test=getarg_tests
  28
  29 ... or to run just the doubledash test:
  30
  31     test_bitcoin --run_test=getarg_tests/doubledash
  32
  33 Run `test_bitcoin --help` for the full list.
  34
  35 ### Note on adding test cases
  36
  37 The sources in this directory are unit test cases.  Boost includes a
  38 unit testing framework, and since bitcoin already uses boost, it makes
  39 sense to simply use this framework rather than require developers to
  40 configure some other framework (we want as few impediments to creating
  41 unit tests as possible).
  42
  43 The build system is setup to compile an executable called `test_bitcoin`
  44 that runs all of the unit tests.  The main source file is called
  45 test_bitcoin.cpp. To add a new unit test file to our test suite you need
  46 to add the file to `src/Makefile.test.include`. The pattern is to create
  47 one test file for each class or source file for which you want to create
  48 unit tests.  The file naming convention is `<source_filename>_tests.cpp`
  49 and such files should wrap their tests in a test suite
  50 called `<source_filename>_tests`. For an example of this pattern,
  51 examine `uint256_tests.cpp`.
  52
  53 For further reading, I found the following website to be helpful in
  54 explaining how the boost unit test framework works:
  55 [http://www.alittlemadness.com/2009/03/31/c-unit-testing-with-boosttest/](http://archive.is/dRBGf).