rgb-cln/contrib/pyln-testing
Christian Decker 9378be72a9 pyln: Allow users to override the LightningNode class
Quite a few of the things in the LightningNode class are tailored to their use
in the c-lightning tests, so I decided to split those customizations out into
a sub-class, and adding one more fixture that just serves the class. This
allows us to override the LightningNode implementation in our own tests, while
still having sane defaults for other users.
2019-11-12 21:23:55 +01:00
..
pyln/testing pyln: Allow users to override the LightningNode class 2019-11-12 21:23:55 +01:00
README.md pyln-testing: Copy basic support infrastructure into pyln.testing 2019-11-12 21:23:55 +01:00
requirements.txt pyln-testing: Copy basic support infrastructure into pyln.testing 2019-11-12 21:23:55 +01:00
setup.py pyln-testing: Copy basic support infrastructure into pyln.testing 2019-11-12 21:23:55 +01:00

README.md

pyln-testing: A library to write tests against c-lightning

This library implements a number of utilities that help building tests for c-lightning nodes. In particular it provides a number of pytest fixtures that allow the management of a test network of a given topology and then execute a test scenarion.

pyln-testing is used by c-lightning for its internal tests, and by the community plugin directory to exercise the plugins.

Installation

pyln-testing is available on pip:

pip install pyln-testing

Alternatively you can also install the development version to get access to currently unreleased features by checking out the c-lightning source code and installing into your python3 environment:

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.