JuliaCI / JuliaCI/LocalCoverage.jl

Cumbersome long filenames in show of coverage report.

Open
#50 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
79
Forks
26
PR merge metrics
No merged PRs in 30d

Description

When running a coverage report, the filenames printed contain the full path, not just the path relative to the project root. I'm not sure if this is intentional, or a problem related to my system setup specifically. (Running coverage over LocalRegistry as it's an Open Source project I happened to have open at the time.)

┌────────────────────────────────────────────────────────────────────────┬───────┬─────┬──────┬─────┐      
│ Filename                                                               │ Lines │ Hit │ Miss │   % │      
├────────────────────────────────────────────────────────────────────────┼───────┼─────┼──────┼─────┤      
│ C:\\Users\\12345678\\.julia\\dev\\LocalRegistry\\src\\LocalRegistry.jl │   261 │ 250 │   11 │ 96% │      
├────────────────────────────────────────────────────────────────────────┼───────┼─────┼──────┼─────┤      
│ TOTAL                                                                  │   261 │ 250 │   11 │ 96% │      
└────────────────────────────────────────────────────────────────────────┴───────┴─────┴──────┴─────┘ 

I hacked a small implementation that removes the summary.pkgdir from the filename. This did require some juggling with the case of the drive letter (on Windows...), which did trigger me to think that maybe that was the only cause of the issue.

The output I get with my hacky fix is

┌─────────────────────────┬───────┬─────┬──────┬─────┐
│ Filename                │ Lines │ Hit │ Miss │   % │
├─────────────────────────┼───────┼─────┼──────┼─────┤
│ \\src\\LocalRegistry.jl │   261 │ 250 │   11 │ 96% │
├─────────────────────────┼───────┼─────┼──────┼─────┤
│ TOTAL                   │   261 │ 250 │   11 │ 96% │
└─────────────────────────┴───────┴─────┴──────┴─────┘

So is the default behaviour I see intentional? And if so is the fix I implemented welcome?

Contributor guide

No contributing guide indexed for this repository

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

Reproduce the coverage report using a project with a long Windows-style path, then trace where the report formats filenames relative to the project root. Compare the current output with the relative-path output shown in the issue; done means the report avoids unnecessary absolute-path prefixes without breaking path handling.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
testing-qa
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.