From 1fafeee01ace600a16bc70bc2c43c039bd2ab893 Mon Sep 17 00:00:00 2001 From: Krisztian Litkey Date: Fri, 4 Oct 2013 14:36:13 +0300 Subject: [PATCH] build-sys: added githooks to do Change-Id insertion/filtering. Added a bunch of git hooks that collectively try to automatically insert or filter gerrit Change-Id tags depending on the branch name. Branches matching *tizen* will have tags inserted other will have tags filtered out. If you have a bunch of existing commits where you want do a bulk insert/filter operation, just run git rebase -i over the range of commits, mark all for rewording, and the hooks will (try to) do the right thing for you. To get the name-based insertion/filtering logic working correctly over rebases, we have to save the branch name in a pre-rebase hook, use the saved name if it exists or dig it out if not in the commit-msg hook, and remove the saved name in a post-rewrite hook. --- githooks/commit-msg | 206 ++++++++++++++++++++++++++++++++++++++++++++++++++ githooks/post-rewrite | 10 +++ githooks/pre-rebase | 25 ++++++ 3 files changed, 241 insertions(+) create mode 100755 githooks/commit-msg create mode 100755 githooks/post-rewrite create mode 100755 githooks/pre-rebase diff --git a/githooks/commit-msg b/githooks/commit-msg new file mode 100755 index 0000000..8836d79 --- /dev/null +++ b/githooks/commit-msg @@ -0,0 +1,206 @@ +#!/bin/sh +# From Gerrit Code Review 2.6.1.20130902 +# +# 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. +# + +unset GREP_OPTIONS + +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 + + # Does Change-Id: already exist? if so, exit (no change). + if grep -i '^Change-Id:' "$MSG" >/dev/null + then + return + fi + + id=`_gen_ChangeId` + T="$MSG.tmp.$$" + AWK=awk + if [ -x /usr/xpg4/bin/awk ]; then + # Solaris AWK is just too broken + AWK=/usr/xpg4/bin/awk + fi + + # How this works: + # - parse the commit message as (textLine+ blankLine*)* + # - assume textLine+ to be a footer until proven otherwise + # - exception: the first block is not footer (as it is the title) + # - read textLine+ into a variable + # - then count blankLines + # - once the next textLine appears, print textLine+ blankLine* as these + # aren't footer + # - in END, the last textLine+ block is available for footer parsing + $AWK ' + BEGIN { + # while we start with the assumption that textLine+ + # is a footer, the first block is not. + isFooter = 0 + footerComment = 0 + blankLines = 0 + } + + # Skip lines starting with "#" without any spaces before it. + /^#/ { next } + + # Skip the line starting with the diff command and everything after it, + # up to the end of the file, assuming it is only patch data. + # If more than one line before the diff was empty, strip all but one. + /^diff --git a/ { + blankLines = 0 + while (getline) { } + next + } + + # Count blank lines outside footer comments + /^$/ && (footerComment == 0) { + blankLines++ + next + } + + # Catch footer comment + /^\[[a-zA-Z0-9-]+:/ && (isFooter == 1) { + footerComment = 1 + } + + /]$/ && (footerComment == 1) { + footerComment = 2 + } + + # We have a non-blank line after blank lines. Handle this. + (blankLines > 0) { + print lines + for (i = 0; i < blankLines; i++) { + print "" + } + + lines = "" + blankLines = 0 + isFooter = 1 + footerComment = 0 + } + + # Detect that the current block is not the footer + (footerComment == 0) && (!/^\[?[a-zA-Z0-9-]+:/ || /^[a-zA-Z0-9-]+:\/\//) { + isFooter = 0 + } + + { + # We need this information about the current last comment line + if (footerComment == 2) { + footerComment = 0 + } + if (lines != "") { + lines = lines "\n"; + } + lines = lines $0 + } + + # Footer handling: + # If the last block is considered a footer, splice in the Change-Id at the + # right place. + # Look for the right place to inject Change-Id by considering + # CHANGE_ID_AFTER. Keys listed in it (case insensitive) come first, + # then Change-Id, then everything else (eg. Signed-off-by:). + # + # Otherwise just print the last block, a new line and the Change-Id as a + # block of its own. + END { + unprinted = 1 + if (isFooter == 0) { + print lines "\n" + lines = "" + } + changeIdAfter = "^(" tolower("'"$CHANGE_ID_AFTER"'") "):" + numlines = split(lines, footer, "\n") + for (line = 1; line <= numlines; line++) { + if (unprinted && match(tolower(footer[line]), changeIdAfter) != 1) { + unprinted = 0 + print "Change-Id: I'"$id"'" + } + print footer[line] + } + if (unprinted) { + print "Change-Id: I'"$id"'" + } + }' "$MSG" > "$T" && mv "$T" "$MSG" || rm -f "$T" +} +_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 +} + + +del_ChangeId() { + T="$MSG.tmp.$$" + + cat "$MSG" | grep -v 'Change-Id: I' > "$T" && mv "$T" "$MSG" || rm -f "$T" +} + + +gittop=$(while [ ! -d .git -a $(pwd) != "/" ]; do cd ..; done; echo $(pwd)) + +if [ -f $gittop/.rebase-branch-name ]; then + branch=$(cat $gittop/.rebase-branch-name) + echo "Taken branch name \"$branch\" from saved branch name file..." +else + branch=$(git branch -l | grep '^\*' | cut -d ' ' -f 2) + echo "Using current branch name..." +fi + +case $branch in + \(*|-) + echo "Can't figure out rebased branch name, not touching anything..." + ;; + *tizen*) + add_ChangeId + ;; + *) + del_ChangeId + ;; +esac + + +exit 0 diff --git a/githooks/post-rewrite b/githooks/post-rewrite new file mode 100755 index 0000000..a23bc51 --- /dev/null +++ b/githooks/post-rewrite @@ -0,0 +1,10 @@ +#!/bin/sh + +gittop=$(while [ ! -d .git -a $(pwd) != "/" ]; do cd ..; done; echo $(pwd)) + +if [ -f $gittop/.rebase-branch-name ]; then + rm -f $gittop/.rebase-branch-name + echo "Removed saved branch name file..." +fi + +exit 0 diff --git a/githooks/pre-rebase b/githooks/pre-rebase new file mode 100755 index 0000000..1fe53bf --- /dev/null +++ b/githooks/pre-rebase @@ -0,0 +1,25 @@ +#!/bin/sh + +# This hook is called with the following parameters: +# +# $1 -- the upstream the series was forked from. +# $2 -- the branch being rebased (or empty when rebasing the current branch). + +# Dig out and save the name of the branch being rebased for commit-msg hook. +# There the branch name is used to add gerrit Change-Id footers to branches +# matching .*tizen.* and remove from any other branches. + +branch=$(git branch -l | grep '^\*' | cut -d ' ' -f 2) +gittop=$(while [ ! -d .git -a $(pwd) != "/" ]; do cd ..; done; echo $(pwd)) + +case $branch in + \(*) + echo "-" > $gittop/.rebase-branch-name + ;; + *) + echo "$branch" > $gittop/.rebase-branch-name + echo "Saved branch name \"$branch\" for commit-msg hook..." + ;; +esac + +exit 0 -- 2.7.4