runtimeverification / runtimeverification/kontrol

Consider splitting integration tests between several folders

Open
#458 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Python
Stars
122
Forks
16
PR merge metrics
No merged PRs in 30d

Description

As @anvacaru suggested, in KEVM, tests are split between several proof folders depending on the project, where each project can have a separate lemma file.

In Kontrol, there's a single Foundry project under tests/integration, while it might make sense to move, e.g., the Optimism test with a dedicate set of lemmas (will be added in https://github.com/runtimeverification/kontrol/pull/369) or CSE tests to their own folders. That would likely ensure that lemmas are only applied in relevant contracts while https://github.com/runtimeverification/kontrol/issues/442 is being investigated. In addition, it would make individual definitions more compact than the current common one, which might be easier to inspect.

At the same time, this should also be coordinated with the Haskell Backend team who use our tests for profiling.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing tests/integration, the proposed Optimism changes in pull request #369, and issue #442 to understand the current test and lemma organization. Determine a folder structure that separates project-specific definitions while coordinating with the Haskell Backend team so profiling use remains supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
solidity
Domain
testing
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.