diff --git a/clang/utils/analyzer/CmpRuns.py b/clang/utils/analyzer/CmpRuns.py old mode 100755 new mode 100644 index d80481da03f1d..f7f28d9dc72e2 --- a/clang/utils/analyzer/CmpRuns.py +++ b/clang/utils/analyzer/CmpRuns.py @@ -25,7 +25,6 @@ diff = compare_results(resultsA, resultsB) """ -import argparse import json import os import plistlib @@ -524,51 +523,7 @@ def dump_scan_build_results_diff(dir_old: ResultsDirectory, len(results_new.diagnostics) -def generate_option_parser(): - parser = argparse.ArgumentParser() - - parser.add_argument("--root-old", dest="root_old", - help="Prefix to ignore on source files for " - "OLD directory", - action="store", type=str, default="") - parser.add_argument("--root-new", dest="root_new", - help="Prefix to ignore on source files for " - "NEW directory", - action="store", type=str, default="") - parser.add_argument("--verbose-log", dest="verbose_log", - help="Write additional information to LOG " - "[default=None]", - action="store", type=str, default=None, - metavar="LOG") - parser.add_argument("--stats-only", action="store_true", dest="stats_only", - default=False, help="Only show statistics on reports") - parser.add_argument("--show-stats", action="store_true", dest="show_stats", - default=False, help="Show change in statistics") - parser.add_argument("--histogram", action="store", default=None, - choices=[HistogramType.RELATIVE.value, - HistogramType.LOG_RELATIVE.value, - HistogramType.ABSOLUTE.value], - help="Show histogram of paths differences. " - "Requires matplotlib") - parser.add_argument("old", nargs=1, help="Directory with old results") - parser.add_argument("new", nargs=1, help="Directory with new results") - - return parser - - -def main(): - parser = generate_option_parser() - args = parser.parse_args() - - dir_old = ResultsDirectory(args.old[0], args.root_old) - dir_new = ResultsDirectory(args.new[0], args.root_new) - - dump_scan_build_results_diff(dir_old, dir_new, - show_stats=args.show_stats, - stats_only=args.stats_only, - histogram=args.histogram, - verbose_log=args.verbose_log) - - -if __name__ == '__main__': - main() +if __name__ == "__main__": + print("CmpRuns.py should not be used on its own.") + print("Please use 'SATest.py compare' instead") + sys.exit(1) diff --git a/clang/utils/analyzer/SATest.py b/clang/utils/analyzer/SATest.py new file mode 100755 index 0000000000000..4fb7bf7499477 --- /dev/null +++ b/clang/utils/analyzer/SATest.py @@ -0,0 +1,164 @@ +#!/usr/bin/env python + +import SATestAdd +import SATestBuild +import SATestUpdateDiffs +import CmpRuns + +from ProjectMap import ProjectInfo, ProjectMap + +import argparse +import sys + + +def add(parser, args): + if args.source == "git" and (args.origin == "" or args.commit == ""): + parser.error( + "Please provide both --origin and --commit if source is 'git'") + + if args.source != "git" and (args.origin != "" or args.commit != ""): + parser.error("Options --origin and --commit don't make sense when " + "source is not 'git'") + + project = ProjectInfo(args.name[0], args.mode, args.source, args.origin, + args.commit) + + SATestAdd.add_new_project(project) + + +def build(parser, args): + SATestBuild.VERBOSE = args.verbose + tester = SATestBuild.RegressionTester(args.jobs, args.override_compiler, + args.extra_analyzer_config, + args.regenerate, + args.strictness) + tests_passed = tester.test_all() + + if not tests_passed: + sys.stderr.write("ERROR: Tests failed.\n") + sys.exit(42) + + +def compare(parser, args): + dir_old = CmpRuns.ResultsDirectory(args.old[0], args.root_old) + dir_new = CmpRuns.ResultsDirectory(args.new[0], args.root_new) + + CmpRuns.dump_scan_build_results_diff(dir_old, dir_new, + show_stats=args.show_stats, + stats_only=args.stats_only, + histogram=args.histogram, + verbose_log=args.verbose_log) + + +def update(parser, args): + project_map = ProjectMap() + for project in project_map.projects: + SATestUpdateDiffs.update_reference_results(project) + + +def main(): + parser = argparse.ArgumentParser() + subparsers = parser.add_subparsers() + + # add subcommand + add_parser = subparsers.add_parser( + "add", + help="Add a new project for the analyzer testing.") + # TODO: Add an option not to build. + # TODO: Set the path to the Repository directory. + add_parser.add_argument("name", nargs=1, help="Name of the new project") + add_parser.add_argument("--mode", action="store", default=1, type=int, + choices=[0, 1, 2], + help="Build mode: 0 for single file project, " + "1 for scan_build, " + "2 for single file c++11 project") + add_parser.add_argument("--source", action="store", default="script", + choices=["script", "git", "zip"], + help="Source type of the new project: " + "'git' for getting from git " + "(please provide --origin and --commit), " + "'zip' for unpacking source from a zip file, " + "'script' for downloading source by running " + "a custom script {}" + .format(SATestBuild.DOWNLOAD_SCRIPT)) + add_parser.add_argument("--origin", action="store", default="", + help="Origin link for a git repository") + add_parser.add_argument("--commit", action="store", default="", + help="Git hash for a commit to checkout") + add_parser.set_defaults(func=add) + + # build subcommand + build_parser = subparsers.add_parser( + "build", + help="Build projects from the project map and compare results with " + "the reference.") + build_parser.add_argument("--strictness", dest="strictness", + type=int, default=0, + help="0 to fail on runtime errors, 1 to fail " + "when the number of found bugs are different " + "from the reference, 2 to fail on any " + "difference from the reference. Default is 0.") + build_parser.add_argument("-r", dest="regenerate", action="store_true", + default=False, + help="Regenerate reference output.") + build_parser.add_argument("--override-compiler", action="store_true", + default=False, help="Call scan-build with " + "--override-compiler option.") + build_parser.add_argument("-j", "--jobs", dest="jobs", + type=int, default=0, + help="Number of projects to test concurrently") + build_parser.add_argument("--extra-analyzer-config", + dest="extra_analyzer_config", type=str, + default="", + help="Arguments passed to to -analyzer-config") + build_parser.add_argument("-v", "--verbose", action="count", default=0) + build_parser.set_defaults(func=build) + + # compare subcommand + cmp_parser = subparsers.add_parser( + "compare", + help="Comparing two static analyzer runs in terms of " + "reported warnings and execution time statistics.") + cmp_parser.add_argument("--root-old", dest="root_old", + help="Prefix to ignore on source files for " + "OLD directory", + action="store", type=str, default="") + cmp_parser.add_argument("--root-new", dest="root_new", + help="Prefix to ignore on source files for " + "NEW directory", + action="store", type=str, default="") + cmp_parser.add_argument("--verbose-log", dest="verbose_log", + help="Write additional information to LOG " + "[default=None]", + action="store", type=str, default=None, + metavar="LOG") + cmp_parser.add_argument("--stats-only", action="store_true", + dest="stats_only", default=False, + help="Only show statistics on reports") + cmp_parser.add_argument("--show-stats", action="store_true", + dest="show_stats", default=False, + help="Show change in statistics") + cmp_parser.add_argument("--histogram", action="store", default=None, + choices=[CmpRuns.HistogramType.RELATIVE.value, + CmpRuns.HistogramType.LOG_RELATIVE.value, + CmpRuns.HistogramType.ABSOLUTE.value], + help="Show histogram of paths differences. " + "Requires matplotlib") + cmp_parser.add_argument("old", nargs=1, help="Directory with old results") + cmp_parser.add_argument("new", nargs=1, help="Directory with new results") + cmp_parser.set_defaults(func=compare) + + # update subcommand + upd_parser = subparsers.add_parser( + "update", + help="Update static analyzer reference results based on the previous " + "run of SATest build. Assumes that SATest build was just run.") + # TODO: add option to decide whether we should use git + upd_parser.set_defaults(func=update) + + args = parser.parse_args() + args.func(parser, args) + + +if __name__ == "__main__": + main() diff --git a/clang/utils/analyzer/SATestAdd.py b/clang/utils/analyzer/SATestAdd.py old mode 100755 new mode 100644 index 7d68ef261dbf6..9d0919345182f --- a/clang/utils/analyzer/SATestAdd.py +++ b/clang/utils/analyzer/SATestAdd.py @@ -45,7 +45,6 @@ import SATestBuild from ProjectMap import ProjectMap, ProjectInfo -import argparse import os import sys @@ -85,41 +84,7 @@ def is_existing_project(project_map: ProjectMap, project: ProjectInfo) -> bool: for existing_project in project_map.projects) -# TODO: Add an option not to build. -# TODO: Set the path to the Repository directory. if __name__ == "__main__": - parser = argparse.ArgumentParser() - - parser.add_argument("name", nargs=1, help="Name of the new project") - parser.add_argument("--mode", action="store", default=1, type=int, - choices=[0, 1, 2], - help="Build mode: 0 for single file project, " - "1 for scan_build, " - "2 for single file c++11 project") - parser.add_argument("--source", action="store", default="script", - choices=["script", "git", "zip"], - help=f"Source type of the new project: " - f"'git' for getting from git " - f"(please provide --origin and --commit), " - f"'zip' for unpacking source from a zip file, " - f"'script' for downloading source by running " - f"a custom script {SATestBuild.DOWNLOAD_SCRIPT}") - parser.add_argument("--origin", action="store", default="", - help="Origin link for a git repository") - parser.add_argument("--commit", action="store", default="", - help="Git hash for a commit to checkout") - - args = parser.parse_args() - - if args.source == "git" and (args.origin == "" or args.commit == ""): - parser.error( - "Please provide both --origin and --commit if source is 'git'") - - if args.source != "git" and (args.origin != "" or args.commit != ""): - parser.error("Options --origin and --commit don't make sense when " - "source is not 'git'") - - project = ProjectInfo(args.name[0], args.mode, args.source, args.origin, - args.commit) - - add_new_project(project) + print("SATestAdd.py should not be used on its own.") + print("Please use 'SATest.py add' instead") + sys.exit(1) diff --git a/clang/utils/analyzer/SATestBuild.py b/clang/utils/analyzer/SATestBuild.py old mode 100755 new mode 100644 index b81d09ff31888..d5b0710c8d613 --- a/clang/utils/analyzer/SATestBuild.py +++ b/clang/utils/analyzer/SATestBuild.py @@ -46,7 +46,6 @@ import SATestUtils from ProjectMap import DownloadType, ProjectInfo, ProjectMap -import argparse import glob import logging import math @@ -635,7 +634,6 @@ def __init__(self, tasks_queue: TestQueue, the canonical ones. :param failure_flag: Used to signify a failure during the run. """ - self.args = args self.tasks_queue = tasks_queue self.results_differ = results_differ self.failure_flag = failure_flag @@ -883,37 +881,6 @@ def clean_up_empty_folders(output_dir: str): if __name__ == "__main__": - # Parse command line arguments. - parser = argparse.ArgumentParser( - description="Test the Clang Static Analyzer.") - - parser.add_argument("--strictness", dest="strictness", type=int, default=0, - help="0 to fail on runtime errors, 1 to fail when the " - "number of found bugs are different from the " - "reference, 2 to fail on any difference from the " - "reference. Default is 0.") - parser.add_argument("-r", dest="regenerate", action="store_true", - default=False, help="Regenerate reference output.") - parser.add_argument("--override-compiler", action="store_true", - default=False, help="Call scan-build with " - "--override-compiler option.") - parser.add_argument("-j", "--jobs", dest="jobs", type=int, - default=0, - help="Number of projects to test concurrently") - parser.add_argument("--extra-analyzer-config", - dest="extra_analyzer_config", type=str, - default="", - help="Arguments passed to to -analyzer-config") - parser.add_argument("-v", "--verbose", action="count", default=0) - - args = parser.parse_args() - - VERBOSE = args.verbose - tester = RegressionTester(args.jobs, args.override_compiler, - args.extra_analyzer_config, args.regenerate, - args.strictness) - tests_passed = tester.test_all() - - if not tests_passed: - stderr("ERROR: Tests failed.") - sys.exit(42) + print("SATestBuild.py should not be used on its own.") + print("Please use 'SATest.py build' instead") + sys.exit(1) diff --git a/clang/utils/analyzer/SATestUpdateDiffs.py b/clang/utils/analyzer/SATestUpdateDiffs.py old mode 100755 new mode 100644