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.

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

Fix #2266 #2412

Open
wants to merge 5 commits into
base: dev
Choose a base branch
from
Open

Fix #2266 #2412

wants to merge 5 commits into from

Conversation

DarkaMaul
Copy link
Contributor

@DarkaMaul DarkaMaul commented Apr 8, 2024

When a function was used as a r-value in a variable assignment, its type was not properly printed using the slithir printer.

This PR fixes that.

It also add a test to check that this issue does not arise again. However, I'm unsure where to put this test and if we even want tests for this kind of issues.

Summary by CodeRabbit

  • Bug Fixes

    • Corrected the display of return types for functions to ensure accurate type representation.
  • Tests

    • Added new end-to-end tests for Solidity contracts to verify inheritance and function assignment.
    • Introduced a new test function to validate the PrinterSlithIR output, ensuring certain content is correctly generated.

Copy link

coderabbitai bot commented Apr 8, 2024

Walkthrough

The changes introduce improvements to the assignment.py file to correctly display function return types when rvalues are functions. Additionally, a new Solidity test file bug-2266.sol and a test function test_slithir_printer in test_printers.py are added to ensure the correct functionality of PrinterSlithIR by generating output and checking specific content.

Changes

Files/Paths Change Summary
slither/slithir/operations/assignment.py Modified to properly display return types of functions when rvalues are functions.
tests/e2e/printers/test_data/bug-2266.sol Introduced two Solidity contracts, A and B, for testing function assignment and inheritance.
tests/e2e/printers/test_printers.py Added test_slithir_printer to test PrinterSlithIR functionality and included necessary imports.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Test as test_slithir_printer
    participant Printer as PrinterSlithIR
    participant Output as Output

    Test->>Printer: Generate output
    Printer->>Output: Create dot file
    Output-->>Test: Return content
    Test-->>Printer: Assert specific content

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@DarkaMaul DarkaMaul changed the base branch from master to dev April 8, 2024 09:46
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between fdf54f6 and 114dc2e.
Files selected for processing (3)
  • slither/slithir/operations/assignment.py (1 hunks)
  • tests/e2e/printers/test_data/test_printer_slithir/bug-2266.sol (1 hunks)
  • tests/e2e/printers/test_printers.py (2 hunks)
Additional comments not posted (3)
tests/e2e/printers/test_data/test_printer_slithir/bug-2266.sol (1)

1-13: The Solidity test file bug-2266.sol is correctly set up to replicate the issue being addressed. It effectively demonstrates the assignment of a function to a local variable, which is central to the issue fixed by this PR.

tests/e2e/printers/test_printers.py (1)

40-52: The test function test_slithir_printer correctly implements the logic to verify the fix for the PrinterSlithIR functionality. However, it would be beneficial to add a comment explaining why the presence of "slither.core.solidity_types" in the output indicates a failure to correctly display function types.

slither/slithir/operations/assignment.py (1)

48-63: The changes made to the Assignment class correctly address the issue of displaying function return types when they are used as r-values in assignments. To ensure robustness, consider adding unit tests covering both single and multiple return types scenarios.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 114dc2e and 9fe27d3.

Files selected for processing (1)
  • tests/e2e/printers/test_printers.py (3 hunks)
Additional context used
GitHub Check: Lint Code Base
tests/e2e/printers/test_printers.py

[warning] 38-38:
C0303: Trailing whitespace (trailing-whitespace)

Additional comments not posted (3)
tests/e2e/printers/test_printers.py (3)

10-10: The import of PrinterSlithIR is correctly placed and necessary for the new functionality.


39-39: The comment about testing the include/exclude interface behavior enhances clarity and understanding.


52-64: The new test_slithir_printer function is well-implemented and covers the necessary assertions to ensure the PrinterSlithIR is functioning as expected.

tests/e2e/printers/test_printers.py Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9fe27d3 and f3f4b20.

Files selected for processing (1)
  • tests/e2e/printers/test_printers.py (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • tests/e2e/printers/test_printers.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant