#! /usr/pkg/bin/atf-sh
# AUTOMATICALLY GENERATED FROM Makefile
# Copyright 2011 The Kyua Authors.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright
#   notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
#   notice, this list of conditions and the following disclaimer in the
#   documentation and/or other materials provided with the distribution.
# * Neither the name of Google Inc. nor the names of its contributors
#   may be used to endorse or promote products derived from this software
#   without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


# Subcommand to strip out the durations and timestamps in a report.
#
# This is to make the reports deterministic and thus easily testable.  The
# time deltas are replaced by the fixed string S.UUU and the timestamps are
# replaced by the fixed strings YYYYMMDD.HHMMSS.ssssss and
# YYYY-MM-DDTHH:MM:SS.ssssssZ depending on their original format.
#
# This variable should be used as shown here:
#
#     atf_check ... -x kyua report "| ${utils_strip_times}"
#
# Use the utils_install_times_wrapper function to create a 'kyua' wrapper
# script that automatically does this.
# CHECK_STYLE_DISABLE
utils_strip_times='sed -E \
    -e "s,( |\[|\")[0-9][0-9]*\.[0-9][0-9][0-9](s]|s|\"),\1S.UUU\2,g" \
    -e "s,[0-9]{8}-[0-9]{6}-[0-9]{6},YYYYMMDD-HHMMSS-ssssss,g" \
    -e "s,[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{6}Z,YYYY-MM-DDTHH:MM:SS.ssssssZ,g"'
# CHECK_STYLE_ENABLE


# Same as utils_strip_times but avoids stripping timestamp-based report IDs.
#
# This is to make the reports deterministic and thus easily testable.  The
# time deltas are replaced by the fixed string S.UUU and the timestamps are
# replaced by the fixed string YYYY-MM-DDTHH:MM:SS.ssssssZ.
# CHECK_STYLE_DISABLE
utils_strip_times_but_not_ids='sed -E \
    -e "s,( |\[|\")[0-9][0-9]*\.[0-9][0-9][0-9](s]|s|\"),\1S.UUU\2,g" \
    -e "s,[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{6}Z,YYYY-MM-DDTHH:MM:SS.ssssssZ,g"'
# CHECK_STYLE_ENABLE


# Computes the results id for a test suite run.
#
# The computed path is "generic" in the sense that it does not include a
# real timestamp: it only includes a placeholder.  This function should be
# used along the utils_strip_times function so that the timestamps of
# the real results files are stripped out.
#
# \param path Optional path to use; if not given, use the cwd.
utils_results_id() {
    local test_suite_id="$(utils_test_suite_id "${@}")"
    echo "${test_suite_id}.YYYYMMDD-HHMMSS-ssssss"
}


# Computes the results file for a test suite run.
#
# The computed path is "generic" in the sense that it does not include a
# real timestamp: it only includes a placeholder.  This function should be
# used along the utils_strip_times function so that the timestampts of the
# real results files are stripped out.
#
# \param path Optional path to use; if not given, use the cwd.
utils_results_file() {
    echo "${HOME}/.kyua/store/results.$(utils_results_id "${@}").db"
}


# Copies a helper binary from the source directory to the work directory.
#
# \param name The name of the binary to copy.
# \param destination The target location for the binary; can be either
#     a directory name or a file name.
utils_cp_helper() {
    local name="${1}"; shift
    local destination="${1}"; shift

    ln -s "$(atf_get_srcdir)"/helpers/"${name}" "${destination}"
}


# Creates a 'kyua' binary in the path that strips timing data off the output.
#
# Call this on test cases that wish to replace timing data in the *stdout* of
# Kyua with the deterministic strings.  This is to be used by tests that
# validate the 'test' and 'report' subcommands.
utils_install_times_wrapper() {
    local DUMMY_KYUA_BINDIR=$(pwd)
    local DUMMY_KYUA_BIN="$DUMMY_KYUA_BINDIR/kyua"

    [ ! -x "$DUMMY_KYUA_BIN" ] || return

    local ORIG_KYUA_BIN=$(which kyua)
    cat >"$DUMMY_KYUA_BIN" <<EOF
#! /bin/sh

$ORIG_KYUA_BIN "\${@}" >kyua.tmpout
result=\${?}
cat kyua.tmpout | ${utils_strip_times}
exit \${result}
EOF
    chmod +x "$DUMMY_KYUA_BIN"
    export PATH="$DUMMY_KYUA_BINDIR:${PATH}"
}


