sikkienl/dash
1
0
Fork 0
mirror of https://github.com/dashpay/dash.git synced 2024-12-25 12:02:48 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge bitcoin/bitcoin#27906: doc: test: update TestShell instructions

Browse Source 
14405e8d4d259c18a21fc006d0a27550be3171f8 doc: test: update TestShell instructions (ismaelsadeeq)

Pull request description:

  Fixes  #27904

  From  #27904 and IRC.
  Update [Testshell instructions ](https://github.com/bitcoin/bitcoin/blob/master/test/functional/test-shell.md#2-importing-testshell-from-the-bitcoin-core-repository)

  E.g `TestShell.setup()` throws
  ```
  AttributeError: type object 'TestShell' has no attribute 'setup'
  ```
  Parentheses are missing, it should be `TestShell().setup()`

ACKs for top commit:
  Sjors:
    utACK 14405e8d4d259c18a21fc006d0a27550be3171f8
  brunoerg:
    crACK 14405e8d4d259c18a21fc006d0a27550be3171f8
  hernanmarino:
    utACK 14405e8d4d259c18a21fc006d0a27550be3171f8

Tree-SHA512: ffe5fa1103a3b00ef0ee99879adae967b0da07cb8f8451c4c261b0a70b3b666af7aeaacd6f46f85a84ee5e9c7c7ed49700209b5b1f124d7a76efc420ad5c9cd9
This commit is contained in:
fanquake 2023-06-18 12:47:50 +02:00 committed by pasta
parent fbc6c6e644
commit ba5f4c0332
No known key found for this signature in database
GPG Key ID: E2F3D7916E722D38
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
test/functional/test-shell.md
View File

@ -37,13 +37,13 @@ importing the `TestShell` class from the `test_shell` sub-package.
The following `TestShell` methods manage the lifetime of the underlying bitcoind The following `TestShell` methods manage the lifetime of the underlying bitcoind
processes and logging utilities. processes and logging utilities.
* `TestShell.setup()` * `TestShell().setup()`
* `TestShell.shutdown()` * `TestShell().shutdown()`
The `TestShell` inherits all `BitcoinTestFramework` members and methods, such The `TestShell` inherits all `BitcoinTestFramework` members and methods, such
as: as:
* `TestShell.nodes[index].rpc_method()` * `TestShell().nodes[index].rpc_method()`
* `TestShell.log.info("Custom log message")` * `TestShell().log.info("Custom log message")`
The following sections demonstrate how to initialize, run, and shut down a The following sections demonstrate how to initialize, run, and shut down a
`TestShell` object. `TestShell` object.
@ -141,7 +141,7 @@ instances and remove all temporary data and logging directories.
20XX-XX-XXTXX:XX:XX.XXXXXXX TestFramework (INFO): Tests successful 20XX-XX-XXTXX:XX:XX.XXXXXXX TestFramework (INFO): Tests successful
``` ```
To prevent the logs from being removed after a shutdown, simply set the To prevent the logs from being removed after a shutdown, simply set the
`TestShell.options.nocleanup` member to `True`. `TestShell().options.nocleanup` member to `True`.
``` ```
>>> test.options.nocleanup = True >>> test.options.nocleanup = True
>>> test.shutdown() >>> test.shutdown()
@ -160,9 +160,9 @@ underlying `BitcoinTestFramework`:
The `TestShell` object initializes with the default settings inherited from the The `TestShell` object initializes with the default settings inherited from the
`BitcoinTestFramework` class. The user can override these in `BitcoinTestFramework` class. The user can override these in
`TestShell.setup(key=value)`. `TestShell().setup(key=value)`.
**Note:** `TestShell.reset()` will reset test parameters to default values and **Note:** `TestShell().reset()` will reset test parameters to default values and
can be called after the TestShell is shut down. can be called after the TestShell is shut down.
| Test parameter key | Default Value | Description | | Test parameter key | Default Value | Description |
@ -179,7 +179,7 @@ can be called after the TestShell is shut down.
| `perf` | False | Profiles running nodes with `perf` for the duration of the test if set to `True`. | | `perf` | False | Profiles running nodes with `perf` for the duration of the test if set to `True`. |
| `rpc_timeout` | `60` | Sets the RPC server timeout for the underlying bitcoind processes. | | `rpc_timeout` | `60` | Sets the RPC server timeout for the underlying bitcoind processes. |
| `setup_clean_chain` | `False` | A 200-block-long chain is initialized from cache by default. Instead, `setup_clean_chain` initializes an empty blockchain if set to `True`. | | `setup_clean_chain` | `False` | A 200-block-long chain is initialized from cache by default. Instead, `setup_clean_chain` initializes an empty blockchain if set to `True`. |
| `randomseed` | Random Integer | `TestShell.options.randomseed` is a member of `TestShell` which can be accessed during a test to seed a random generator. User can override default with a constant value for reproducible test runs. | | `randomseed` | Random Integer | `TestShell().options.randomseed` is a member of `TestShell` which can be accessed during a test to seed a random generator. User can override default with a constant value for reproducible test runs. |
| `supports_cli` | `False` | Whether the bitcoin-cli utility is compiled and available for the test. | | `supports_cli` | `False` | Whether the bitcoin-cli utility is compiled and available for the test. |
| `tmpdir` | `"/var/folders/.../"` | Sets directory for test logs. Will be deleted upon a successful test run unless `nocleanup` is set to `True` | | `tmpdir` | `"/var/folders/.../"` | Sets directory for test logs. Will be deleted upon a successful test run unless `nocleanup` is set to `True` |
| `trace_rpc` | `False` | Logs all RPC calls if set to `True`. | | `trace_rpc` | `False` | Logs all RPC calls if set to `True`. |