phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-04-29 14:59:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

test: fix TestShell initialization and reset()

Browse source
This commit is contained in:
Brandon Odiwuor 2024-12-03 12:42:56 +03:00
parent ebe4cac38b
commit 303f8cca05
2 changed files with 13 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
test/functional/test-shell.md
View file

@ -24,13 +24,16 @@ user inputs. Such environments include the Python3 command line interpreter or
## 2. Importing `TestShell` from the Bitcoin Core repository ## 2. Importing `TestShell` from the Bitcoin Core repository
We can import the `TestShell` by adding the path of the Bitcoin Core We can import the `TestShell` by adding the path of the configured Bitcoin Core
`test_framework` module to the beginning of the PATH variable, and then `test_framework` module to the beginning of the PATH variable, and then
importing the `TestShell` class from the `test_shell` sub-package. importing the `TestShell` class from the `test_shell` sub-package. Since
the build system creates a copy of the `test_framework` module into a new `build/`
directory along with the required configuration file, the path to the build copy
must be used.
``` ```
>>> import sys >>> import sys
>>> sys.path.insert(0, "/path/to/bitcoin/test/functional") >>> sys.path.insert(0, "/path/to/bitcoin/build/test/functional")
>>> from test_framework.test_shell import TestShell >>> from test_framework.test_shell import TestShell
``` ```
@ -155,7 +158,7 @@ To prevent the logs from being removed after a shutdown, simply set the
The following utility consolidates logs from the bitcoind nodes and the The following utility consolidates logs from the bitcoind nodes and the
underlying `BitcoinTestFramework`: underlying `BitcoinTestFramework`:
* `/path/to/bitcoin/test/functional/combine_logs.py * `/path/to/bitcoin/build/test/functional/combine_logs.py
'/path/to/bitcoin_func_test_XXXXXXX'` '/path/to/bitcoin_func_test_XXXXXXX'`
## 6. Custom `TestShell` parameters ## 6. Custom `TestShell` parameters
@ -170,9 +173,9 @@ can be called after the TestShell is shut down.
| Test parameter key | Default Value | Description | | Test parameter key | Default Value | Description |
|---|---|---| |---|---|---|
| `bind_to_localhost_only` | `True` | Binds bitcoind P2P services to `127.0.0.1` if set to `True`.| | `bind_to_localhost_only` | `True` | Binds bitcoind P2P services to `127.0.0.1` if set to `True`.|
| `cachedir` | `"/path/to/bitcoin/test/cache"` | Sets the bitcoind datadir directory. | | `cachedir` | `"/path/to/bitcoin/build/test/cache"` | Sets the bitcoind datadir directory. |
| `chain` | `"regtest"` | Sets the chain-type for the underlying test bitcoind processes. | | `chain` | `"regtest"` | Sets the chain-type for the underlying test bitcoind processes. |
| `configfile` | `"/path/to/bitcoin/test/config.ini"` | Sets the location of the test framework config file. | | `configfile` | `"/path/to/bitcoin/build/test/config.ini"` | Sets the location of the test framework config file. |
| `coveragedir` | `None` | Records bitcoind RPC test coverage into this directory if set. | | `coveragedir` | `None` | Records bitcoind RPC test coverage into this directory if set. |
| `loglevel` | `INFO` | Logs events at this level and higher. Can be set to `DEBUG`, `INFO`, `WARNING`, `ERROR` or `CRITICAL`. | | `loglevel` | `INFO` | Logs events at this level and higher. Can be set to `DEBUG`, `INFO`, `WARNING`, `ERROR` or `CRITICAL`. |
| `nocleanup` | `False` | Cleans up temporary test directory if set to `True` during `shutdown`. | | `nocleanup` | `False` | Cleans up temporary test directory if set to `True` during `shutdown`. |

7
test/functional/test_framework/test_shell.py
View file

@ -61,7 +61,8 @@ class TestShell:
print("Shutdown TestShell before resetting!") print("Shutdown TestShell before resetting!")
else: else:
self.num_nodes = None self.num_nodes = None
super().__init__() dummy_testshell_file = pathlib.Path(__file__).absolute().parent.parent / "testshell_dummy.py"
super().__init__(dummy_testshell_file)
instance = None instance = None
@ -74,8 +75,8 @@ class TestShell:
# cache. Since TestShell is meant for interactive use, there is no concrete # cache. Since TestShell is meant for interactive use, there is no concrete
# test; passing a dummy name is fine though, as only the containing directory # test; passing a dummy name is fine though, as only the containing directory
# is relevant for successful initialization. # is relevant for successful initialization.
tests_directory = pathlib.Path(__file__).resolve().parent.parent dummy_testshell_file = pathlib.Path(__file__).absolute().parent.parent / "testshell_dummy.py"
TestShell.instance = TestShell.__TestShell(tests_directory / "testshell_dummy.py") TestShell.instance = TestShell.__TestShell(dummy_testshell_file)
TestShell.instance.running = False TestShell.instance.running = False
return TestShell.instance return TestShell.instance