crytic/echidna

feat: remove different testing modes

Open

#941 opened on Feb 17, 2023

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Haskell (434 forks)auto 404
enhancementgood first issueusability

Repository metrics

Stars
 (3,162 stars)
PR merge metrics
 (PR metrics pending)

Description

I've seen a few users getting confused as to why echidna is telling them that there are no tests to be found. It's usually the case that they did not include --test-mode assertion.

Suggestion: Remove different testing modes. Assertion mode should be the default. The normal mode (where functions with signature "echidna*() returns (bool)" are being used can just be included, i.e. if Echidna finds functions that meet that requirement, use the normal mode on those. Optimization mode could be done automatically for functions that return a comparable value (uint, int), i.e. "echidna*() returns (uint)". This might remove some of the friction for onboarding new users.

Contributor guide

Research direction
Inspect the codebase to understand how different testing modes are currently implemented, then remove the mode selection and make assertion mode the default, while adding automatic detection for normal and optimization modes based on function signatures.
Tech stack
haskell
Domain
testingdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitHaskell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75