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

Upgraded Slither-mutate #2278

Merged
merged 16 commits into from
Jan 29, 2024
Merged

Conversation

vishnuram1999
Copy link
Contributor

Description

slither-mutate is a mutation testing tool for evaluating the test suites of solidity-based smart contracts.

Features

The tool addresses issues faced while using the well-known mutation testing tool, the Universal Mutator.

  • Utilizes slither-generated AST for generating mutants by replacing keywords, operators, conditions, and more. This approach ensures that comments are excluded and minimizes the likelihood of producing Solidity code that cannot be compiled.
  • Encompasses diverse mutators categorized by severity, preventing the generation of less severe mutants when highly severe mutants are valid. This not only enhances efficiency but also reduces runtime.
  • Incorporates fail-fast or bail feature for test commands, optimizing execution speed.
  • Facilitates the creation of new mutators using existing templates, providing flexibility and extensibility to the mutation process.

Link

README explains the usage and available CLI arguments.

@CLAassistant
Copy link

CLAassistant commented Jan 24, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@0xalpharush 0xalpharush left a comment

Choose a reason for hiding this comment

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

Just did a quick pass.

I'd like to add a CI integration test like the ones in scripts/ that runs each mutant over a foundry codebase. (This would involve creating scripts/ci_test_mutate.sh and adding "mutate" to this list so that it's run in CI.

It'd also be nice to have an input-output pair for each mutant type to know what it is expected to do and to "lock-in" its behavior and make it so that reviewers can catch regressions in future PRs. Our detector tests use pytest-insta to perform snapshot/golden testing and that may work nicely for this.

slither/tools/mutator/README.md Outdated Show resolved Hide resolved
slither/tools/mutator/__main__.py Outdated Show resolved Hide resolved
slither/tools/mutator/__main__.py Outdated Show resolved Hide resolved
slither/tools/mutator/__main__.py Outdated Show resolved Hide resolved
slither/tools/mutator/__main__.py Outdated Show resolved Hide resolved
slither/tools/mutator/__main__.py Outdated Show resolved Hide resolved
slither/tools/mutator/utils/file_handling.py Outdated Show resolved Hide resolved
slither/tools/mutator/utils/testing_generated_mutant.py Outdated Show resolved Hide resolved
slither/tools/mutator/utils/testing_generated_mutant.py Outdated Show resolved Hide resolved
slither/tools/mutator/utils/testing_generated_mutant.py Outdated Show resolved Hide resolved
Copy link
Contributor

coderabbitai bot commented Jan 26, 2024

Important

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

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.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@0xalpharush 0xalpharush merged commit afa604d into crytic:dev Jan 29, 2024
74 checks passed
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.

3 participants