Skip to content

Commit 727e995

Browse files
masterjedykamilsa
masterjedy
authored and
kamilsa
committed
add clang-tidy check (#10)
Signed-off-by: Yura Zarudniy <[email protected]>
1 parent 46c5686 commit 727e995

12 files changed

+402
-22
lines changed

‎.clang-tidy-ignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
build/.*
2+
cmake-build-debug/.*
3+
cmake/.*
4+
test/.*
5+
deps/.*
6+
.*\.pb\.h
7+
.*\.pb\.cc

‎.github/pull_request_template.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!-- You will not see HTML commented line in Pull Request body -->
2+
<!-- Optional sections may be omitted. Just remove them or write None -->
3+
4+
<!-- ### Requirements -->
5+
<!-- * Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion. -->
6+
<!-- * All new code must have code coverage above 70% (https://docs.codecov.io/docs/about-code-coverage). -->
7+
<!-- * Branch must be rebased onto base branch (https://soramitsu.atlassian.net/wiki/spaces/IS/pages/11173889/Rebase+and+merge+guide). -->
8+
9+
10+
### Description of the Change
11+
12+
<!-- We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. -->
13+
<!-- Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts. -->
14+
15+
### Benefits
16+
17+
<!-- What benefits will be realized by the code change? -->
18+
19+
### Possible Drawbacks
20+
21+
<!-- What are the possible side-effects or negative impacts of the code change? -->
22+
<!-- If no drawbacks, explicitly mention this (write None) -->
23+
24+
### Usage Examples or Tests *[optional]*
25+
26+
<!-- Point reviewers to the test, code example or documentation which shows usage example of this feature -->
27+
28+
### Alternate Designs *[optional]*
29+
30+
<!-- Explain what other alternates were considered and why the proposed version was selected -->

‎.github/workflows/clang-tidy.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Clang Tidy
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- master
10+
11+
jobs:
12+
build:
13+
runs-on: macOS-10.14
14+
steps:
15+
- uses: actions/checkout@v1
16+
name: checkout
17+
with:
18+
submodules: true
19+
clean: true
20+
fetch-depth: 1
21+
- name: install
22+
run: |
23+
brew install ninja llvm
24+
sudo python3 -m pip install --upgrade pip
25+
sudo python3 -m pip install scikit-build cmake requests gitpython gcovr pyyaml
26+
- name: run checks
27+
run: |
28+
#!/bin/bash
29+
LLVM_DIR=/usr/local/Cellar/llvm
30+
test -d $LLVM_DIR || echo $(echo "llvm is absent, cannot continue" && exit 1)
31+
VER_COUNT=$(ls -1 ${LLVM_DIR} | wc -l)
32+
test ${VER_COUNT} -eq 0 && echo "no llvm version detected" && exit 1
33+
test $VER_COUNT -gt 1 && echo "wrong llvm installation" && exit 1
34+
LLVM_VER=$(ls -1 ${LLVM_DIR})
35+
export LLVM_ROOT=${LLVM_DIR}/${LLVM_VER}
36+
export PATH=${LLVM_ROOT}/bin:${LLVM_ROOT}/share/clang:${PATH}
37+
cmake . -GNinja -Bbuild
38+
housekeeping/clang-tidy.sh build

‎CMakeLists.txt

+26-22
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
cmake_minimum_required(VERSION 3.12)
22

33
find_program(CCACHE_FOUND ccache)
4-
if(CCACHE_FOUND)
4+
if (CCACHE_FOUND)
55
set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)
66
set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ccache)
7-
endif(CCACHE_FOUND)
7+
endif (CCACHE_FOUND)
88

99

1010
set(
@@ -25,35 +25,39 @@ HunterGate(
2525

2626
project(cpp_filecoin)
2727

28-
if(NOT EXISTS "${CMAKE_TOOLCHAIN_FILE}")
28+
if (NOT EXISTS "${CMAKE_TOOLCHAIN_FILE}")
2929
# https://cgold.readthedocs.io/en/latest/tutorials/toolchain/globals/cxx-standard.html#summary
3030
set(CMAKE_CXX_STANDARD 17)
3131
set(CMAKE_CXX_STANDARD_REQUIRED ON)
3232
set(CMAKE_CXX_EXTENSIONS OFF)
3333
set(CMAKE_POSITION_INDEPENDENT_CODE TRUE)
34-
endif()
34+
endif ()
3535

3636
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
3737

3838
include(CheckCXXCompilerFlag)
3939
include(cmake/toolchain-util.cmake)
4040
include(cmake/dependencies.cmake)
4141
include(cmake/functions.cmake)
42+
include(cmake/san.cmake)
43+
44+
# export compile commands for clang-tidy to analyse only changed files
45+
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
4246

4347
print("C flags: ${CMAKE_C_FLAGS}")
4448
print("CXX flags: ${CMAKE_CXX_FLAGS}")
4549
print("Using CMAKE_TOOLCHAIN_FILE=${CMAKE_TOOLCHAIN_FILE}")
4650

47-
option(TESTING "Build tests" ON )
48-
option(CLANG_FORMAT "Enable clang-format target" ON )
49-
option(CLANG_TIDY "Enable clang-tidy checks during compilation" OFF)
50-
option(COVERAGE "Enable generation of coverage info" OFF)
51+
option(TESTING "Build tests" ON)
52+
option(CLANG_FORMAT "Enable clang-format target" ON)
53+
option(CLANG_TIDY "Enable clang-tidy checks during compilation" OFF)
54+
option(COVERAGE "Enable generation of coverage info" OFF)
5155
# sanitizers will be enabled only for Filecoin, and will be disabled for dependencies
52-
option(ASAN "Enable address sanitizer" OFF)
53-
option(LSAN "Enable leak sanitizer" OFF)
54-
option(MSAN "Enable memory sanitizer" OFF)
55-
option(TSAN "Enable thread sanitizer" OFF)
56-
option(UBSAN "Enable UB sanitizer" OFF)
56+
option(ASAN "Enable address sanitizer" OFF)
57+
option(LSAN "Enable leak sanitizer" OFF)
58+
option(MSAN "Enable memory sanitizer" OFF)
59+
option(TSAN "Enable thread sanitizer" OFF)
60+
option(UBSAN "Enable UB sanitizer" OFF)
5761

5862

5963
## setup compilation flags
@@ -86,17 +90,17 @@ if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "^(AppleClang|Clang|GNU)$")
8690
elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC")
8791
# using Visual Studio C++
8892
# TODO(warchant): add flags https://github.com/lefticus/cppbestpractices/blob/master/02-Use_the_Tools_Available.md#msvc
89-
endif()
93+
endif ()
9094

91-
if(COVERAGE)
95+
if (COVERAGE)
9296
include(cmake/coverage.cmake)
93-
endif()
94-
if(CLANG_TIDY)
97+
endif ()
98+
if (CLANG_TIDY)
9599
include(cmake/clang-tidy.cmake)
96-
endif()
97-
if(CLANG_FORMAT)
100+
endif ()
101+
if (CLANG_FORMAT)
98102
include(cmake/clang-format.cmake)
99-
endif()
103+
endif ()
100104

101105
add_subdirectory(deps)
102106

@@ -114,7 +118,7 @@ include_directories(
114118
add_subdirectory(core)
115119

116120

117-
if(TESTING)
121+
if (TESTING)
118122
enable_testing()
119123
add_subdirectory(test)
120-
endif()
124+
endif ()

‎cmake/toolchain/compiler/clang-8.cmake

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
if(DEFINED POLLY_COMPILER_CLANG_CMAKE)
2+
return()
3+
else()
4+
set(POLLY_COMPILER_CLANG_CMAKE 1)
5+
endif()
6+
7+
include(${CMAKE_CURRENT_LIST_DIR}/../../print.cmake)
8+
9+
if(XCODE_VERSION)
10+
set(_err "This toolchain is not available for Xcode")
11+
set(_err "${_err} because Xcode ignores CMAKE_C(XX)_COMPILER variable.")
12+
set(_err "${_err} Use xcode.cmake toolchain instead.")
13+
fatal_error(${_err})
14+
endif()
15+
16+
find_program(CMAKE_C_COMPILER clang-8)
17+
find_program(CMAKE_CXX_COMPILER clang++-8)
18+
19+
if(NOT CMAKE_C_COMPILER)
20+
fatal_error("clang-8 not found")
21+
endif()
22+
23+
if(NOT CMAKE_CXX_COMPILER)
24+
fatal_error("clang++-8 not found")
25+
endif()
26+
27+
set(
28+
CMAKE_C_COMPILER
29+
"${CMAKE_C_COMPILER}"
30+
CACHE
31+
STRING
32+
"C compiler"
33+
FORCE
34+
)
35+
36+
set(
37+
CMAKE_CXX_COMPILER
38+
"${CMAKE_CXX_COMPILER}"
39+
CACHE
40+
STRING
41+
"C++ compiler"
42+
FORCE
43+
)

‎cmake/toolchain/compiler/clang-9.cmake

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
if(DEFINED POLLY_COMPILER_CLANG_9_CMAKE)
2+
return()
3+
else()
4+
set(POLLY_COMPILER_CLANG_9_CMAKE 1)
5+
endif()
6+
7+
include(${CMAKE_CURRENT_LIST_DIR}/../../print.cmake)
8+
9+
if(XCODE_VERSION)
10+
set(_err "This toolchain is not available for Xcode")
11+
set(_err "${_err} because Xcode ignores CMAKE_C(XX)_COMPILER variable.")
12+
set(_err "${_err} Use xcode.cmake toolchain instead.")
13+
fatal_error(${_err})
14+
endif()
15+
16+
find_program(CMAKE_C_COMPILER clang-9)
17+
find_program(CMAKE_CXX_COMPILER clang++-9)
18+
19+
if(NOT CMAKE_C_COMPILER)
20+
fatal_error("clang-9 not found")
21+
endif()
22+
23+
if(NOT CMAKE_CXX_COMPILER)
24+
fatal_error("clang++-9 not found")
25+
endif()
26+
27+
set(
28+
CMAKE_C_COMPILER
29+
"${CMAKE_C_COMPILER}"
30+
CACHE
31+
STRING
32+
"C compiler"
33+
FORCE
34+
)
35+
36+
set(
37+
CMAKE_CXX_COMPILER
38+
"${CMAKE_CXX_COMPILER}"
39+
CACHE
40+
STRING
41+
"C++ compiler"
42+
FORCE
43+
)

‎cmake/toolchain/compiler/gcc-8.cmake

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
if(DEFINED POLLY_COMPILER_GCC_8_CMAKE_)
2+
return()
3+
else()
4+
set(POLLY_COMPILER_GCC_8_CMAKE_ 1)
5+
endif()
6+
7+
find_program(CMAKE_C_COMPILER gcc-8)
8+
find_program(CMAKE_CXX_COMPILER g++-8)
9+
10+
if(NOT CMAKE_C_COMPILER)
11+
fatal_error("gcc-8 not found")
12+
endif()
13+
14+
if(NOT CMAKE_CXX_COMPILER)
15+
fatal_error("g++-8 not found")
16+
endif()
17+
18+
set(
19+
CMAKE_C_COMPILER
20+
"${CMAKE_C_COMPILER}"
21+
CACHE
22+
STRING
23+
"C compiler"
24+
FORCE
25+
)
26+
27+
set(
28+
CMAKE_CXX_COMPILER
29+
"${CMAKE_CXX_COMPILER}"
30+
CACHE
31+
STRING
32+
"C++ compiler"
33+
FORCE
34+
)

‎cmake/toolchain/compiler/gcc-9.cmake

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
if(DEFINED POLLY_COMPILER_GCC_9_CMAKE_)
2+
return()
3+
else()
4+
set(POLLY_COMPILER_GCC_9_CMAKE_ 1)
5+
endif()
6+
7+
find_program(CMAKE_C_COMPILER gcc-9)
8+
find_program(CMAKE_CXX_COMPILER g++-9)
9+
10+
if(NOT CMAKE_C_COMPILER)
11+
fatal_error("gcc-9 not found")
12+
endif()
13+
14+
if(NOT CMAKE_CXX_COMPILER)
15+
fatal_error("g++-9 not found")
16+
endif()
17+
18+
set(
19+
CMAKE_C_COMPILER
20+
"${CMAKE_C_COMPILER}"
21+
CACHE
22+
STRING
23+
"C compiler"
24+
FORCE
25+
)
26+
27+
set(
28+
CMAKE_CXX_COMPILER
29+
"${CMAKE_CXX_COMPILER}"
30+
CACHE
31+
STRING
32+
"C++ compiler"
33+
FORCE
34+
)

‎housekeeping/clang-tidy.sh

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
#!/bin/bash -xe
2+
3+
## on master branch: analyzes all cpp files
4+
## on other branches: analyzes cpp files changed in this branch, in comparison to master
5+
6+
function get_abs_path(){
7+
echo $(echo "$(cd "$(dirname "$1")"; pwd -P)/$(basename "$1")")
8+
}
9+
10+
function get_files(){
11+
local head=$(git rev-parse --abbrev-ref HEAD)
12+
if [[ "${head}" = "master" ]]; then
13+
echo $(find . -type f | grep "cpp")
14+
else
15+
echo $(git diff --name-only HEAD..origin/master | grep "cpp" | grep -v "test")
16+
fi
17+
}
18+
19+
BUILD_DIR=$(get_abs_path $1)
20+
cd $(dirname $0)/..
21+
22+
# list of cpp files changed in this branch (in comparison to master); tests are ignored
23+
FILES=$(get_files)
24+
25+
CLANG_TIDY=$(which clang-tidy)
26+
RUN_CLANG_TIDY=$(which run-clang-tidy.py)
27+
28+
# filter compile_commands.json
29+
echo ${FILES} | python3 ./housekeeping/filter_compile_commands.py -p ${BUILD_DIR}
30+
31+
# exec run-clang-tidy.py
32+
python3 ${RUN_CLANG_TIDY} -clang-tidy-binary=${CLANG_TIDY} -p ${BUILD_DIR} -header-filter "core/.*\.hpp"

‎housekeeping/codecov.sh

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#!/bin/bash -xe
2+
3+
buildDir=$1
4+
token=$2
5+
6+
which git
7+
8+
9+
if [ -z "$buildDir" ]; then
10+
echo "buildDir is empty"
11+
exit 1
12+
fi
13+
14+
if [ -z "$token" ]; then
15+
echo "token arg is empty"
16+
exit 2
17+
fi
18+
19+
bash <(curl -s https://codecov.io/bash) -s $buildDir -t $token

0 commit comments

Comments
 (0)