Skip to content

Commit a09e56f

Browse files
committed
doc: add new doc with test scenarios for different modes
1 parent 945fffe commit a09e56f

File tree

1 file changed

+89
-0
lines changed

1 file changed

+89
-0
lines changed

doc/testing.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Test scenarios
2+
3+
The possible number of combinations of local/remote configurations has become
4+
quite large over time.
5+
6+
The following tests should be run whenever something in the local/remote config
7+
or proxying changes:
8+
9+
## `lnd` integrated
10+
11+
### All daemons integrated
12+
13+
```shell
14+
--httpslisten=[::]:8443
15+
--uipassword=testnet3
16+
--network=regtest
17+
--lnd-mode=integrated
18+
...
19+
```
20+
21+
1. Open UI, make sure Loop and Pool calls are served correctly
22+
2. Use `lncli` against LiT
23+
`lncli --network regtest getinfo`
24+
3. Use `pool` and `loop` CLI against `lnd` main gRPC server (port `10009`)
25+
- `loop --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.loop/regtest/loop.macaroon terms`
26+
- `pool --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.pool/regtest/pool.macaroon getinfo`
27+
4. Use `pool` and `loop` CLI against LiT proxy server (port `8443`)
28+
- `loop --rpcserver=localhost:8443 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.loop/regtest/loop.macaroon terms`
29+
- `pool --rpcserver=localhost:8443 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.pool/regtest/pool.macaroon getinfo`
30+
31+
### Loop daemon remote
32+
33+
```shell
34+
--httpslisten=[::]:8443
35+
--uipassword=testnet3
36+
--network=regtest
37+
--lnd-mode=integrated
38+
--loop-mode=remote
39+
...
40+
```
41+
42+
1. Open UI, make sure Loop and Pool calls are served correctly
43+
2. Use `lncli` against LiT
44+
`lncli --network regtest getinfo`
45+
3. Use `pool` and `loop` CLI against `lnd` main gRPC server (port `10009`)
46+
- `loop --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.loop/regtest/loop.macaroon terms`
47+
**Expect to get an `unknown service` error!**
48+
- `pool --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.pool/regtest/pool.macaroon getinfo`
49+
**Expect to get an `unknown service` error!**
50+
4. Use `pool` and `loop` CLI against LiT proxy server (port `8443`)
51+
- `loop --rpcserver=localhost:8443 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.loop/regtest/loop.macaroon terms`
52+
- `pool --rpcserver=localhost:8443 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.pool/regtest/pool.macaroon getinfo`
53+
54+
## `lnd` remote
55+
56+
### All daemons integrated
57+
58+
```shell
59+
--httpslisten=[::]:8443
60+
--uipassword=testnet3
61+
--network=regtest
62+
--remote.lnd.rpcserver=localhost:10009
63+
...
64+
```
65+
66+
1. Open UI, make sure Loop and Pool calls are served correctly
67+
2. Use `lncli` against LiT
68+
`lncli --network regtest --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.lnd/data/chain/bitcoin/regtest/admin.macaroon getinfo`
69+
3. Use `pool` and `loop` CLI against LiT proxy server (port `8443`)
70+
- `loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.loop/regtest/loop.macaroon terms`
71+
- `pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.pool/regtest/pool.macaroon getinfo`
72+
73+
### Loop daemon remote
74+
75+
```shell
76+
--httpslisten=[::]:8443
77+
--uipassword=testnet3
78+
--network=regtest
79+
--remote.lnd.rpcserver=localhost:10009
80+
--loop-mode=remote
81+
...
82+
```
83+
84+
1. Open UI, make sure Loop and Pool calls are served correctly
85+
2. Use `lncli` against LiT
86+
`lncli --network regtest --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.lnd/data/chain/bitcoin/regtest/admin.macaroon getinfo`
87+
3. Use `pool` and `loop` CLI against LiT proxy server (port `8443`)
88+
- `loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.loop/regtest/loop.macaroon terms`
89+
- `pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.pool/regtest/pool.macaroon getinfo`

0 commit comments

Comments
 (0)