LND portion of integration tests

[orbitalturtle]

All righty, here's a PR that sets up the LND portion of our integration tests :-]

This PR:

• Builds LND in a Makefile. Right now it's pretty simple, wanted to at least get the POC running. But we can probably add some things... like feeding the Makefile more granular options to pass to the integration tests, which we can borrow some of LND's approach for
• Fixes up the tests file structure, so the user can find all relevant files in /tmp/ldk-tests/
• Adds an LND struct that we can use to run the LND node and interact with the lightning node via the grpc client.
• Tests that LND + LDK properly connect

Next PR(s):

• Will add the necessary Github actions for: 1) uploading logs, 2) run the integration tests properly with the new Makefile setup.
• Will finally add lndk to the mix and add a test showing it's forwarding onion messages properly :)

Note that I borrowed some of the approach here for the Makefile and associated github action tests from LND, so credit to them there :)

[orbitalturtle]

Oh I forgot that changing up the test commands would break the current github actions build/cargo test process. So I'll add an update to the github actions to this PR soon.

[carlaKC]

So I'll add an update to the github actions to this PR soon.

Does this need review in the meantime or should we wait for this?

[orbitalturtle]

@carlaKC It's ready for a review! The build process is working now but I just need to fix the codecov portion now.

[codecov]

Codecov Report

All modified lines are covered by tests ✅

❗ No coverage uploaded for pull request base (ldk-test-setup@3b9539a). Click here to learn what that means.

Additional details and impacted files

@@                Coverage Diff                @@
##             ldk-test-setup      #74   +/-   ##
=================================================
  Coverage                  ?   58.69%           
=================================================
  Files                     ?        5           
  Lines                     ?      983           
  Branches                  ?        0           
=================================================
  Hits                      ?      577           
  Misses                    ?      406           
  Partials                  ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[carlaKC]

Nice work!

Running into some path issues:

running 2 tests
test test_ldk_lnd_connect ... thread 'test_ldk_lnd_connect' panicked at 'Failed to execute lnd command: Os { code: 2, kind: NotFound, message: "No such file or directory" }', tests/common/mod.rs:206:14
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
FAILED
test test_ldk_send_onion_message ... thread 'test_ldk_send_onion_message' panicked at 'Failed to execute lnd command: Os { code: 2, kind: NotFound, message: "No such file or directory" }', tests/common/mod.rs:206:14
FAILED

failures:

failures:
    test_ldk_lnd_connect
    test_ldk_send_onion_message

test result: FAILED. 0 passed; 2 failed; 0 ignored; 0 measured; 0 filtered out; finished in 2.25s

error: test failed, to rerun pass `--test integration_tests`

[carlaKC]

This will fail if golang isn't installed?

[orbitalturtle]

True, should we just add instructions explaining that Go is a dependency?

[carlaKC]

Could you explain what this does?

[orbitalturtle]

With the --all-features flag codecov includes the integration tests in the coverage, but I think we only want to be looking at the unit tests. So --bin lndk specifies that we only want to be looking at the tests in /src for the lndk binary. Would it be helpful to add a note about this in the commit?

[carlaKC]

Am I correct in thinking that this will also run the unit tests? That doesn't really make sense to me.

Can we use cargo test --test {itest module} to only run the itests? Likewise, we should have a way to only run unit tests.

[orbitalturtle]

Good point, yes I'll update this

[orbitalturtle]

Btw, I wrote up some instructions in CONTRIBUTING to specify how to run integration tests vs. unit tests

[orbitalturtle]

@carlaKC Thanks for the review! For the file not existing error, is this when running make itest?

[carlaKC]

@carlaKC Thanks for the review! For the file not existing error, is this when running make itest?

Yeah, on make itest :(

[orbitalturtle]

@carlaKC got it! Just pushed up some changes. Let me know if the addition to the Makefile helps with the path error... since I don't have Mac I'm unable to test but it looks like the problem was that on MacOS the path in the Makefile was not aligning with what temp_dir() returns in the code https://doc.rust-lang.org/nightly/std/env/fn.temp_dir.html

[orbitalturtle]

D'oh, I messed something up when trying to rebase integration tests part 3 on top of this PR. But we can continue our conversation in #77