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.

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

Import .coverdata after test run and improve documentation #309

Merged
merged 3 commits into from
Aug 9, 2023

Conversation

zachallaun
Copy link
Contributor

Hi friends! Thanks for such a great tool.

This PR adds additional documentation/usage for the --import-cover flag and makes a change that improves the ergonomics of integration test coverage.

  • .coverdata is now imported just before ExCoveralls.execute/3, instead of during ExCoveralls.start/2. This allows coverage data generated during the test run to be included in the final report.
  • Fixed a small error in documentation: --import_cover -> --import-cover
  • Added a new section to the README with additional explanation and an example of --import-cover usage.

/cc @albertored, who first introduced this feature

@zachallaun
Copy link
Contributor Author

Additional context for my own use-case:

I'm working on a library that modifies the behavior of mix test. To do end-to-end integration testing, some test modules are dynamically generated, saved to a temp directory, and run using a shell command to mix test.

test_command = """
echo "#{test.test_input}" | \
  CI=false mix test #{file_path} \
    --seed 0
"""

task = Task.async(System, :shell, [test_command])

This change allows me to save out the coverage data from those tests and include them in the final coverage report, all within the same test run:

test_command = """
echo "#{test.test_input}" | \
  CI=false mix test #{file_path} \
    --seed 0 \
    --cover \
    --export-coverage #{test.name}
"""

task = Task.async(System, :shell, [test_command])

Now I can run the following:

$ mix coveralls --import-cover cover

@zachallaun zachallaun force-pushed the import-coverdata-improvements branch from fba79d2 to f9409da Compare April 14, 2023 15:35
README.md Outdated Show resolved Hide resolved
@zachallaun
Copy link
Contributor Author

Just wanted to bump this in case it can sneak into the release you mentioned might be later today, @parroty! No worries if not :)

@parroty
Copy link
Owner

parroty commented Aug 9, 2023

Thank you for the follow-up 🙇 .

@parroty parroty merged commit ead9d5a into parroty:master Aug 9, 2023
@zachallaun
Copy link
Contributor Author

And thank you for the work you do!

tonyrud added a commit to Vetspire/excoveralls that referenced this pull request Sep 27, 2024
* 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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants