使用shell脚本进行clang-tidy静态代码分析

0. 引言

clang-tidy 是基于 Clang 的工具，提供了丰富的代码检查功能，可以根据用户配置文件进行定制化的检查和规则定义。
之前的文章《使用 Clang-Tidy 进行静态代码分析：完整的配置与 CMake 集成实例》已经对clang-tidy的安装和配置做了基本介绍，并指明了如何与CMake集成。
本文将介绍如何使用 shell脚本进行clang-tidy静态代码分析。

1. 完整检测脚本代码 clang-tidy-check.sh

#!/bin/bash
set -e# Default build directory
DEFAULT_BUILD_DIR="build"# Check if source dir path and optionally a build dir path are provided as arguments
if [ "$#" -lt 1 ] || [ "$#" -gt 2 ]; thenecho "Usage: $0 <source_dir_path> [build_dir_path]"echo "Error: Exactly one or two arguments expected."exit 1
fi# Save the user-inputted source dir path to a variable
SOURCE_DIR="$1"# If a second argument (build directory) is provided, use it; otherwise, use the default
if [ "$#" -eq 2 ]; thenBUILD_DIR="$2"echo "$2"
elseBUILD_DIR="$DEFAULT_BUILD_DIR"echo "No build directory specified, using default: '${BUILD_DIR}'"
fi# Check if the source path is an existing directory
if [ ! -d "${SOURCE_DIR}" ]; thenecho "Error: SOURCE_DIR '${SOURCE_DIR}' does not exist."exit 1
elseecho "SOURCE_DIR is '${SOURCE_DIR}'"
fi# Optionally, you can also check if the BUILD_DIR exists or handle its absence according to your needs
if [ ! -d "${BUILD_DIR}" ]; thenecho "Warning: BUILD_DIR '${BUILD_DIR}' does not exist. Depending on your script's logic, this may or may not be a problem."
fi
############## Set the source directory and build directory
ROOT_DIR="$(pwd)"
CLANG_TIDY_CONFIG="${ROOT_DIR}/.clang-tidy"
COMPILE_COMMANDS="${BUILD_DIR}/compile_commands.json"# Check if compile_commands.json exists
if [ ! -f "${COMPILE_COMMANDS}" ]; thenecho "Error: compile_commands.json not found in ${BUILD_DIR}."exit 1
fi# Find all .cc files in the source directory recursively
ALL_STATIC_CHECK_FILES=$(find "${SOURCE_DIR}" -type f -name '*.cpp')filter_clang_tidy_output() {awk '/^clang-diagnostic-unused-command-line-argument/ {next}/^[0-9]+ warnings generated/ {next}/^Suppressed [0-9]+ warnings/ {next}/^Use -header-filter=.*$/ {next}/^Use -system-headers .*$/ {next}/\/usr\// ||/\/opt\// {skipping=1} # Start skipping upon a match with any of the specified patternsskipping == 1 && $0 ~ /\| * *\^/ {skipping=0; next} # Stop skipping when encountering the flexible patternskipping == 0 {print} # Print lines when not skipping'
}# Function to run clang-tidy
run_clang_tidy() {echo "Running clang-tidy..."for file in $ALL_STATIC_CHECK_FILES; doclang-tidy-18 "${file}" -p "${BUILD_DIR}" --warnings-as-errors=* \-config-file="${CLANG_TIDY_CONFIG}" -extra-arg=-std=c++14 \2>&1| filter_clang_tidy_output \|| touch "${BUILD_DIR}/clang_tidy_failed"done
}# Run clang-tidy
run_clang_tidy# Check the results
if [ -f "${BUILD_DIR}/clang_tidy_failed" ]; thenecho "Clang-tidy detected issues."exit 1
elseecho "No Clang-tidy issues found."
fi

1.1 流程图

1.2 脚本功能概述

这段脚本的主要功能包括：

1. 检查输入参数的合法性，确保源代码目录路径正确，并根据需要指定构建目录。
2. 检查是否存在编译命令文件 compile_commands.json，该文件是 clang-tidy 进行分析所必需的。
3. 使用 find 命令递归查找源代码目录中的所有 .cpp 文件。
4. 运行 clang-tidy 对每个找到的 .cpp 文件进行静态代码分析，输出详细的警告和建议。
5. 过滤和处理 clang-tidy 的输出，以排除不必要的警告信息。
6. 根据分析结果判断是否有代码问题，并相应地处理结果。

2. 该脚本优缺点

这段脚本的优点在于：

• 自动化分析:有 compile_commands.json 文件即可进行分析，不用依赖CMakeLists.txt。
• 灵活处理: 可以根据分析结果，灵活地处理代码中的问题或警告，确保代码质量和稳定性。

然而，该脚本也存在一些潜在的缺点：

• 依赖性问题: 脚本依赖于正确配置的 clang-tidy 和 compile_commands.json 文件，因为不像CMake每次可以实时更新 compile_commands.json 文件，如果配置不正确可能导致分析失败。
• 效率问题: 因为是依次遍历列表中的文件，对大型代码库进行全面的静态分析可能会消耗较多的时间和计算资源，影响效率。