# Creates a 'kyua' binary in the path that makes the output of 'test' stable.
#
# Call this on test cases that wish to replace timing data with deterministic
# strings and that need the result lines in the output to be sorted
# lexicographically.  The latter hides the indeterminism caused by parallel
# execution so that the output can be verified.  For these reasons, this is to
# be used exclusively by tests that validate the 'test' subcommand.
utils_install_stable_test_wrapper() {
    local DUMMY_KYUA_BINDIR=$(pwd)
    local DUMMY_KYUA_BIN="$DUMMY_KYUA_BINDIR/kyua"

    [ ! -x "$DUMMY_KYUA_BIN" ] || return

    local ORIG_KYUA_BIN=$(which kyua)
    cat >"$DUMMY_KYUA_BIN" <<EOF
#! /bin/sh

$ORIG_KYUA_BIN "\${@}" >kyua.tmpout
result=\${?}
cat kyua.tmpout | ${utils_strip_times} >kyua.tmpout2

# Sort the test result lines but keep the rest intact.
grep '[^ ]*:[^ ]*' kyua.tmpout2 | sort >kyua.tmpout3
grep -v '[^ ]*:[^ ]*' kyua.tmpout2 >kyua.tmpout4
cat kyua.tmpout3 kyua.tmpout4

exit \${result}
EOF
    chmod +x "$DUMMY_KYUA_BIN"
    export PATH="$DUMMY_KYUA_BINDIR:${PATH}"
}


# Defines a test case with a default head.
utils_test_case() {
    local name="${1}"; shift

    atf_test_case "${name}"
    eval "${name}_head() {
        atf_set require.progs kyua
    }"
}


