blob: 5e8da5c5471dabfef750ef577411b6562e82cd49 [file] [log] [blame]
#!/usr/bin/env python3
# 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.
import hashlib
import pathlib
import subprocess
import sys
patterns = [
'cpp/CMakeLists.txt',
# Keep an explicit list of files to format as we don't want to reformat
# files we imported from other location.
'cpp/cmake_modules/BuildUtils.cmake',
'cpp/cmake_modules/DefineOptions.cmake',
'cpp/cmake_modules/FindArrow.cmake',
'cpp/cmake_modules/FindArrowCUDA.cmake',
'cpp/cmake_modules/FindArrowDataset.cmake',
'cpp/cmake_modules/FindArrowFlight.cmake',
'cpp/cmake_modules/FindArrowFlightTesting.cmake',
'cpp/cmake_modules/FindArrowPython.cmake',
'cpp/cmake_modules/FindArrowPythonFlight.cmake',
'cpp/cmake_modules/FindArrowTesting.cmake',
'cpp/cmake_modules/FindBrotli.cmake',
'cpp/cmake_modules/FindClangTools.cmake',
'cpp/cmake_modules/FindFlatbuffersAlt.cmake',
'cpp/cmake_modules/FindGLOG.cmake',
'cpp/cmake_modules/FindGandiva.cmake',
'cpp/cmake_modules/FindInferTools.cmake',
'cpp/cmake_modules/FindLLVMAlt.cmake',
'cpp/cmake_modules/FindLz4.cmake',
'cpp/cmake_modules/FindParquet.cmake',
'cpp/cmake_modules/FindPlasma.cmake',
'cpp/cmake_modules/FindPython3Alt.cmake',
'cpp/cmake_modules/FindRE2.cmake',
'cpp/cmake_modules/FindRapidJSONAlt.cmake',
'cpp/cmake_modules/FindSnappyAlt.cmake',
'cpp/cmake_modules/FindThrift.cmake',
'cpp/cmake_modules/FindZSTD.cmake',
'cpp/cmake_modules/Findc-aresAlt.cmake',
'cpp/cmake_modules/FindgRPCAlt.cmake',
'cpp/cmake_modules/FindgflagsAlt.cmake',
'cpp/cmake_modules/Findjemalloc.cmake',
'cpp/cmake_modules/SetupCxxFlags.cmake',
'cpp/cmake_modules/ThirdpartyToolchain.cmake',
'cpp/cmake_modules/san-config.cmake',
'cpp/cmake_modules/UseCython.cmake',
'cpp/cmake_modules/Usevcpkg.cmake',
'cpp/src/**/CMakeLists.txt',
'cpp/tools/**/CMakeLists.txt',
'java/gandiva/CMakeLists.txt',
'python/CMakeLists.txt',
]
here = pathlib.Path(__file__).parent
def find_cmake_files():
for pat in patterns:
yield from here.glob(pat)
def run_cmake_format(paths):
# cmake-format is fast enough that running in parallel doesn't seem
# necessary
# autosort is off because it breaks in cmake_format 5.1
# See: https://github.com/cheshirekow/cmake_format/issues/111
cmd = ['cmake-format', '--in-place', '--autosort=false'] + paths
try:
subprocess.run(cmd, check=True)
except FileNotFoundError:
try:
import cmake_format
except ImportError:
raise ImportError(
"Please install cmake-format: `pip install cmake_format`")
else:
# Other error, re-raise
raise
def check_cmake_format(paths):
hashes = {}
for p in paths:
contents = p.read_bytes()
hashes[p] = hashlib.sha256(contents).digest()
run_cmake_format(paths)
# Check contents didn't change
changed = []
for p in paths:
contents = p.read_bytes()
if hashes[p] != hashlib.sha256(contents).digest():
changed.append(p)
if changed:
items = "\n".join("- %s" % p for p in sorted(changed))
print("The following cmake files need re-formatting:\n%s" % (items,))
print()
print("Consider running `run-cmake-format.py`")
sys.exit(1)
if __name__ == "__main__":
paths = list(find_cmake_files())
if "--check" in sys.argv:
check_cmake_format(paths)
else:
run_cmake_format(paths)