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

Collect and visualize code coverage #394

Open
chrgernoe opened this issue Jan 17, 2023 · 3 comments
Open

Collect and visualize code coverage #394

chrgernoe opened this issue Jan 17, 2023 · 3 comments
Assignees
Labels
KTLO This feature will not be delivered to customers
Projects

Comments

@chrgernoe
Copy link
Member

The project has now quiet some test implemented but we don't know what exactly is covered.

@chrgernoe chrgernoe added the KTLO This feature will not be delivered to customers label Jan 17, 2023
@chrgernoe chrgernoe added this to the v0.7.0 milestone Jan 17, 2023
@chrgernoe chrgernoe self-assigned this Jan 17, 2023
@chrgernoe chrgernoe added this to To do in YacGuide via automation Jan 17, 2023
@chrgernoe chrgernoe moved this from To do to In progress in YacGuide Jan 17, 2023
@paetz
Copy link
Collaborator

paetz commented Jan 17, 2023

I've also started looking around for tools providing this but could only find some 3rd-party stuff.
Questions:

  • How and where to present the data? Will it be like a script you run locally? Or will it run in CI and output coverage to CI console?
    Some ideas:
  • For every app build (locally and CI) the coverage will be created (normally as HTML file).
    -- In the local case, it should be written to some file at a specific location, maybe somehow tagged with branch name and commit hash, if possible.
    -- For CI, the created HTML should be saved as an artifact and linked in the CI console output, if this is possible.

I guess, in the first instance it would be also fine to simply have a CI console output like: Test coverage: Functional coverage: x%, branch coverage: y% and adding the detailed coverage report later.

@chrgernoe
Copy link
Member Author

It seems, there are two main tools for Kotlin code coverage collection:

  • JaCoCo - Java Code Coverage Library, which exists quiet a while.
  • kotlinx-cover - Kotlin specific code coverage tool, developed by the Kotlin guys itself. Relative young project.

There is an external free service called codecov for visualization, which used by many open source projects. Both tools produce an output which can be uploaded to this service via CI. Also both tools can create a local coverage report as HTML.

@paetz paetz removed this from the v0.7.0 milestone Jan 19, 2023
@paetz
Copy link
Collaborator

paetz commented Jan 19, 2023

I've removed the milestone. There is no special need for it to be part of any specific version.

@chrgernoe chrgernoe moved this from In progress to To do in YacGuide Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
KTLO This feature will not be delivered to customers
Projects
YacGuide
  
To do
Development

No branches or pull requests

2 participants