Skip to content

Commit

Permalink
[CI] Add CMake format check (#5941)
Browse files Browse the repository at this point in the history
  • Loading branch information
PHILO-HE authored Jun 14, 2024
1 parent 142cf0f commit f1bb1d6
Show file tree
Hide file tree
Showing 36 changed files with 1,362 additions and 1,019 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/check_license.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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.

name: license header check
on:
pull_request
concurrency:
group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }}
cancel-in-progress: true

jobs:
license-check:
name: License Header Check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Check License Header
run: |
git fetch --recurse-submodules=no origin main ${{github.event.pull_request.base.sha}}
pip install regex
cd $GITHUB_WORKSPACE/
./.github/workflows/util/check.sh ${{github.event.pull_request.base.sha}}
49 changes: 31 additions & 18 deletions .github/workflows/code_style.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,43 +14,56 @@
# limitations under the License.

name: Code style checks

on:
pull_request

pull_request:
paths:
- '.github/workflows/code_style.yml'
- 'cpp/**'
- 'cpp-ch/**'
concurrency:
group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }}
cancel-in-progress: true

jobs:
formatting-check:
name: Formatting Check
CPP-format-check:
name: CPP Format Check
runs-on: ubuntu-latest
strategy:
matrix:
path:
- check: 'cpp/core'
exclude: ''
- check: 'cpp/velox'
- check: 'cpp'
exclude: ''
steps:
- uses: actions/checkout@v4
- name: Run clang-format style check for C/C++ programs.
- name: Run clang-format style check for C/C++
uses: jidicula/[email protected]
with:
clang-format-version: '15'
check-path: ${{ matrix.path['check'] }}
fallback-style: 'Google' # optional

license-check:
name: License Header Check
CMake-format-check:
name: CMake Format Check
runs-on: ubuntu-latest

container: ubuntu:22.04
steps:
- uses: actions/checkout@v3

- name: Check License Header
- name: Install tools
run: |
apt update -y
apt install git python3-pip -y
pip3 install --user cmake-format
- uses: actions/checkout@v4
- name: Check CMake format
run: |
git fetch --recurse-submodules=no origin main ${{github.event.pull_request.base.sha}}
pip install regex
dev/check.sh ${{github.event.pull_request.base.sha}}
git config --global --add safe.directory $GITHUB_WORKSPACE
cd $GITHUB_WORKSPACE/
fileList=$(find ./cpp ./cpp-ch -name CMakeLists.txt -o -name *.cmake)
for file in $fileList; do
/github/home/.local/bin/cmake-format --first-comment-is-literal True --in-place $file
done
if [ -n "$(git status --porcelain)" ]; then
echo "Please use cmake-format to format cmake files or apply the below patch."
git diff -- '*CMakeLists.txt' '*.cmake'
exit 1
fi
echo "No CMake format issue."
File renamed without changes.
4 changes: 2 additions & 2 deletions dev/check.sh → .github/workflows/util/check.sh
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
# limitations under the License.

