Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix lcov 2.0 source file handling #315

Merged
merged 1 commit into from
Aug 9, 2023
Merged

Fix lcov 2.0 source file handling #315

merged 1 commit into from
Aug 9, 2023

Conversation

warmwaffles
Copy link
Contributor

Prior to 2.0 being released, genhtml was much better about handling source files from the following paths:

  • test/support/some_helper.ex
  • lib/foo/bar.ex

But after 2.0 was released, when rendering with genhtml the paths would be mangled and look like the following:

  • test/support/test/support/some_helper.ex
  • lib/foo/lib/foo/bar.ex

I have tried in vain with many permutations of --prefix when running genhtml but the ultimate fix that made all of this go away was using the absolute path for the source file (SF).

@warmwaffles
Fix lcov 2.0 source file handling
c6b4bd4 
Prior to 2.0 being released, `genhtml` was much better about handling
source files from the following paths:

* `test/support/some_helper.ex`
* `lib/foo/bar.ex`

But after 2.0 was released, when rendering with `genhtml` the paths
would be mangled and look like the following:

* `test/support/test/support/some_helper.ex`
* `lib/foo/lib/foo/bar.ex`

I have tried in vain with many permutations of `--prefix` when running
`genhtml` but the ultimate fix that made all of this go away was using
the absolute path for the source file (`SF`).
@warmwaffles warmwaffles force-pushed the fix-lcov-2.0-pathing-problems branch from 3633ecf to c6b4bd4 Compare July 24, 2023 21:20
warmwaffles
warmwaffles commented Jul 24, 2023
View reviewed changes
test/lcov_test.exs
@@ -53,18 +53,18 @@ defmodule ExCoveralls.LcovTest do
Lcov.execute(@source_info)
end) =~ @stats_result

assert(File.read!(report) =~ ~s(TN:\nSF:test/fixtures/test.ex\nDA:1,0\nDA:2,1\nLF:2\nLH:1\nend_of_record\n))
%{size: size} = File.stat! report
assert(size == @file_size)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to remove the file size assertion because with the absolute path being used, it would cause the file size to be different.

We already test the file size via the File.read! and matching it against the string.

@warmwaffles
Copy link
Contributor Author

Hopefully @parroty this is okay to merge upstream as it would be nice for me to stop having to manually shim in a find replace for SF: files in my lcov info file.

@parroty parroty merged commit b475ec9 into parroty:master Aug 9, 2023
4 checks passed
@parroty
Copy link
Owner

parroty commented Aug 9, 2023

Thanks!

@warmwaffles warmwaffles deleted the fix-lcov-2.0-pathing-problems branch August 9, 2023 04:20
@warmwaffles
Copy link
Contributor Author

I think the issue resides somewhere in the lcov perl based upstream when they updated to 2.0, but I really don't know or have the time to go figure that bit out.

standback

@parroty
Copy link
Owner

parroty commented Aug 9, 2023

Thanks for the comment 🙇 . (Before releasing the new version) I just wanted to confirm if it works on lcov 1.x too, as it's about the path expansion, correct?

@warmwaffles
Copy link
Contributor Author

warmwaffles commented Aug 9, 2023 •
edited
Loading

Correct, it's the path expansion/truncation being messed up. I have not checked this with lcov 1.0 as my distro and others have all bumped and upgraded as well.

@warmwaffles
Copy link
Contributor Author

warmwaffles commented Aug 9, 2023 •
edited
Loading

This is what it looks like on LCOV 2.0 before this patch

20230808-233818

And after the patch is applied

20230808-234028

Generated with

MIX_ENV=test mix coveralls.lcov


genhtml \
    --output-directory cover \
    --show-navigation \
    --no-function-coverage \
    --no-branch-coverage \
    --flat \
    --quiet \
    ./cover/lcov.info

@warmwaffles
Copy link
Contributor Author

warmwaffles commented Aug 9, 2023 •
edited
Loading

20230808-234429

Here's the patch with lcov 1.16

pardon my crappy coverage here... you can see why I need this 😄

@parroty
Copy link
Owner

parroty commented Aug 9, 2023

Thanks for the detailed information 🙇 . I try to release the package later today.

