Merge #497: Add instructions to build daemon for testing

d337568706c5e6070d05d378392e74d590438f0b Add instructions to build deamon for testing (Novo)

Pull request description:

  @darosior  I tried following the testing instructions and I got an error that indicated that the `target/debug` directory did not exist. This PR adds instructions that specifically ask devs to build the project before testing. I think this will be helpful to others when trying to run the tests.

ACKs for top commit:
  darosior:
    ACK d337568706c5e6070d05d378392e74d590438f0b -- Thank you for improving the documentation.

Tree-SHA512: 9ba9c141de13f30128497734f231df6763713e18d5d0e6f2d92cdd3f3d3ca0490755760ecb0b7375a067365156a781e4d42ce07da337cbda594b39855adc2e69
This commit is contained in:
Antoine Poinsot 2023-05-12 10:49:57 +02:00
commit 08223c0ded
No known key found for this signature in database
GPG Key ID: E13FC145CD3F4304

View File

@ -8,6 +8,20 @@ Python scripts are used for the automation, and specifically the [`pytest` frame
Credits: this test framework was taken and adapted from revaultd, which was itself adapted from
[C-lightning's test framework](https://github.com/ElementsProject/lightning/tree/master/contrib/pyln-testing).
### Building the project for testing
To run the tests, we must build the debug version of `lianad`. Follow the instructions at [`doc/BUILD.md`](../doc/BUILD.md) but instead of running
```
$ cargo build --release
```
Run
```
$ cargo build
```
to build the daemon for testing.
The `lianad` and `liana-cli` binaries will be in the `target/debug` directory at the root of the
repository.
### Test dependencies
Functional tests dependencies can be installed using `pip`. Use a virtual environment.