path: root/email/aiaiai-email-test-patchset

#!/bin/sh -efu

# Copyright 2011-2012 Intel Corporation
# Author: Artem Bityutskiy
# License: GPLv2

srcdir="$(readlink -ev -- ${0%/*}/..)"
PATH="$srcdir:$srcdir/helpers:$srcdir/email:$srcdir/helpers/libshell:$PATH"

. shell-error
. shell-args
. shell-signal
. aiaiai-sh-functions
. aiaiai-email-sh-functions

PROG="${0##*/}"
export message_time="yes"

# This is a small trick to make sure the script is portable - check if 'dash'
# is present, and if yes - use it.
if can_switch_to_dash; then
	exec dash -euf -- "$srcdir/$PROG" "$@"
	exit $?
fi

show_usage()
{
	cat <<-EOF
Usage: $PROG [options] <cfgfile.ini>

The mbox file containing the patches to test is expected to come from stdin
(unless --input option is specified).

<cfgfile.ini>          - the configuration file.

Options:
  -i, --input=MBOX       use the MBOX file instead of stdin;
  -C, --confdir=CDIR     path to the directory containing the defconfig files
                         (those you specify in the config file); by default the
                         defconfig files are assumed to be part of the
                         <kernel-tree>; this option makes it possible to use
                         stand-alone defconfig files instead;
  -p, --preserve         preserve all the temporary files - do not clean up;
      --test-mode        test mode - work as usually, but do not actually
                         send replies;
      --bisectability    test bisectability;
      --sparse           check with sparse while building;
      --smatch           check with smatch while building;
      --cppcheck         check with cppcheck;
      --coccinelle       check with coccinelle;
  -v, --verbose          be verbose;
  -h, --help             show this text and exit.
EOF
}

fail_usage()
{
	[ -z "$1" ] || printf "%s\n" "$1"
	show_usage
	exit 1
}

preserve=
verbose=
mbox=
tmpdir=
cleanup_handler()
{
	rm $verbose -rf -- "$mbox" >&2

	if [ -n "$preserve" ]; then
		verbose "Preserved tmpdir: $tmpdir"
	else
		[ -z "$tmpdir" ] || verbose "Removing $tmpdir";
		rm -rf -- "$tmpdir" >&2
	fi
}
set_cleanup_handler cleanup_handler

# List currently supported projects.
list_projects()
{
	local prj

	LC_ALL=C sed -n -e "s/^\[prj_\(.*\)\]$/\1/p" "$cfgfile" | \
	    while read -r prj; do
		# Get project description
		local descr
		ini_config_get_or_die descr "$cfgfile" "prj_$prj" "description"

		local email="$cfg_ownmail_local+$prj@$cfg_ownmail_domain"
		printf "* %s\n" "$prj ($email): $descr"
	done
}

# Send an e-mail reply to the patch submitter.
send_email()
{
	compose_email "$reply_to" "$reply_cc" "$reply_subj" "$reply_id" \
		> "$tmpdir/mail"

	[ -z "$verbose" ] || cat -- "$tmpdir/mail" >&2

	if [ -z "$test_mode" ]; then
		mutt -x -H "$tmpdir/mail" </dev/null
	else
		verbose "Do not actually send the email - we are in test mode"
	fi
}

# This function is called when the target project for the patch under test was
# not specified. It sends a sensible reply back to the submitter, without
# carbon-copying anyone else.
error_no_project_specified()
{
	send_email <<EOF
Sorry, but you have not specified the project name. Please, specify it
using the "+" symbol in the e-mail address of $cfg_ownname. For example,
"$cfg_ownmail_local+XYZ@$cfg_ownmail_domain" would mean project "XYZ".

List of projects $cfg_ownname supports:

$(list_projects)

Please, contact "$cfg_adminname" <$cfg_adminmail>
if you have any questions.
EOF
	exit 0
}

# This function is called when the patch submitter specifies a non-existing
# project. It sends a sensible reply back, without carbon-copying anyone else.
error_project_not_found()
{
	send_email <<EOF
Sorry, but project "$prj" is not supported. List of projects $cfg_ownname
currently supports:

$(list_projects)

Please, contact "$cfg_adminname" <$cfg_adminmail>
if you have any questions.
EOF
	exit 0
}

# This function is called when the 'aiaiai-test-patchest' fails. This most
# probably means a bug or configuration issues. This function sends
# corresponding e-mail notification.
error_test_patchset_failed()
{
	send_email <<EOF
Sorry, but an internal $cfg_ownname error happened. Please, contact
"$cfg_adminname" <$cfg_adminmail>.
EOF
	exit 0
}

# This is a helper function which sends a notification about the patch under
# test being accepted for testing.
send_accepted_email()
{
	send_email <<EOF
Your patch or patch-set:

$(fetch_header_per_patch "Subject" < "$mbox" | sort)

has been accepted by $cfg_ownname and scheduled for testing.
EOF
}

# This is a helper function which sends the reply e-mail with the results of
# testing.
send_results_email()
{
	send_email <<EOF
$cfg_built_preamble

$(fetch_header_per_patch "Subject" < "$mbox" | sort)

Project: $pcfg_name ($pcfg_description)

Configurations: $pcfg_configs

$(cat -- $tmpdir/test-patchset.log)
EOF
}

