code.grnet.gr Git - ganeti-local/blob - autotools/check-python-code

   1 #!/bin/bash
   2 #
   3
   4 # Copyright (C) 2009, 2011 Google Inc.
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 # 02110-1301, USA.
  20
  21 set -e
  22
  23 # Ensure the checks always use the same locale
  24 export LC_ALL=C
  25
  26 readonly maxlinelen=$(for ((i=0; i<81; ++i)); do echo -n .; done)
  27
  28 if [[ "${#maxlinelen}" != 81 ]]; then
  29   echo "Internal error: Check for line length is incorrect" >&2
  30   exit 1
  31 fi
  32
  33 # "[...] If the last ARG evaluates to 0, let returns 1; 0 is returned
  34 # otherwise.", hence ignoring the return value.
  35 let problems=0 || :
  36
  37 for script; do
  38   if grep -n -H -F $'\t' "$script"; then
  39     let ++problems
  40     echo "Found tabs in $script" >&2
  41   fi
  42
  43   if grep -n -H -E '[[:space:]]$' "$script"; then
  44     let ++problems
  45     echo "Found end-of-line-whitespace in $script" >&2
  46   fi
  47
  48   # FIXME: This will also match "foo.xrange(...)"
  49   if grep -n -H -E '^[^#]*\<xrange\>' "$script"; then
  50     let ++problems
  51     echo "Forbidden function 'xrange' used in $script" >&2
  52   fi
  53
  54   if grep -n -H -E -i '#[[:space:]]*(vim|Local[[:space:]]+Variables):' "$script"
  55   then
  56     let ++problems
  57     echo "Found editor-specific settings in $script" >&2
  58   fi
  59
  60   if grep -n -H "^$maxlinelen" "$script"; then
  61     let ++problems
  62     echo "Longest line in $script is longer than 80 characters" >&2
  63   fi
  64
  65   if grep -n -H -E -i \
  66     '#.*\bpylint[[:space:]]*:[[:space:]]*disable-msg\b' "$script"
  67   then
  68     let ++problems
  69     echo "Found old-style pylint disable pragma in $script" >&2
  70   fi
  71 done
  72
  73 if [[ "$problems" -gt 0 ]]; then
  74   echo "Found $problems problem(s) while checking code." >&2
  75   exit 1
  76 fi