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

Cobertura conciseness and summary option #1180

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

rshearman
Copy link

  • 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.

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
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.

output coverage summary (gitlab integration)
1 participant