TEMP=`getopt -n $PROG -o i:,C:,p,v,h --long test-mode,input:,confdir:,preserve,bisectability,sparse,smatch,cppcheck,coccinelle,verbose,help -- "$@"` ||
	fail_usage ""
eval set -- "$TEMP"

mbox=
confdir=
test_mode=
bisectability=
sparse=
smatch=
cppcheck=
coccinelle=

while true; do
	case "$1" in
	-i|--input)
		mbox="$(opt_check_read "$1" "$2")"
		shift
		;;
	-C|--confdir)
		confdir="$(opt_check_dir "$1" "$2")"
		shift
		;;
	-p|--preserve)
		preserve="--preserve"
		;;
	--test-mode)
		test_mode=y
		;;
	--bisectability)
		bisectability="--bisectability"
		;;
	--sparse)
		sparse="--sparse"
		;;
	--smatch)
		smatch="--smatch"
		;;
	--cppcheck)
		cppcheck="--cppcheck"
		;;
	--coccinelle)
		coccinelle="--coccinelle"
		;;
	-v|--verbose) verbose=-v
		;;
	-h|--help)
		show_usage
		exit 0
		;;
	--) shift; break
                ;;
	*) fail_usage "Unrecognized option: $1"
		;;
	esac
	shift
done

[ "$#" -eq 1 ] || die "Insufficient or too many arguments"

program_required "mutt" ""
program_required "grep" ""
program_required "sed" ""
program_required "formail" ""

cfgfile="$1"; shift

# Save the mbox to a temporary file if it comes from stdin
if [ -z "$mbox" ]; then
	mbox="$(mktemp -t "$PROG.mbox.XXXX")"
	cat > "$mbox"
fi

cat "$mbox"
# Use the cover letter subject and message ID if possible. If the cover letter
# was present, 'aiaiai-email-lda' would save them in special privat headers.
subj="$(fetch_header "X-Aiaiai-Cover-Letter-Subject" < "$mbox")"
[ -n "$subj" ] || fetch_header_or_die subj "Subject" < "$mbox"

id="$(fetch_header "X-Aiaiai-Cover-Letter-Message-Id" < "$mbox")"
[ -n "$id" ] || fetch_header_or_die id "Message-Id" < "$mbox"

fetch_header_or_die from "From" < "$mbox"
to="$(fetch_header "To" < "$mbox")"
cc="$(fetch_header "Cc" < "$mbox")"

# Either "To:" or "Cc:" must exist
if [ -z "$to" ] && [ -z "$cc" ]; then
       die "Neither \"To:\" nor \"Cc:\" header found"
fi

printf "\n"
verbose "Testing mbox: \"$from: $subj (Message-Id: $id)\""
verbose "parsing config file \"$cfgfile\""

parse_config "$cfgfile"

mkdir $verbose -p -- "$cfg_workdir" >&2

tmpdir="$(mktemp --tmpdir="$cfg_workdir" -dt "$PROG.XXXX")"
mv $verbose -- "$mbox" "$tmpdir/mbox" >&2
mbox="$tmpdir/mbox"

# Find out the project name
prj="$(fetch_project_name "$to" "$cfg_ownmail")"
verbose "Project \"$prj\""

# Replies will refer the first patch of the patch-set under test
reply_subj="$subj"
reply_id="$id"
# Replies will be sent to the patch submitter
reply_to="$from"
# And do not Cc anyone thus far
reply_cc=

# Reject the e-mail if the project has not been specified
if [ -z "$prj" ]; then
	error_no_project_specified
fi

# Get the project configuration
parse_prj_config "$cfgfile" "$prj"

# Check if the project specified by the submitter exists
if [ -z "$pcfg_name" ]; then
	error_project_not_found
fi

# Create the Cc list for replies that we'll be sending
if [ "$pcfg_reply_to_all" != "1" ]; then
	# Replies all the patch recipients will be CCed
	reply_cc="$(merge_addresses "$to" "$cc")"
	reply_cc="$(merge_addresses "$reply_cc" "$pcfg_always_cc")"
	reply_cc=$(strip_address "$reply_cc" "$cfg_ownmail")
else
	reply_cc="$pcfg_always_cc"
fi

# Notify the sender that the patches have been accepted
if [ "$pcfg_accept_notify" = "1" ]; then
	verbose "Sending \"accepted\" e-mail"
	send_accepted_email
fi

# Test the path (or patch-set)
verbose "Test configs \"$pcfg_configs\" branch \"$pcfg_branch\" of \"$pcfg_path\""
aiaiai-test-patchset $verbose $preserve \
	$bisectability $sparse $smatch $cppcheck $coccinelle \
	-i "$mbox" -j "$cfg_jobs" -c "$pcfg_branch" -w "$tmpdir" \
	${confdir:+-C "$confdir"} \
	${pcfg_unwanted_keywords:+-K "$pcfg_unwanted_keywords"} -- \
	${pcfg_kmake_opts:+-M "$pcfg_kmake_opts"} \
	"$pcfg_path" "$pcfg_configs" > "$tmpdir/test-patchset.log" ||
{
	verbose "aiaiai-test-patchset failed"
	error_test_patchset_failed
}

# Mail the results of testing
verbose "Test is finished, sending back the results"
send_results_email