aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-18 22:54:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

pyln: Make the grpcio dependencies optional

Browse Source 
We also document how the grpc test mode works, and why it currently
lacks coverage.

Changelog-Changed: pyln-testing: The grpc dependencies are now optional.
This commit is contained in:
Christian Decker
2023-07-20 14:41:07 +02:00
committed by Rusty Russell
parent 22462e1d91
commit 975046a790
3 changed files with 36 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
contrib/pyln-testing/README.md
View File

@@ -31,3 +31,31 @@ 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.
## Testing GRPC Bindings
The grpc bindings can be tested by setting the `CLN_TEST_GRPC=1`
environment variable. This will cause the testing framework to use a
grpc client to talk to the `cln-grpc` plugin, rather than talking
directly to the node's JSON-RPC interface. Since the GRPC related
dependencies are guarded behind a feature flag in `pyln-testing`
you'll need to install it with the `grpc` feature enabled in order to
be able to run in this mode.
Below is a diagram of how the normal JSON-RPC interaction looks like,
followed by one that display the grpc interaction:
```
CLN -- JSON-RPC -- LightningRpc -- pytest
\_____CLN_____/ \_______pytest_______/
```
```
CLN -- JSON-RPC -- cln-rpc -- rpc2grpc converters -- grpc interface -- python grpc client -- python grpc2json converter -- pytest
\_____CLN_____/ \___________cln-grpc-plugin____________________/ \__________________________pytest________________________/
```
As you can see the grpc mode attempts to emulate the simple JSON-RPC
mode by passing the call through a number of conversions. The last
step `grpc2json` is rather incomplete, and will cause quite a few
tests to fail for now, until the conversion is completed and we reach
feature parity between the interaction modes.

2
contrib/pyln-testing/pyln/testing/utils.py
View File

@@ -6,7 +6,6 @@ from pathlib import Path
from pyln.client import RpcError
from pyln.testing.btcproxy import BitcoinRpcProxy
from pyln.testing.gossip import GossipStore
from pyln.testing import grpc
from collections import OrderedDict
from decimal import Decimal
from pyln.client import LightningRpc
@@ -820,6 +819,7 @@ class LightningNode(object):
self._create_jsonrpc_rpc(jsonschemas)
def _create_grpc_rpc(self):
from pyln.testing import grpc
self.grpc_port = reserve_unused_port()
d = self.lightning_dir / TEST_NETWORK
d.mkdir(parents=True, exist_ok=True)

10
contrib/pyln-testing/pyproject.toml
View File

@@ -21,12 +21,16 @@ pyln-client = ">=23"
Flask = "^2"
cheroot = "^8"
psutil = "^5.9"
grpcio = "^1"
pyln-grpc-proto = "^0.1"
grpcio = { version = "^1", optional = true }
pyln-grpc-proto = { version = "^0.1", optional = true }
[tool.poetry.dev-dependencies]
pyln-client = { path = "../pyln-client", develop = true}
pyln-grpc-proto = { path = "../pyln-grpc-proto", develop = true}
pyln-grpc-proto = { path = "../pyln-grpc-proto", develop = true, optional = true}
[tool.poetry.extras]
grpc = ["pyln-grpc-proto", "grpcio"]
[build-system]
requires = ["poetry-core>=1.0.0"]