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

Add CLI command to generate sample config #1100

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add CLI command to generate sample config #1100

wants to merge 1 commit into from

Conversation

arcz
Copy link
Member

@arcz arcz commented Jul 22, 2023

This changes the CLI interface of Echidna by adding echidna init command that generates a sample echidna.yaml config and moves the current fuzzing interface to echidna fuzz ... command:

Echidna

Usage: echidna [--version] COMMAND

  EVM property-based testing framework

Available options:
  -h,--help                Show this help text
  --version                Show version

Available commands:
  init                     Write a sample config file to echidna.yaml
  fuzz                     Run fuzzing

I reused the existing tests/solidity/basic/default.yaml, which already contains all the config options up to date.
I polished the contents by separating config options into logical groups and improved the descriptions. This file still requires work to be more user-friendly.

Additional ideas to consider:

  • Load the echidna.yaml config by default
  • Add path to echidna init <path>

Closes #940

@arcz arcz requested a review from ggrieco-tob as a code owner July 22, 2023 14:13
# Number of fuzzing workers to run, should not exceed the number of available cores.
workers: 1

# Test mode, one of: property, assertion, overflow, exploration, optimization.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# Test mode, one of: property, assertion, overflow, exploration, optimization.
# Test mode, one of: property, assertion, dapptest, overflow, exploration, optimization.

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.

echidna init subcommand to generate config file
2 participants