Teach abuild to emit JUnit formatted build reports
[coreboot.git] / util / abuild / abuild
index 1e67685ffbb438e8a485d160fcc4c53908fc10e5..0ed295ff1826319c6d87172d731d3194041ff156 100755 (executable)
 #  This file is subject to the terms and conditions of the GNU General
 #  Public License. See the file COPYING in the main directory of this
 #  archive for more details.
-#     
+#
 
 #set -x # Turn echo on....
 
-ABUILD_DATE="January 29th, 2010"
-ABUILD_VERSION="0.9"
+ABUILD_DATE="December 10th, 2010"
+ABUILD_VERSION="0.9.1"
 
 # Where shall we place all the build trees?
-TARGET=$( pwd )/coreboot-builds
+TARGET=coreboot-builds
 XMLFILE=$( pwd )/abuild.xml
 
 # path to payload. Should be more generic
 PAYLOAD=/dev/null
 
 # Lines of error context to be printed in FAILURE case
-CONTEXT=5
+CONTEXT=6
 
 TESTSUBMISSION="http://qa.coreboot.org/deployment/send.php"
 
@@ -35,6 +35,9 @@ cpus=1
 # Configure-only mode
 configureonly=0
 
+# Did any board fail to build?
+failed=0
+
 # One might want to adjust these in case of cross compiling
 for i in make gmake gnumake nonexistant_make; do
        $i --version 2>/dev/null |grep "GNU Make" >/dev/null && break
@@ -55,12 +58,21 @@ silent=
 # clang mode enabled by -sb option.
 scanbuild=false
 
+# use ccache
+ccache=false
+
 # stackprotect mode enabled by -ns option.
 stackprotect=false
 
 # loglevel changed with -l / --loglevel option
 loglevel=default
 
