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

rm gcovr dep implement json html report #1099

Merged
merged 4 commits into from
Jan 9, 2024

Conversation

brianignacio5
Copy link
Collaborator

@brianignacio5 brianignacio5 commented Dec 21, 2023

Description

Remove gcovr use in the extension in favor of implementing our own JSON and HTML report from toolchain gcov executables.

Type of change

  • New feature (non-breaking change which adds functionality)

Steps to test this pull request

Provide a list of steps to test changes in this PR and required output

  1. Follow the code coverage tutorial or code coverage documentation.
  2. Observe results. After executing the ESP-IDF: Add Editor Coverage and ESP-IDF: Get HTML Coverage Report for Project should provide similar results.

How has this been tested?

Manual testing following code coverage tutorial.

Test Configuration:

  • ESP-IDF Version: 5.0
  • OS (Windows,Linux and macOS): macOS

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

@brianignacio5 brianignacio5 force-pushed the enhance/rm-gcovr-dependency branch from fcb60e1 to fb5daa5 Compare December 21, 2023 10:08
src/coverage/gcdaPaths.ts Fixed Show fixed Hide fixed
Copy link

github-actions bot commented Dec 21, 2023

Download the artifacts for this pull request:

Copy link
Collaborator

@radurentea radurentea left a comment

Choose a reason for hiding this comment

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

LGTM from a coding perspective.

However, I have the following suggestions for the design:

  1. The black font on the red background in the HTML Report is quite hard too see:
    bg-red

  2. For the columns that don't have values we should leave them empty or put "0%" instead of "-%"
    novalues

  3. I think this is a bug, in old HTML Report the map value was "low: <75.0 %" instead of "low: >= 0%"
    comparison
    old comparison

  4. We should update the screenshots as well for the gcov documentation

@radurentea radurentea self-requested a review January 3, 2024 14:24
Copy link
Collaborator

@radurentea radurentea left a comment

Choose a reason for hiding this comment

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

LGTM

@AndriiFilippov
Copy link
Collaborator

AndriiFilippov commented Jan 8, 2024

@brianignacio5 hi !

Tested:
OS - MacOS
ESP-IDF: v5.1.2

LGTM 👍
Since you have updated Report, do you think code coverage tutorial be also updated ? I mean like illustration.

@brianignacio5
Copy link
Collaborator Author

@brianignacio5 hi !

Tested: OS - MacOS ESP-IDF: v5.1.2

LGTM 👍 Since you have updated Report, do you think code coverage tutorial be also updated ? I mean like illustration.

Updated the HTML report picture and removed gcovr from docs

@AndriiFilippov
Copy link
Collaborator

LGTM 👍

@brianignacio5 brianignacio5 merged commit 4723524 into master Jan 9, 2024
6 checks passed
@brianignacio5 brianignacio5 deleted the enhance/rm-gcovr-dependency branch January 9, 2024 13:22
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