blob: 304beff51d063fcf2537aaa0ce159b6fd724dd0b (
plain)
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
|
#!/bin/bash
# Copyright (c) 2020 Cisco and/or its affiliates.
# 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.
set -eEo pipefail
CLANG_FORMAT_VER_REGEX='([0-9]+)\.[0-9]+\.[0-9]+'
CLANG_FORMAT_DIFF="/usr/share/clang/clang-format-diff.py"
# TODO: Remove clang-format-${CLANG_FORMAT_VER} from 'make install-deps' when
# CLANG_FORMAT_VER default value is upgraded to 15 after Ubuntu-20.04 is deprecated
CLANG_FORMAT_VER=${CLANG_FORMAT_VER:-11}
GIT_DIFF_ARGS="-U0 --no-color --relative HEAD~1"
GIT_DIFF_EXCLUDE_LIST=(
':!*.patch'
':(exclude)*src/vppinfra/dlmalloc.*'
)
CLANG_FORMAT_DIFF_ARGS="-style file -p1"
SUFFIX="-${CLANG_FORMAT_VER}"
# Attempt to find clang-format to confirm Clang version.
if command -v "clang-format${SUFFIX}" &> /dev/null;
then
CLANG_FORMAT="clang-format${SUFFIX}"
else
echo "*******************************************************************"
echo "* CHECKSTYLE FAILED"
echo "* Could not locate the clang-format${SUFFIX} script"
echo "* Run 'make install-deps' to install it"
echo "*******************************************************************"
exit 1
fi
CLANG_FORMAT_VERSION=$(${CLANG_FORMAT} --version)
echo "$CLANG_FORMAT_VERSION"
# Confirm that Clang is the expected version.
if [[ ! $CLANG_FORMAT_VERSION =~ $CLANG_FORMAT_VER_REGEX ]];
then
echo "*******************************************************************"
echo "* CHECKSTYLE VERSION REGEX CHECK FAILED"
echo "* $CLANG_FORMAT_VERSION"
echo "*******************************************************************"
exit 1
fi
if [[ ! $CLANG_FORMAT_VER == "${BASH_REMATCH[1]}" ]];
then
echo "*******************************************************************"
echo "* CHECKSTYLE VERSION CHECK FAILED"
echo "* Expected major version $CLANG_FORMAT_VER, found ${BASH_REMATCH[1]}"
echo "*******************************************************************"
exit 1
fi
# Attempt to find clang-format-diff.
if command -v clang-format-diff${SUFFIX} &> /dev/null;
then
CLANG_FORMAT_DIFF=clang-format-diff${SUFFIX}
elif command -v clang-format-diff.py &> /dev/null;
then
CLANG_FORMAT_DIFF=clang-format-diff.py
elif command -v clang-format-diff &> /dev/null;
then
CLANG_FORMAT_DIFF=clang-format-diff
elif [ ! -f $CLANG_FORMAT_DIFF ] ;
then
echo "*******************************************************************"
echo "* CHECKSTYLE FAILED"
echo "* Could not locate the clang-format-diff script"
echo "* Run 'make install-deps' to install it"
echo "*******************************************************************"
exit 1
fi
in=$(mktemp)
git diff ${GIT_DIFF_ARGS} ${GIT_DIFF_EXCLUDE_LIST[@]} > ${in}
line_count=$(sed -n '/^+.*\*INDENT-O[NF][F]\{0,1\}\*/p' ${in} | wc -l)
if [ ${line_count} -gt 0 ] ; then
echo
sed -n '/^+++ /{h}; /^+.*\*INDENT-O[NF][F]\{0,1\}\*/{x;p;x;p;}' ${in}
echo
echo "*******************************************************************"
echo "* CHECKSTYLE FAILED"
echo "* Please remove INDENT-ON and INDENT-OFF from modified lines."
echo "*******************************************************************"
rm ${in}
exit 1
fi
if [ "${1}" == "--fix" ]; then
cat ${in} | ${CLANG_FORMAT_DIFF} ${CLANG_FORMAT_DIFF_ARGS} -i
filelist=$(sed -n 's/^+++ b\/\(.*\.[ch]\)/\1/p' ${in})
git status ${filelist}
rm ${in}
exit 0
fi
line_count=$(sed -n '/^+.*\s\+$/p' ${in} | wc -l)
if [ ${line_count} -gt 0 ] ; then
echo
sed -n '/^+++/h; /^+.*\s\+$/{x;p;x;p;}' ${in}
echo
echo "*******************************************************************"
echo "* CHECKSTYLE FAILED"
echo "* Trailing whitespace detected"
echo "*******************************************************************"
rm ${in}
exit 1
fi
out=$(mktemp)
cat ${in} | ${CLANG_FORMAT_DIFF} ${CLANG_FORMAT_DIFF_ARGS} > ${out}
rm ${in}
line_count=$(cat ${out} | wc -l)
if [ -t 1 ] && [ -n $(tput colors) ] && [ $(tput colors) -ge 1 ] && \
command -v highlight &> /dev/null ; then
highlight --syntax diff -O ansi ${out}
else
cat ${out}
fi
rm ${out}
if [ ${line_count} -gt 0 ] ; then
echo "*******************************************************************"
echo "* CHECKSTYLE FAILED"
echo "* CONSULT DIFF ABOVE"
echo "* NOTE: Running 'extras/scripts/checkstyle.sh --fix' *MAY* fix the issue"
echo "*******************************************************************"
exit 1
else
echo "*******************************************************************"
echo "* CHECKSTYLE SUCCESSFULLY COMPLETED"
echo "*******************************************************************"
exit 0
fi
|
