forked from envoyproxy/envoy
-
Notifications
You must be signed in to change notification settings - Fork 1
/
run_clang_tidy.sh
executable file
·189 lines (158 loc) · 6.52 KB
/
run_clang_tidy.sh
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
#!/usr/bin/env bash
set -eo pipefail
# ENVOY_SRCDIR should point to where Envoy source lives, while SRCDIR could be a downstream build
# (for example envoy-filter-example).
[[ -z "${ENVOY_SRCDIR}" ]] && ENVOY_SRCDIR="${PWD}"
[[ -z "${SRCDIR}" ]] && SRCDIR="${ENVOY_SRCDIR}"
export LLVM_CONFIG=${LLVM_CONFIG:-llvm-config}
LLVM_PREFIX=${LLVM_PREFIX:-$(${LLVM_CONFIG} --prefix)}
CLANG_TIDY=${CLANG_TIDY:-$(${LLVM_CONFIG} --bindir)/clang-tidy}
CLANG_APPLY_REPLACEMENTS=${CLANG_APPLY_REPLACEMENTS:-$(${LLVM_CONFIG} --bindir)/clang-apply-replacements}
FIX_YAML="${FIX_YAML:-clang-tidy-fixes.yaml}"
CLANG_TIDY_APPLY_FIXES="${CLANG_TIDY_APPLY_FIXES:-}"
CLANG_TIDY_FIX_DIFF="${CLANG_TIDY_FIX_DIFF:-}"
DIFF_TARGET_REMOTE="${DIFF_TARGET_REMOTE:-origin}"
DIFF_TARGET_BRANCH="${DIFF_TARGET_BRANCH:-${CI_TARGET_BRANCH:-origin/main}}"
# Exclude merges for finding merge base if required
DIFF_HEAD="$(git rev-list --no-merges HEAD -n1)"
MERGE_HEAD="$(git rev-list HEAD -n1)"
# Quick syntax check of .clang-tidy.
${CLANG_TIDY} -dump-config > /dev/null 2> clang-tidy-config-errors.txt
if [[ -s clang-tidy-config-errors.txt ]]; then
cat clang-tidy-config-errors.txt
rm clang-tidy-config-errors.txt
exit 1
fi
rm clang-tidy-config-errors.txt
echo "Generating compilation database..."
# bazel build need to be run to setup virtual includes, generating files which are consumed
# by clang-tidy
read -ra COMP_DB_TARGETS <<< "$COMP_DB_TARGETS"
"${ENVOY_SRCDIR}/tools/gen_compilation_database.py" --include_headers "${COMP_DB_TARGETS[@]}"
# Do not run clang-tidy against win32 impl
# TODO(scw00): We should run clang-tidy against win32 impl once we have clang-cl support for Windows
function exclude_win32_impl() {
grep -v source/common/filesystem/win32/ | grep -v source/common/common/win32 | grep -v source/exe/win32 | grep -v source/common/api/win32 | grep -v source/common/event/win32
}
# Do not run clang-tidy against macOS impl
# TODO: We should run clang-tidy against macOS impl for completeness
function exclude_macos_impl() {
grep -v source/common/filesystem/kqueue/ | grep -v source/extensions/network/dns_resolver/apple/apple_dns_impl | grep -v test/extensions/network/dns_resolver/apple/apple_dns_impl_test
}
# Do not run incremental clang-tidy on check_format testdata files.
function exclude_check_format_testdata() {
grep -v tools/testdata/check_format/
}
# Exclude files in third_party which are temporary forks from other OSS projects.
function exclude_third_party() {
grep -v third_party/ | grep -v bazel/external/http_parser
}
# Exclude files which are part of the Wasm emscripten environment
function exclude_wasm_emscripten() {
grep -v source/extensions/common/wasm/ext
}
# Exclude files which are part of the Wasm SDK
function exclude_wasm_sdk() {
grep -v proxy_wasm_cpp_sdk
}
# Exclude files which are part of the Wasm Host environment
function exclude_wasm_host() {
grep -v proxy_wasm_cpp_host
}
# Exclude proxy-wasm test_data.
function exclude_wasm_test_data() {
grep -v wasm/test_data
}
# Exclude files which are part of the Wasm examples
function exclude_wasm_examples() {
grep -v examples/wasm
}
# Exclude envoy mobile.
function exclude_envoy_mobile() {
grep -v mobile/
}
function filter_excludes() {
exclude_envoy_mobile | exclude_check_format_testdata | exclude_win32_impl | exclude_macos_impl | exclude_third_party | exclude_wasm_emscripten | exclude_wasm_sdk | exclude_wasm_host | exclude_wasm_test_data | exclude_wasm_examples
}
function run_clang_tidy() {
python3 "${LLVM_PREFIX}/share/clang/run-clang-tidy.py" \
-clang-tidy-binary="${CLANG_TIDY}" \
-clang-apply-replacements-binary="${CLANG_APPLY_REPLACEMENTS}" \
-export-fixes="${FIX_YAML}" -j "${NUM_CPUS:-0}" -p "${SRCDIR}" -quiet \
${APPLY_CLANG_TIDY_FIXES:+-fix} "$@"
}
function run_clang_tidy_diff() {
local diff
diff="$(git diff "${1}" | filter_excludes)"
if [[ -z "$diff" ]]; then
echo "No changes detected, skipping clang_tidy_diff"
return 0
fi
echo "$diff" | \
python3 "${LLVM_PREFIX}/share/clang/clang-tidy-diff.py" \
-clang-tidy-binary="${CLANG_TIDY}" \
-export-fixes="${FIX_YAML}" -j "${NUM_CPUS:-0}" -p 1 -quiet
}
if [[ $# -gt 0 ]]; then
echo "Running clang-tidy on: $*"
run_clang_tidy "$@"
elif [[ "${RUN_FULL_CLANG_TIDY}" == 1 ]]; then
echo "Running a full clang-tidy"
run_clang_tidy
else
if [[ -z "${DIFF_REF}" ]]; then
# Postsubmit
if [[ "${BUILD_REASON}" == *CI ]]; then
DIFF_REF="HEAD^"
# Presubmit/PR
elif [[ -n "${BUILD_REASON}" ]]; then
# Common ancestor commit - we only want the changes between the merged commit
# and the common ancestor - ie the changes in this PR
DIFF_REF="$(git merge-base "${MERGE_HEAD}" "${DIFF_TARGET_BRANCH}")"
else
# TODO(phlax): this is the path used for local CI. Make this work
# similar to above, allow the `remote` to be configurable, and
# document the workflow for devs
DIFF_REF=$("${ENVOY_SRCDIR}"/tools/git/last_github_commit.sh)
fi
fi
if [[ "${DIFF_REF}" == "${DIFF_HEAD}" ]]; then
# TODO(phlax): either skip this altogether in scheduled runs or run full clang tidy
echo "Nothing changed"
exit 0
fi
echo "Running clang-tidy-diff against ${DIFF_REF} ($(git rev-parse "${DIFF_REF}")), current HEAD ($(git rev-parse "${DIFF_HEAD}"))"
run_clang_tidy_diff "${DIFF_REF}"
fi
if [[ -s "${FIX_YAML}" ]]; then
echo >&2
echo "clang-tidy check failed, potentially fixed by clang-apply-replacements:" >&2
echo >&2
# Replace the CI path with `.` so it should work locally for devs
sed -i s#BuildDirectory:.*#BuildDirectory:\ .# "${FIX_YAML}"
cat "${FIX_YAML}" >&2
if [[ -n "${CLANG_TIDY_APPLY_FIXES}" ]]; then
if [[ ! -e "$CLANG_APPLY_REPLACEMENTS" ]]; then
echo "clang-apply-replacements MISSING: ${CLANG_APPLY_REPLACEMENTS}" >&2
else
# Copy the yaml file into repo directory if its in a different location.
if [[ "$(dirname "${FIX_YAML}")" != "$PWD" ]]; then
FIX_YAML_NAME="$(basename "${FIX_YAML}")"
if [[ -e "$FIX_YAML_NAME" ]]; then
# remove existing file
rm "$FIX_YAML_NAME"
fi
cp "${FIX_YAML}" .
fi
${CLANG_APPLY_REPLACEMENTS} .
echo >&2
echo "Changes applied:" >&2
echo >&2
git --no-pager diff >&2
if [[ -n "${CLANG_TIDY_FIX_DIFF}" ]]; then
git diff > "${CLANG_TIDY_FIX_DIFF}"
fi
fi
fi
exit 1
fi