You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by ct...@apache.org on 2016/01/22 18:58:08 UTC
[02/12] accumulo git commit: ACCUMULO-4109 Automate RC builds more
ACCUMULO-4109 Automate RC builds more
Prompt for minimal information and automate release candidate staging
and branching as much as possible
* Colorize output
* Ensure it passes shellcheck
* Handle failures wherever possible
* Handle creating test RCs easier, with --extraReleaseArgs
* Attempt to handle differences in credential caching support in gpg/gpg2
* Log output of mvn to a temp file for review
* Verify branches after release candidate is pushed
* Provide assistance uploading branches for voting
* Provide instructions on next steps
Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/34bd2633
Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/34bd2633
Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/34bd2633
Branch: refs/heads/1.7
Commit: 34bd2633584b827834c47461c705f0493304e600
Parents: 27300d8
Author: Christopher Tubbs <ct...@apache.org>
Authored: Wed Jan 13 22:45:03 2016 -0500
Committer: Christopher Tubbs <ct...@apache.org>
Committed: Fri Jan 22 12:09:46 2016 -0500
----------------------------------------------------------------------
assemble/build.sh | 279 +++++++++++++++++++++++++++++++++++++------------
pom.xml | 4 +-
2 files changed, 214 insertions(+), 69 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/accumulo/blob/34bd2633/assemble/build.sh
----------------------------------------------------------------------
diff --git a/assemble/build.sh b/assemble/build.sh
index 0f76376..76bbb48 100755
--- a/assemble/build.sh
+++ b/assemble/build.sh
@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
@@ -15,134 +15,277 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-loc=`dirname "$0"`
-loc=`cd "$loc/.."; pwd`
+cd "$(dirname "$0")/.." || exit 1
+scriptname=$(basename "$0")
-cd "$loc"
+# check for gpg2
+hash gpg2 2>/dev/null && gpgCommand=gpg2 || gpgCommand=gpg
-fail() {
- echo ' ' $@
- exit 1
+# check if running in a color terminal
+terminalSupportsColor() {
+ local c; c=$(tput colors 2>/dev/null) || c=-1
+ [[ -t 1 ]] && [[ $c -ge 8 ]]
}
+terminalSupportsColor && doColor=1 || doColor=0
-run() {
- echo $@
- eval $@
- if [ $? -ne 0 ]
- then
- fail $@ fails
- fi
-}
+color() { local c; c=$1; shift; [[ $doColor -eq 1 ]] && echo -e "\\e[0;${c}m${*}\\e[0m" || echo "$@"; }
+red() { color 31 "$@"; }
+green() { color 32 "$@"; }
+yellow() { color 33 "$@"; }
-runAt() {
- ( cd $1 ; echo in `pwd`; shift ; run $@ ) || fail
-}
+fail() { echo -e ' ' "$@"; exit 1; }
+runLog() { local o; o=$1 && shift && echo "$(green Running) $(yellow "$@" '>>' "$o")" && echo Running "$@" >> "$o" && eval "$@" >> "$o"; }
+run() { echo "$(green Running) $(yellow "$@")" && eval "$@"; }
+runOrFail() { run "$@" || fail "$(yellow "$@")" "$(red failed)"; }
+
+currentBranch() { local b; b=$(git symbolic-ref -q HEAD) && echo "${b##refs/heads/}"; }
cacheGPG() {
# make sure gpg agent has key cached
# TODO prompt for key instead of using default?
- TESTFILE="/tmp/${USER}-gpgTestFile-$(date -u +%s).txt"
- touch "${TESTFILE}" && gpg --sign "${TESTFILE}" && rm -f "${TESTFILE}" "${TESTFILE}.gpg"
+ local TESTFILE; TESTFILE=$(mktemp --tmpdir "${USER}-gpgTestFile-XXXXXXXX.txt")
+ [[ -r $TESTFILE ]] && "$gpgCommand" --sign "${TESTFILE}" && rm -f "${TESTFILE}" "${TESTFILE}.gpg"
}
+prompter() {
+ # $1 description; $2 pattern to validate against
+ local x
+ read -r -p "Enter the $1: " x
+ until eval "[[ \$x =~ ^$2\$ ]]"; do
+ echo " $(red "$x") is not a proper $1" 1>&2
+ read -r -p "Enter the $1: " x
+ done
+ echo "$x"
+}
+
+pretty() { local f; f=$1; shift; git log "--pretty=tformat:$f" "$@"; }
+gitCommits() { pretty %H "$@"; }
+gitCommit() { gitCommits -n1 "$@"; }
+gitSubject() { pretty %s "$@"; }
+
createEmail() {
- read -p 'Enter the staging repository number: ' stagingrepo
- read -p 'Enter the version to be released (eg. x.y.z): ' tag
- read -p 'Enter the release candidate number (eg. 1, 2, etc.): ' rc
+ # $1 version (optional); $2 rc seqence num (optional); $3 staging repo num (optional)
+ local ver; [[ -n $1 ]] && ver=$1 || ver=$(prompter 'version to be released (eg. x.y.z)' '[0-9]+[.][0-9]+[.][0-9]+')
+ local rc; [[ -n $2 ]] && rc=$2 || rc=$(prompter 'release candidate sequence number (eg. 1, 2, etc.)' '[0-9]+')
+ local stagingrepo; [[ -n $3 ]] && stagingrepo=$3 || stagingrepo=$(prompter 'staging repository number from https://repository.apache.org/#stagingRepositories' '[0-9]+')
- commit=$(git show $tag -n1 --pretty=raw --no-color | head -1 | awk '{print $2}')
- branch=$tag-rc$rc
+ local branch; branch=$ver-rc$rc
+ local commit; commit=$(gitCommit "$branch") || exit 1
+ local tag; tag=rel/$ver
echo
- echo "IMPORTANT!! IMPORTANT!! IMPORTANT!! IMPORTANT!! IMPORTANT!! IMPORTANT!!"
+ yellow "IMPORTANT!! IMPORTANT!! IMPORTANT!! IMPORTANT!! IMPORTANT!! IMPORTANT!!"
echo
- echo " Don't forget to push a branch named $branch with"
- echo " its head at ${commit:0:7} so people can review!"
+ echo " Don't forget to push a branch named $(green "$branch") with"
+ echo " its head at $(green "${commit:0:7}") so others can review using:"
+ echo " $(green "git push origin ${commit:0:7}:refs/heads/$branch")"
echo
- echo " However, do *NOT* push the $tag tag until after the vote"
- echo " passes and the tag is re-made with a gpg signature using"
- echo " \`git tag -f -m 'Apache Accumulo $tag' -s rel/$tag ${commit:0:7}\`"
+ echo " Remember, $(red DO NOT PUSH) the $(red "$tag") tag until after the vote"
+ echo " passes and the tag is re-made with a gpg signature using:"
+ echo " $(red "git tag -f -m 'Apache Accumulo $ver' -s $tag ${commit:0:7}")"
echo
- echo "IMPORTANT!! IMPORTANT!! IMPORTANT!! IMPORTANT!! IMPORTANT!! IMPORTANT!!"
+ yellow "IMPORTANT!! IMPORTANT!! IMPORTANT!! IMPORTANT!! IMPORTANT!! IMPORTANT!!"
echo
- read -p 'Press Enter to generate the [VOTE] email...' rc
+ read -r -s -p 'Press Enter to generate the [VOTE] email...'
+ echo 1>&2
# compute the date with a buffer of 30 minutes
- votedate=$(date -d "+3 days 30 minutes" "+%s")
+ local votedate; votedate=$(date -d "+3 days 30 minutes" "+%s")
# round back to the previous half-hour
- halfhour=$(($votedate - ($votedate % 1800)))
+ local halfhour; halfhour=$((votedate - (votedate % 1800)))
votedate=$(date -u -d"1970-01-01 $halfhour seconds UTC")
export TZ="America/New_York"
- edtvotedate=$(date -d"1970-01-01 $halfhour seconds UTC")
+ local edtvotedate; edtvotedate=$(date -d"1970-01-01 $halfhour seconds UTC")
export TZ="America/Los_Angeles"
- pdtvotedate=$(date -d"1970-01-01 $halfhour seconds UTC")
+ local pdtvotedate; pdtvotedate=$(date -d"1970-01-01 $halfhour seconds UTC")
- cat <<EOF
-============================================================
-Subject: [VOTE] Accumulo $branch
-============================================================
+ local fingerprint; fingerprint=$("$gpgCommand" --list-secret-keys --with-colons --with-fingerprint 2>/dev/null | awk -F: '$1 == "fpr" {print $10}')
+ [[ -z $fingerprint ]] && fingerprint="UNSPECIFIED"
+ cat <<EOF
+$(yellow '============================================================')
+Subject: $(green [VOTE] Accumulo "$branch")
+$(yellow '============================================================')
Accumulo Developers,
-Please consider the following candidate for Accumulo $tag.
+Please consider the following candidate for Accumulo $(green "$ver").
Git Commit:
- $commit
+ $(green "$commit")
Branch:
- $branch
+ $(green "$branch")
If this vote passes, a gpg-signed tag will be created using:
- git tag -f -m 'Apache Accumulo $tag' -s rel/$tag $commit
+ $(green "git tag -f -m 'Apache Accumulo $ver' -s $tag $commit")
-Staging repo: https://repository.apache.org/content/repositories/orgapacheaccumulo-$stagingrepo
-Source (official release artifact): https://repository.apache.org/content/repositories/orgapacheaccumulo-$stagingrepo/org/apache/accumulo/accumulo/$tag/accumulo-$tag-src.tar.gz
-Binary: https://repository.apache.org/content/repositories/orgapacheaccumulo-$stagingrepo/org/apache/accumulo/accumulo/$tag/accumulo-$tag-bin.tar.gz
+Staging repo: $(green "https://repository.apache.org/content/repositories/orgapacheaccumulo-$stagingrepo")
+Source (official release artifact): $(green "https://repository.apache.org/content/repositories/orgapacheaccumulo-$stagingrepo/org/apache/accumulo/accumulo/$ver/accumulo-$ver-src.tar.gz")
+Binary: $(green "https://repository.apache.org/content/repositories/orgapacheaccumulo-$stagingrepo/org/apache/accumulo/accumulo/$ver/accumulo-$ver-bin.tar.gz")
(Append ".sha1", ".md5", or ".asc" to download the signature/hash for a given artifact.)
All artifacts were built and staged with:
mvn release:prepare && mvn release:perform
Signing keys are available at https://www.apache.org/dist/accumulo/KEYS
-(Expected fingerprint: $(gpg --list-secret-keys --with-colons --with-fingerprint | awk -F: '$1 == "fpr" {print $10}'))
+(Expected fingerprint: $(green "$fingerprint"))
-Release notes (in progress) can be found at https://accumulo.apache.org/release_notes/$tag
+Release notes (in progress) can be found at: $(green "https://accumulo.apache.org/release_notes/$ver")
Please vote one of:
[ ] +1 - I have verified and accept...
[ ] +0 - I have reservations, but not strong enough to vote against...
[ ] -1 - Because..., I do not accept...
-... these artifacts as the $tag release of Apache Accumulo.
+... these artifacts as the $(green "$ver") release of Apache Accumulo.
-This vote will end on $votedate
-($edtvotedate / $pdtvotedate)
+This vote will end on $(green "$votedate")
+($(green "$edtvotedate") / $(green "$pdtvotedate"))
Thanks!
P.S. Hint: download the whole staging repo with
wget -erobots=off -r -l inf -np -nH \\
- https://repository.apache.org/content/repositories/orgapacheaccumulo-$stagingrepo/
+ $(green "https://repository.apache.org/content/repositories/orgapacheaccumulo-$stagingrepo/")
# note the trailing slash is needed
-
-============================================================
+$(yellow '============================================================')
EOF
}
-if [[ $1 = '--create-release-candidate' ]]; then
- cacheGPG
+cleanUpAndFail() {
+ # $1 command; $2 log; $3 original branch; $4 next branch
+ echo " Failure in $(red "$1")!"
+ echo " Check output in $(yellow "$2")"
+ echo " Initiating clean up steps..."
+
+ run git checkout "$3"
+
+ # pre-populate branches with expected next branch; de-duplicate later
+ local branches; branches=("$4")
+ local tags; tags=()
+ local x; local y
+ for x in $(gitCommits "${cBranch}..${nBranch}"); do
+ for y in $(git branch --contains "$x" | cut -c3-); do
+ branches=("${branches[@]}" "$y")
+ done
+ for y in $(git tag --contains "$x"); do
+ tags=("${tags[@]}" "$y")
+ done
+ done
+
+ # de-duplicate branches
+ local a
+ branches=($(printf "%s\n" "${branches[@]}" | sort -u))
+ for x in "${branches[@]}"; do
+ echo "Do you wish to clean up (delete) the branch $(yellow "$x")?"
+ a=$(prompter "letter 'y' or 'n'" '[yn]')
+ [[ $a == 'y' ]] && git branch -D "$x"
+ done
+ for x in "${tags[@]}"; do
+ echo "Do you wish to clean up (delete) the tag $(yellow "$x")?"
+ a=$(prompter "letter 'y' or 'n'" '[yn]')
+ [[ $a == 'y' ]] && git tag -d "$x"
+ done
+ exit 1
+}
+
+createReleaseCandidate() {
+ yellow "WARNING!! WARNING!! WARNING!! WARNING!! WARNING!! WARNING!!"
+ echo
+ echo " This will modify your local git repository by creating"
+ echo " branches and tags. Afterwards, you may need to perform"
+ echo " some manual steps to complete the release or to rollback"
+ echo " in the case of failure."
+ echo
+ yellow "WARNING!! WARNING!! WARNING!! WARNING!! WARNING!! WARNING!!"
+ echo
+
+ local extraReleaseArgs; extraReleaseArgs=("$@")
+ if [[ ${#extraReleaseArgs[@]} -ne 0 ]]; then
+ red "CAUTION!! Extra release args may create a non-standard release!!"
+ red "You added '${extraReleaseArgs[*]}'"
+ fi
+ [[ ${#extraReleaseArgs[@]} -eq 0 ]] && [[ $gpgCommand != 'gpg' ]] && extraReleaseArgs=("-Dgpg.executable=$gpgCommand")
+ extraReleaseArgs="-DextraReleaseArgs='${extraReleaseArgs[*]}'"
+
+ local ver
+ ver=$(xmllint --xpath '/*[local-name()="project"]/*[local-name()="version"]/text()' pom.xml)
+ ver=${ver%%-SNAPSHOT}
+ echo "Building release candidate for version: $(green "$ver")"
+
+ local cBranch; cBranch=$(currentBranch) || fail "$(red Failure)" to get current branch from git
+ local rc; rc=$(prompter 'release candidate sequence number (eg. 1, 2, etc.)' '[0-9]+')
+ local rcBranch; rcBranch=$ver-rc$rc
+ local nBranch; nBranch=$rcBranch-next
+
+ cacheGPG || fail "Unable to cache GPG credentials into gpg-agent"
+
+ # create working branch
+ {
+ run git branch "$nBranch" "$cBranch" && run git checkout "$nBranch"
+ } || fail "Unable to create working branch $(red "$nBranch") from $(red "$cBranch")!"
+
# create a release candidate from a branch
- run mvn clean release:clean release:prepare release:perform
-elif [[ $1 = '--seal-jars' ]]; then
+ local oFile; oFile=$(mktemp --tmpdir "accumulo-build-$rcBranch-XXXXXXXX.log")
+ {
+ [[ -w $oFile ]] && runLog "$oFile" mvn clean release:clean
+ } || cleanUpAndFail 'mvn clean release:clean' "$oFile" "$cBranch" "$nBranch"
+ runLog "$oFile" mvn -B release:prepare "${extraReleaseArgs}" || \
+ cleanUpAndFail "mvn release:prepare ${extraReleaseArgs}" "$oFile" "$cBranch" "$nBranch"
+ runLog "$oFile" mvn release:perform "${extraReleaseArgs}" || \
+ cleanUpAndFail "mvn release:perform ${extraReleaseArgs}" "$oFile" "$cBranch" "$nBranch"
+
+ # switch back to original branch
+ run git checkout "${cBranch}"
+
+ # verify the next branch contains both expected log messages and no more
+ {
+ [[ $(gitCommits "${cBranch}..${nBranch}" | wc -l) -eq 2 ]] && \
+ [[ $(gitCommit "${nBranch}~2") == $(gitCommit "${cBranch}") ]] && \
+ [[ $(gitSubject "${nBranch}") =~ ^\[maven-release-plugin\]\ prepare\ for\ next ]] && \
+ [[ $(gitSubject "${nBranch}~1") =~ ^\[maven-release-plugin\]\ prepare\ release\ rel[/]$ver ]]
+ } || cleanUpAndFail "verifying that $nBranch contains only logs from release plugin"
+
+ # verify the tag is one behind $nBranch and one ahead of $cBranch
+ [[ $(gitCommit "${nBranch}~1") == $(gitCommit "refs/tags/rel/$ver") ]] || \
+ cleanUpAndFail "verifying that ${nBranch}~1 == refs/tags/rel/$ver"
+
+ # remove tag which was created
+ run git tag -d "rel/$ver" || \
+ cleanUpAndFail "removing unused git tag rel/$ver"
+
+ # create release candidate branch to vote on
+ run git branch "$rcBranch" "${nBranch}~1" || \
+ cleanUpAndFail "creating branch $rcBranch"
+
+ # push branches (ask first)
+ local origin; origin=$(git remote -v | grep ^origin | grep push | awk '{print $2}')
+ echo "Do you wish to push the following branches to origin ($(green "$origin"))?"
+ echo " $(yellow "$rcBranch") (for others to examine for the vote)"
+ echo " $(yellow "$nBranch") (for merging into $cBranch if vote passes)"
+ local a; a=$(prompter "letter 'y' or 'n'" '[yn]')
+ {
+ [[ $a == 'y' ]] && \
+ run git push -u origin "refs/heads/$nBranch" "refs/heads/$rcBranch"
+ } || red "Did not push branches; you'll need to perform this step manually."
+
+ # continue to creating email notification
+ echo "$(red Running)" "$(yellow "$scriptname" --create-email "$ver" "$rc")"
+ createEmail "$ver" "$rc"
+}
+
+if [[ $1 == '--create-release-candidate' ]]; then
+ shift
+ createReleaseCandidate "$@"
+elif [[ $1 == '--seal-jars' ]]; then
cacheGPG
# build a tag, but with sealed jars
- run mvn clean install \
- -P apache-release,seal-jars,thrift,assemble,docs
-elif [[ $1 = '--test' ]]; then
+ runOrFail mvn clean install -P apache-release,seal-jars,thrift,assemble,docs
+elif [[ $1 == '--test' ]]; then
cacheGPG
# build a tag, but with tests
- run mvn clean install \
- -P apache-release,thrift,assemble,docs
-elif [[ $1 = '--create-email' ]]; then
- createEmail
+ runOrFail mvn clean install -P apache-release,thrift,assemble,docs
+elif [[ $1 == '--create-email' ]]; then
+ shift
+ createEmail "$@"
else
- fail "Missing one of: --create-release-candidate, --test, --seal-jars, --create-email"
+ fail "Missing one of: $(red --create-release-candidate), $(red --test), $(red --seal-jars), $(red --create-email)"
fi
http://git-wip-us.apache.org/repos/asf/accumulo/blob/34bd2633/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index de8302c..3238007 100644
--- a/pom.xml
+++ b/pom.xml
@@ -122,6 +122,8 @@
<bouncycastle.version>1.50</bouncycastle.version>
<!-- relative path for Eclipse format; should override in child modules if necessary -->
<eclipseFormatterStyle>${project.parent.basedir}/contrib/Eclipse-Accumulo-Codestyle.xml</eclipseFormatterStyle>
+ <!-- extra release args for testing -->
+ <extraReleaseArgs />
<!-- findbugs-maven-plugin won't work on jdk8 or later; set to 3.0.0 or newer -->
<findbugs.version>2.5.5</findbugs.version>
<!-- surefire/failsafe plugin option -->
@@ -621,7 +623,7 @@
<!-- Work around MRELEASE-812 -->
<version>2.5</version>
<configuration>
- <arguments>-P !autoformat,apache-release,thrift,assemble,docs,sunny -Dtimeout.factor=2</arguments>
+ <arguments>-P !autoformat,apache-release,thrift,assemble,docs,sunny -Dtimeout.factor=2 ${extraReleaseArgs}</arguments>
<autoVersionSubmodules>true</autoVersionSubmodules>
<goals>clean deploy</goals>
<preparationGoals>clean verify</preparationGoals>