highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2026-04-27 23:39:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for test_shell submodule

Browse Source
This commit is contained in:
JamesC
2019-10-24 20:33:06 +02:00
committed by James Chiang
parent f5112369cf
commit 19139ee034
2 changed files with 198 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
test/functional/README.md
View File

@@ -99,6 +99,16 @@ P2PInterface object and override the callback methods.
Examples tests are [p2p_unrequested_blocks.py](p2p_unrequested_blocks.py),
[p2p_compactblocks.py](p2p_compactblocks.py).
#### Prototyping tests
The [`TestShell`](test-shell.md) class exposes the BitcoinTestFramework
functionality to interactive Python3 environments and can be used to prototype
tests. This may be especially useful in a REPL environment with session logging
utilities, such as
[IPython](https://ipython.readthedocs.io/en/stable/interactive/reference.html#session-logging-and-restoring).
The logs of such interactive sessions can later be adapted into permanent test
cases.
### Test framework modules
The following are useful modules for test developers. They are located in
[test/functional/test_framework/](test_framework).