Skip to content
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.

Sign up for GitHub

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

Jump to bottom

lnwire: simplify fuzz targets #9263

Merged
merged 5 commits into from
Nov 13, 2024
Merged

lnwire: simplify fuzz targets #9263

merged 5 commits into from
Nov 13, 2024

Conversation

morehouse
Copy link
Collaborator

Reduces code duplication and fluff.

A pure refactor built on top of #9251.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 12, 2024 •
edited
Loading

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
🪧 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 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
guggero approved these changes Nov 13, 2024
View reviewed changes
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.

Nice, LGTM 🎉

@guggero guggero requested a review from ellemouton November 13, 2024 09:25
ellemouton
ellemouton reviewed Nov 13, 2024
View reviewed changes
Copy link
Collaborator

@ellemouton ellemouton left a comment

Choose a reason for hiding this comment

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

Very nice cleanup, thanks! 🧹 🧼

ellemouton
ellemouton approved these changes Nov 13, 2024
View reviewed changes
Copy link
Collaborator

@ellemouton ellemouton left a comment

Choose a reason for hiding this comment

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

oops - clicked the wrong button 🤓

@guggero
Copy link
Collaborator

guggero commented Nov 13, 2024

Needs a rebase, then I'll merge.

@morehouse
lnwire: remove superfluous "Prefix with..." comments
4097527 
These comments add nothing of value since the following line is always
self-documenting:

  data = prefixWithMsgType(data, MsgTypeToBePrefixed)
@morehouse
lnwire: s/harness/wireMsgHarness
b7a1a1e 
This slightly more descriptive name distinguishes the wire message
harness from the onion failure harness while also obviating the
repetitive comments at every call site.
@morehouse
lnwire: move message prefixing to the harness
b9381ac 
The prefixing is done every time the harness is used, so it may as well
reside in the harness itself.
@morehouse
lnwire: adapt harness for custom equality funcs
d0e6a7a 
There are several fuzz targets that can't use the standard require.Equal
check for various reasons. By adapting the harness to accept a custom
equality function, we can reduce code duplication in these targets.
@morehouse
lnwire: use assertEqualFunc in onion failure harness
75bdf2d 
Simplifies the code slightly and improves the error message printed if
the original and deserialized messages do not match.
@morehouse morehouse force-pushed the simplify_fuzz_lnwire branch from 06f3320 to 75bdf2d Compare November 13, 2024 16:26
@morehouse
Copy link
Collaborator Author

Rebased.

@guggero guggero merged commit 60caa04 into lightningnetwork:master Nov 13, 2024
20 of 21 checks passed
@morehouse morehouse deleted the simplify_fuzz_lnwire branch November 13, 2024 20:15
@morehouse morehouse mentioned this pull request Nov 14, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ellemouton ellemouton ellemouton approved these changes

@guggero guggero guggero approved these changes

Assignees
No one assigned
Labels
fuzzing no-changelog no-itest refactoring
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@morehouse @guggero @ellemouton