#!/bin/bash
#
# Copyright (C) 2019 EfficiOS Inc.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; only version 2
# of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

# This test validates that a `src.ctf.fs` component handles gracefully invalid
# CTF traces and produces the expected error message.

SH_TAP=1

if [ "x${BT_TESTS_SRCDIR:-}" != "x" ]; then
	UTILSSH="$BT_TESTS_SRCDIR/utils/utils.sh"
else
	UTILSSH="$(dirname "$0")/../../../utils/utils.sh"
fi

# shellcheck source=../../../utils/utils.sh
source "$UTILSSH"

fail_trace_dir="$BT_CTF_TRACES_PATH/fail"

stdout_file=$(mktemp -t test_ctf_fail_stdout.XXXXXX)
stderr_file=$(mktemp -t test_ctf_fail_stderr.XXXXXX)
data_dir="${BT_TESTS_SRCDIR}/data/plugins/src.ctf.fs/fail"

test_fail() {
	local name="$1"
	local expected_stdout_file="$2"
	local expected_error_msg="$3"

	bt_cli "${stdout_file}" "${stderr_file}" \
		-c sink.text.details -p "with-trace-name=no,with-stream-name=no" "${fail_trace_dir}/${name}"
	isnt $? 0 "Trace ${name}: babeltrace exits with an error"

	bt_diff "${expected_stdout_file}" "${stdout_file}"
	ok $? "Trace ${name}: babeltrace produces the expected stdout"

	# The expected error message will likely be found in the error stream
	# even if Babeltrace aborts (e.g. hits an assert).  Check that the
	# Babeltrace CLI finishes gracefully by checking that the error stream
	# contains an error stack printed by the CLI.
	grep --silent "^CAUSED BY " "${stderr_file}"
	ok $? "Trace ${name}: babeltrace produces an error stack"

	grep --silent "${expected_error_msg}" "${stderr_file}"
	ok $? "Trace ${name}: babeltrace produces the expected error message"
}


plan_tests 12

test_fail \
	"invalid-packet-size/trace" \
	"/dev/null" \
	"Failed to index CTF stream file '.*channel0_3'"

test_fail \
	"valid-events-then-invalid-events" \
	"${data_dir}/valid-events-then-invalid-events.expect" \
	"No event class with ID of event class ID to use in stream class: .*stream-class-id=0, event-class-id=255"

test_fail \
	"metadata-syntax-error" \
	"/dev/null" \
	"^  Component class's \"query\" method failed: "

rm -f "${stdout_file}" "${stderr_file}"
