path: root/infra/command/format

#!/bin/bash

INVALID_EXIT=0
FILES_TO_CHECK=()
DIRECTORIES_TO_BE_TESTED=()
DIRECTORIES_NOT_TO_BE_TESTED=()
DEFAULT_CLANG_FORMAT="clang-format-8"
CLANG_FORMAT_CANDIDATES=()
PATCH_FILE=format.patch
CHECK_DIFF_ONLY="0"
CHECK_STAGED_ONLY="0"

function Usage()
{
  echo "Usage: $0 $(basename ${BASH_SOURCE[0]}) [OPTIONS] [<file|dir> ...]"
  echo "If no arguments are specified, it formats all nnas codes"
  echo "If <file>s are given, it reformats the files"
  echo ""
  echo "Options:"
  echo "      --clang-format <TOOL>     clang format bin (default: $DEFAULT_CLANG_FORMAT)"
  echo "      --diff-only               check diff files with master"
  echo "      --staged-only             check git staged files"
}

while [[ $# -gt 0 ]]
do
  arg="$1"
  case $arg in
    -h|--help|help)
      Usage
      exit 0
      ;;
    --clang-format)
      CLANG_FORMAT_CANDIDATES=($2)
      shift 2
      ;;
    --clang-format=*)
      CLANG_FORMAT_CANDIDATES=(${1#*=})
      shift
      ;;
    --staged-only)
      CHECK_STAGED_ONLY="1"
      CHECK_DIFF_ONLY="1"
      shift
      ;;
    --diff-only)
      CHECK_DIFF_ONLY="1"
      shift
      ;;
    *)
      DIRECTORIES_TO_BE_TESTED+=($1)
      shift
      ;;
  esac
done

function pushd () {
  command pushd "$@" > /dev/null
}

function popd () {
  command popd "$@" > /dev/null
}

function command_exists() {
  command -v $1 > /dev/null 2>&1
}

function check_newline() {
  # Exclude binary (refer .gitattributes file)
  # TODO Remove svg file excluding
  #   .svg: xml type ML for vector graphic
  FILES_TO_CHECK_EOF=`echo "$FILES_TO_CHECK" | tr ' ' '\n' | egrep -v '((\.caffemodel)|(\.png)|(\.pdf)|(\.h5)|(\.pdf)|(\.tar.gz)|(\.tflite)|(\.pdf)|(\.bmp)|(\.svg))$'`

  for f in ${FILES_TO_CHECK_EOF[@]}; do
    # Check no new line at end of file
    if diff /dev/null "$f" | tail -1 | grep '^\\ No newline' > /dev/null; then
      echo >> "$f"
    fi
  done
}

