chiark / gitweb /
Merge branch 'master' into 'master'
[fdroidserver.git] / hooks / pre-commit
1 #!/bin/bash
2 #
3 # Simple pre-commit hook to check that there are no errors in the fdroidserver
4 # source files.
5
6 # Redirect output to stderr.
7 exec 1>&2
8
9 files=`git diff-index --cached HEAD 2>&1 | sed 's/^:.*     //' | uniq | cut -b100-500`
10 if [ -z "$files" ]; then
11     PY_FILES="fdroid makebuildserver setup.py examples/*.py buildserver/*.py fdroidserver/*.py"
12     PY_TEST_FILES="tests/*.TestCase"
13     SH_FILES="hooks/pre-commit"
14     BASH_FILES="fd-commit jenkins-build docs/update.sh completion/bash-completion"
15     RB_FILES="buildserver/cookbooks/*/recipes/*.rb"
16 else
17     # if actually committing right now, then only run on the files
18     # that are going to be committed at this moment
19     PY_FILES=
20     PY_TEST_FILES=
21     SH_FILES=
22     BASH_FILES=
23     RB_FILES=
24
25     for f in $files; do
26         case $f in
27             *.py)
28                 PY_FILES+=" $f"
29                 ;;
30             *.TestCase)
31                 PY_TEST_FILES+=" $f"
32                 ;;
33             *.rb)
34                 RB_FILES+=" $f"
35                 ;;
36             *)
37                 if head -1 $f | grep '^#!/bin/sh' > /dev/null 2>&1; then
38                     SH_FILES+=" $f"
39                 elif head -1 $f | grep '^#!/bin/bash' > /dev/null 2>&1; then
40                     BASH_FILES+=" $f"
41                 elif head -1 $f | grep '^#!.*python' > /dev/null 2>&1; then
42                     PY_FILES+=" $f"
43                 fi
44                 ;;
45         esac
46     done
47 fi
48
49 # We ignore the following PEP8 warnings
50 # * E123: closing bracket does not match indentation of opening bracket's line
51 #   - Broken if multiple indentation levels start on a single line
52 # * E501: line too long (82 > 79 characters)
53 #   - Recommended for readability but not enforced
54 #   - Some lines are awkward to wrap around a char limit
55 # * W503: line break before binary operator
56 #   - Quite pedantic
57
58 PEP8_IGNORE="E123,E501,W503"
59
60 err() {
61         echo ERROR: "$@"
62         exit 1
63 }
64
65 warn() {
66         echo WARNING: "$@"
67 }
68
69 cmd_exists() {
70         command -v $1 1>/dev/null
71 }
72
73 find_command() {
74         local name=$1
75         for suff in "3" "-python3" ""; do
76                 cmd=${1}${suff}
77                 if cmd_exists $cmd; then
78                         echo $cmd
79                         return 0
80                 fi
81         done
82         warn "$1 is not installed, using dummy placeholder!"
83         echo -n echo
84 }
85
86 PYFLAKES=$(find_command pyflakes)
87 PEP8=$(find_command pep8)
88
89 if [ "$PY_FILES $PY_TEST_FILES" != " " ]; then
90     if ! $PYFLAKES $PY_FILES $PY_TEST_FILES; then
91         err "pyflakes tests failed!"
92     fi
93 fi
94
95 if [ "$PY_FILES" != "" ]; then
96     if ! $PEP8 --ignore=$PEP8_IGNORE $PY_FILES; then
97         err "pep8 tests failed!"
98     fi
99 fi
100
101 # The tests use a little hack in order to cleanly import the fdroidserver
102 # package locally like a regular package.  pep8 doesn't see that, so this
103 # makes pep8 skip E402 on the test files that need that hack.
104 if [ "$PY_TEST_FILES" != "" ]; then
105     if ! $PEP8 --ignore=$PEP8_IGNORE,E402 $PY_TEST_FILES; then
106         err "pep8 tests failed!"
107     fi
108 fi
109
110 for f in $SH_FILES; do
111         if ! dash -n $f; then
112                 err "dash tests failed!"
113         fi
114 done
115
116 for f in $BASH_FILES; do
117         if ! bash -n $f; then
118                 err "bash tests failed!"
119         fi
120 done
121
122 for f in $RB_FILES; do
123         if ! ruby -c $f 1>/dev/null; then
124                 err "ruby tests failed!"
125         fi
126 done
127
128 exit 0