scripts+make+GH: Add simple backwards compatibility test to the CI

[ellemouton]

In this PR, a simple backwards compatibility test script is added to the repo & it is added as a CI step.

Test description:

1. Spin up the following network where all nodes are running a tagged version of LND:

Alice (v0.18.5) <---> Bob (v0.18.5) <---> Charlie (v0.18.5) <---> Dave (v0.18.5)

2. Perform basic tests to ensure that Bob can send, receive and route.

3. Shutdown Bob & restart it but this time with the version of the code in the current PR

Alice (v0.18.5) <---> Bob (PR-branch) <---> Charlie (v0.18.5) <---> Dave (v0.18.5)

4. Test that the channels become active again (ie the restart is successful) and that Bob can still send, receive and route.

More info:

See the added README.md for more info about the script & how to play around with it locally.

Running it:

You can test this locally simply by running: make backwards-compat-test

Example of passing itests but failing backwards compat test

See this PR which demonstrates a case where the bug introduced
by the PR is not caught by itests or unit tests but is caught by the backwards compatibility test.

The output of the CI step looks as follows:

Use 'docker scan' to run Snyk tests against images to find vulnerabilities and learn how to fix them
🐳 Starting bob-pr
bitcoind is up-to-date
Creating bob-pr ... done
⌛ Waiting for bob to start (timeout: 15s).....................
❌ Error: Timeout after 15 seconds waiting for bob to start
🐳 Tearing down the cluster

Example Success Output (see this PR's CI):

🐳 Starting the cluster
⌛ Waiting for alice to satisfy 'node_started'....
✅ alice satisfied 'node_started'
⌛ Waiting for bob to satisfy 'node_started'
✅ bob satisfied 'node_started'
⌛ Waiting for charlie to satisfy 'node_started'
✅ charlie satisfied 'node_started'
⌛ Waiting for dave to satisfy 'node_started'
✅ dave satisfied 'node_started'
🏎️ All nodes satisfied 'node_started'!
🔗 Setting up Bitcoin node
🔗 Bitcoin node is set up
💰 Funded alice with 5 BTC
💰 Funded bob with 5 BTC
💰 Funded charlie with 5 BTC
💰 Funded dave with 5 BTC
📞 Connected alice to bobb...
📞 Connected bob to charliee...
📞 Connected charlie to davee...
🔗 Opened channel between alice and bob
🔗 Opened channel between bob and charlie
🔗 Opened channel between charlie and dave
Set up network: Alice <-> Bob <-> Charlie <-> Dave
👀 alice sees all the channels!
👀 bob sees all the channels!
👀 charlie sees all the channels!
👀 dave sees all the channels!
ℹ️ alice is running on commit 4ccf4fc24c750d098cf24566ef4bbc0311c7d476
ℹ️ bob is running on commit 4ccf4fc24c750d098cf24566ef4bbc0311c7d476
ℹ️ charlie is running on commit 4ccf4fc24c750d098cf24566ef4bbc0311c7d476
ℹ️ dave is running on commit 4ccf4fc24c750d098cf24566ef4bbc0311c7d476
💸 Payment sent from bob to dave
💸 Payment sent from dave to bob
💸 Payment sent from alice to dave
🐳 Stopping bob
🐳 Rebuilding bob-pr
🐳 Starting bob-pr
⌛ Waiting for bob to start..
✅ bob has started
🟠 Waiting for bob to have exactly 2 active channels...
⌛ bob sees 2 active channels...
🟢 bob now has exactly 2 active channels!
ℹ️ bob is running on commit 1bb9a38fa0e792124cf98db414a7ae3cdd8ee5ff
💸 Payment sent from bob to dave
💸 Payment sent from dave to bob
💸 Payment sent from alice to dave
🛡️⚔️🫡 Backwards compatibility test passed! 🫡⚔️🛡️
🐳 Tearing down the cluster

[coderabbitai]

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)

• llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[guggero]

Super cool addition! Also great because it runs comparatively quickly. Huge win 💯
Now we just need to remember to periodically update the versions of lnd we test against.

[yyforyongyu]

Very nice!!