summaryrefslogtreecommitdiff
path: root/infra/command/format
blob: cc1fc09594df1e1fa1dedd4a08372619fa57ba2b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
#!/bin/bash

INVALID_EXIT=0
FILES_TO_CHECK=()
DIRECTORIES_NOT_TO_BE_TESTED=()

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() {
  # Check all files (CMakeLists.txt, *.cl, ... not only for C++, Python)
  if [[ ${#FILES_TO_CHECK} -ne 0 ]]; then
    CRCHECK=$(file ${FILES_TO_CHECK} | grep 'with CR')
  fi
  FILES_TO_FIX=($(echo "$CRCHECK" | grep "with CRLF line" | cut -d':' -f1))
  for f in ${FILES_TO_FIX[@]}; do
    tr -d '\r' < $f > $f.fixed && cat $f.fixed > $f && rm $f.fixed
  done
  FILES_TO_FIX=($(echo "${CRCHECK}" | grep "with CR line" | cut -d':' -f1))
  for f in ${FILES_TO_FIX[@]}; do
    tr '\r' '\n' < $f > $f.fixed && cat $f.fixed > $f && rm $f.fixed
  done
}

function check_permission() {
  # Check all files except script
  FILES_TO_CHECK_PERMISSION=()
  for f in ${FILES_TO_CHECK[@]}; do
    # Manually ignore permission checking
    if [[ ${f} == !(nnas|nnfw|nncc|*.sh|*.py) ]]; then
      FILES_TO_CHECK_PERMISSION+=("${f}")
    fi
  done

  if [[ ${#FILES_TO_CHECK_PERMISSION} -eq 0 ]]; then
    return
  fi
  for FILE_TO_CHECK in ${FILES_TO_CHECK_PERMISSION[@]}; do
    RESULT=$(stat -c '%A' ${FILE_TO_CHECK} | grep 'x')
    if [ "${RESULT}" != "" ]; then
      chmod a-x ${FILE_TO_CHECK}
    fi
  done
}

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

  CLANG_FORMAT_CANDIDATES=()
  CLANG_FORMAT_CANDIDATES+=("clang-format")
  CLANG_FORMAT_CANDIDATES+=("clang-format-3.9")

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

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

  # Check c++ files
  FILES_TO_CHECK_CPP=()
  for f in ${FILES_TO_CHECK[@]}; do
    # Manually ignore style checking
    if [[ ${f} == +(*/NeuralNetworks.h|*/NeuralNetworksExtensions.h) ]]; then
      continue
    fi

    # File extension to check
    if [[ ${f} == +(*.h|*.hpp|*.cpp|*.cc|*.c|*.cl) ]]; then
      FILES_TO_CHECK_CPP+=("${f}")
    fi
  done

  # Skip by '.FORMATDENY' file
  for s in ${DIRECTORIES_NOT_TO_BE_TESTED[@]}; do
    FILES_TO_CHECK_CPP=(${FILES_TO_CHECK_CPP[*]/$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=()
  for f in ${FILES_TO_CHECK[@]}; do
    # File extension to check
    if [[ ${f} == *.py ]]; then
      FILES_TO_CHECK_PYTHON+=("${f}")
    fi
  done
  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 --style='{based_on_style: pep8, column_limit: 90}' ${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)" ]; then
  echo "[WARNING] Commit all the changes before running format check"
  echo "          format.patch file will contain unstaged files"
fi

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

FILES_TO_CHECK=$(git ls-files -c --exclude-standard)
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
    FILES_TO_CHECK=$(git diff --name-only --diff-filter=d HEAD~${DIFF_COMMITS})
  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

DIFF=$(git diff | tee format.patch)

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 [[ ${PATCHFILE_SIZE} -ne 0 ]]; then
  echo "[FAILED] Format checker failed and update code to follow convention."
  echo "         You can find changes in format.patch"
fi

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

exit 1