Git precommit hooks - pylint and forbidden strings

commit-msg

#!/bin/sh
# From Gerrit Code Review 2.1.6.1
#
# Part of Gerrit Code Review (http://code.google.com/p/gerrit/)
#
# Copyright (C) 2009 The Android Open Source Project
#
# 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.
#

CHANGE_ID_AFTER="Bug|Issue"
MSG="$1"

# Check for, and add if missing, a unique Change-Id
#
add_ChangeId() {
	clean_message=$(sed -e '
		/^diff --git a\/.*/{
			s///
			q
		}
		/^Signed-off-by:/d
		/^#/d
	' "$MSG" | git stripspace)
	if test -z "$clean_message"
	then
		return
	fi

	if grep -i '^Change-Id:' "$MSG" >/dev/null
	then
		return
	fi

	id=$(_gen_ChangeId)
	perl -e '
		$MSG = shift;
		$id = shift;
		$CHANGE_ID_AFTER = shift;

		undef $/;
		open(I, $MSG); $_ = <I>; close I;
		s|^diff --git a/.*||ms;
		s|^#.*$||mg;
		exit unless $_;

		@message = split /\n/;
		$haveFooter = 0;
		$startFooter = @message;
		for($line = @message - 1; $line >= 0; $line--) {
			$_ = $message[$line];

			if (/^[a-zA-Z0-9-]+:/ && !m,^[a-z0-9-]+://,) {
				$haveFooter++;
				next;
			}
			next if /^[ []/;
			$startFooter = $line if ($haveFooter && /^\r?$/);
			last;
		}

		@footer = @message[$startFooter+1..@message];
		@message = @message[0..$startFooter];
		push(@footer, "") unless @footer;

		for ($line = 0; $line < @footer; $line++) {
			$_ = $footer[$line];
			next if /^($CHANGE_ID_AFTER):/i;
			last;
		}
		splice(@footer, $line, 0, "Change-Id: I$id");

		$_ = join("\n", @message, @footer);
		open(O, ">$MSG"); print O; close O;
	' "$MSG" "$id" "$CHANGE_ID_AFTER"
}
_gen_ChangeIdInput() {
	echo "tree $(git write-tree)"
	if parent=$(git rev-parse HEAD^0 2>/dev/null)
	then
		echo "parent $parent"
	fi
	echo "author $(git var GIT_AUTHOR_IDENT)"
	echo "committer $(git var GIT_COMMITTER_IDENT)"
	echo
	printf '%s' "$clean_message"
}
_gen_ChangeId() {
	_gen_ChangeIdInput |
	git hash-object -t commit --stdin
}


add_ChangeId

pre-commit

#!/bin/sh
# see http://zgp.org/~dmarti/tips/git-multiple-post-receive-hooks/
# pee is from moreutils

pee $GIT_DIR/hooks/pre-commit-*

pre-commit-forbidden-strings.rb

#!/usr/bin/env ruby

# Git pre-commit hook that prevents accidentally committing things that shouldn't be, like:
#
#   * ":focus", used with RSpec/Guard
#   * "show_page", used to debug request specs
#   * "console.log" or "console.debug", used in JavaScript debugging
#   * "DO NOT COMMIT!" comments
#
# Modify the regexps to suit your needs. The error message shows the full regexp match, or just the first capture group, if there is one.
#
# To bypass this commit hook (and others), perhaps when defining ":focus" or "show_page" for the first time, commit with the "--no-verify" option.
#
# By Henrik Nyh <http://henrik.nyh.se> 2011-10-08 under the MIT License.
#
#
# Install:
#
# cd your_project
# curl https://raw.github.com/henrik/dotfiles/master/githooks/pre-commit -o .git/hooks/pre-commit && chmod u+x .git/hooks/pre-commit
#
# Or store it centrally and symlink in your projects:
#
# curl --create-dirs https://raw.github.com/henrik/dotfiles/master/githooks/pre-commit -o ~/.githooks/pre-commit && chmod u+x ~/.githooks/pre-commit
# cd your_project
# ln -s ~/.githooks/pre-commit .git/hooks


FORBIDDEN = [
             /\W(:focus)\b/,
             /\bshow_page\b/,
             /\bconsole\.log\b/,
             /\bconsole\.debug\b/,
             /\bdo not commit\b/i,
             /\bipdb\.set_trace\b/,
             /\bpdb\.set_trace\b/,
            ]

full_diff = `git diff --cached --`

full_diff.scan(%r{^\+\+\+ b/(.+)\n@@.*\n([\s\S]*?)(?:^diff|\z)}).each do |file, diff|
  added = diff.split("\n").select { |x| x.start_with?("+") }.join("\n")
  if FORBIDDEN.any? { |re| added.match(re) }
    puts %{Git hook forbids adding "#{$1 || $&}" to #{file}}
    puts "To commit anyway, use --no-verify"
    exit 1
  end
end

pre-commit-pylint.sh

#!/bin/bash
 
# try and us the pylint from the venv associated with the git project
# adapted from
# http://hmarr.com/2010/jan/19/making-virtualenv-play-nice-with-git/

PYLINT="pylint"

GIT_DIR=`git rev-parse --git-dir 2> /dev/null`
if [ $? == 0 ]; then
    # Find the repo root and check for virtualenv name override
    GIT_DIR=`\cd $GIT_DIR; pwd`
    PROJECT_ROOT=`dirname "$GIT_DIR"`
    ENV_NAME=`basename "$PROJECT_ROOT"`
    if [ -f "$PROJECT_ROOT/.venv" ]; then
        ENV_NAME=`cat "$PROJECT_ROOT/.venv"`
    fi
    # set venv pylint if exists
    if [ -x "$WORKON_HOME/$ENV_NAME/bin/pylint" ]; then
       PYLINT="$WORKON_HOME/$ENV_NAME/bin/pylint"
    fi
fi

files_modified=`git diff-index --cached --name-only HEAD`

for f in $files_modified; do
    if [[ $f == *.py ]]; then
        $PYLINT -E $f 
        if [ $? != 0 ]; then
            echo "Code fails pylint check."
            exit 1
        fi
    fi
done 
exit