forked from apache/incubator-pegasus
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(CI): Introduce clang tidy linter (apache#2094)
> clang-tidy is a clang-based C++ “linter” tool. Its purpose is to provide an extensible framework for diagnosing and fixing typical programming errors, like style violations, interface misuse, or bugs that can be deduced via static analysis. clang-tidy is modular and provides a convenient interface for writing new checks. This patch introduces clang-tidy to lint the Pegasus code, there are many issues are needed to be fixed, it would be a very large patch if fix them all in one patch. So only changed files will be checked in the newly added GitHub action. To lint the code localy before submitting the code, please follow the steps: 1. Install `clang-tidy`, now we are using clang-tidy-14. `sudo apt-get install clang-tidy -y` 2. Setup the compilation database the clang-tidy needed. `./run.sh build --test --compiler clang-14,clang++-14 -t debug --skip_thirdparty -c --cmake_only` 3. Lint the code. (The example checked the code modified from the local `origin/master` branch). `./scripts/clang_tidy.py --rev-range $(git log origin/master -n1 --format=format:"%H")`
- Loading branch information
Showing
4 changed files
with
181 additions
and
8 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
|
|
||
| # https://releases.llvm.org/14.0.0/tools/clang/tools/extra/docs/clang-tidy/index.html | ||
|
|
||
| CheckOptions: [] | ||
| Checks: 'abseil-*,boost-*,bugprone-*,cert-*,clang-analyzer-*,concurrency-*,cppcoreguidelines-*,darwin-*,fuchsia-*,google-*,hicpp-*,linuxkernel-*,llvm-*,misc-*,modernize-*,performance-*,portability-*,readability-*' | ||
| ExtraArgs: | ||
| ExtraArgsBefore: [] | ||
| FormatStyle: none | ||
| HeaderFilterRegex: '' | ||
| InheritParentConfig: true | ||
| UseColor: true | ||
| User: 'clang-tidy' | ||
| WarningsAsErrors: '' |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| #!/usr/bin/env python3 | ||
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
|
|
||
| # Most of the code are inspired by https://github.com/apache/kudu/blob/856fa3404b00ee02bd3bc1d77d414ede2b2cd02e/build-support/clang_tidy_gerrit.py | ||
|
|
||
| import argparse | ||
| import collections | ||
| import json | ||
| import multiprocessing | ||
| from multiprocessing.pool import ThreadPool | ||
| import os | ||
| import re | ||
| import subprocess | ||
| import sys | ||
| import tempfile | ||
|
|
||
| ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), "..")) | ||
|
|
||
| BUILD_PATH = os.path.join(ROOT, "build", "latest") | ||
|
|
||
| def run_tidy(sha="HEAD", is_rev_range=False): | ||
| diff_cmdline = ["git", "diff" if is_rev_range else "show", sha] | ||
|
|
||
| # Figure out which paths changed in the given diff. | ||
| changed_paths = subprocess.check_output(diff_cmdline + ["--name-only", "--pretty=format:"]).splitlines() | ||
| changed_paths = [p for p in changed_paths if p] | ||
|
|
||
| # Produce a separate diff for each file and run clang-tidy-diff on it | ||
| # in parallel. | ||
| # | ||
| # Note: this will incorporate any configuration from .clang-tidy. | ||
| def tidy_on_path(path): | ||
| patch_file = tempfile.NamedTemporaryFile() | ||
| cmd = diff_cmdline + [ | ||
| "--src-prefix=%s/" % ROOT, | ||
| "--dst-prefix=%s/" % ROOT, | ||
| "--", | ||
| path] | ||
| subprocess.check_call(cmd, stdout=patch_file, cwd=ROOT) | ||
| # TODO(yingchun): some checks could be disabled before we fix them. | ||
| # "-checks=-llvm-include-order,-modernize-concat-nested-namespaces,-cppcoreguidelines-pro-type-union-access,-cppcoreguidelines-macro-usage,-cppcoreguidelines-special-member-functions,-hicpp-special-member-functions,-modernize-use-trailing-return-type,-bugprone-easily-swappable-parameters,-google-readability-avoid-underscore-in-googletest-name,-cppcoreguidelines-avoid-c-arrays,-hicpp-avoid-c-arrays,-modernize-avoid-c-arrays,-llvm-header-guard,-cppcoreguidelines-pro-bounds-pointer-arithmetic", | ||
| cmdline = ["clang-tidy-diff", | ||
| "-clang-tidy-binary", | ||
| "clang-tidy", | ||
| "-p0", | ||
| "-path", BUILD_PATH, | ||
| "-extra-arg=-language=c++", | ||
| "-extra-arg=-std=c++17", | ||
| "-extra-arg=-Ithirdparty/output/include"] | ||
| return subprocess.check_output( | ||
| cmdline, | ||
| stdin=open(patch_file.name), | ||
| cwd=ROOT).decode() | ||
| pool = ThreadPool(multiprocessing.cpu_count()) | ||
| try: | ||
| return "".join(pool.imap(tidy_on_path, changed_paths)) | ||
| except KeyboardInterrupt as ki: | ||
| sys.exit(1) | ||
| finally: | ||
| pool.terminate() | ||
| pool.join() | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| # Basic setup and argument parsing. | ||
| parser = argparse.ArgumentParser(description="Run clang-tidy on a patch") | ||
| parser.add_argument("--rev-range", action="store_true", | ||
| default=False, | ||
| help="Whether the revision specifies the 'rev..' range") | ||
| parser.add_argument('rev', help="The git revision (or range of revisions) to process") | ||
| args = parser.parse_args() | ||
|
|
||
| # Run clang-tidy and parse the output. | ||
| clang_output = run_tidy(args.rev, args.rev_range) | ||
| parsed = re.match(r'.+(warning|error): .+', clang_output, re.MULTILINE | re.DOTALL) | ||
| print(clang_output, file=sys.stderr) | ||
| if not parsed: | ||
| print("No warnings", file=sys.stderr) | ||
| sys.exit(0) | ||
| sys.exit(1) | ||
|
|