# Computes the test suite identifier for results files files.
#
# \param path Optional path to use; if not given, use the cwd.
utils_test_suite_id() {
    local path=
    if [ ${#} -gt 0 ]; then
        path="$(cd ${1} && pwd)"; shift
    else
        path="$(pwd)"
    fi
    echo "${path}" | sed -e 's,^/,,' -e 's,/,_,g'
}
# Copyright 2011 The Kyua Authors.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright
#   notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
#   notice, this list of conditions and the following disclaimer in the
#   documentation and/or other materials provided with the distribution.
# * Neither the name of Google Inc. nor the names of its contributors
#   may be used to endorse or promote products derived from this software
#   without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


utils_test_case defaults
defaults_body() {
    atf_check -s exit:0 \
        -o match:'^architecture = ' \
        -o match:'^platform = ' \
        kyua config
}


utils_test_case all
all_body() {
    mkdir "${HOME}/.kyua"
    cat >"${HOME}/.kyua/kyua.conf" <<EOF
syntax(2)
architecture = "my-architecture"
execenvs = "my-env1 my-env2"
parallelism = 256
platform = "my-platform"
unprivileged_user = "$(id -u -n)"
test_suites.suite1.the_variable = "value1"
test_suites.suite2.the_variable = "value2"
EOF

    cat >expout <<EOF
architecture = my-architecture
execenvs = my-env1 my-env2
parallelism = 256
platform = my-platform
test_suites.suite1.the_variable = value1
test_suites.suite2.the_variable = value2
unprivileged_user = $(id -u -n)
EOF

    atf_check -s exit:0 -o file:expout -e empty kyua config
}


utils_test_case one__ok
one__ok_body() {
    mkdir "${HOME}/.kyua"
    cat >"${HOME}/.kyua/kyua.conf" <<EOF
syntax(2)
test_suites.first.one = 1
test_suites.first.two = 2
EOF

    cat >expout <<EOF
test_suites.first.two = 2
EOF

    atf_check -s exit:0 -o file:expout -e empty kyua config \
        test_suites.first.two
}


utils_test_case one__fail
one__fail_body() {
    mkdir "${HOME}/.kyua"
    cat >"${HOME}/.kyua/kyua.conf" <<EOF
syntax(2)
test_suites.first.one = 1
test_suites.first.three = 3
EOF

    cat >experr <<EOF
kyua: W: 'test_suites.first.two' is not defined.
EOF

    atf_check -s exit:1 -o empty -e file:experr kyua config \
        test_suites.first.two
}


utils_test_case many__ok
many__ok_body() {
    mkdir "${HOME}/.kyua"
    cat >"${HOME}/.kyua/kyua.conf" <<EOF
syntax(2)
architecture = "overriden"
unknown_setting = "foo"
test_suites.first.one = 1
test_suites.first.two = 2
EOF

    cat >expout <<EOF
architecture = overriden
test_suites.first.two = 2
test_suites.first.one = 1
EOF

    atf_check -s exit:0 -o file:expout -e empty kyua config \
        architecture \
        test_suites.first.two \
        test_suites.first.one  # Inverse order on purpose.
    atf_check -s exit:0 -o match:architecture -o not-match:unknown_setting \
        -e empty kyua config
}


utils_test_case many__fail
many__fail_body() {
    mkdir "${HOME}/.kyua"
    cat >"${HOME}/.kyua/kyua.conf" <<EOF
syntax(2)
test_suites.first.one = 1
test_suites.first.three = 3
EOF

    cat >expout <<EOF
test_suites.first.one = 1
test_suites.first.three = 3
EOF

    cat >experr <<EOF
kyua: W: 'test_suites.first.two' is not defined.
kyua: W: 'test_suites.first.fourth' is not defined.
EOF

    atf_check -s exit:1 -o file:expout -e file:experr kyua config \
        test_suites.first.one test_suites.first.two \
        test_suites.first.three test_suites.first.fourth
}


utils_test_case config_flag__default_system
config_flag__default_system_body() {
    cat >kyua.conf <<EOF
syntax(2)
test_suites.foo.var = "baz"
EOF

    atf_check -s exit:1 -o empty \
        -e match:"kyua: W: 'test_suites.foo.var'.*not defined" \
        kyua config test_suites.foo.var
    export KYUA_CONFDIR="$(pwd)"
    atf_check -s exit:0 -o match:"foo.var = baz" -e empty \
        kyua config test_suites.foo.var
}


utils_test_case config_flag__default_home
config_flag__default_home_body() {
    cat >kyua.conf <<EOF
syntax(2)
test_suites.foo.var = "bar"
EOF
    export KYUA_CONFDIR="$(pwd)"
    atf_check -s exit:0 -o match:"test_suites.foo.var = bar" -e empty \
        kyua config test_suites.foo.var

    # The previously-created "system-wide" file has to be ignored.
    mkdir .kyua
    cat >.kyua/kyua.conf <<EOF
syntax(2)
test_suites.foo.var = "baz"
EOF
    atf_check -s exit:0 -o match:"test_suites.foo.var = baz" -e empty \
        kyua config test_suites.foo.var
}


utils_test_case config_flag__explicit__ok
config_flag__explicit__ok_body() {
    cat >kyua.conf <<EOF
syntax(2)
test_suites.foo.var = "baz"
EOF

    atf_check -s exit:1 -o empty \
        -e match:"kyua: W: 'test_suites.foo.var'.*not defined" \
        kyua config test_suites.foo.var
    atf_check -s exit:0 -o match:"test_suites.foo.var = baz" -e empty \
        kyua -c kyua.conf config test_suites.foo.var
    atf_check -s exit:0 -o match:"test_suites.foo.var = baz" -e empty \
        kyua --config=kyua.conf config test_suites.foo.var
}


utils_test_case config_flag__explicit__disable
config_flag__explicit__disable_body() {
    cat >kyua.conf <<EOF
syntax(2)
test_suites.foo.var = "baz"
EOF
    mkdir .kyua
    cp kyua.conf .kyua/kyua.conf
    export KYUA_CONFDIR="$(pwd)"

    atf_check -s exit:0 -o match:"test_suites.foo.var = baz" -e empty \
        kyua config test_suites.foo.var
    atf_check -s exit:1 -o empty \
        -e match:"kyua: W: 'test_suites.foo.var'.*not defined" \
        kyua --config=none config test_suites.foo.var
}


utils_test_case config_flag__explicit__missing_file
config_flag__explicit__missing_file_body() {
    cat >experr <<EOF
kyua: E: Load of 'foo' failed: File 'foo' not found.
EOF
    atf_check -s exit:2 -o empty -e file:experr kyua --config=foo config
}


utils_test_case config_flag__explicit__bad_file
config_flag__explicit__bad_file_body() {
    touch custom
    atf_check -s exit:2 -o empty -e match:"No syntax defined" \
        kyua --config=custom config
}


utils_test_case variable_flag__no_config
variable_flag__no_config_body() {
    atf_check -s exit:0 \
        -o match:'test_suites.suite1.the_variable = value1' \
        -o match:'test_suites.suite2.the_variable = value2' \
        -e empty \
        kyua \
        -v "test_suites.suite1.the_variable=value1" \
        -v "test_suites.suite2.the_variable=value2" \
        config

    atf_check -s exit:0 \
        -o match:'test_suites.suite1.the_variable = value1' \
        -o match:'test_suites.suite2.the_variable = value2' \
        -e empty \
        kyua \
        --variable="test_suites.suite1.the_variable=value1" \
        --variable="test_suites.suite2.the_variable=value2" \
        config
}


utils_test_case variable_flag__override_default_config
variable_flag__override_default_config_body() {
    mkdir "${HOME}/.kyua"
    cat >"${HOME}/.kyua/kyua.conf" <<EOF
syntax(2)
test_suites.suite1.the_variable = "value1"
test_suites.suite2.the_variable = "should not be used"
EOF

    atf_check -s exit:0 \
        -o match:'test_suites.suite1.the_variable = value1' \
        -o match:'test_suites.suite2.the_variable = overriden' \
        -o match:'test_suites.suite3.the_variable = new' \
        -e empty kyua \
        -v "test_suites.suite2.the_variable=overriden" \
        -v "test_suites.suite3.the_variable=new" \
        config

    atf_check -s exit:0 \
        -o match:'test_suites.suite1.the_variable = value1' \
        -o match:'test_suites.suite2.the_variable = overriden' \
        -o match:'test_suites.suite3.the_variable = new' \
        -e empty kyua \
        --variable="test_suites.suite2.the_variable=overriden" \
        --variable="test_suites.suite3.the_variable=new" \
        config
}


utils_test_case variable_flag__override_custom_config
variable_flag__override_custom_config_body() {
    cat >config <<EOF
syntax(2)
test_suites.suite1.the_variable = "value1"
test_suites.suite2.the_variable = "should not be used"
EOF

    atf_check -s exit:0 \
        -o match:'test_suites.suite2.the_variable = overriden' \
        -e empty kyua -c config \
        -v "test_suites.suite2.the_variable=overriden" config

    atf_check -s exit:0 \
        -o match:'test_suites.suite2.the_variable = overriden' \
        -e empty kyua -c config \
        --variable="test_suites.suite2.the_variable=overriden" config
}


utils_test_case variable_flag__invalid_key
variable_flag__invalid_key_body() {
    # CHECK_STYLE_DISABLE
    cat >experr <<EOF
Usage error: Invalid argument '' for option --variable: Argument does not have the form 'K=V'.
Type 'kyua help' for usage information.
EOF
    # CHECK_STYLE_ENABLE
    atf_check -s exit:3 -o empty -e file:experr kyua \
        -v "test_suites.a.b=c" -v "" config
}


utils_test_case variable_flag__invalid_value
variable_flag__invalid_value_body() {
    cat >experr <<EOF
kyua: E: Invalid value for property 'parallelism': Must be a positive integer.
EOF
    atf_check -s exit:2 -o empty -e file:experr kyua \
        -v "parallelism=0" config
}


atf_init_test_cases() {
    atf_add_test_case defaults
    atf_add_test_case all
    atf_add_test_case one__ok
    atf_add_test_case one__fail
    atf_add_test_case many__ok
    atf_add_test_case many__fail

    atf_add_test_case config_flag__default_system
    atf_add_test_case config_flag__default_home
    atf_add_test_case config_flag__explicit__ok
    atf_add_test_case config_flag__explicit__disable
    atf_add_test_case config_flag__explicit__missing_file
    atf_add_test_case config_flag__explicit__bad_file

    atf_add_test_case variable_flag__no_config
    atf_add_test_case variable_flag__override_default_config
    atf_add_test_case variable_flag__override_custom_config
    atf_add_test_case variable_flag__invalid_key
    atf_add_test_case variable_flag__invalid_value
}