export BASE_COMMIT=$1
dev/check.py header branch
./.github/workflows/util/check.py header branch
if [ $? -ne 0 ]; then
dev/check.py header branch --fix
./.github/workflows/util/check.py header branch --fix
echo -e "\n==== Apply using:"
echo "patch -p1 \<<EOF"
git --no-pager diff
Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
*cpp-ch/local-engine/Storages/ch_parquet/arrow/*
*dev/*
*.github/workflows/util/*
File renamed without changes.
File renamed without changes.
File renamed without changes.
160 changes: 81 additions & 79 deletions cpp-ch/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ cmake_minimum_required(VERSION 3.20)

file(READ ${CMAKE_CURRENT_SOURCE_DIR}/clickhouse.version CH_VERSION)

set(CH_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/ClickHouse CACHE STRING "ClickHouse source dir")
set(CH_SOURCE_DIR
${CMAKE_CURRENT_SOURCE_DIR}/ClickHouse
CACHE STRING "ClickHouse source dir")
string(REGEX REPLACE ".*CH_ORG=([^\n]+).*" "\\1" CH_ORG "${CH_VERSION}")
string(REGEX REPLACE ".*CH_BRANCH=([^\n]+).*" "\\1" CH_BRANCH "${CH_VERSION}")
string(REGEX REPLACE ".*CH_COMMIT=([^\n]+).*" "\\1" CH_COMMIT "${CH_VERSION}")
Expand All @@ -27,93 +29,93 @@ message("CH_COMMIT=${CH_COMMIT}")

project(libch LANGUAGES C CXX ASM)
file(GLOB clickhouse_files "${CH_SOURCE_DIR}/*")
if ("${CH_SOURCE_DIR}" STREQUAL "${CMAKE_SOURCE_DIR}/ClickHouse")
if (NOT clickhouse_files)
execute_process(COMMAND git clone -b ${CH_BRANCH} --depth 3 https://github.com/${CH_ORG}/ClickHouse.git ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
execute_process(COMMAND git reset --hard ${CH_COMMIT} WORKING_DIRECTORY ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
execute_process(COMMAND git submodule update --init --force --depth 1 WORKING_DIRECTORY ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
else()
execute_process(COMMAND git fetch origin ${CH_BRANCH} --depth 3 WORKING_DIRECTORY ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
execute_process(COMMAND git checkout ${CH_BRANCH} WORKING_DIRECTORY ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
execute_process(COMMAND git reset --hard ${CH_COMMIT} WORKING_DIRECTORY ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
execute_process(COMMAND git submodule update --init --recursive --force --depth 1 WORKING_DIRECTORY ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
endif()
if("${CH_SOURCE_DIR}" STREQUAL "${CMAKE_SOURCE_DIR}/ClickHouse")
if(NOT clickhouse_files)
execute_process(
COMMAND
git clone -b ${CH_BRANCH} --depth 3
https://github.com/${CH_ORG}/ClickHouse.git ${CH_SOURCE_DIR}
COMMAND_ERROR_IS_FATAL ANY)
execute_process(
COMMAND git reset --hard ${CH_COMMIT}
WORKING_DIRECTORY ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
execute_process(
COMMAND git submodule update --init --force --depth 1
WORKING_DIRECTORY ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
else()
execute_process(
COMMAND git fetch origin ${CH_BRANCH} --depth 3
WORKING_DIRECTORY ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
execute_process(
COMMAND git checkout ${CH_BRANCH}
WORKING_DIRECTORY ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
execute_process(
COMMAND git reset --hard ${CH_COMMIT}
WORKING_DIRECTORY ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
execute_process(
COMMAND git submodule update --init --recursive --force --depth 1
WORKING_DIRECTORY ${CH_SOURCE_DIR} COMMAND_ERROR_IS_FATAL ANY)
endif()
else()
if (NOT clickhouse_files)
# Checking out *all* submodules takes > 5 min. Therefore, the smoke build ("FastTest") in CI initializes only the set of
# submodules minimally needed for a build and we cannot assume here that all submodules are populated.
message(ERROR "clickhouse ${CH_SOURCE_DIR} is missing or empty. to fix try run:")
message(STATUS " git clone --recursive --depth 1 https://github.com/Kyligence/ClickHouse.git ${CMAKE_SOURCE_DIR}")
endif()
if(NOT clickhouse_files)
# Checking out *all* submodules takes > 5 min. Therefore, the smoke build
# ("FastTest") in CI initializes only the set of submodules minimally needed
# for a build and we cannot assume here that all submodules are populated.
message(ERROR
"clickhouse ${CH_SOURCE_DIR} is missing or empty. to fix try run:")
message(
STATUS
" git clone --recursive --depth 1 https://github.com/Kyligence/ClickHouse.git ${CMAKE_SOURCE_DIR}"
)
endif()
endif()

if (EXISTS "${CH_SOURCE_DIR}/utils/extern-local-engine")
execute_process(COMMAND rm -rf ${CH_SOURCE_DIR}/utils/extern-local-engine)
endif ()
execute_process(COMMAND ln -s ${CMAKE_CURRENT_SOURCE_DIR}/local-engine ${CH_SOURCE_DIR}/utils/extern-local-engine COMMAND_ERROR_IS_FATAL ANY)
if(EXISTS "${CH_SOURCE_DIR}/utils/extern-local-engine")
execute_process(COMMAND rm -rf ${CH_SOURCE_DIR}/utils/extern-local-engine)
endif()
execute_process(
COMMAND ln -s ${CMAKE_CURRENT_SOURCE_DIR}/local-engine
${CH_SOURCE_DIR}/utils/extern-local-engine COMMAND_ERROR_IS_FATAL ANY)

# execute_process(COMMAND find ${CMAKE_CURRENT_SOURCE_DIR}/local-engine -regex '.*\.\(c\|cpp\|h\)' -exec clang-format-15 --verbose -i --style=file -i {} \;)
# execute_process(COMMAND find ${CMAKE_CURRENT_SOURCE_DIR}/local-engine -regex
# '.*\.\(c\|cpp\|h\)' -exec clang-format-15 --verbose -i --style=file -i {} \;)

set(CH_BINARY_DIR "${CMAKE_CURRENT_SOURCE_DIR}/build")
option(ENABLE_CPP_TEST "Build CPP Unit test" OFF)

if (ENABLE_CPP_TEST)
add_custom_command(
USES_TERMINAL
COMMAND
bash -c
\"cmake -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-DENABLE_PROTOBUF=ON
-DENABLE_TESTS=ON
-DENABLE_JEMALLOC=ON
-DENABLE_MULTITARGET_CODE=ON
-DENABLE_EXTERN_LOCAL_ENGINE=ON
-DCOMPILER_FLAGS='-fvisibility=hidden -fvisibility-inlines-hidden'
-S ${CH_SOURCE_DIR} -G Ninja -B ${CH_BINARY_DIR} &&
cmake --build ${CH_BINARY_DIR} --target ch unit_tests_local_engine\"
OUTPUT _build_ch)
if(ENABLE_CPP_TEST)
add_custom_command(
USES_TERMINAL
COMMAND
bash -c \"cmake -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} -DENABLE_PROTOBUF=ON
-DENABLE_TESTS=ON -DENABLE_JEMALLOC=ON -DENABLE_MULTITARGET_CODE=ON
-DENABLE_EXTERN_LOCAL_ENGINE=ON -DCOMPILER_FLAGS='-fvisibility=hidden
-fvisibility-inlines-hidden' -S ${CH_SOURCE_DIR} -G Ninja -B
${CH_BINARY_DIR} && cmake --build ${CH_BINARY_DIR} --target ch
unit_tests_local_engine\"
OUTPUT _build_ch)
else()
add_custom_command(
USES_TERMINAL
COMMAND
bash -c
\"cmake -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-DENABLE_PROTOBUF=ON
-DENABLE_TESTS=OFF
-DENABLE_JEMALLOC=ON
-DENABLE_MULTITARGET_CODE=ON
-DENABLE_EXTERN_LOCAL_ENGINE=ON
-DENABLE_ODBC=OFF
-DENABLE_CAPNP=OFF
-DENABLE_ROCKSDB=OFF
-DENABLE_GRPC=OFF
-DENABLE_RUST=OFF
-DENABLE_H3=OFF
-DENABLE_AMQPCPP=OFF
-DENABLE_CASSANDRA=OFF
-DENABLE_KAFKA=OFF
-DENABLE_NATS=OFF
-DENABLE_LIBPQXX=OFF
-DENABLE_NURAFT=OFF
-DENABLE_DATASKETCHES=OFF
-DENABLE_SQLITE=OFF
-DENABLE_S2_GEOMETRY=OFF
-DENABLE_ANNOY=OFF
-DENABLE_ULID=OFF
-DENABLE_MYSQL=OFF
-DENABLE_BCRYPT=OFF
-DENABLE_LDAP=OFF
-DENABLE_MSGPACK=OFF
-DUSE_REPLXX=OFF
-DENABLE_CLICKHOUSE_ALL=OFF
-DCOMPILER_FLAGS='-fvisibility=hidden -fvisibility-inlines-hidden'
-S ${CH_SOURCE_DIR} -G Ninja -B ${CH_BINARY_DIR} &&
cmake --build ${CH_BINARY_DIR} --target libch\"
OUTPUT _build_ch)
add_custom_command(
USES_TERMINAL
COMMAND
bash -c \"cmake -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} -DENABLE_PROTOBUF=ON
-DENABLE_TESTS=OFF -DENABLE_JEMALLOC=ON -DENABLE_MULTITARGET_CODE=ON
-DENABLE_EXTERN_LOCAL_ENGINE=ON -DENABLE_ODBC=OFF -DENABLE_CAPNP=OFF
-DENABLE_ROCKSDB=OFF -DENABLE_GRPC=OFF -DENABLE_RUST=OFF -DENABLE_H3=OFF
-DENABLE_AMQPCPP=OFF -DENABLE_CASSANDRA=OFF -DENABLE_KAFKA=OFF
-DENABLE_NATS=OFF -DENABLE_LIBPQXX=OFF -DENABLE_NURAFT=OFF
-DENABLE_DATASKETCHES=OFF -DENABLE_SQLITE=OFF -DENABLE_S2_GEOMETRY=OFF
-DENABLE_ANNOY=OFF -DENABLE_ULID=OFF -DENABLE_MYSQL=OFF
-DENABLE_BCRYPT=OFF -DENABLE_LDAP=OFF -DENABLE_MSGPACK=OFF
-DUSE_REPLXX=OFF -DENABLE_CLICKHOUSE_ALL=OFF
-DCOMPILER_FLAGS='-fvisibility=hidden -fvisibility-inlines-hidden' -S
${CH_SOURCE_DIR} -G Ninja -B ${CH_BINARY_DIR} && cmake --build
${CH_BINARY_DIR} --target libch\"
OUTPUT _build_ch)
endif()

add_custom_target(build_ch ALL DEPENDS _build_ch)
Loading

0 comments on commit f1bb1d6

Please sign in to comment.