diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2019-11-05 15:55:49 -0500 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2019-11-06 11:56:53 -0500 |
| commit | fa4c6fa9b1139791f45f1495d662c1c7cd2f7ed6 (patch) | |
| tree | 5e3268d8a7072c8c033231c2bb7a782abe2c68c6 /src/test | |
| parent | faec28252cf4f8e754c689a7a44fd421f631db50 (diff) | |
doc: Add documentation for new test/lib
Diffstat (limited to 'src/test')
| -rw-r--r-- | src/test/README.md | 4 | ||||
| -rw-r--r-- | src/test/util/README.md | 11 |
2 files changed, 13 insertions, 2 deletions
diff --git a/src/test/README.md b/src/test/README.md index 96dcb072bc..731720f654 100644 --- a/src/test/README.md +++ b/src/test/README.md @@ -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 diff --git a/src/test/util/README.md b/src/test/util/README.md new file mode 100644 index 0000000000..36ad645201 --- /dev/null +++ b/src/test/util/README.md @@ -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). |