diff options
Diffstat (limited to 'rfc.sh')
| -rwxr-xr-x | rfc.sh | 280 |
1 files changed, 145 insertions, 135 deletions
@@ -4,6 +4,29 @@ # i.e. where we are interested in the result of a command, # we have to run the command in an if-statement. +UPSTREAM=${GLUSTER_UPSTREAM} +if [ "x$UPSTREAM" -eq "x" ]; then + for rmt in $(git remote); do + rmt_repo=$(git remote show $rmt -n | grep Fetch | awk '{ print $3 }'); + if [ $rmt_repo -eq "git@github:gluster/glusterfs" ]; then + UPSTREAM=$rmt + echo "Picked $rmt as upstream remote" + break + fi + done +fi + +USER_REPO=${GLUSTER_USER_REPO:-origin} +if [ "x${USER_REPO}" -eq "x${UPSTREAM}" ] ; then + echo "When you submit patches, it should get submitted to your fork, not to upstream directly" + echo "If you are not sure, check `for rmt in $(git remote); do git remote show $rmt -n; done`" + echo "And pick the correct remote you would like to push to and do `export GLUSTER_USER_REPO=$rmt`" + echo "" + echo "Exiting..." + exit 1 +fi + + while getopts "v" opt; do case $opt in @@ -17,7 +40,7 @@ done shift $((OPTIND-1)) -branch="release-3.12"; +branch="devel"; set_hooks_commit_msg() { @@ -49,21 +72,21 @@ is_num() backport_id_message() { echo "" - echo "This commit is to a non-master branch, and hence is treated as a backport." + echo "This commit is to a non-devel branch, and hence is treated as a backport." echo "" echo "For backports we would like to retain the same gerrit Change-Id across" echo "branches. On auto inspection it is found that a gerrit Change-Id is" - echo "missing, or the Change-Id is not found on your local master" + echo "missing, or the Change-Id is not found on your local devel branch" echo "" echo "This could mean a few things:" echo " 1. This is not a backport, hence choose Y on the prompt to proceed" - echo " 2. Your origin master is not up to date, hence the script is unable" - echo " to find the corresponding Change-Id on master. Either choose N," + echo " 2. Your $USER_REPO/devel is not up to date, hence the script is unable" + echo " to find the corresponding Change-Id on devel. Either choose N," echo " 'git fetch', and try again, OR if you are sure you used the" echo " same Change-Id, choose Y at the prompt to proceed" echo " 3. You commented or removed the Change-Id in your commit message after" echo " cherry picking the commit. Choose N, fix the commit message to" - echo " use the same Change-Id as master (git commit --amend), resubmit" + echo " use the same Change-Id as 'devel' (git commit --amend), resubmit" echo "" } @@ -71,13 +94,13 @@ check_backport() { moveon='N' - # Backports are never made to master - if [ $branch = "master" ]; then + # Backports are never made to 'devel' + if [ $branch = "devel" ]; then return; fi # Extract the change ID from the commit message - changeid=$(git show --format='%b' | grep -i '^Change-Id: ' | awk '{print $2}') + changeid=$(git log -n1 --format='%b' | grep -i '^Change-Id: ' | awk '{print $2}') # If there is no change ID ask if we should continue if [ -z "$changeid" ]; then @@ -85,22 +108,22 @@ check_backport() echo -n "Did not find a Change-Id for a possible backport. Continue (y/N): " read moveon else - # Search master for the same change ID (rebase_changes has run, so we + # Search 'devel' for the same change ID (rebase_changes has run, so we # should never not find a Change-Id) - mchangeid=$(git log origin/master --format='%b' --grep="^Change-Id: ${changeid}" | grep ${changeid} | awk '{print $2}') + mchangeid=$(git log $UPSTREAM/devel --format='%b' --grep="^Change-Id: ${changeid}" | grep ${changeid} | awk '{print $2}') - # Check if we found the change ID on master, else throw a message to + # Check if we found the change ID on 'devel', else throw a message to # decide if we should continue. - # NOTE: If master was not rebased, we will not find the Change-ID and + # NOTE: If 'devel' was not rebased, we will not find the Change-ID and # could hit a false positive case here (or if someone checks out some - # other branch as master). + # other branch as 'devel'). if [ "${mchangeid}" = "${changeid}" ]; then moveon="Y" else backport_id_message; echo "Change-Id of commit: $changeid" - echo "Change-Id on master: $mchangeid" - echo -n "Did not find mentioned Change-Id on master for a possible backport. Continue (y/N): " + echo "Change-Id on devel: $mchangeid" + echo -n "Did not find mentioned Change-Id on 'devel' for a possible backport. Continue (y/N): " read moveon fi fi @@ -115,10 +138,51 @@ check_backport() rebase_changes() { - GIT_EDITOR=$0 git rebase -i origin/$branch; + GIT_EDITOR=$0 git rebase -i $UPSTREAM/$branch; } +# Regex elaborated: +# grep options: +# -w -> --word-regexp (from the man page) +# Select only those lines containing matches that form whole words. +# The test is that the matching substring must either be at the +# beginning of the line, or preceded by a non-word constituent +# character. Similarly, it must be either at the end of the line or +# followed by a non-word constituent character. Word-constituent +# characters are letters, digits, and the underscore. +# +# IOW, the above helps us find the pattern with leading or training +# spaces or non word consituents like , or ; +# +# -i -> --ignore-case (case insensitive search) +# +# -o -> --only-matching (only print matching portion of the line) +# +# -E -> --extended-regexp (use extended regular expression) +# +# ^ +# The search begins at the start of each line +# +# [[:space:]]* +# Any number of spaces is accepted +# +# (Fixes|Updates) +# Finds 'Fixes' OR 'Updates' in any case combination +# +# (:)? +# Followed by an optional : (colon) +# +# [[:space:]]+ +# Followed by 1 or more spaces +# +# # +# Followed by # +# +# [[:digit:]]+ +# Followed by 1 or more digits +REFRE="^[[:space:]]*(Fixes|Updates)(:)?[[:space:]]+#[[:digit:]]+" + editor_mode() { if [ $(basename "$1") = "git-rebase-todo" ]; then @@ -127,22 +191,34 @@ editor_mode() fi if [ $(basename "$1") = "COMMIT_EDITMSG" ]; then - if grep -qi '^BUG: ' $1; then + # see note above function warn_reference_missing for regex elaboration + # Lets first check for github issues + ref=$(git log -n1 --format='%b' | grep -iow -E "${REFRE}" | awk -F '#' '{print $2}'); + if [ "x${ref}" != "x" ]; then return; fi + while true; do echo Commit: "\"$(head -n 1 $1)\"" - echo -n "Enter Bug ID: " - read bug - if [ -z "$bug" ]; then + echo -n "Github Issue ID: " + read issue + if [ -z "$issue" ]; then return; fi - if ! is_num "$bug"; then - echo "Invalid Bug ID ($bug)!!!"; + if ! is_num "$issue"; then + echo "Invalid Github Issue ID!!!"; continue; fi - sed "/^Change-Id:/{p; s/^.*$/BUG: $bug/;}" $1 > $1.new && \ + echo "Select yes '(y)' if this patch fixes the issue/feature completely," + echo -n "or is the last of the patchset which brings feature (Y/n): " + read fixes + fixes_string="Fixes" + if [ "${fixes}" = 'N' ] || [ "${fixes}" = 'n' ]; then + fixes_string="Updates" + fi + + sed "/^Change-Id:/{p; s/^.*$/${fixes_string}: #${issue}/;}" $1 > $1.new && \ mv $1.new $1; return; done @@ -158,120 +234,38 @@ EOF assert_diverge() { - git diff origin/$branch..HEAD | grep -q .; + git diff $UPSTREAM/$branch..HEAD | grep -q .; } -check_patches_for_coding_style() -{ - git fetch origin; - - check_patch_script=./build-aux/checkpatch.pl - if [ ! -e ${check_patch_script} ] ; then - echo "${check_patch_script} is not executable .. abort" - exit 1 - fi - - # The URL of our Gerrit server - export GERRIT_URL="review.gluster.org" - - echo "Running coding guidelines check ..." - head=$(git rev-parse --abbrev-ref HEAD) - # Kludge: "1>&2 && echo $? || echo $?" is to get around - # "-e" from script invocation - RES=$(git format-patch --stdout origin/${branch}..${head} \ - | ${check_patch_script} --strict --terse - 1>&2 && echo $? || echo $?) - if [ "$RES" -eq 1 ] ; then - echo "Errors caught, get details by:" - echo " git format-patch --stdout origin/${branch}..${head} \\" - echo " | ${check_patch_script} --strict --gerrit-url ${GERRIT_URL} -" - echo "and correct errors" - exit 1 - elif [ "$RES" -eq 2 ] ; then - echo "Warnings or checks caught, get details by:" - echo " git format-patch --stdout origin/${branch}..${head} \\" - echo " | ${check_patch_script} --strict --gerrit-url ${GERRIT_URL} -" - echo -n "Do you want to continue anyway [no/yes]: " - read yesno - if [ "${yesno}" != "yes" ] ; then - echo "Aborting..." - exit 1 - fi - fi -} - -github_issue_message() +warn_reference_missing() { echo "" - echo "=== Missing a github issue reference in a potential enhancement! ===" + echo "=== Missing a reference in commit! ===" + echo "" + echo "Gluster commits are made with a reference to a github issue" echo "" - echo "Gluster code submissions that are enhancements (IOW, not functional" - echo "bug fixes, but improvements of any nature to the code) are tracked" - echo "using github issues. A check on the commit message, reveals that" - echo "there is no bug associated with this change, hence it could be a" - echo "potential code improvement or feature enhancement" + echo "A check on the commit message, reveals that there is no " + echo "github issue referenced in the commit message." echo "" - echo "If this is an enhancement, request a github issue be filed at [1]" - echo "and referenced in the commit message as," - echo "\"Fixes gluster/glusterfs#n\" OR \"Updates gluster/glusterfs#n\"," - echo "where n is the issue number" + echo "https://github.com/gluster/glusterfs/issues/new" echo "" - echo "You can reference multiple issues that this commit addresses as," - echo "\"fixes gluster/glusterfs#n, updates gluster/glusterfs#m\", and so on" + echo "Please open an issue and reference the same in the commit message " + echo "using the following tags:" echo "" - echo "[1] https://github.com/gluster/glusterfs/issues/new" + echo "\"Fixes: #NNNN\" OR \"Updates: #NNNN\"," + echo "where NNNN is the issue id" echo "" echo "You may abort the submission choosing 'N' below and use" echo "'git commit --amend' to add the issue reference before posting" - echo "to gerrit. If this is a bug fix, choose 'Y' to continue." + echo "to gerrit." echo "" -} - -check_for_github_issue() -{ - # NOTE: Since we run '#!/bin/sh -e', the check is in an if, - # as grep count maybe 0 - # - # Regex elaborated: - # grep -w -> --word-regexp (from the man page) - # Select only those lines containing matches that form whole words. - # The test is that the matching substring must either be at the - # beginning of the line, or preceded by a non-word constituent - # character. Similarly, it must be either at the end of the line or - # followed by a non-word constituent character. Word-constituent - # characters are letters, digits, and the underscore. - # IOW, the above helps us find the pattern with leading or training spaces - # or non word consituents like , or ; - # - # grep -c -> gives us a count of matches, which is all we need here - # - # [fF][iI][xX][eE][sS]|[uU][pP][dD][aA][tT][eE][sS]) - # Finds 'fixes' OR 'updates' in any case combination - # - # (:)? - # Followed by an optional : (colon) - # - # [[:space:]]+ - # followed by 1 or more spaces - # - # (gluster\/glusterfs)? - # Followed by 0 or more gluster/glusterfs - # - # # - # Followed by # - # - # [[:digit:]]+ - # Followed by 1 or more digits - if [ 0 = "$(git log --format=%B -n 1 | grep -cow -E "([fF][iI][xX][eE][sS]|[uU][pP][dD][aA][tT][eE][sS])(:)?[[:space:]]+(gluster\/glusterfs)?#[[:digit:]]+")" ]; then - moveon='N' - github_issue_message; - echo -n "Missing github issue reference in a potential RFE. Continue (y/N): " - read moveon - if [ "${moveon}" = 'Y' ] || [ "${moveon}" = 'y' ]; then - return; - else - exit 1 - fi + echo -n "Missing reference to a github issue. Continue (y/N): " + read moveon + if [ "${moveon}" = 'Y' ] || [ "${moveon}" = 'y' ]; then + return; + else + exit 1 fi } @@ -286,7 +280,7 @@ main() return; fi - check_patches_for_coding_style; + git fetch $UPSTREAM; rebase_changes; @@ -294,15 +288,31 @@ main() assert_diverge; - bug=$(git show --format='%b' | grep -i '^BUG: ' | awk '{print $2}'); + # see note above variable REFRE for regex elaboration + reference=$(git log -n1 --format='%b' | grep -iow -E "${REFRE}" | awk -F '#' '{print $2}'); - # If this is a commit against master and does not have a bug ID - # it could be a feature or an RFE, check if there is a github - # issue reference, and if not suggest commit message amendment - if [ -z "$bug" ] && [ $branch = "master" ]; then - check_for_github_issue; + # If this is a commit against 'devel' and does not have a github + # issue reference. Warn the contributor that one of the 2 is required + if [ -z "${reference}" ] && [ $branch = "devel" ]; then + warn_reference_missing; fi + # TODO: add clang-format command here. It will after the changes are done everywhere else + clang_format=$(clang-format --version) + if [ ! -z "${clang_format}" ]; then + # Considering git show may not give any files as output matching the + # criteria, good to tell script not to fail on error + set +e + list_of_files=$(git show --pretty="format:" --name-only | + grep -v "contrib/" | egrep --color=never "*\.[ch]$"); + if [ ! -z "${list_of_files}" ]; then + echo "${list_of_files}" | xargs clang-format -i + fi + set -e + else + echo "High probability of your patch not passing smoke due to coding standard check" + echo "Please install 'clang-format' to format the patch before submitting" + fi if [ "$DRY_RUN" = 1 ]; then drier='echo -e Please use the following command to send your commits to review:\n\n' @@ -310,10 +320,10 @@ main() drier= fi - if [ -z "$bug" ]; then - $drier git push origin HEAD:refs/for/$branch/rfc; + if [ -z "${reference}" ]; then + $drier git push $USER_REPO HEAD:temp_${branch}/$(date +%Y-%m-%d_%s); else - $drier git push origin HEAD:refs/for/$branch/bug-$bug; + $drier git push $USER_REPO HEAD:issue${reference}_${branch}; fi } |