#!/usr/bin/env bash # 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. #set -x ulimit -n 1024 ### Setup some variables. ### SVN_REVISION and BUILD_URL are set by Hudson if it is run by patch process ### Read variables from properties file bindir=$(dirname $0) # Defaults if [ -z "$MAVEN_HOME" ]; then MVN=mvn else MVN=$MAVEN_HOME/bin/mvn fi PROJECT_NAME=Hbase JENKINS=false PATCH_DIR=/tmp SUPPORT_DIR=/tmp BASEDIR=$(pwd) PS=${PS:-ps} AWK=${AWK:-awk} WGET=${WGET:-wget} SVN=${SVN:-svn} GREP=${GREP:-grep} PATCH=${PATCH:-patch} JIRACLI=${JIRA:-jira} FINDBUGS_HOME=${FINDBUGS_HOME} FORREST_HOME=${FORREST_HOME} ECLIPSE_HOME=${ECLIPSE_HOME} ############################################################################### printUsage() { echo "Usage: $0 [options] patch-file | defect-number" echo echo "Where:" echo " patch-file is a local patch file containing the changes to test" echo " defect-number is a JIRA defect number (e.g. 'HADOOP-1234') to test (Jenkins only)" echo echo "Options:" echo "--patch-dir= The directory for working and output files (default '/tmp')" echo "--basedir= The directory to apply the patch to (default current directory)" echo "--mvn-cmd= The 'mvn' command to use (default \$MAVEN_HOME/bin/mvn, or 'mvn')" echo "--ps-cmd= The 'ps' command to use (default 'ps')" echo "--awk-cmd= The 'awk' command to use (default 'awk')" echo "--svn-cmd= The 'svn' command to use (default 'svn')" echo "--grep-cmd= The 'grep' command to use (default 'grep')" echo "--patch-cmd= The 'patch' command to use (default 'patch')" echo "--findbugs-home= Findbugs home directory (default FINDBUGS_HOME environment variable)" echo "--forrest-home= Forrest home directory (default FORREST_HOME environment variable)" echo "--dirty-workspace Allow the local SVN workspace to have uncommitted changes" echo echo "Jenkins-only options:" echo "--jenkins Run by Jenkins (runs tests and posts results to JIRA)" echo "--support-dir= The directory to find support files in" echo "--wget-cmd= The 'wget' command to use (default 'wget')" echo "--jira-cmd= The 'jira' command to use (default 'jira')" echo "--jira-password= The password for the 'jira' command" echo "--eclipse-home= Eclipse home directory (default ECLIPSE_HOME environment variable)" } ############################################################################### parseArgs() { for i in $* do case $i in --jenkins) JENKINS=true ;; --patch-dir=*) PATCH_DIR=${i#*=} ;; --support-dir=*) SUPPORT_DIR=${i#*=} ;; --basedir=*) BASEDIR=${i#*=} ;; --mvn-cmd=*) MVN=${i#*=} ;; --ps-cmd=*) PS=${i#*=} ;; --awk-cmd=*) AWK=${i#*=} ;; --wget-cmd=*) WGET=${i#*=} ;; --svn-cmd=*) SVN=${i#*=} ;; --grep-cmd=*) GREP=${i#*=} ;; --patch-cmd=*) PATCH=${i#*=} ;; --jira-cmd=*) JIRACLI=${i#*=} ;; --jira-password=*) JIRA_PASSWD=${i#*=} ;; --findbugs-home=*) FINDBUGS_HOME=${i#*=} ;; --forrest-home=*) FORREST_HOME=${i#*=} ;; --eclipse-home=*) ECLIPSE_HOME=${i#*=} ;; --dirty-workspace) DIRTY_WORKSPACE=true ;; *) PATCH_OR_DEFECT=$i ;; esac done if [ -z "$PATCH_OR_DEFECT" ]; then printUsage exit 1 fi if [[ $JENKINS == "true" ]] ; then echo "Running in Jenkins mode" defect=$PATCH_OR_DEFECT ECLIPSE_PROPERTY="-Declipse.home=$ECLIPSE_HOME" else echo "Running in developer mode" JENKINS=false ### PATCH_FILE contains the location of the patchfile PATCH_FILE=$PATCH_OR_DEFECT if [[ ! -e "$PATCH_FILE" ]] ; then echo "Unable to locate the patch file $PATCH_FILE" cleanupAndExit 0 fi ### Check if $PATCH_DIR exists. If it does not exist, create a new directory if [[ ! -e "$PATCH_DIR" ]] ; then mkdir "$PATCH_DIR" if [[ $? == 0 ]] ; then echo "$PATCH_DIR has been created" else echo "Unable to create $PATCH_DIR" cleanupAndExit 0 fi fi ### Obtain the patch filename to append it to the version number defect=`basename $PATCH_FILE` fi } ############################################################################### checkout () { echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Testing patch for ${defect}." echo "======================================================================" echo "======================================================================" echo "" echo "" ### When run by a developer, if the workspace contains modifications, do not continue ### unless the --dirty-workspace option was set status=`$SVN stat --ignore-externals | sed -e '/^X[ ]*/D'` if [[ $JENKINS == "false" ]] ; then if [[ "$status" != "" && -z $DIRTY_WORKSPACE ]] ; then echo "ERROR: can't run in a workspace that contains the following modifications" echo "$status" cleanupAndExit 1 fi echo else cd $BASEDIR $SVN revert -R . rm -rf `$SVN status --no-ignore` $SVN update fi return $? } ############################################################################### setup () { ### Download latest patch file (ignoring .htm and .html) when run from patch process if [[ $JENKINS == "true" ]] ; then $WGET -q -O $PATCH_DIR/jira http://issues.apache.org/jira/browse/$defect if [[ `$GREP -c 'Patch Available' $PATCH_DIR/jira` == 0 ]] ; then echo "$defect is not \"Patch Available\". Exiting." cleanupAndExit 0 fi relativePatchURL=`$GREP -o '"/jira/secure/attachment/[0-9]*/[^"]*' $PATCH_DIR/jira | $GREP -v -e 'htm[l]*$' | sort | tail -1 | $GREP -o '/jira/secure/attachment/[0-9]*/[^"]*'` patchURL="http://issues.apache.org${relativePatchURL}" patchNum=`echo $patchURL | $GREP -o '[0-9]*/' | $GREP -o '[0-9]*'` echo "$defect patch is being downloaded at `date` from" echo "$patchURL" $WGET -q -O $PATCH_DIR/patch $patchURL VERSION=${SVN_REVISION}_${defect}_PATCH-${patchNum} JIRA_COMMENT="Here are the results of testing the latest attachment $patchURL against trunk revision ${SVN_REVISION}." ### Copy in any supporting files needed by this process cp -r $SUPPORT_DIR/lib/* ./lib #PENDING: cp -f $SUPPORT_DIR/etc/checkstyle* ./src/test ### Copy the patch file to $PATCH_DIR else VERSION=PATCH-${defect} cp $PATCH_FILE $PATCH_DIR/patch if [[ $? == 0 ]] ; then echo "Patch file $PATCH_FILE copied to $PATCH_DIR" else echo "Could not copy $PATCH_FILE to $PATCH_DIR" cleanupAndExit 0 fi fi . $BASEDIR/dev-support/test-patch.properties ### exit if warnings are NOT defined in the properties file if [ -z "$OK_FINDBUGS_WARNINGS" ] || [[ -z "$OK_JAVADOC_WARNINGS" ]] || [[ -z $OK_RELEASEAUDIT_WARNINGS ]] ; then echo "Please define the following properties in test-patch.properties file" echo "OK_FINDBUGS_WARNINGS" echo "OK_RELEASEAUDIT_WARNINGS" echo "OK_JAVADOC_WARNINGS" cleanupAndExit 1 fi echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Pre-build trunk to verify trunk stability and javac warnings" echo "======================================================================" echo "======================================================================" echo "" echo "" echo "$MVN clean compile -DskipTests -D${PROJECT_NAME}PatchProcess > $PATCH_DIR/trunkJavacWarnings.txt 2>&1" $MVN clean compile -DskipTests -D${PROJECT_NAME}PatchProcess > $PATCH_DIR/trunkJavacWarnings.txt 2>&1 if [[ $? != 0 ]] ; then echo "Trunk compilation is broken?" cleanupAndExit 1 fi } ############################################################################### ### Check for @author tags in the patch checkAuthor () { echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Checking there are no @author tags in the patch." echo "======================================================================" echo "======================================================================" echo "" echo "" authorTags=`$GREP -c -i '@author' $PATCH_DIR/patch` echo "There appear to be $authorTags @author tags in the patch." if [[ $authorTags != 0 ]] ; then JIRA_COMMENT="$JIRA_COMMENT -1 @author. The patch appears to contain $authorTags @author tags which the Hadoop community has agreed to not allow in code contributions." return 1 fi JIRA_COMMENT="$JIRA_COMMENT +1 @author. The patch does not contain any @author tags." return 0 } ############################################################################### ### Check for tests in the patch checkTests () { echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Checking there are new or changed tests in the patch." echo "======================================================================" echo "======================================================================" echo "" echo "" testReferences=`$GREP -c -i '/test' $PATCH_DIR/patch` echo "There appear to be $testReferences test files referenced in the patch." if [[ $testReferences == 0 ]] ; then if [[ $JENKINS == "true" ]] ; then patchIsDoc=`$GREP -c -i 'title="documentation' $PATCH_DIR/jira` if [[ $patchIsDoc != 0 ]] ; then echo "The patch appears to be a documentation patch that doesn't require tests." JIRA_COMMENT="$JIRA_COMMENT +0 tests included. The patch appears to be a documentation patch that doesn't require tests." return 0 fi fi JIRA_COMMENT="$JIRA_COMMENT -1 tests included. The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch." return 1 fi JIRA_COMMENT="$JIRA_COMMENT +1 tests included. The patch appears to include $testReferences new or modified tests." return 0 } ############################################################################### ### Attempt to apply the patch applyPatch () { echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Applying patch." echo "======================================================================" echo "======================================================================" echo "" echo "" $PATCH -p0 -E < $PATCH_DIR/patch if [[ $? != 0 ]] ; then echo "PATCH APPLICATION FAILED" JIRA_COMMENT="$JIRA_COMMENT -1 patch. The patch command could not apply the patch." return 1 fi return 0 } ############################################################################### ### Check there are no javadoc warnings checkJavadocWarnings () { echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Determining number of patched javadoc warnings." echo "======================================================================" echo "======================================================================" echo "" echo "" echo "$MVN clean compile javadoc:javadoc -DskipTests -D${PROJECT_NAME}PatchProcess > $PATCH_DIR/patchJavadocWarnings.txt 2>&1" $MVN clean compile javadoc:javadoc -DskipTests -D${PROJECT_NAME}PatchProcess > $PATCH_DIR/patchJavadocWarnings.txt 2>&1 javadocWarnings=`$GREP '\[WARNING\]' $PATCH_DIR/patchJavadocWarnings.txt | $AWK '/Javadoc Warnings/,EOF' | $GREP warning | $AWK 'BEGIN {total = 0} {total += 1} END {print total}'` echo "" echo "" echo "There appear to be $javadocWarnings javadoc warnings generated by the patched build." ### if current warnings greater than OK_JAVADOC_WARNINGS if [[ $javadocWarnings > $OK_JAVADOC_WARNINGS ]] ; then JIRA_COMMENT="$JIRA_COMMENT -1 javadoc. The javadoc tool appears to have generated `expr $(($javadocWarnings-$OK_JAVADOC_WARNINGS))` warning messages." return 1 fi JIRA_COMMENT="$JIRA_COMMENT +1 javadoc. The javadoc tool did not generate any warning messages." return 0 } ############################################################################### ### Check there are no changes in the number of Javac warnings checkJavacWarnings () { echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Determining number of patched javac warnings." echo "======================================================================" echo "======================================================================" echo "" echo "" echo "$MVN clean compile -DskipTests -D${PROJECT_NAME}PatchProcess > $PATCH_DIR/patchJavacWarnings.txt 2>&1" $MVN clean compile -DskipTests -D${PROJECT_NAME}PatchProcess > $PATCH_DIR/patchJavacWarnings.txt 2>&1 if [[ $? != 0 ]] ; then JIRA_COMMENT="$JIRA_COMMENT -1 javac. The patch appears to cause mvn compile goal to fail." return 1 fi ### Compare trunk and patch javac warning numbers if [[ -f $PATCH_DIR/patchJavacWarnings.txt ]] ; then trunkJavacWarnings=`$GREP '\[WARNING\]' $PATCH_DIR/trunkJavacWarnings.txt | $AWK 'BEGIN {total = 0} {total += 1} END {print total}'` patchJavacWarnings=`$GREP '\[WARNING\]' $PATCH_DIR/patchJavacWarnings.txt | $AWK 'BEGIN {total = 0} {total += 1} END {print total}'` echo "There appear to be $trunkJavacWarnings javac compiler warnings before the patch and $patchJavacWarnings javac compiler warnings after applying the patch." if [[ $patchJavacWarnings != "" && $trunkJavacWarnings != "" ]] ; then if [[ $patchJavacWarnings -gt $trunkJavacWarnings ]] ; then JIRA_COMMENT="$JIRA_COMMENT -1 javac. The applied patch generated $patchJavacWarnings javac compiler warnings (more than the trunk's current $trunkJavacWarnings warnings)." return 1 fi fi fi JIRA_COMMENT="$JIRA_COMMENT +1 javac. The applied patch does not increase the total number of javac compiler warnings." return 0 } ############################################################################### ### Check there are no changes in the number of release audit (RAT) warnings checkReleaseAuditWarnings () { echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Determining number of patched release audit warnings." echo "======================================================================" echo "======================================================================" echo "" echo "" echo "$MVN apache-rat:check -D${PROJECT_NAME}PatchProcess 2>&1" $MVN apache-rat:check -D${PROJECT_NAME}PatchProcess 2>&1 find $BASEDIR -name rat.txt | xargs cat > $PATCH_DIR/patchReleaseAuditWarnings.txt ### Compare trunk and patch release audit warning numbers if [[ -f $PATCH_DIR/patchReleaseAuditWarnings.txt ]] ; then patchReleaseAuditWarnings=`$GREP -c '\!?????' $PATCH_DIR/patchReleaseAuditWarnings.txt` echo "" echo "" echo "There appear to be $OK_RELEASEAUDIT_WARNINGS release audit warnings before the patch and $patchReleaseAuditWarnings release audit warnings after applying the patch." if [[ $patchReleaseAuditWarnings != "" && $OK_RELEASEAUDIT_WARNINGS != "" ]] ; then if [[ $patchReleaseAuditWarnings -gt $OK_RELEASEAUDIT_WARNINGS ]] ; then JIRA_COMMENT="$JIRA_COMMENT -1 release audit. The applied patch generated $patchReleaseAuditWarnings release audit warnings (more than the trunk's current $OK_RELEASEAUDIT_WARNINGS warnings)." $GREP '\!?????' $PATCH_DIR/patchReleaseAuditWarnings.txt > $PATCH_DIR/patchReleaseAuditProblems.txt echo "Lines that start with ????? in the release audit report indicate files that do not have an Apache license header." >> $PATCH_DIR/patchReleaseAuditProblems.txt JIRA_COMMENT_FOOTER="Release audit warnings: $BUILD_URL/artifact/trunk/patchprocess/patchReleaseAuditProblems.txt $JIRA_COMMENT_FOOTER" return 1 fi fi fi JIRA_COMMENT="$JIRA_COMMENT +1 release audit. The applied patch does not increase the total number of release audit warnings." return 0 } ############################################################################### ### Check there are no changes in the number of Checkstyle warnings checkStyle () { echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Determining number of patched checkstyle warnings." echo "======================================================================" echo "======================================================================" echo "" echo "" echo "THIS IS NOT IMPLEMENTED YET" echo "" echo "" echo "$MVN compile checkstyle:checkstyle -D${PROJECT_NAME}PatchProcess" $MVN compile checkstyle:checkstyle -D${PROJECT_NAME}PatchProcess JIRA_COMMENT_FOOTER="Checkstyle results: $BUILD_URL/artifact/trunk/build/test/checkstyle-errors.html $JIRA_COMMENT_FOOTER" ### TODO: calculate actual patchStyleErrors # patchStyleErrors=0 # if [[ $patchStyleErrors != 0 ]] ; then # JIRA_COMMENT="$JIRA_COMMENT # # -1 checkstyle. The patch generated $patchStyleErrors code style errors." # return 1 # fi # JIRA_COMMENT="$JIRA_COMMENT # # +1 checkstyle. The patch generated 0 code style errors." return 0 } ############################################################################### ### Check there are no changes in the number of Findbugs warnings checkFindbugsWarnings () { findbugs_version=`${FINDBUGS_HOME}/bin/findbugs -version` echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Determining number of patched Findbugs warnings." echo "======================================================================" echo "======================================================================" echo "" echo "" echo "$MVN clean compile findbugs:findbugs -D${PROJECT_NAME}PatchProcess" $MVN clean compile findbugs:findbugs -D${PROJECT_NAME}PatchProcess < /dev/null if [ $? != 0 ] ; then JIRA_COMMENT="$JIRA_COMMENT -1 findbugs. The patch appears to cause Findbugs (version ${findbugs_version}) to fail." return 1 fi findbugsWarnings=0 for file in $(find $BASEDIR -name findbugsXml.xml) do relative_file=${file#$BASEDIR/} # strip leading $BASEDIR prefix if [ ! $relative_file == "target/findbugsXml.xml" ]; then module_suffix=${relative_file%/target/findbugsXml.xml} # strip trailing path module_suffix=`basename ${module_suffix}` fi cp $file $PATCH_DIR/patchFindbugsWarnings${module_suffix}.xml $FINDBUGS_HOME/bin/setBugDatabaseInfo -timestamp "01/01/2000" \ $PATCH_DIR/patchFindbugsWarnings${module_suffix}.xml \ $PATCH_DIR/patchFindbugsWarnings${module_suffix}.xml newFindbugsWarnings=`$FINDBUGS_HOME/bin/filterBugs -first "01/01/2000" $PATCH_DIR/patchFindbugsWarnings${module_suffix}.xml \ $PATCH_DIR/newPatchFindbugsWarnings${module_suffix}.xml | $AWK '{print $1}'` echo "Found $newFindbugsWarnings Findbugs warnings ($file)" findbugsWarnings=$((findbugsWarnings+newFindbugsWarnings)) $FINDBUGS_HOME/bin/convertXmlToText -html \ $PATCH_DIR/newPatchFindbugsWarnings${module_suffix}.xml \ $PATCH_DIR/newPatchFindbugsWarnings${module_suffix}.html JIRA_COMMENT_FOOTER="Findbugs warnings: $BUILD_URL/artifact/trunk/patchprocess/newPatchFindbugsWarnings${module_suffix}.html $JIRA_COMMENT_FOOTER" done ### if current warnings greater than OK_FINDBUGS_WARNINGS if [[ $findbugsWarnings > $OK_FINDBUGS_WARNINGS ]] ; then JIRA_COMMENT="$JIRA_COMMENT -1 findbugs. The patch appears to introduce `expr $(($findbugsWarnings-$OK_FINDBUGS_WARNINGS))` new Findbugs (version ${findbugs_version}) warnings." return 1 fi JIRA_COMMENT="$JIRA_COMMENT +1 findbugs. The patch does not introduce any new Findbugs (version ${findbugs_version}) warnings." return 0 } ############################################################################### ### Run the tests runTests () { echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Running tests." echo "======================================================================" echo "======================================================================" echo "" echo "" failed_tests="" ### Kill any rogue build processes from the last attempt $PS auxwww | $GREP ${PROJECT_NAME}PatchProcess | $AWK '{print $2}' | /usr/bin/xargs -t -I {} /bin/kill -9 {} > /dev/null echo "$MVN clean test -D${PROJECT_NAME}PatchProcess" $MVN clean test -D${PROJECT_NAME}PatchProcess if [[ $? != 0 ]] ; then ### Find and format names of failed tests failed_tests=`find . -name 'TEST*.xml' | xargs $GREP -l -E " /dev/null #echo "$ANT_HOME/bin/ant -Dversion="${VERSION}" -DHadoopPatchProcess= -Dtest.junit.output.format=xml -Dtest.output=no -Dcompile.c++=yes -Dforrest.home=$FORREST_HOME inject-system-faults" #$ANT_HOME/bin/ant -Dversion="${VERSION}" -DHadoopPatchProcess= -Dtest.junit.output.format=xml -Dtest.output=no -Dcompile.c++=yes -Dforrest.home=$FORREST_HOME inject-system-faults echo "NOP" return 0 if [[ $? != 0 ]] ; then JIRA_COMMENT="$JIRA_COMMENT -1 system test framework. The patch failed system test framework compile." return 1 fi JIRA_COMMENT="$JIRA_COMMENT +1 system test framework. The patch passed system test framework compile." return 0 } ############################################################################### ### Submit a comment to the defect's Jira submitJiraComment () { local result=$1 ### Do not output the value of JIRA_COMMENT_FOOTER when run by a developer if [[ $JENKINS == "false" ]] ; then JIRA_COMMENT_FOOTER="" fi if [[ $result == 0 ]] ; then comment="+1 overall. $JIRA_COMMENT $JIRA_COMMENT_FOOTER" else comment="-1 overall. $JIRA_COMMENT $JIRA_COMMENT_FOOTER" fi ### Output the test result to the console echo " $comment" if [[ $JENKINS == "true" ]] ; then echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Adding comment to Jira." echo "======================================================================" echo "======================================================================" echo "" echo "" ### Update Jira with a comment export USER=hudson $JIRACLI -s https://issues.apache.org/jira -a addcomment -u hadoopqa -p $JIRA_PASSWD --comment "$comment" --issue $defect $JIRACLI -s https://issues.apache.org/jira -a logout -u hadoopqa -p $JIRA_PASSWD fi } ############################################################################### ### Cleanup files cleanupAndExit () { local result=$1 if [[ $JENKINS == "true" ]] ; then if [ -e "$PATCH_DIR" ] ; then mv $PATCH_DIR $BASEDIR fi fi echo "" echo "" echo "======================================================================" echo "======================================================================" echo " Finished build." echo "======================================================================" echo "======================================================================" echo "" echo "" exit $result } ############################################################################### ############################################################################### ############################################################################### JIRA_COMMENT="" JIRA_COMMENT_FOOTER="Console output: $BUILD_URL/console This message is automatically generated." ### Check if arguments to the script have been specified properly or not parseArgs $@ cd $BASEDIR checkout RESULT=$? if [[ $JENKINS == "true" ]] ; then if [[ $RESULT != 0 ]] ; then exit 100 fi fi setup checkAuthor RESULT=$? checkTests (( RESULT = RESULT + $? )) applyPatch if [[ $? != 0 ]] ; then submitJiraComment 1 cleanupAndExit 1 fi checkJavadocWarnings (( RESULT = RESULT + $? )) checkJavacWarnings (( RESULT = RESULT + $? )) ### Checkstyle not implemented yet #checkStyle #(( RESULT = RESULT + $? )) checkFindbugsWarnings (( RESULT = RESULT + $? )) checkReleaseAuditWarnings (( RESULT = RESULT + $? )) ### Do not call these when run by a developer if [[ $JENKINS == "true" ]] ; then runTests (( RESULT = RESULT + $? )) JIRA_COMMENT_FOOTER="Test results: $BUILD_URL/testReport/ $JIRA_COMMENT_FOOTER" fi submitJiraComment $RESULT cleanupAndExit $RESULT