File: coverage.py

package info (click to toggle)
blender 4.3.2%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 309,564 kB
  • sloc: cpp: 2,385,210; python: 330,236; ansic: 280,972; xml: 2,446; sh: 972; javascript: 317; makefile: 170
file content (97 lines) | stat: -rwxr-xr-x 2,939 bytes parent folder | download
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
#!/usr/bin/env python3
# SPDX-FileCopyrightText: 2024 Blender Authors
#
# SPDX-License-Identifier: GPL-2.0-or-later

import argparse
import os
import shutil
import sys
import textwrap
import webbrowser

from coverage_report import parse, report_as_html
from coverage_report.util import print_updateable_line
from pathlib import Path

usage = textwrap.dedent(
    """\
    coverage.py <command> [<args>]

    Commands:
        report                              Analyse coverage data and generate html report.
          [--build-directory]                 Blender build directory. This will be scanned for .gcda files.
          [--no-browser]                      Don't open the browser in the end.
        reset [--build-directory]           Delete .gcda files.
        help                                Show this help.
    """
)


def main():
    parser = argparse.ArgumentParser(description="Blender test coverage", usage=usage)

    parser.add_argument("command", nargs="?", default="help")
    args = parser.parse_args(sys.argv[1:2])
    command = args.command

    argv = sys.argv[2:]

    if command == "report":
        run_report(argv)
    elif command == "reset":
        run_reset(argv)
    elif command == "help":
        print(usage)
    else:
        print("Unknown command: {}".format(command))
        sys.exit(1)


def run_report(argv):
    parser = argparse.ArgumentParser(usage=usage)
    parser.add_argument("--build-directory", type=str, default=".")
    parser.add_argument("--no-browser", action="store_true", default=False)
    args = parser.parse_args(argv)

    build_dir = Path(args.build_directory).absolute()
    if not is_blender_build_directory(build_dir):
        print("Directory does not seem to be a Blender build directory.")
        sys.exit(1)

    coverage_dir = build_dir / "coverage"
    analysis_dir = coverage_dir / "analysis"
    reference_dir = coverage_dir / "reference"
    report_dir = coverage_dir / "report"

    parse(build_dir, analysis_dir)
    report_as_html(analysis_dir, report_dir, reference_dir=reference_dir)

    if not args.no_browser:
        webbrowser.open("file://" + str(report_dir / "index.html"))


def run_reset(argv):
    parser = argparse.ArgumentParser(usage=usage)
    parser.add_argument("--build-directory", type=str, default=".")
    args = parser.parse_args(argv)

    build_dir = Path(args.build_directory).absolute()
    if not is_blender_build_directory(build_dir):
        print("Directory does not seem to be a Blender build directory.")
        sys.exit(1)

    print("Remove .gcda files...")
    gcda_files = list(build_dir.glob("**/*.gcda"))
    for i, path in enumerate(gcda_files):
        print_updateable_line("[{}/{}] Remove: {}".format(i + 1, len(gcda_files), path))
        os.remove(path)
    print()


def is_blender_build_directory(build_dir):
    return (Path(build_dir) / "CMakeCache.txt").exists()


if __name__ == '__main__':
    main()