OpenZeppelin / OpenZeppelin/contracts-sui

[Task]: Improve/update lcov generation to improve coverage accuracy

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

Nobody has claimed this yet.

bug
Dominant language
Move
Stars
49
Forks
14
PR merge metrics
No merged PRs in 30d

Description

We are currently using sui move coverage lcov for our codecov integration.

This tool fails to generate correct mappings when macros defined in a different source file are used in a module, by mapping the macro source file line numbers to the module source file, breaking the hit count and the lines map.

We should either fix this issue with a wrapper, or by directly contributing to the sui framework, or by using a different tool.

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 reproducing the Codecov integration issue with sui move coverage lcov, focusing on modules that use macros defined in another source file. Compare the generated source mappings, hit counts, and lines map against the actual macro locations. Done means a wrapper, Sui framework change, or replacement tool produces correct coverage mappings.

Written by the indexing model from the issue text.

Assessment

Domain
testing-qa, tooling
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.