diff options
| author | JamesC <james.chiangwu@gmail.com> | 2019-10-24 20:33:06 +0200 |
|---|---|---|
| committer | James Chiang <james.chiangwu@gmail.com> | 2019-11-04 16:02:28 +0100 |
| commit | 19139ee034d20ebab1b91d3ac13a8eee70b59374 (patch) | |
| tree | d3b7757292a9eddcf00e15daa910f7d7b0188a1a /test/functional/README.md | |
| parent | f5112369cf91451d2d0bf574a9bfdaea04696939 (diff) | |
Add documentation for test_shell submodule
Diffstat (limited to 'test/functional/README.md')
| -rw-r--r-- | test/functional/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/test/functional/README.md b/test/functional/README.md index a9b83076eb..77a9ce9acb 100644 --- a/test/functional/README.md +++ b/test/functional/README.md @@ -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). |