description.sh

#! /bin/bash
# description.sh
########################################################################
# CHANGE JENKINS BUILD DESCRIPTION
#
USAGE="
    description.sh [-a|-p] [-u <JenkinsURL>] -j <JenkinsJob> \\
    -b <jenkinsBuild> -d <description> [-c <color>]

    where:
        -a: Append new description to current description
        -p: Prepend new description to current description
        Description replaced if neither -p or -a are
        specified.
        -d: Description for build
        -u: Full URL of Jenkins server. If not given, it will be taken
            from value embedded in program.
        -j: Jenkins 'Job' name (aka 'project).
        -b: Build Number
        -c: Color of text
        -h: Display this help text
"
#
########################################################################

########################################################################
# FUNCTIONS
#
function error {
    printf "ERROR: $1\n$USAGE\n" 1>&2
    exit 2
}
#
########################################################################

########################################################################
# MAIN PROGRAM
#

jenkins_url="http://xxxxxxxxxxxxxx/jenkins"
prepend_flag=""
append_flag=""
readonly USER="xxxxxxxxxx"
readonly PASSWORD="xxxxxxxxxxxxxxxxxxxxxxxxxxxx"

#
# Set options
#
while getopts :aphd:u:j:b:c: option
do
    case $option in
    a)  append_flag=1;;
    p)  prepend_flag=1;;
    u)  jenkins_url="$OPTARG";;
    j)  job_name="$OPTARG";;
    b)  build_number="$OPTARG";;
    c)  color="$OPTARG";;
    d)  new_description="$OPTARG";;
    h)  printf "\n$USAGE\n"
        exit 0;;
    *)  error "Invalid Argument";;
    esac
done
shift $(( $OPTIND - 1 ))

#
# Verify options
#

[ -z "$new_description" ]   && error "Missing parameter '-d': Description"
[ -z "$build_number" ]      && error "Missing parameter '-b': Build Number"
[ -z "$job_name" ]      && error "Missing parameter '-j': Job Name"

#
# Get old description (if -a or -p flag)
#

if [ -n "$append_flag" -o -n "$prepend_flag" ]
then
    old_description=$(curl -s --user "$USER:$PASSWORD" --data-urlencode "tree=description" \
    "$jenkins_url/job/$job_name/$build_number/api/json")
    [ $? -ne 0 ] && error "Could not get description: $?"
fi
old_description=${old_description#*:\"} #Remove JSON garbage
old_description=${old_description%\"\}} #Remove JSON garbage

#
# Translate linefeeds
#
old_description=$(sed 's/\\r\\n/\
/g' <<<$old_description)

echo "Old Description = '$old_description'"

#
# Create the new description
#
if [ -n "$color" ] #Add color to the description
then
    new_description="<font color=$color><b>$new_description</b></font>"
fi

if [ "$prepend_flag" -a -n "$old_description" ] #Prepend new description to old description
then
    new_description="$new_description<br/>
$old_description"
elif [ "$append_flag" -a -n "$old_description" ] #Append new description to old description
then
    new_description="$old_description<br/>
$new_description"
fi

#
# Now set the description
#

if curl -u $USER:$PASSWORD   --data-urlencode "description=$new_description" \
    --data-urlencode "Submit=Submit" \
    "$jenkins_url/job/$job_name/$build_number/submitDescription"
then
    echo "Description successfully changed on Build #$build_number in Jenkins job $job_name"
else
    echo "WARNING: Description was not set. Manually change the descripiton of the build"
    echo "         for Build #$build_number in Jenkins job $job_name"
fi
echo "The description appears below"
echo "$new_description"
#
# DONE
########################################################################