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

Publish code coverage reports on the web #689

Closed
wants to merge 1 commit into from

Conversation

mwperina
Copy link
Member

@mwperina mwperina commented Jan 5, 2024

Code coverage reports can be generated during integration test run, but
at the moment we have following limitations:

  1. We are not running integration tests with code coverage report
    enabled after a PR is merged
  2. At this moment there is no way to create GH job which would wait
    until integration tests executed using packit are finished and fetch
    the code coverage results
  3. We don't have allowed to merge content to bluechi repo automatically
    as a result of some CI workflow
  4. Code coverage report is generated using lcov as an HTML (lcov doesn't
    provide the option to generate report in markdown) and readthedocs.io
    doesn't provide a way to import existing HTML files

So this patch describes a manual flow to publish code coverage report
results into our documentation web site bluechi.readthedocs.io

Signed-off-by: Martin Perina [email protected]

@mwperina
Copy link
Member Author

mwperina commented Jan 5, 2024

Here is the screenshot of code coverage report on our web site
Screenshot from 2024-01-05 18-35-28

@mwperina
Copy link
Member Author

mwperina commented Jan 5, 2024

@ArtiomDivak

Copy link
Contributor

@ArtiomDivak ArtiomDivak left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@engelmi engelmi left a comment

Choose a reason for hiding this comment

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

I am not sure this is the right approach. It involves a lot of manual work - running the tests to get the coverage artifacts needs to be done locally on a developers machine and then it needs to be updated by committing to the repo.

I tried to create a proposal that runs the integration tests with coverage in the GH workflow, extracting the coverage HTML report and adding a comment with the summary to the PR here:
#690
It would look like in this example here: nwutils/nw-electron-adapter#5 (comment)

Current problem is that the GITHUB_TOKEN apparently doesn't have the proper permissions in the eclipse orga. Will have to look into that and created a PR to the self-service repo (eclipse-bluechi/.eclipsefdn#11).

Code coverage reports can be generated during integration test run, but
at the moment we have following limitations:

1. We are not running integration tests with code coverage report
   enabled after a PR is merged
2. At this moment there is no way to create GH job which would wait
   until integration tests executed using packit are finished and fetch
   the code coverage results
3. We don't have allowed to merge content to bluechi repo automatically
   as a result of some CI workflow
4. Code coverage report is generated using lcov as an HTML (lcov doesn't
   provide the option to generate report in markdown) and readthedocs.io
   doesn't provide a way to import existing HTML files

So this patch describes a manual flow to publish code coverage report
results into our documentation web site bluechi.readthedocs.io

Signed-off-by: Martin Perina <[email protected]>
@mwperina
Copy link
Member Author

mwperina commented Jan 8, 2024

Closing in favor of #694

@mwperina mwperina closed this Jan 8, 2024
@mwperina mwperina deleted the add-code-cov-to-doc branch January 8, 2024 18:51
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