Skip to content

Commit

Permalink
doc: Add documentation for new test/lib
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcoFalke committed Nov 6, 2019
1 parent faec282 commit fa4c6fa
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ configure some other framework (we want as few impediments to creating
unit tests as possible).

The build system is set up to compile an executable called `test_bitcoin`
that runs all of the unit tests. The main source file is called
`setup_common.cpp`.
that runs all of the unit tests. The main source file for the test library is found in
`util/setup_common.cpp`.

### Compiling/running unit tests

Expand Down
11 changes: 11 additions & 0 deletions src/test/util/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Test library

This contains files for the test library, which is used by the test binaries (unit tests, benchmarks, fuzzers, gui
tests).

Generally, the files in this folder should be well-separated modules. New code should be added to existing modules or
(when in doubt) a new module should be created.

The utilities in here are compiled into a library, which does not hold any state. However, the main file `setup_common`
defines the common test setup for all test binaries. The test binaries will handle the global state when they
instantiate the `BasicTestingSetup` (or one of its derived classes).

0 comments on commit fa4c6fa

Please sign in to comment.