+# update existing image
+update=false
+
+# CBFS prefix
+cbfs_prefix=fallback
+
 ARCH=`uname -m | sed -e s/i.86/i386/ -e s/sun4u/sparc64/ \
        -e s/i86pc/i386/ \
        -e s/arm.*/arm/ -e s/sa110/arm/ -e s/x86_64/amd64/ \
@@ -85,17 +97,32 @@ function debug
 function xml
 {
        test "$mode" == "xml" && printf "$*\n" >> $XMLFILE
+       return 0
 }
 
 function xmlfile
 {
-       test "$mode" == "xml" && { 
+       test "$mode" == "xml" && {
                printf '<![CDATA[\n'
                cat $1
-               printf ']]>\n' 
+               printf ']]>\n'
        } >> $XMLFILE
 }
 
+function junit
+{
+       test "$mode" == "junit" && printf "$*\n" >> $XMLFILE
+       return 0
+}
+
+function junitfile
+{
+       test "$mode" == "junit" && {
+               printf '<![CDATA[\n'
+               cat $1
+               printf ']]>\n'
+       } >> $XMLFILE
+}
 
 
 function vendors
@@ -109,9 +136,9 @@ function mainboards
 {
        # make this a function so we can easily select
        # without breaking readability
-       
+
        VENDOR=$1
-       
+
        ls -1 $ROOT/src/mainboard/$VENDOR | grep -v Kconfig
 }
 
@@ -133,7 +160,7 @@ function create_config
        build_dir=$TARGET/${VENDOR}_${MAINBOARD}
 
         # get a working payload for the board if we have one.
-        # the --payload option expects a directory containing 
+        # the --payload option expects a directory containing
        # a shell script payload.sh
        #   Usage: payload.sh [VENDOR] [DEVICE]
        # the script returns an absolute path to the payload binary.
@@ -143,49 +170,63 @@ function create_config
                printf "Using payload $PAYLOAD\n"
        fi
 
-       $MAKE distclean obj=${build_dir}
+       [ "$update" = "true" ] && mv ${build_dir}/coreboot.rom coreboot.rom.tmp
        mkdir -p ${build_dir}
+       mkdir -p $TARGET/sharedutils
+       [ "$update" = "true" ] && mv coreboot.rom.tmp ${build_dir}/coreboot.rom
 
        if [ "$CONFIG" != "" ]; then
                printf "  Using existing configuration $CONFIG ... "
                xml "  <config>$CONFIG</config>"
-               cp $CONFIG .config
+               cp src/mainboard/$VENDOR/$MAINBOARD/$CONFIG ${build_dir}/config.build
        else
                printf "  Creating config file... "
                xml "  <config>autogenerated</config>"
-               grep "depends[\t ]on[\t ]*VENDOR" src/mainboard/$VENDOR/$MAINBOARD/../Kconfig | \
-                       sed "s,^.*\(VENDOR_.*\)[^A-Z0-9_]*,CONFIG_\1=y," > .config
-               grep "config[\t ]*BOARD" src/mainboard/$VENDOR/$MAINBOARD/Kconfig | \
-                       sed "s,^.*\(BOARD_.*\)[^A-Z0-9_]*,CONFIG_\1=y," >> .config
+               grep "if[\t ]*VENDOR" src/mainboard/$VENDOR/$MAINBOARD/../Kconfig | \
+                       sed "s,^.*\(VENDOR_.*\)[^A-Z0-9_]*,CONFIG_\1=y," > ${build_dir}/config.build
+               grep "if[\t ]*BOARD" src/mainboard/$VENDOR/$MAINBOARD/Kconfig | \
+                       sed "s,^.*\(BOARD_.*\)[^A-Z0-9_]*,CONFIG_\1=y," >> ${build_dir}/config.build
                grep "select[\t ]*ARCH" src/mainboard/$VENDOR/$MAINBOARD/Kconfig | \
-                       sed "s,^.*\(ARCH_.*\)[^A-Z0-9_]*,CONFIG_\1=y," >> .config
-               echo "CONFIG_MAINBOARD_DIR=\"$VENDOR/$MAINBOARD\"" >> .config
+                       sed "s,^.*\(ARCH_.*\)[^A-Z0-9_]*,CONFIG_\1=y," >> ${build_dir}/config.build
+               echo "CONFIG_MAINBOARD_DIR=\"$VENDOR/$MAINBOARD\"" >> ${build_dir}/config.build
+               echo "CONFIG_CBFS_PREFIX=\"$cbfs_prefix\"" >> ${build_dir}/config.build
                if [ "$PAYLOAD" != "/dev/null" ]; then
-                       echo "# CONFIG_PAYLOAD_NONE is not set" >> .config
-                       echo "CONFIG_PAYLOAD_ELF=y" >> .config
-                       echo "CONFIG_FALLBACK_PAYLOAD_FILE=\"$PAYLOAD\"" >> .config
+                       echo "# CONFIG_PAYLOAD_NONE is not set" >> ${build_dir}/config.build
+                       echo "# CONFIG_PAYLOAD_SEABIOS is not set" >> ${build_dir}/config.build
+                       echo "CONFIG_PAYLOAD_ELF=y" >> ${build_dir}/config.build
+                       echo "CONFIG_PAYLOAD_FILE=\"$PAYLOAD\"" >> ${build_dir}/config.build
                fi
 
                if [ "$loglevel" != "default" ]; then
                        printf "(loglevel override) "
-                       echo "CONFIG_MAXIMUM_CONSOLE_LOGLEVEL_$loglevel=y" >> .config
-                       echo "CONFIG_MAXIMUM_CONSOLE_LOGLEVEL=$loglevel" >> .config
-                       echo "CONFIG_DEFAULT_CONSOLE_LOGLEVEL_$loglevel=y" >> .config
-                       echo "CONFIG_DEFAULT_CONSOLE_LOGLEVEL=$loglevel" >> .config
+                       echo "CONFIG_MAXIMUM_CONSOLE_LOGLEVEL_$loglevel=y" >> ${build_dir}/config.build
+                       echo "CONFIG_MAXIMUM_CONSOLE_LOGLEVEL=$loglevel" >> ${build_dir}/config.build
+                       echo "CONFIG_DEFAULT_CONSOLE_LOGLEVEL_$loglevel=y" >> ${build_dir}/config.build
+                       echo "CONFIG_DEFAULT_CONSOLE_LOGLEVEL=$loglevel" >> ${build_dir}/config.build
+               fi
+
+               if [ "$update" != "false" ]; then
+                       printf "(update) "
+                       echo "CONFIG_UPDATE_IMAGE=y" >> ${build_dir}/config.build
+               fi
+
+               if [ "$ccache" = "true" ]; then
+                       printf "(ccache enabled) "
+                       echo "CONFIG_CCACHE=y" >> ${build_dir}/config.build
                fi
 
                if [ "$scanbuild" = "true" ]; then
                        printf "(scan-build enabled) "
-                       echo "CONFIG_SCANBUILD_ENABLE=y" >> .config
-                       echo "CONFIG_SCANBUILD_REPORT_LOCATION=\"$TARGET/scan-build-results-tmp\"" >> .config
+                       echo "CONFIG_SCANBUILD_ENABLE=y" >> ${build_dir}/config.build
+                       echo "CONFIG_SCANBUILD_REPORT_LOCATION=\"$TARGET/scan-build-results-tmp\"" >> ${build_dir}/config.build
                fi
        fi
 
-       yes "" | $MAKE oldconfig obj=${build_dir} > ${build_dir}/config.log
+       #yes "" | $MAKE oldconfig -j $cpus obj=${build_dir} objutil=$TARGET/sharedutils &> ${build_dir}/config.log
+       yes "" | $MAKE oldconfig DOTCONFIG=${build_dir}/config.build obj=${build_dir} objutil=$TARGET/sharedutils &> ${build_dir}/config.log
        ret=$?
-       mv .config.old $TARGET/${VENDOR}_${MAINBOARD}/config.in
        if [ $ret -eq 0 ]; then
-               printf "ok\n"
+               printf "ok"
                xml "  <builddir>ok</builddir>"
                xml "  <log>"
                xmlfile $build_dir/config.log
@@ -193,7 +234,8 @@ function create_config
                xml ""
                return 0
        else
-               printf "FAILED! Log excerpt:\n"
+               # Does this ever happen?
+               printf "FAILED!\nLog excerpt:\n"
                xml "  <builddir>failed</builddir>"
                xml "  <log>"
                xmlfile $build_dir/config.log
@@ -209,68 +251,78 @@ function create_buildenv
        VENDOR=$1
        MAINBOARD=$2
        CONFIG=$3
+
        create_config $VENDOR $MAINBOARD $CONFIG
+       ret=$?
+
+       # Allow simple "make" in the target directory
+       MAKEFILE=$TARGET/${VENDOR}_${MAINBOARD}/Makefile
+       echo "# autogenerated" > $MAKEFILE
+       echo "TOP=$ROOT" >> $MAKEFILE
+       echo "BUILD=$TARGET" >> $MAKEFILE
+       echo "OBJ=\$(BUILD)/${VENDOR}_${MAINBOARD}" >> $MAKEFILE
+       echo "OBJUTIL=\$(BUILD)/sharedutils" >> $MAKEFILE
+       echo "all:" >> $MAKEFILE
+       echo "  @cp -a config.h config.h.bak" >> $MAKEFILE
+       echo "  @cd \$(TOP); \$(MAKE) oldconfig DOTCONFIG=\$(OBJ)/config.build objutil=\$(OBJUTIL) obj=\$(OBJ)" >> $MAKEFILE
+       echo "  @tail -n+6 config.h > config.new; tail -n+6 config.h.bak > config.old" >> $MAKEFILE
+       echo "  @cmp -s config.new config.old && cp -a config.h.bak config.h || echo \"Config file changed\"" >> $MAKEFILE
+       echo "  @rm config.h.bak config.new config.old" >> $MAKEFILE
+       echo "  @cd \$(TOP); \$(MAKE) DOTCONFIG=\$(OBJ)/config.build objutil=\$(OBJUTIL) obj=\$(OBJ)" >> $MAKEFILE
+
+       return $ret
 }
 
 function compile_target
-{      
+{
        VENDOR=$1
        MAINBOARD=$2
 
-       printf "  Compiling image "
+       printf " Compiling image "
        test "$cpus" == "" && printf "in parallel .. "
        test "$cpus" == "1" && printf "on 1 cpu .. "
        test 0$cpus -gt 1 && printf "on %d cpus in parallel .. " $cpus
 
        CURR=$( pwd )
-       stime=`perl -e 'print time();' 2>/dev/null || date +%s`
+       #stime=`perl -e 'print time();' 2>/dev/null || date +%s`
        build_dir=$TARGET/${VENDOR}_${MAINBOARD}
-       eval $MAKE $silent -j $cpus obj=${build_dir} \
+       eval $MAKE $silent -j $cpus DOTCONFIG=${build_dir}/config.build obj=${build_dir} objutil=$TARGET/sharedutils \
                &> ${build_dir}/make.log
        ret=$?
-       mv .config ${build_dir}/config.build
        mv .xcompile ${build_dir}/xcompile.build
        cd $TARGET/${VENDOR}_${MAINBOARD}
+
        etime=`perl -e 'print time();' 2>/dev/null || date +%s`
        duration=$(( $etime - $stime ))
+       xml "  <buildtime>${duration}s</buildtime>"
+       junit " <testcase classname='board' name='$TARCH/$VENDOR/$MAINBOARD' time='$duration' >"
+
+       xml "  <log>"
+       xmlfile make.log
+       xml "  </log>"
+
        if [ $ret -eq 0 ]; then
                xml "  <compile>ok</compile>"
-               xml "  <compiletime>${duration}s</compiletime>"
-               xml "  <log>"
-               xmlfile make.log
-               xml "  </log>"
+               junit "<system-out>"
+               junitfile make.log
+               junit "</system-out>"
                printf "ok\n" > compile.status
                printf "ok. (took ${duration}s)\n"
                cd $CURR
                return 0
        else
                xml "  <compile>failed</compile>"
-               xml "  <compiletime>${duration}s</compiletime>"
-               xml "  <log>"
-               xmlfile make.log
-               xml "  </log>"
-
-               printf "FAILED after ${duration}s! Log excerpt:\n"
+               junit "<failure type='BuildFailed'>"
+               junitfile make.log
+               junit "</failure>"
+               printf "FAILED after ${duration}s!\nLog excerpt:\n"
                tail -n $CONTEXT make.log 2> /dev/null || tail -$CONTEXT make.log
                cd $CURR
+               failed=1
                return 1
        fi
 }
 
-function built_successfully
-{
-       CURR=`pwd`
-       status="fail"
-       if [ -d "$TARGET/${VENDOR}_${MAINBOARD}" ]; then
-               cd $TARGET/${VENDOR}_${MAINBOARD}
-               if [ -r compile.status ] ; then
-                       status=`cat compile.status`
-               fi
-               cd $CURR
-       fi
-       [ "$buildall" != "true" -a "$status" == "ok" ]
-}
-
 function build_broken
 {
        CURR=`pwd`
@@ -304,13 +356,13 @@ function build_target
                fi
                CROSS_COMPILE="$TARCH-elf-"
                CC=gcc
-               echo using $CROSS_COMPILE$CC
+               CROSS_TEXT=", using $CROSS_COMPILE$CC"
                found_crosscompiler=true
        fi
 
        HOSTCC='gcc'
 
-       printf "Processing mainboard/$VENDOR/$MAINBOARD"
+       printf "Building $VENDOR/$MAINBOARD; "
 
        xml "<mainboard>"
        xml ""
@@ -321,8 +373,9 @@ function build_target
        xml ""
 
        if [ "$ARCH" = "$TARCH" -o $found_crosscompiler = true ]; then
-               printf " ($TARCH: ok)\n"
+               printf "$TARCH: ok$CROSS_TEXT\n"
        else
+               # FIXME this is basically the same as above.
                found_crosscompiler=false
                if [ "$ARCH" == amd64 -a "$TARCH" == i386 ]; then
                        CC="gcc -m32"
@@ -342,20 +395,23 @@ function build_target
                        done
                fi
 
-       
+
                # TBD: look for suitable cross compiler suite
                # cross-$TARCH-gcc and cross-$TARCH-ld
-               
+
                # Check result:
                if [ $found_crosscompiler == "false" ]; then
-                       printf " ($TARCH: skipped, we're $ARCH)\n\n"
+                       printf "$TARCH: skipped, we're $ARCH\n\n"
                        xml "  <status>notbuilt</status>"
                        xml ""
                        xml "</mainboard>"
-               
+
+                       junit " <testcase classname='board' name='$TARCH/$VENDOR/$MAINBOARD' >"
+                       junit "<failure type='NoCrossCompiler'>No cross-compiler for $TARCH found</failure>"
+
                        return 0
                else
-                       printf " ($TARCH: ok, we're $ARCH with a ${CROSS_COMPILE} cross compiler)\n"
+                       printf "$TARCH: ok, $ARCH using ${CROSS_COMPILE}gcc\n"
                        xml "  <compiler>"
                        xml "    <path>`which ${CROSS_COMPILE}gcc`</path>"
                        xml "    <version>`${CROSS_COMPILE}gcc --version | head -1`</version>"
@@ -370,37 +426,39 @@ function build_target
                CC="$CC -fno-stack-protector"
        fi
 
-       built_successfully $VENDOR $MAINBOARD && \
-       {
-               printf " ( mainboard/$VENDOR/$MAINBOARD previously ok )\n\n"
-               xml "  <status>previouslyok</status>"
-               xml ""
-               xml "</mainboard>"
-               return 0
-       }
-
        build_broken $VENDOR $MAINBOARD || \
        {
                printf " ( broken mainboard/$VENDOR/$MAINBOARD skipped )\n\n"
                xml "  <status>knownbroken</status>"
                xml ""
                xml "</mainboard>"
+               junit " <testcase classname='board' name='$TARCH/$VENDOR/$MAINBOARD' >"
+               junit "<failure type='KnownBroken'>Board is marked as broken</failure>"
                return 0
        }
-       
+
+       stime=`perl -e 'print time();' 2>/dev/null || date +%s`
        create_buildenv $VENDOR $MAINBOARD $CONFIG
        if [ $? -eq 0  -a  $configureonly -eq 0 ]; then
-               compile_target $VENDOR $MAINBOARD && 
+               if [ "$scanbuild" = "true" ]; then
+                       rm -rf $TARGET/scan-build-results-tmp
+               fi
+               compile_target $VENDOR $MAINBOARD &&
                        xml "  <status>ok</status>" ||
                        xml "<status>broken</status>"
                if [ "$scanbuild" = "true" ]; then
+                       rm -rf $TARGET/${VENDOR}_${MAINBOARD}-scanbuild
                        mv `dirname $TARGET/scan-build-results-tmp/*/index.html` $TARGET/${VENDOR}_${MAINBOARD}-scanbuild
-                       MAKE=$origMAKE
                fi
        fi
+       # Not calculated here because we still print it in compile_target
+       #etime=`perl -e 'print time();' 2>/dev/null || date +%s`
+       #duration=$(( $etime - $stime ))
+       #xml "  <buildtime>${duration}s</buildtime>"
 
        xml ""
        xml "</mainboard>"
+       junit "</testcase>"
 
        printf "\n"
 }
@@ -480,18 +538,23 @@ function myhelp
        printf "    [-h|--help]                   print this help and exit\n"
        printf "    [-x|--xml]                    write xml log file \n"
        printf "                                  (defaults to $XMLFILE)\n"
+       printf "    [-J|--junit]                  write JUnit formatted xml log file \n"
+       printf "                                  (defaults to $XMLFILE)\n"
        printf "    [-T|--test]                   submit image(s) to automated test system\n"
        printf "    [-c|--cpus <numcpus>]         build on <numcpus> at the same time\n"
        printf "    [-s|--silent]                 omit compiler calls in logs\n"
        printf "    [-ns|--nostackprotect]        use gcc -fno-stack-protector option\n"
        printf "    [-sb|--scan-build]            use clang's static analyzer\n"
+       printf "    [-y|--ccache]                 use ccache\n"
        printf "    [-C|--config]                 configure-only mode\n"
        printf "    [-l|--loglevel <num>]         set loglevel\n"
+       printf "    [-u|--update]                 update existing image\n"
+       printf "    [-P|--prefix <name>]          file name prefix in CBFS\n"
        printf "    [lbroot]                      absolute path to coreboot sources\n"
        printf "                                  (defaults to $ROOT)\n\n"
 }
 
-function myversion 
+function myversion
 {
        cat << EOF
 
@@ -512,19 +575,19 @@ target=""
 buildall=false
 verbose=false
 
-test -f util/sconfig/config.g && ROOT=$( pwd )
-test -f ../util/sconfig/config.g && ROOT=$( cd ..; pwd )
+test -f util/sconfig/sconfig.l && ROOT=$( pwd )
+test -f ../util/sconfig/sconfig.l && ROOT=$( cd ..; pwd )
 test "$ROOT" = "" && ROOT=$( cd ../..; pwd )
 
 # parse parameters.. try to find out whether we're running GNU getopt
 getoptbrand="`getopt -V`"
 if [ "${getoptbrand:0:6}" == "getopt" ]; then
        # Detected GNU getopt that supports long options.
-       args=`getopt -l version,verbose,help,all,target:,broken,payloads:,test,cpus:,silent,xml,config,loglevel: Vvhat:bp:Tc:sxCl: -- "$@"`
-       eval set "$args"
+       args=`getopt -l version,verbose,help,all,target:,broken,payloads:,test,cpus:,silent,junit,xml,config,loglevel:,remove,prefix:,update,nostackprotect,scan-build,ccache -o Vvhat:bp:Tc:sJxCl:rP:uy -- "$@"`
+       eval set -- $args
 else
        # Detected non-GNU getopt
-       args=`getopt Vvhat:bp:Tc:sxCl:o $*`
+       args=`getopt Vvhat:bp:Tc:sJxCl:rP:uy $*`
        set -- $args
 fi
 
@@ -536,11 +599,12 @@ fi
 while true ; do
        case "$1" in
                -x|--xml)       shift; mode=xml; rm -f $XMLFILE ;;
+               -J|--junit)     shift; mode=junit; rm -f $XMLFILE ;;
                -t|--target)    shift; target="$1"; shift;;
                -a|--all)       shift; buildall=true;;
                -b|--broken)    shift; buildbroken=true;;
-               -r|--remove)    shift; remove=true; shift;;
-               -v|--verbose)   shift; verbose=true;;
+               -r|--remove)    shift; remove=true;;
+               -v|--verbose)   shift; verbose=true; silent='V=1';;
                -V|--version)   shift; myversion; exit 0;;
                -h|--help)      shift; myversion; myhelp; exit 0;;
                -p|--payloads)  shift; payloads="$1"; shift;;
@@ -549,8 +613,11 @@ while true ; do
                -s|--silent)    shift; silent="-s";;
                -ns|--nostackprotect) shift; stackprotect=true;;
                -sb|--scan-build) shift; scanbuild=true;;
+               -y|--ccache)    shift; ccache=true;;
                -C|--config)    shift; configureonly=1;;
                -l|--loglevel)  shift; loglevel="$1"; shift;;
+               -u|--update)    shift; update="true";;
+               -P|--prefix)    shift; cbfs_prefix="$1"; shift;;
                --)             shift; break;;
                -*)             printf "Invalid option\n\n"; myhelp; exit 1;;
                *)              break;;
@@ -565,11 +632,20 @@ debug "ROOT=$ROOT"
 xml '<?xml version="1.0" encoding="utf-8"?>'
 xml '<abuild>'
 
+junit '<?xml version="1.0" encoding="utf-8"?>'
+junit '<testsuite>'
+
 if [ "$target" != "" ]; then
        # build a single board
        VENDOR=`printf $target|cut -f1 -d/`
        MAINBOARD=`printf $target|cut -f2 -d/`
        CONFIG=`printf $target|cut -f3 -d/`
+       if [ ! -r $ROOT/src/mainboard/$target ]; then
+               printf "No such target: $target\n"
+               xml '</abuild>'
+               junit '</testsuite>'
+               exit 1
+       fi
        build_target $VENDOR $MAINBOARD $CONFIG
        test_target $VENDOR $MAINBOARD
 else
@@ -583,4 +659,6 @@ else
        done
 fi
 xml '</abuild>'
+junit '</testsuite>'
 
+exit $failed