software-mansion / cairo-coverage

Code coverage tool for cairo
MIT License
16 stars 3 forks source link

Enable Users to see Code Coverage on expaned code #49

Open ksew1 opened 2 months ago

ksew1 commented 2 months ago

We should allow users to run coverage on expanded code, especially to see coverage for macros that might contain conditional statements and thus can be not fully covered. We can approach this in three ways, ranked from the easiest to the most complicated:

Proposed Solutions:

  1. Ask users to run scarb expand on their own and input it to Cairo coverage

    • Changes Required: Only in Scarb
    • Description: Users will manually run scarb expand and then input the expanded code into Cairo coverage tool.
  2. Add --expand flag to Forge

    • Changes Required: In Scarb and Forge
    • Description: Forge will run scarb expand behind the scenes and then pass the output to Cairo-coverage. This process will be automated for the user.
  3. Change mappings in the compiler to also point to expanded lines

    • Changes Required: Needs more investigation
    • Description: Needs more investigation

Additional Requirements: