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

Printer cheatcode #2413

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

Printer cheatcode #2413

wants to merge 8 commits into from

Conversation

DarkaMaul
Copy link
Contributor

@DarkaMaul DarkaMaul commented Apr 8, 2024

Change description

Implement a new printer to display cheatcodes usage.
Fixes #2141

Caveats

The cheatcodes are usually used in test files. Thus, the classic command:

slither --printer cheatcode project_directory/

will not work because the default is to remove tests files from being analyzed.

To force the usage:

slither --printer cheatcode --foundry-compile-all project_directory

Example output

slither --print cheatcode --foundry-compile-all tests/e2e/printers/test_data/test_printer_cheatcode
'forge clean' running (wd: ./slither/tests/e2e/printers/test_data/test_printer_cheatcode)
'forge build --build-info' running (wd: ./slither/tests/e2e/printers/test_data/test_printer_cheatcode)
INFO:Printers:CounterTest (test/Counter.t.sol)
	setUp
		L[21]: deal
		L[22]: deal
	testIncrement
		L[28]: prank
		L[30]: assertEq
		L[32]: prank
		L[34]: assertEq

INFO:Slither:tests/e2e/printers/test_data/test_printer_cheatcode analyzed (34 contracts)

Missing

  • Wiki entry
  • Force to analyze test file if the printer is selected?

Summary by CodeRabbit

  • New Features

    • Introduced a Solidity smart contract named Counter with functions for number manipulation.
    • Added a CounterTest suite to test the functionality of the Counter contract.
  • Documentation

    • Included a README.md file with instructions for initializing a counter using a specific command.
    • Added a foundry.toml file with configuration settings for the test_printer_cheatcode printer.
  • Tests

    • Updated test script with new imports, global variables, and a test function for CheatcodePrinter.

Copy link

coderabbitai bot commented Apr 8, 2024

Walkthrough

Walkthrough

The update focuses on integrating the CheatcodePrinter into various components of the project, enhancing cheatcode tracking and testing in Solidity contracts. This includes adding the printer to CI scripts, updating printer management files, and setting up corresponding end-to-end tests.

Changes

File Path Change Summary
scripts/ci_test_printers.sh Added "cheatcode" to ALL_PRINTERS.
slither/printers/all_printers.py Imported CheatcodePrinter.
slither/printers/summary/cheatcodes.py Introduced CheatcodePrinter class.
tests/e2e/printers/test_data/.../README.md Added instructions for printer usage.
tests/e2e/printers/test_data/.../foundry.toml Set up config for test_printer_cheatcode.
tests/e2e/printers/test_data/.../src/Counter.sol Added Counter contract.
tests/e2e/printers/test_data/.../test/Counter.t.sol Introduced tests for Counter.
tests/e2e/printers/test_printers.py Enhanced test scripts with new imports, variables, and test_printer_cheatcode() function.

Possibly related issues


Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between bb8b108 and ee46cae.
Files selected for processing (1)
  • tests/e2e/printers/test_data/test_printer_cheatcode/README.md (1 hunks)
Additional Context Used
LanguageTool (2)
tests/e2e/printers/test_data/test_printer_cheatcode/README.md (2)

Near line 1: Posibleng may nahanap na mali sa ispeling
Context: # Counter Init using : ```shell forge install f...


Near line 3: Posibleng may nahanap na mali sa ispeling
Context: # Counter Init using : ```shell forge install foundry-rs/fo...

Additional comments not posted (1)
tests/e2e/printers/test_data/test_printer_cheatcode/README.md (1)

5-7: The shell command block is correctly formatted.


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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

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: 3

Comment on lines 3 to 6
Init using :
```shell
forge install foundry-rs/forge-std
```
Copy link

Choose a reason for hiding this comment

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

Ensure fenced code blocks are surrounded by blank lines for proper formatting.

+ 
```shell
5~
forge install foundry-rs/forge-std
6~

<!-- This is an auto-generated comment by CodeRabbit -->

slither/printers/summary/cheatcodes.py Show resolved Hide resolved
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: 3

@@ -0,0 +1,7 @@
# Counter
Copy link

Choose a reason for hiding this comment

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

Correct the spelling error in the comment.

- # Counter
+ # Counter - Initialize using:

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
# Counter
# Counter - Initialize using:

@@ -0,0 +1,7 @@
# Counter

Init using :
Copy link

Choose a reason for hiding this comment

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

Clarify the initialization instruction for better readability.

- Init using :
+ Initialize the environment using the following command:

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
Init using :
Initialize the environment using the following command:


```shell
forge install foundry-rs/forge-std
```
Copy link

Choose a reason for hiding this comment

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

Add a newline at the end of the file to adhere to best practices.

+

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
```

</details>
<!-- suggestion_end -->

<!-- This is an auto-generated comment by CodeRabbit -->

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

2 participants