-
Notifications
You must be signed in to change notification settings - Fork 149
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
Cobertura conciseness and summary option #1180
Open
rshearman
wants to merge
5
commits into
mozilla:master
Choose a base branch
from
rshearman:cobertura-summary
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
For plain lines (without branch information) then there's no need to write out opening and closing tags for the line element. It is more concise to output an empty element, and conciseness is important to avoid hitting processing limits from certain services that parse the output earlier than is necessary.
…tion Some parsers of cobertura coverage files places limits on the file size (e.g. GitLab - 10MB), so being as concise as possible is advantageous. For this reason, change the cobertura output to not add newlines and indent between XML elements, and add a new output type cobertura-pretty for cases where the newlines and indent is desired. Changing the format for the existing cobertura output type rather than keeping it the same and introducing a new concise output type was opted for since cobertura is designed to be machine-readable and most of the time users would not need to inspect the file manually. This results in a 42% reduction in output file size for a repository of mine.
Add a --print-summary option along the lines of what gcovr supports and outputting in a compatible format. The number of functions covered isn't output (it is with gcovr) as this is more complicated to calculate and it's unclear if it would be useful. Fixes mozilla#556
marco-c
reviewed
Sep 25, 2024
@@ -292,6 +297,9 @@ struct Opt { | |||
/// No symbol demangling. | |||
#[arg(long)] | |||
no_demangle: bool, | |||
/// Print a summary of the results | |||
#[arg(long)] | |||
print_summary: bool, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What if we have "summary" as one of the possible output types instead of adding a --print-summary option?
Thanks @rshearman, I've merged the two commits related to Cobertura. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add --print-summary option Add a --print-summary option along the lines
of what gcovr supports and outputting in a compatible format. The number
of functions covered isn't output (it is with gcovr) as this is more
complicated to calculate and it's unclear if it would be useful.
Fixes output coverage summary (gitlab integration) #556
Make cobertura output more concise and add cobertura-pretty output option
Some parsers of cobertura coverage files places limits on the file size
(e.g. GitLab - 10MB), so being as concise as possible is advantageous.
For this reason, change the cobertura output to not add newlines and
indent between XML elements, and add a new output type cobertura-pretty
for cases where the newlines and indent is desired.
Changing the format for the existing cobertura output type rather than
keeping it the same and introducing a new concise output type was opted
for since cobertura is designed to be machine-readable and most of the
time users would not need to inspect the file manually.
This results in a 42% reduction in output file size for a repository of
mine.
Make output of plain lines in cobertura reports more concise For plain
lines (without branch information) then there's no need to write out
opening and closing tags for the line element. It is more concise to
output an empty element, and conciseness is important to avoid hitting
processing limits from certain services that parse the output earlier
than is necessary.