Swarm 2014.1: User Guide

The following is a Jenkins build script used during the development of Swarm:

#!/bin/bash
ME=jenkins-swarm-trigger

# specify branch identifiers and depot paths that correspond
# with the project configuration in Swarm.
declare -A branches
branches[main] = "//depot/project/..."

function usage
{
    cat << USAGE >&2
    $ME
    This script is meant to be called by a triggered Jenkins build
    from Swarm. It needs the following environment variables defined:
    * JOB_NAME          (Jenkins): name of the Jenkins build project
    * WORKSPACE         (Jenkins): workspace directory to be created
    * BUILD_URL         (Jenkins): URL of resulting build
    * SWARM_BRANCH        (Swarm): name of branch
    * SWARM_CHANGE        (Swarm): changelist to sync/unshelve
    * SWARM_CHANGE_STATUS (Swarm): changelist is shelved or submitted
    * ANT_TARGETS         (Swarm): what Ant targets to call
    * SWARM_FAILURE_URL   (Swarm): URL to get upon build failure
    * SWARM_SUCCESS_URL   (Swarm): URL to get upon build success
USAGE
    exit 5
}

function checkEnv
{
    while [ ! -z "$1" ]
    do
        [ -z "${!1}" ] &&
            exitFail "environment variable [$1] not defined"
        
        shift
    done
}

function checkChangeStatus
{
    [ -z "$1" ] || [ -z "$2" ] &&
        exitFail "specify change & status to checkChangeStatus"

    local change="$1"
    local status="$2"

    echo "$ME: checking change [$change] is [$status]..."
    p4 changes -s $status @$change,@$change 2> /dev/null |
        head -n1 |
        grep -q "^Change $change on" ||
        exitFail "change [$change] does not appear to be [$status]"

    return 0
}

function exitFail
{
    [ ! -z "$1" ] &&
        echo "$ME: error: $*"

    echo "$ME: exiting with failure..."
    [ ! -z "$SWARM_FAILURE_URL" ] &&
        echo "$ME: reporting failure to [$SWARM_FAILURE_URL]" &&
        curl -d url=$BUILD_URL -o - $SWARM_FAILURE_URL |
            python -mjson.tool

    exit 1 
}

function exitGood
{
    echo "$ME: exit with success..."
    [ ! -z "$SWARM_SUCCESS_URL" ] &&
        echo "$ME: reporting success to [$SWARM_SUCCESS_URL]" &&
        curl -d url=$BUILD_URL -o - $SWARM_SUCCESS_URL |
            python -mjson.tool

    exit 0 
}

function isNotSet
{
    if [[ ! ${!1} && ${!1-_} ]]
    then
        return 1
    fi
}


echo "$ME: checking inputs"
checkEnv JOB_NAME WORKSPACE BUILD_URL SWARM_BRANCH SWARM_CHANGE\
    SWARM_CHANGE_STATUS

for v in JOB_NAME WORKSPACE BUILD_URL SWARM_BRANCH SWARM_CHANGE\
    SWARM_CHANGE_STATUS ANT_TARGETS SWARM_SUCCESS_URL\
    SWARM_FAILURE_URL
do
    echo -e "$v =\t[${!v}]"
done

cd $WORKSPACE || exitFail

which p4 > /dev/null 2>&1
[ $? -ne 0 ] &&
    exitFail "p4 not found in PATH"

which ant > /dev/null 2>&1
[ $? -ne 0 ] &&
    exitFail "ant not found in PATH"

p4 -h > /dev/null 2>&1
[ $? -ne 0 ] &&
    exitFail "trouble running p4"

p4 help > /dev/null 2>&1
[ $? -ne 0 ] &&
    exitFail "trouble connecting to Perforce service"

echo "$ME: change in question:"
p4 describe -s @$SWARM_CHANGE | grep ^[^#]

checkChangeStatus $SWARM_CHANGE $SWARM_CHANGE_STATUS

# create the view

isNotSet branches[${SWARM_BRANCH}]
[ $? -ne 0 ] &&
    exitFail "unknown branch [$SWARM_BRANCH]" ;;
p4branch = ${branches[${SWARM_BRANCH}]}

p4user=`p4 -ztag info | grep "^\.\.\. userName" | awk '{print $3}'`
p4client=$JOB_NAME

echo "$ME: creating client..."
cat << ! | p4 client -i
client: $p4client
Owner: $p4user
Description:
 Jenkins build workspace for Swarm CI needs
Root: $WORKSPACE
Options: noallwrite clobber nocompress unlocked nomodtime rmdir
SubmitOptions:  submitunchanged
LineEnd:    local
View:
 $p4branch/... //$JOB_NAME/...
!
[ $? -ne 0 ] &&
    exitFail "trouble creating client"

echo "$ME: client defined:"
p4 client -o $p4client | grep ^[^#] | tr '\t' ' '\
    | sed -e "s,^, ,"

# sync the files

echo "$ME: reverting any open files..."
p4 -c $p4client revert -k //... || exitFail

echo "$ME: purging workspace..."
(cd $WORKSPACE && rm -fr *)

echo "$ME: determining how to sync..."
case "$SWARM_CHANGE_STATUS" in
shelved)
    echo "$ME: quietly force-syncing to head..."
    p4 -c $p4client sync -qf || exitFail

    echo "$ME: unshelving [$SWARM_CHANGE]..."
    p4 -c $p4client unshelve -s $SWARM_CHANGE || exitFail
    p4 -c $p4client resolve -am || exitFail
    p4 -c $p4client resolve -ay || exitFail
    ;;
submitted)
    echo "$ME: quietly force-syncing to @$SWARM_CHANGE..."
    p4 -c $p4client sync -qf @$SWARM_CHANGE || exitFail
    ;;
*)
    exitFail "unknown change status [$SWARM_CHANGE_STATUS]"
    ;;
esac

# call the build

[ ! -r build.xml ] &&
    exitFail "build.xml not present"

echo "$ME: calling [ant $ANT_TARGETS]..."
ant $ANT_TARGETS
RC=$?

# report build result

if [ $RC -eq 0 ]
then
    exitGood
else
    exitFail "build returned non-zero exit status [$RC]"
fi

# shouldn't get here
exit 99