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
|
#!/bin/bash
# Copyright (c) 2022 by Apex.AI Inc. All rights reserved.
#
# Licensed 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.
#
# SPDX-License-Identifier: Apache-2.0
# This script checks code files with clang-tidy
# Example usage: ./tools/scripts/clang_tidy_check.sh full|hook|ci_pull_request
set -e
MODE=${1:-full} # Can be either `full` for all files or `hook` for formatting with git hooks
FILE_FILTER="\.(h|hpp|inl|c|cpp)$"
FILE_BLACKLIST='(test|testing|tools|iceoryx_dds|iceoryx_binding_c|doc|iceoryx_integrationtest|iceoryx_meta|iceoryx_examples|platform)'
fail() {
printf "\033[1;31merror: %s: %s\033[0m\n" ${FUNCNAME[1]} "${1:-"Unknown error"}"
exit 1
}
CLANG_TIDY_VERSION=12
CLANG_TIDY_CMD="clang-tidy-$CLANG_TIDY_VERSION"
if ! command -v $CLANG_TIDY_CMD &> /dev/null
then
CLANG_TIDY_MAJOR_VERSION=$(clang-tidy --version | sed -rn 's/.*([0-9][0-9])\.[0-9].*/\1/p')
if [[ $CLANG_TIDY_MAJOR_VERSION -lt "$CLANG_TIDY_VERSION" ]]; then
echo "Warning: clang-tidy version $CLANG_TIDY_VERSION or higher is not installed."
echo "Code will not be linted."
exit 0
else
CLANG_TIDY_CMD="clang-tidy"
fi
fi
WORKSPACE=$(git rev-parse --show-toplevel)
cd "${WORKSPACE}"
if ! [[ -f build/compile_commands.json ]]; then
export CXX=clang++
export CC=clang
cmake -Bbuild -Hiceoryx_meta -DBUILD_TEST=ON -DBUILD_EXAMPLES=ON
fi
if [[ "$MODE" == "hook"* ]]; then
FILES=$(git diff --cached --name-only --diff-filter=CMRT | grep -E "$FILE_FILTER" | grep -Ev "$FILE_BLACKLIST" | cat)
# List only added files
ADDED_FILES=$(git diff --cached --name-only --diff-filter=A | grep -E "$FILE_FILTER" | grep -Ev "$FILE_BLACKLIST" | cat)
echo "Checking files with Clang-Tidy"
echo " "
if [ -z "$FILES" ]; then
echo "No modified files to check, skipping clang-tidy"
else
$CLANG_TIDY_CMD -p build $FILES
fi
if [ -z "$ADDED_FILES" ]; then
echo "No added files to check, skipping clang-tidy"
else
$CLANG_TIDY_CMD --warnings-as-errors=* -p build $ADDED_FILES
fi
exit
elif [[ "$MODE" == "full"* ]]; then
FILES=$(git ls-files | grep -E "$FILE_FILTER" | grep -Ev "$FILE_BLACKLIST")
echo "Checking all files with Clang-Tidy"
echo " "
echo $FILES
run-$CLANG_TIDY_CMD -p build $FILES
exit $?
elif [[ "$MODE" == "ci_pull_request"* ]]; then
FILES=$(echo $2 | grep -E "$FILE_FILTER" | grep -Ev "$FILE_BLACKLIST" | cat)
echo " "
echo $FILES
if [ -z "$FILES" ]; then
echo "No modified files to check, skipping clang-tidy"
else
$CLANG_TIDY_CMD -p build $FILES
fi
fi
|
