2022-04-06 07:09:48 +02:00
|
|
|
# pyln-testing: A library to write tests against Core Lightning
|
2019-10-26 20:27:37 +02:00
|
|
|
|
|
|
|
|
This library implements a number of utilities that help building tests for
|
2022-04-06 07:09:48 +02:00
|
|
|
Core Lightning nodes. In particular it provides a number of pytest fixtures that
|
2019-10-26 20:27:37 +02:00
|
|
|
allow the management of a test network of a given topology and then execute a
|
|
|
|
|
test scenarion.
|
|
|
|
|
|
2022-04-06 07:09:48 +02:00
|
|
|
`pyln-testing` is used by Core Lightning for its internal tests, and by the
|
2019-10-26 20:27:37 +02:00
|
|
|
community plugin directory to exercise the plugins.
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
`pyln-testing` is available on `pip`:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
pip install pyln-testing
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Alternatively you can also install the development version to get access to
|
2022-04-06 07:09:48 +02:00
|
|
|
currently unreleased features by checking out the Core Lightning source code and
|
2019-10-26 20:27:37 +02:00
|
|
|
installing into your python3 environment:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git clone https://github.com/ElementsProject/lightning.git
|
|
|
|
|
cd lightning/contrib/pyln-testing
|
|
|
|
|
python3 setup.py develop
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This will add links to the library into your environment so changing the
|
|
|
|
|
checked out source code will also result in the environment picking up these
|
|
|
|
|
changes. Notice however that unreleased versions may change API without
|
|
|
|
|
warning, so test thoroughly with the released version.
|
|
|
|
|
|
