1#!/bin/bash 2# 3# Copyright (c) 2019, The OpenThread Authors. 4# All rights reserved. 5# 6# Redistribution and use in source and binary forms, with or without 7# modification, are permitted provided that the following conditions are met: 8# 1. Redistributions of source code must retain the above copyright 9# notice, this list of conditions and the following disclaimer. 10# 2. Redistributions in binary form must reproduce the above copyright 11# notice, this list of conditions and the following disclaimer in the 12# documentation and/or other materials provided with the distribution. 13# 3. Neither the name of the copyright holder nor the 14# names of its contributors may be used to endorse or promote products 15# derived from this software without specific prior written permission. 16# 17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 18# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 21# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 22# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 25# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 26# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 27# POSSIBILITY OF SUCH DAMAGE. 28# 29 30# 31# The script to check or format source code of OpenThread. 32# 33# Format c/c++, markdown, python, and shell: 34# 35# script/make-pretty 36# 37# Format c/c++ only: 38# 39# script/make-pretty clang 40# script/make-pretty clang-format 41# script/make-pretty clang-tidy 42# 43# Format markdown only: 44# 45# script/make-pretty markdown 46# 47# Format python only: 48# 49# script/make-pretty python 50# 51# Format shell only: 52# 53# script/make-pretty shell 54# 55# Check only: 56# 57# script/make-pretty check clang 58# script/make-pretty check clang-format 59# script/make-pretty check clang-tidy 60# script/make-pretty check markdown 61# script/make-pretty check python 62# script/make-pretty check shell 63# 64 65set -euo pipefail 66 67OT_BUILD_JOBS=$(getconf _NPROCESSORS_ONLN) 68readonly OT_BUILD_JOBS 69 70OT_EXCLUDE_DIRS=(third_party doc/site) 71readonly OT_EXCLUDE_DIRS 72 73OT_CLANG_SOURCES=('*.c' '*.cc' '*.cpp' '*.h' '*.hpp') 74readonly OT_CLANG_SOURCES 75 76OT_MARKDOWN_SOURCES=('*.md') 77readonly OT_MARKDOWN_SOURCES 78 79OT_PYTHON_SOURCES=('*.py') 80readonly OT_PYTHON_SOURCES 81 82OT_CLANG_TIDY_FIX_DIRS=('examples' 'include' 'src' 'tests') 83readonly OT_CLANG_TIDY_FIX_DIRS 84 85OT_CLANG_TIDY_BUILD_OPTS=( 86 '-DCMAKE_EXPORT_COMPILE_COMMANDS=ON' 87 '-DOT_ANYCAST_LOCATOR=ON' 88 '-DOT_APP_RCP=OFF' 89 '-DOT_MTD=OFF' 90 '-DOT_RCP=OFF' 91 '-DOT_PLATFORM=simulation' 92 '-DOT_BACKBONE_ROUTER=ON' 93 '-DOT_BORDER_AGENT=ON' 94 '-DOT_BORDER_ROUTER=ON' 95 '-DOT_BORDER_ROUTING=ON' 96 '-DOT_BORDER_ROUTING_DHCP6_PD=ON' 97 '-DOT_CHANNEL_MANAGER=ON' 98 '-DOT_CHANNEL_MANAGER_CSL=ON' 99 '-DOT_CHANNEL_MONITOR=ON' 100 '-DOT_COAP=ON' 101 '-DOT_COAP_BLOCK=ON' 102 '-DOT_COAP_OBSERVE=ON' 103 '-DOT_COAPS=ON' 104 '-DOT_COMMISSIONER=ON' 105 '-DOT_CSL_RECEIVER=ON' 106 '-DOT_DATASET_UPDATER=ON' 107 '-DOT_DHCP6_CLIENT=ON' 108 '-DOT_DHCP6_SERVER=ON' 109 '-DOT_DIAGNOSTIC=ON' 110 '-DOT_DNS_CLIENT=ON' 111 '-DOT_DNS_DSO=ON' 112 '-DOT_DNS_UPSTREAM_QUERY=ON' 113 '-DOT_DNSSD_SERVER=ON' 114 '-DOT_DUA=ON' 115 '-DOT_MLR=ON' 116 '-DOT_ECDSA=ON' 117 '-DOT_HISTORY_TRACKER=ON' 118 '-DOT_IP6_FRAGM=ON' 119 '-DOT_JAM_DETECTION=ON' 120 '-DOT_JOINER=ON' 121 '-DOT_LINK_RAW=ON' 122 '-DOT_LINK_METRICS_INITIATOR=ON' 123 '-DOT_LINK_METRICS_SUBJECT=ON' 124 '-DOT_MAC_FILTER=ON' 125 '-DOT_MESH_DIAG=ON' 126 '-DOT_NAT64_BORDER_ROUTING=ON' 127 '-DOT_NAT64_TRANSLATOR=ON' 128 '-DOT_NETDATA_PUBLISHER=ON' 129 '-DOT_NETDIAG_CLIENT=ON' 130 '-DOT_PING_SENDER=ON' 131 '-DOT_REFERENCE_DEVICE=ON' 132 '-DOT_SERVICE=ON' 133 '-DOT_SLAAC=ON' 134 '-DOT_SNTP_CLIENT=ON' 135 '-DOT_SRP_ADV_PROXY=ON' 136 '-DOT_SRP_CLIENT=ON' 137 '-DOT_SRP_SERVER=ON' 138 '-DOT_THREAD_VERSION=1.3' 139 '-DOT_TREL=ON' 140 '-DOT_COVERAGE=ON' 141 '-DOT_LOG_LEVEL_DYNAMIC=ON' 142 '-DOT_COMPILE_WARNING_AS_ERROR=ON' 143 '-DOT_UPTIME=ON' 144) 145readonly OT_CLANG_TIDY_BUILD_OPTS 146 147do_clang_format() 148{ 149 echo -e '========================================' 150 echo -e ' format c/c++ (clang-format)' 151 echo -e '========================================' 152 153 git ls-files "${OT_CLANG_SOURCES[@]}" | grep -v -E "^($(echo "${OT_EXCLUDE_DIRS[@]}" | tr ' ' '|'))" \ 154 | xargs -n3 -P"$OT_BUILD_JOBS" script/clang-format -style=file -i -verbose 155} 156 157do_clang_format_check() 158{ 159 echo -e '========================================' 160 echo -e ' check c/c++ (clang-format)' 161 echo -e '========================================' 162 163 git ls-files "${OT_CLANG_SOURCES[@]}" | grep -v -E "^($(echo "${OT_EXCLUDE_DIRS[@]}" | tr ' ' '|'))" \ 164 | xargs -n3 -P"$OT_BUILD_JOBS" script/clang-format-check 165} 166 167do_clang_tidy_fix() 168{ 169 echo -e '========================================' 170 echo -e ' format c/c++ (clang-tidy)' 171 echo -e '========================================' 172 173 (mkdir -p ./build/cmake-tidy \ 174 && cd ./build/cmake-tidy \ 175 && THREAD_VERSION=1.3 cmake "${OT_CLANG_TIDY_BUILD_OPTS[@]}" ../.. \ 176 && ../../script/clang-tidy -j"$OT_BUILD_JOBS" "${OT_CLANG_TIDY_FIX_DIRS[@]}" -fix) 177} 178 179do_clang_tidy_check() 180{ 181 echo -e '========================================' 182 echo -e ' check c/c++ (clang-tidy)' 183 echo -e '========================================' 184 185 (mkdir -p ./build/cmake-tidy \ 186 && cd ./build/cmake-tidy \ 187 && THREAD_VERSION=1.3 cmake "${OT_CLANG_TIDY_BUILD_OPTS[@]}" ../.. \ 188 && ../../script/clang-tidy -j"$OT_BUILD_JOBS" "${OT_CLANG_TIDY_FIX_DIRS[@]}") 189} 190 191do_markdown_format() 192{ 193 echo -e '========================================' 194 echo -e ' format markdown' 195 echo -e '========================================' 196 197 git ls-files "${OT_MARKDOWN_SOURCES[@]}" | grep -v -E "^($(echo "${OT_EXCLUDE_DIRS[@]}" | tr ' ' '|'))" \ 198 | xargs -n10 -P"$OT_BUILD_JOBS" npx prettier@2.0.4 --write 199} 200 201do_markdown_check() 202{ 203 echo -e '========================================' 204 echo -e ' check markdown' 205 echo -e '========================================' 206 207 git ls-files "${OT_MARKDOWN_SOURCES[@]}" | grep -v -E "^($(echo "${OT_EXCLUDE_DIRS[@]}" | tr ' ' '|'))" \ 208 | xargs -n10 -P"$OT_BUILD_JOBS" npx prettier@2.0.4 --check 209} 210 211do_python_format() 212{ 213 echo -e '========================================' 214 echo -e ' format python' 215 echo -e '========================================' 216 217 git ls-files "${OT_PYTHON_SOURCES[@]}" | grep -v -E "^($(echo "${OT_EXCLUDE_DIRS[@]}" | tr ' ' '|'))" \ 218 | xargs -n10 -P"$OT_BUILD_JOBS" python3 -m yapf --verbose --style '{based_on_style: google, column_limit: 119}' -ipr 219} 220 221do_python_check() 222{ 223 echo -e '========================================' 224 echo -e ' check python' 225 echo -e '========================================' 226 227 git ls-files "${OT_PYTHON_SOURCES[@]}" | grep -v -E "^($(echo "${OT_EXCLUDE_DIRS[@]}" | tr ' ' '|'))" \ 228 | xargs -n10 -P"$OT_BUILD_JOBS" python3 -m yapf --verbose --style '{based_on_style: google, column_limit: 119}' -dpr 229} 230 231do_shell_format() 232{ 233 echo -e '========================================' 234 echo -e ' format shell' 235 echo -e '========================================' 236 237 git ls-files | xargs shfmt -f | grep -v -E "^($(echo "${OT_EXCLUDE_DIRS[@]}" | tr ' ' '|'))" \ 238 | xargs -n10 -P"$OT_BUILD_JOBS" shfmt -i 4 -bn -ci -fn -s -w 239} 240 241do_shell_check() 242{ 243 echo -e '========================================' 244 echo -e ' check shell' 245 echo -e '========================================' 246 247 git ls-files | xargs shfmt -f | grep -v -E "^($(echo "${OT_EXCLUDE_DIRS[@]}" | tr ' ' '|'))" \ 248 | xargs -n10 -P"$OT_BUILD_JOBS" shfmt -i 4 -bn -ci -fn -s -d 249 250 git ls-files | xargs shfmt -f | grep -v -E "^($(echo "${OT_EXCLUDE_DIRS[@]}" | tr ' ' '|'))" \ 251 | xargs -n10 -P"$OT_BUILD_JOBS" shellcheck 252} 253 254do_check() 255{ 256 if [ $# == 0 ]; then 257 do_clang_format_check 258 do_clang_tidy_check 259 do_markdown_check 260 do_python_check 261 do_shell_check 262 elif [ "$1" == 'clang' ]; then 263 do_clang_format_check 264 do_clang_tidy_check 265 elif [ "$1" == 'clang-format' ]; then 266 do_clang_format_check 267 elif [ "$1" == 'clang-tidy' ]; then 268 do_clang_tidy_check 269 elif [ "$1" == 'markdown' ]; then 270 do_markdown_check 271 elif [ "$1" == 'python' ]; then 272 do_python_check 273 elif [ "$1" == 'shell' ]; then 274 do_shell_check 275 else 276 echo >&2 "Unsupported check: $1. Supported: clang, markdown, python, shell" 277 # 128 for Invalid arguments 278 exit 128 279 fi 280} 281 282main() 283{ 284 if [ $# == 0 ]; then 285 do_clang_tidy_fix 286 do_clang_format 287 do_markdown_format 288 do_python_format 289 do_shell_format 290 elif [ "$1" == 'clang' ]; then 291 do_clang_tidy_fix 292 do_clang_format 293 elif [ "$1" == 'clang-format' ]; then 294 do_clang_format 295 elif [ "$1" == 'clang-tidy' ]; then 296 do_clang_tidy_fix 297 elif [ "$1" == 'markdown' ]; then 298 do_markdown_format 299 elif [ "$1" == 'python' ]; then 300 do_python_format 301 elif [ "$1" == 'shell' ]; then 302 do_shell_format 303 elif [ "$1" == 'check' ]; then 304 shift 305 do_check "$@" 306 else 307 echo >&2 "Unsupported action: $1. Supported: clang, markdown, python, shell" 308 # 128 for Invalid arguments 309 exit 128 310 fi 311 312} 313 314main "$@" 315