ci_scripts/pre-commit.sh

#!/usr/bin/env bash
#
# ============LICENSE_START=======================================================
#  Copyright (C) 2019 Nordix Foundation.
# ================================================================================
# Licensed 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.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================
#
# Pre-commit hook for running checkstyle on changed Java sources
#
# To use this you need:
# 1. Checkstyle's jar file downloaded *version is important checkstyle-8.13-all.jar
# 2. To configure git:
#   * git config --add checkstyle.jar <location_of_jar>
# 3. Copy this file to your .git/hooks directory as pre-commit
#
# Now, when you commit, you will be disallowed from doing so
# until you pass your checkstyle checks.

changed_files=" "
for file in $(git diff --cached --name-status | grep -E '\.(java)$' | grep -vE '^D' | awk '{print $2}')
do
  changed_files+="$file "
done

printf "Using checkstyle sheet "
checkstlye_jar_command='git config --get checkstyle.jar'

if ! ($checkstlye_jar_command)
then
  printf "You must configure checkstyle in your git config"
  exit 1
fi

checkstyle_warnings=$(java -jar $($checkstlye_jar_command) -c ci_scripts/onap-style-java.xml $changed_files | grep WARN)
if [ $? == 0 ]
then
  printf "\nWarnings found\n\n"
  echo "$checkstyle_warnings"
  printf "\n###############################################################\n\nFix warnings before committing\n\n"
  exit 1
else
  printf "\nCode checkstyle passed.\n"
fi