tor/scripts/git/pre-commit.git-hook
teor b9a2286765
scripts/git: Add check_cocci_parse.sh to the pre-commit hook
But only check modified files, which dramatically speeds up
check_cocci_parse.sh.

Part of 31919.
2019-10-24 14:09:53 +10:00

101 lines
3.2 KiB
Bash
Executable File

#!/usr/bin/env bash
#
# To install this script, copy it to .git/hooks/pre-commit in local copy of
# tor git repo and make sure it has permission to execute.
#
# This is pre-commit git hook script that prevents commiting your changeset if
# it fails our code formatting, changelog entry formatting, module include
# rules, or best practices tracker.
workdir=$(git rev-parse --show-toplevel)
cd "$workdir" || exit 1
set -e
if [ -n "$(ls ./changes/)" ]; then
python scripts/maint/lintChanges.py ./changes/*
fi
if [ -d src/lib ]; then
# This is the layout in 0.3.5
# There are two copies of this list in this file
perl scripts/maint/checkSpace.pl -C \
src/lib/*/*.[ch] \
src/core/*/*.[ch] \
src/feature/*/*.[ch] \
src/app/*/*.[ch] \
src/test/*.[ch] \
src/test/*/*.[ch] \
src/tools/*.[ch]
elif [ -d src/common ]; then
# This was the layout before 0.3.5
perl scripts/maint/checkSpace.pl -C \
src/common/*/*.[ch] \
src/or/*/*.[ch] \
src/test/*.[ch] \
src/test/*/*.[ch] \
src/tools/*.[ch]
fi
if test -e scripts/maint/practracker/includes.py; then
python scripts/maint/practracker/includes.py
fi
# Only call practracker if ${PT_DIR}/.enable_practracker_in_hooks exists
# We do this check so that we can enable practracker in hooks in master, and
# disable it on maint branches
PT_DIR=scripts/maint/practracker
if [ -e "${PT_DIR}/practracker.py" ]; then
if [ -e "${PT_DIR}/.enable_practracker_in_hooks" ]; then
if ! python3 "${PT_DIR}/practracker.py" "$workdir"; then
exit 1
fi
fi
fi
if [ -e scripts/maint/checkShellScripts.sh ]; then
scripts/maint/checkShellScripts.sh
fi
if [ -e scripts/coccinelle/check_cocci_parse.sh ]; then
if [ $# -eq 0 ]; then
# When called in pre-commit, check the files modified in this commit
CHECK_FILTER="git diff --cached --name-only --diff-filter=ACMR"
# Use the owned tor source layout from 0.3.5 to filter the changed
# files.
# (There are two copies of this list in this file.)
CHECK_FILES="$($CHECK_FILTER \
src/lib/*/*.[ch] \
src/core/*/*.[ch] \
src/feature/*/*.[ch] \
src/app/*/*.[ch] \
src/test/*.[ch] \
src/test/*/*.[ch] \
src/tools/*.[ch] \
)"
fi
if [ "${CHECK_FILES:-$*}" ]; then
printf "Modified files:\n%s\n" "${CHECK_FILES:-$*}"
# Run a verbose cocci parse check on the changed files
# (spatch is slow, so we don't want to check all the files.)
if [ $# -eq 0 ]; then
# pre-commit: use $CHECK_FILES, fails on spaces in file names
#
# We want word splitting here, because file names are space
# separated
# shellcheck disable=SC2086
VERBOSE=1 scripts/coccinelle/check_cocci_parse.sh \
$CHECK_FILES
else
# pre-push: use "$@" to preserve spaces in arguments
VERBOSE=1 scripts/coccinelle/check_cocci_parse.sh \
"$@"
fi
fi
fi