1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
|
import argparse
import io
import logging
import os
import sys
import warnings
import xml.etree.ElementTree as etree
from diff_cover import DESCRIPTION, VERSION
from diff_cover.config_parser import Tool, get_config
from diff_cover.diff_reporter import GitDiffReporter
from diff_cover.git_diff import GitDiffFileTool, GitDiffTool
from diff_cover.git_path import GitPathTool
from diff_cover.report_generator import (
GitHubAnnotationsReportGenerator,
HtmlReportGenerator,
JsonReportGenerator,
MarkdownReportGenerator,
StringReportGenerator,
)
from diff_cover.util import open_file
from diff_cover.violationsreporters.violations_reporter import (
LcovCoverageReporter,
XmlCoverageReporter,
)
FORMAT_HELP = "Format to use"
HTML_REPORT_DEFAULT_PATH = "diff-cover.html"
JSON_REPORT_DEFAULT_PATH = "diff-cover.json"
MARKDOWN_REPORT_DEFAULT_PATH = "diff-cover.md"
COMPARE_BRANCH_HELP = "Branch to compare"
CSS_FILE_HELP = "Write CSS into an external file"
FAIL_UNDER_HELP = (
"Returns an error code if coverage or quality score is below this value"
)
IGNORE_STAGED_HELP = "Ignores staged changes"
IGNORE_UNSTAGED_HELP = "Ignores unstaged changes"
IGNORE_WHITESPACE = "When getting a diff ignore any and all whitespace"
EXCLUDE_HELP = "Exclude files, more patterns supported"
INCLUDE_HELP = "Files to include (glob pattern)"
SRC_ROOTS_HELP = "List of source directories (only for jacoco coverage reports)"
COVERAGE_FILE_HELP = "coverage report (XML or lcov.info)"
DIFF_RANGE_NOTATION_HELP = (
"Git diff range notation to use when comparing branches, defaults to '...'"
)
QUIET_HELP = "Only print errors and failures"
SHOW_UNCOVERED = "Show uncovered lines on the console"
EXPAND_COVERAGE_REPORT = (
"Append missing lines in coverage reports based on the hits of the previous line."
)
INCLUDE_UNTRACKED_HELP = "Include untracked files"
CONFIG_FILE_HELP = "The configuration file to use"
DIFF_FILE_HELP = "The diff file to use"
TOTAL_PERCENT_FLOAT_HELP = (
"Show total coverage/quality as a float rounded to 2 decimal places"
)
LOGGER = logging.getLogger(__name__)
def format_type(value):
"""
Accepts:
--format html:path/to/file.html,json:path/to/file.json
return: dict of strings to paths
"""
return dict((item.split(":", 1) for item in value.split(",")) if value else {})
def parse_coverage_args(argv):
"""
Parse command line arguments, returning a dict of
valid options:
{
'coverage_file': COVERAGE_FILE,
'html_report': None | HTML_REPORT,
'json_report': None | JSON_REPORT,
'external_css_file': None | CSS_FILE,
}
where `COVERAGE_FILE`, `HTML_REPORT`, `JSON_REPORT`, and `CSS_FILE` are paths.
The path strings may or may not exist.
"""
parser = argparse.ArgumentParser(description=DESCRIPTION)
parser.add_argument("coverage_files", type=str, help=COVERAGE_FILE_HELP, nargs="+")
parser.add_argument(
"--format",
type=format_type,
default="",
help=FORMAT_HELP,
)
parser.add_argument(
"--show-uncovered", action="store_true", default=None, help=SHOW_UNCOVERED
)
parser.add_argument(
"--expand-coverage-report",
action="store_true",
default=None,
help=EXPAND_COVERAGE_REPORT,
)
parser.add_argument(
"--external-css-file",
metavar="FILENAME",
type=str,
help=CSS_FILE_HELP,
)
parser.add_argument(
"--compare-branch",
metavar="BRANCH",
type=str,
help=COMPARE_BRANCH_HELP,
)
parser.add_argument(
"--fail-under", metavar="SCORE", type=float, default=None, help=FAIL_UNDER_HELP
)
parser.add_argument(
"--ignore-staged", action="store_true", default=None, help=IGNORE_STAGED_HELP
)
parser.add_argument(
"--ignore-unstaged",
action="store_true",
default=None,
help=IGNORE_UNSTAGED_HELP,
)
parser.add_argument(
"--include-untracked",
action="store_true",
default=None,
help=INCLUDE_UNTRACKED_HELP,
)
parser.add_argument(
"--exclude", metavar="EXCLUDE", type=str, nargs="+", help=EXCLUDE_HELP
)
parser.add_argument(
"--include", metavar="INCLUDE", type=str, nargs="+", help=INCLUDE_HELP
)
parser.add_argument(
"--src-roots",
metavar="DIRECTORY",
type=str,
nargs="+",
help=SRC_ROOTS_HELP,
)
parser.add_argument(
"--diff-range-notation",
metavar="RANGE_NOTATION",
type=str,
choices=["...", ".."],
help=DIFF_RANGE_NOTATION_HELP,
)
parser.add_argument("--version", action="version", version=f"diff-cover {VERSION}")
parser.add_argument(
"--ignore-whitespace",
action="store_true",
default=None,
help=IGNORE_WHITESPACE,
)
parser.add_argument(
"-q", "--quiet", action="store_true", default=None, help=QUIET_HELP
)
parser.add_argument(
"-c", "--config-file", help=CONFIG_FILE_HELP, metavar="CONFIG_FILE"
)
parser.add_argument("--diff-file", type=str, default=None, help=DIFF_FILE_HELP)
parser.add_argument(
"--total-percent-float",
action="store_true",
default=None,
help=TOTAL_PERCENT_FLOAT_HELP,
)
defaults = {
"show_uncovered": False,
"compare_branch": "origin/main",
"fail_under": 0,
"ignore_staged": False,
"ignore_unstaged": False,
"ignore_untracked": False,
"src_roots": ["src/main/java", "src/test/java"],
"ignore_whitespace": False,
"diff_range_notation": "...",
"quiet": False,
"expand_coverage_report": False,
"total_percent_float": False,
}
return get_config(parser=parser, argv=argv, defaults=defaults, tool=Tool.DIFF_COVER)
def generate_coverage_report(
coverage_files,
compare_branch,
diff_tool,
report_formats=None,
css_file=None,
ignore_staged=False,
ignore_unstaged=False,
include_untracked=False,
exclude=None,
include=None,
src_roots=None,
quiet=False,
show_uncovered=False,
expand_coverage_report=False,
total_percent_float=False,
):
"""
Generate the diff coverage report, using kwargs from `parse_args()`.
"""
diff = GitDiffReporter(
compare_branch,
git_diff=diff_tool,
ignore_staged=ignore_staged,
ignore_unstaged=ignore_unstaged,
include_untracked=include_untracked,
exclude=exclude,
include=include,
)
xml_roots = [
etree.parse(coverage_file)
for coverage_file in coverage_files
if coverage_file.endswith(".xml")
]
lcov_roots = [
LcovCoverageReporter.parse(coverage_file)
for coverage_file in coverage_files
if not coverage_file.endswith(".xml")
]
if xml_roots and lcov_roots:
raise ValueError("Mixing LCov and XML reports is not supported yet")
if xml_roots:
coverage = XmlCoverageReporter(xml_roots, src_roots, expand_coverage_report)
else:
coverage = LcovCoverageReporter(lcov_roots, src_roots)
# Build a report generator
if "html" in report_formats:
html_report = report_formats["html"] or HTML_REPORT_DEFAULT_PATH
css_url = css_file
if css_url is not None:
css_url = os.path.relpath(css_file, os.path.dirname(html_report))
reporter = HtmlReportGenerator(
coverage, diff, css_url=css_url, total_percent_float=total_percent_float
)
with open_file(html_report, "wb") as output_file:
reporter.generate_report(output_file)
if css_file is not None:
with open(css_file, "wb") as output_file:
reporter.generate_css(output_file)
if "json" in report_formats:
json_report = report_formats["json"] or JSON_REPORT_DEFAULT_PATH
reporter = JsonReportGenerator(
coverage, diff, total_percent_float=total_percent_float
)
with open_file(json_report, "wb") as output_file:
reporter.generate_report(output_file)
if "markdown" in report_formats:
markdown_report = report_formats["markdown"] or MARKDOWN_REPORT_DEFAULT_PATH
reporter = MarkdownReportGenerator(
coverage, diff, total_percent_float=total_percent_float
)
with open_file(markdown_report, "wb") as output_file:
reporter.generate_report(output_file)
if "github-annotations" in report_formats:
# Github annotations are always written to stdout, but we can use different types
reporter = GitHubAnnotationsReportGenerator(
coverage,
diff,
report_formats["github-annotations"],
total_percent_float=total_percent_float,
)
reporter.generate_report(sys.stdout.buffer)
# Generate the report for stdout
reporter = StringReportGenerator(
coverage,
diff,
show_uncovered,
total_percent_float=total_percent_float,
)
output_file = io.BytesIO() if quiet else sys.stdout.buffer
# Generate the report
reporter.generate_report(output_file)
return reporter.total_percent_covered()
def handle_old_format(description, argv):
parser = argparse.ArgumentParser(description=description)
arg_html = parser.add_argument("--html-report", type=str)
arg_json = parser.add_argument("--json-report", type=str)
arg_markdown = parser.add_argument("--markdown-report", type=str)
parser.add_argument("--format", type=str)
known_args, unknown_args = parser.parse_known_args(argv)
format_ = format_type(known_args.format)
if known_args.html_report:
if "html" in format_:
raise argparse.ArgumentError(
arg_html, "Cannot use along with --format html."
)
warnings.warn(
"The --html-report option is deprecated. "
f"Use --format html:{known_args.html_report} instead."
)
format_["html"] = known_args.html_report
if known_args.json_report:
if "json" in format_:
raise argparse.ArgumentError(
arg_json, "Cannot use along with --format json."
)
warnings.warn(
"The --json-report option is deprecated. "
f"Use --format json:{known_args.json_report} instead."
)
format_["json"] = known_args.json_report
if known_args.markdown_report:
if "markdown" in format_:
raise argparse.ArgumentError(
arg_markdown, "Cannot use along with --format markdown."
)
warnings.warn(
"The --markdown-report option is deprecated. "
f"Use --format markdown:{known_args.markdown_report} instead."
)
format_["markdown"] = known_args.markdown_report
if format_:
unknown_args += [
"--format",
",".join(f"{k}:{v}" for k, v in format_.items()), # noqa: E231
]
return unknown_args
def main(argv=None, directory=None):
"""
Main entry point for the tool, script installed via pyproject.toml
Returns a value that can be passed into exit() specifying
the exit code.
1 is an error
0 is successful run
"""
argv = argv or sys.argv
arg_dict = parse_coverage_args(handle_old_format(DESCRIPTION, argv[1:]))
quiet = arg_dict["quiet"]
level = logging.ERROR if quiet else logging.WARNING
logging.basicConfig(format="%(message)s", level=level)
GitPathTool.set_cwd(directory)
fail_under = arg_dict.get("fail_under")
diff_tool = None
if not arg_dict["diff_file"]:
diff_tool = GitDiffTool(
arg_dict["diff_range_notation"], arg_dict["ignore_whitespace"]
)
else:
diff_tool = GitDiffFileTool(arg_dict["diff_file"])
percent_covered = generate_coverage_report(
arg_dict["coverage_files"],
arg_dict["compare_branch"],
diff_tool,
report_formats=arg_dict["format"],
css_file=arg_dict["external_css_file"],
ignore_staged=arg_dict["ignore_staged"],
ignore_unstaged=arg_dict["ignore_unstaged"],
include_untracked=arg_dict["include_untracked"],
exclude=arg_dict["exclude"],
include=arg_dict["include"],
src_roots=arg_dict["src_roots"],
quiet=quiet,
show_uncovered=arg_dict["show_uncovered"],
expand_coverage_report=arg_dict["expand_coverage_report"],
total_percent_float=arg_dict["total_percent_float"],
)
if percent_covered >= fail_under:
return 0
LOGGER.error("Failure. Coverage is below %i%%.", fail_under)
return 1
if __name__ == "__main__":
sys.exit(main())
|