function check_permission() {
  # Check all files except script
  # Manually ignore permission checking
  FILES_TO_CHECK_PERMISSION=$(git ls-files -c -s --exclude-standard ${FILES_TO_CHECK[@]} | egrep '^100755' | cut -f2)
  FILES_TO_CHECK_PERMISSION=`echo "$FILES_TO_CHECK_PERMISSION" | tr ' ' '\n' | egrep -v '((^nnas)|(^nnfw)|(^nncc)|(\.sh)|(\.py)|(/gradlew))$'`
  FILES_TO_CHECK_PERMISSION=`echo "$FILES_TO_CHECK_PERMISSION" | egrep -v '((^infra/debian/compiler/rules)|(^infra/debian/runtime/rules))$'`
  FILES_TO_CHECK_PERMISSION+=`echo && echo "$FILES_TO_CHECK" | egrep '^tests/nnapi/specs/.*.py$'`
  # Transform to array
  FILES_TO_CHECK_PERMISSION=($FILES_TO_CHECK_PERMISSION)

  if [[ ${#FILES_TO_CHECK_PERMISSION} -eq 0 ]]; then
    return
  fi
  for f in ${FILES_TO_CHECK_PERMISSION[@]}; do
    chmod a-x $f
  done
}

function check_cpp_files() {
  if [[ ${__Check_CPP} -eq 0 ]]; then
    echo "[SKIPPED] C/C++ check is skipped"
    return
  fi

  CLANG_FORMAT_CANDIDATES+=($DEFAULT_CLANG_FORMAT)
  for CLANG_FORMAT_CANDIDATE in ${CLANG_FORMAT_CANDIDATES[@]}; do
    if command_exists ${CLANG_FORMAT_CANDIDATE} ; then
      CLANG_FORMAT="${CLANG_FORMAT_CANDIDATE}"
      break
    fi
  done

  if [[ -z ${CLANG_FORMAT}  ]]; then
    echo "[ERROR] $CLANG_FORMAT is unavailable"
    echo
    echo "        Please install $DEFAULT_CLANG_FORMAT before running format check"
    exit 1
  fi

  # Check c++ files: replace ' ' with newline, check with grep
  FILES_TO_CHECK_CPP=`echo "$FILES_TO_CHECK" | tr ' ' '\n' | egrep '((\.c[cl]?)|(\.cpp)|(\.h(pp)?))$'`
  # Manually ignore style checking
  FILES_TO_CHECK_CPP=`echo "$FILES_TO_CHECK_CPP" | egrep -v '((/NeuralNetworks\.h)|(/NeuralNetworksExtensions\.h))$'`
  # Transform to array
  FILES_TO_CHECK_CPP=($FILES_TO_CHECK_CPP)

  # Skip by '.FORMATDENY' file
  for s in ${DIRECTORIES_NOT_TO_BE_TESTED[@]}; do
    FILES_TO_CHECK_CPP=(${FILES_TO_CHECK_CPP[*]/$s*/})
    FILES_TO_CHECK_CPP_BY_CLANG_FORMAT_8=(${FILES_TO_CHECK_CPP_BY_CLANG_FORMAT_8[*]/$s*/})
  done

  if [[ ${#FILES_TO_CHECK_CPP} -ne 0 ]]; then
    ${CLANG_FORMAT} -i ${FILES_TO_CHECK_CPP[@]}
    EXIT_CODE=$?
    if [[ ${EXIT_CODE} -ne 0 ]]; then
      INVALID_EXIT=${EXIT_CODE}
    fi
  fi
}

function check_python_files() {
  if [[ ${__Check_PYTHON} -eq 0 ]]; then
    echo "[SKIPPED] Python check is skipped"
    return
  fi

  if ! command_exists yapf; then
    echo "[ERROR] yapf is unavailable"
    echo "       Please install yapf."
    exit 1
  fi

  # Check python files
  FILES_TO_CHECK_PYTHON=(`echo "$FILES_TO_CHECK" | tr ' ' '\n' | egrep '\.py$'`)
  # Exceptional case: one-cmds don't have '.py' extension: ignore non-python source (cmake, etc) and ignore shell script: one-prepare-venv
  FILES_TO_CHECK_PYTHON+=(`echo "$FILES_TO_CHECK" | tr ' ' '\n' | egrep '^compiler/one-cmds/[^(\./)]*$' | egrep -v '^compiler/one-cmds/one-prepare-venv$'`)

  for s in ${DIRECTORIES_NOT_TO_BE_TESTED[@]}; do
    skip=${s#'.'/}/
    FILES_TO_CHECK_PYTHON=(${FILES_TO_CHECK_PYTHON[*]/$skip*/})
  done

  if [[ ${#FILES_TO_CHECK_PYTHON} -ne 0 ]]; then
    yapf -i ${FILES_TO_CHECK_PYTHON[@]}
    EXIT_CODE=$?
    if [[ ${EXIT_CODE} -ne 0 ]]; then
      INVALID_EXIT=${EXIT_CODE}
    fi
  fi
}

pushd ${NNAS_PROJECT_PATH}

if [[ -n "$(git diff)" ]] && { [[ "${CHECK_DIFF_ONLY}" != "1" ]] || [[ "${CHECK_STAGED_ONLY}" != "1" ]]; }; then
  echo "[WARNING] Commit all the changes before running format check"
  echo "          ${PATCH_FILE} file will contain unstaged files"
fi

__Check_CPP=${CHECK_CPP:-"1"}
__Check_PYTHON=${CHECK_PYTHON:-"1"}

# Git file mode
#   120000: symbolic link
#   160000: git link
#   100755: regular executable
#   100644: regular readable
# Reference: https://github.com/git/git/blob/cd42415/Documentation/technical/index-format.txt#L72-L81
FILES_TO_CHECK=$(git ls-files -c -s --exclude-standard ${DIRECTORIES_TO_BE_TESTED[@]} | egrep -v '^1[26]0000' | cut -f2)
if [[ "${CHECK_DIFF_ONLY}" = "1" ]]; then
  MASTER_EXIST=$(git rev-parse --verify master)
  CURRENT_BRANCH=$(git branch | grep \* | cut -d ' ' -f2-)
  DIFF_COMMITS=`git log --graph --oneline master..HEAD | wc -l`
  if [[ -z "${MASTER_EXIST}" ]]; then
    echo "Cannot found local master branch"
  elif [[ "${CURRENT_BRANCH}" = "master" ]]; then
    echo "Current branch is master"
  else
    if [[ "${CHECK_STAGED_ONLY}" = "1" ]]; then
      FILES_TO_CHECK=$(git diff --staged --name-only --diff-filter=d)
    else
      FILES_TO_CHECK=$(git diff --name-only --diff-filter=d HEAD~${DIFF_COMMITS})
    fi
    FILES_TO_CHECK=$(git ls-files -c -s --exclude-standard ${FILES_TO_CHECK[@]} | egrep -v '^1[26]0000' | cut -f2)
  fi
fi

for DIR_NOT_TO_BE_TESTED in $(git ls-files -co --exclude-standard '*/.FORMATDENY'); do
  DIRECTORIES_NOT_TO_BE_TESTED+=($(dirname "${DIR_NOT_TO_BE_TESTED}"))
done

check_newline
check_permission
check_cpp_files
check_python_files

if [[ "${CHECK_DIFF_ONLY}" = "1" ]] && [[ "${CHECK_STAGED_ONLY}" = "1" ]]; then
  if [[ ! -z "${FILES_TO_CHECK}" ]]; then
    DIFF=$(git diff ${FILES_TO_CHECK} | tee ${PATCH_FILE})
  fi
else
  DIFF=$(git diff | tee ${PATCH_FILE})
fi

popd

if [[ -z "${CRCHECK}" ]] && [[ ! -n "${DIFF}" ]] && [[ ${INVALID_EXIT} -eq 0 ]]; then
  echo "[PASSED] Format checker succeed."
  return
fi

# Something went wrong

if [[ ! -z "${CRCHECK}" ]]; then
  echo "[FAILED] Please use LF for newline for following files."
  echo "${CRCHECK}"
fi

if [[ -s ${PATCH_FILE} ]]; then
  echo "[FAILED] Format checker failed and update code to follow convention."
  echo "         You can find changes in ${PATCH_FILE}"
fi

if [[ ${INVALID_EXIT} -ne 0 ]]; then
  echo "[[FAILED] Invalid format checker exit."
fi

exit 1