tonyrud added a commit to Vetspire/excoveralls that referenced this pull request Sep 27, 2024
@tonyrud @gorghoa
@parroty @solar05 @whatyouhide @warmwaffles @zachallaun @albertored @rodrigues @gitneko @RKushnir @hkrutzer @juanperi
Update our ex_coveralls with forked master branch (#2)
3ec03e5 
* Cobertura now handles defprotocol and defimpl definitions (parroty#306)

* Cobertura now handles defprotocol and defimpl definitions

* Cobertura, catch all if module type is unknown

* Bump version and update CHANGELOG

* Add Cobertura docs to README.md (parroty#312)

* Update Elixir requirement to 1.11+ (parroty#316)

* Update Elixir requirement to 1.11+

* Update deps

* Replace hackney with httpc (parroty#311)

* Replace hackney with httpc

* SSL options

* FIXUP

* Cache fixed

* Aaaah, caching again

* FIXUP

* Add missing apps to :extra_applications

* Add better check for :public_key

* Bump version and update CHANGELOG

* Fix lcov 2.0 source file handling (parroty#315)

Prior to 2.0 being released, `genhtml` was much better about handling
source files from the following paths:

* `test/support/some_helper.ex`
* `lib/foo/bar.ex`

But after 2.0 was released, when rendering with `genhtml` the paths
would be mangled and look like the following:

* `test/support/test/support/some_helper.ex`
* `lib/foo/lib/foo/bar.ex`

I have tried in vain with many permutations of `--prefix` when running
`genhtml` but the ultimate fix that made all of this go away was using
the absolute path for the source file (`SF`).

* Update CHANGELOG

* Remove erroneous line in ExCoveralls.poster (parroty#318)

* Import `.coverdata` after test run and improve documentation (parroty#309)

* Import `.coverdata` after test run and improve docs

* Update README table of contents

* Update README based on review suggestion

Co-authored-by: Alberto Sartori <[email protected]>

---------

Co-authored-by: Alberto Sartori <[email protected]>

* Update CHANGELOG

* Accept custom http options (parroty#319)

* Accept custom http options

* Add HTTP options docs to README

* Bump version and update CHANGELOG

* Always floor coverage instead of rounding (parroty#310)

* Always floor coverage instead of rounding

We do not want to report a 100% coverage when there are lines
that are not covered.

* Add option to restore previous ceil coverage behaviour

* Bump version and update CHANGELOG

* Update README examples (parroty#320)

* Use explicit steps to remove 1.16 deprecation warning (parroty#322)

* Update CHANGELOG and bump version

* Detect and warn about incorrectly used ignore-comments (parroty#325)

* Detect and warn about incorrectly used ignore-comments

Resolves parroty#197.

* Keep existing ignoring behavior

* Improve formatting

* Test more ignore-related warnings

* Remove warning in the case of ignore-next-line at the EOF

* Test the warning output

* Add a changelog entry

* Adjust test descriptions

---------

Co-authored-by: Roman <[email protected]>

* Fix Elixir 1.17 single-quoted string warning (parroty#327)

* Bump version and update CHANGELOG

* add missing step for Cobertura's range (parroty#329)

Without this change, the output is full of warnings such as
```
warning: negative steps are not supported in String.slice/2, pass 44..-1//1 instead
```

* Update CHANGELOG and version

* Revert "add missing step for Cobertura's range (parroty#329)" (parroty#330)

This reverts commit 00a96c4.

* Revert version change

* Update Range to use function syntax (parroty#332)

* add missing step for Cobertura's range

* Update Range to use function syntax

* run tests in elixir 1.17

* fix test with relative path

---------

Co-authored-by: parroty <[email protected]>

* Update CHANGELOG and version

---------

Co-authored-by: Rodrigue Villetard <[email protected]>
Co-authored-by: parroty <[email protected]>
Co-authored-by: Artem Solomatin <[email protected]>
Co-authored-by: Andrea Leopardi <[email protected]>
Co-authored-by: Matthew Johnston <[email protected]>
Co-authored-by: Zach Allaun <[email protected]>
Co-authored-by: Alberto Sartori <[email protected]>
Co-authored-by: Victor Rodrigues <[email protected]>
Co-authored-by: gitneko <[email protected]>
Co-authored-by: Roman <[email protected]>
Co-authored-by: Roman <[email protected]>
Co-authored-by: Hans Krutzer <[email protected]>
Co-authored-by: Juan Peri <[email protected]>
Co-authored-by: Kenta Nakase <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@warmwaffles @parroty