Skip to content

lntest: add a flag to export data generated during the test #9947

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 23, 2025

Conversation

yyforyongyu
Copy link
Member

Add a new param basedir so we can save the node files and analyze them when needed, sth like,
make itest icase=$icase basedir="your_customized_dir"

which gives,

> tree
.
├── itest-list_payments-Alice-1-1749810982
│   ├── data
│   │   ├── chain
│   │   │   └── bitcoin
│   │   │       └── regtest
│   │   │           ├── admin.macaroon
│   │   │           ├── chainnotifier.macaroon
│   │   │           ├── chan-backup-archives
│   │   │           │   ├── channel.backup-2025-06-13-18-36-29
│   │   │           │   ├── channel.backup-2025-06-13-18-36-30
│   │   │           │   └── channel.backup-2025-06-13-18-36-35
│   │   │           ├── channel.backup
│   │   │           ├── invoice.macaroon
│   │   │           ├── invoices.macaroon
│   │   │           ├── macaroons.db
│   │   │           ├── readonly.macaroon
│   │   │           ├── router.macaroon
│   │   │           ├── signer.macaroon
│   │   │           ├── wallet.db
│   │   │           └── walletkit.macaroon
│   │   ├── graph
│   │   │   └── regtest
│   │   │       ├── channel.db
│   │   │       └── sphinxreplay.db
│   │   └── watchtower
│   │       └── bitcoin
│   │           └── regtest
│   ├── letsencrypt
│   ├── logs
│   │   └── bitcoin
│   │       └── regtest
│   │           └── lnd.log
│   ├── tls.cert
│   └── tls.key

Which is what I used to analyze SQL tables.

@yyforyongyu yyforyongyu added P3 might get fixed, nice to have optimization itests Issues related to integration tests. no-changelog size/micro small bug fix or feature, less than 15 mins of review, less than 250 labels Jun 13, 2025
Copy link
Contributor

coderabbitai bot commented Jun 13, 2025

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.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

Copy link
Collaborator

@guggero guggero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea, will definitely be useful when debugging.
In tapd we just added a -nodelete flag that works similar to the SkipCleanup, then we can just examine the data in the temporary directory.
But specifying another base directory might be helpful as well, to separate folders from separate runs.

@@ -28,6 +29,10 @@ const (
)

var (
// baseDirFlag is the default directory where all the node's data are
// saved. If not set, a temporary dir will be created.
baseDirFlag = flag.String("basedir", ".", "default dir to save data")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Setting "." here will mean it will never be "", so a temp directory is never used.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch! It didn't cause an issue before, I guess it's due to the default setting here BASE_DIR = "", otherwise it would have been caught😅

@yyforyongyu yyforyongyu requested a review from ffranr June 17, 2025 07:04
@yyforyongyu yyforyongyu force-pushed the export-itest-db branch 2 times, most recently from dccfb58 to 3a3cf31 Compare June 17, 2025 10:07
}

// Use customized base dir and skip the cleanups.
cfg.BaseDir = fmt.Sprintf("%s/%s", *baseDirFlag, dirBaseName)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

filepath.Join(*baseDirFlag, dirBaseName)?

This handles path separators correctly across OSes (e.g., / vs \), and avoids accidental double slashes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice catch!

@yyforyongyu yyforyongyu merged commit 09df589 into lightningnetwork:master Jun 23, 2025
35 of 38 checks passed
@yyforyongyu yyforyongyu deleted the export-itest-db branch June 23, 2025 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
itests Issues related to integration tests. no-changelog optimization P3 might get fixed, nice to have size/micro small bug fix or feature, less than 15 mins of review, less than 250
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants