diff options
| author | Chris Stewart <stewart.chris1234@gmail.com> | 2016-07-29 11:52:48 -0500 |
|---|---|---|
| committer | Luke Dashjr <luke-jr+git@utopios.org> | 2016-09-21 02:43:47 +0000 |
| commit | 9b0097976f4e593103cdf4594eb68de9bf9d60b3 (patch) | |
| tree | e6114418cc2c4f6ebb0578bd714e2d781bd6e4d2 /src/test | |
| parent | 8bb1efd9859726e992e4bf21de19f954d2bb2ab0 (diff) | |
| download | bitcoin-9b0097976f4e593103cdf4594eb68de9bf9d60b3.tar.xz | |
Update README.md
Updating documentation for adding new unit test files
Removing unneeded sentence from README
Removing uint160_tests.cpp as it DNE
Formatting command line instructions to use ``
fixing 80 char formatting issue in README
fixing more nits
Github-Pull: #8428
Rebased-From: b8db185952c815444b7052092472ef9af3a42e89
Diffstat (limited to 'src/test')
| -rw-r--r-- | src/test/README.md | 21 |
1 files changed, 9 insertions, 12 deletions
diff --git a/src/test/README.md b/src/test/README.md index b2d6be14f1..61462642bf 100644 --- a/src/test/README.md +++ b/src/test/README.md @@ -5,18 +5,15 @@ 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 -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. - -Add the source files to /src/Makefile.test.include to add them to the build. +test_bitcoin.cpp. To add a new unit test file to our test suite you need +to add the file to `src/Makefile.test.include`. 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 example of this pattern, +examine `uint256_tests.cpp`. For further reading, I found the following website to be helpful in explaining how the boost unit test framework works: @@ -31,5 +28,5 @@ example, to run just the getarg_tests verbosely: test_bitcoin --run_test=getarg_tests/doubledash -Run test_bitcoin --help for the full list. +Run `test_bitcoin --help` for the full list. |