// Copyright 2010 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.

#include "model/test_case.hpp"

#include <sstream>

#include <atf-c++.hpp>

#include "model/metadata.hpp"
#include "model/test_result.hpp"
#include "utils/datetime.hpp"
#include "utils/format/containers.ipp"
#include "utils/fs/path.hpp"
#include "utils/optional.ipp"

namespace datetime = utils::datetime;
namespace fs = utils::fs;


ATF_TEST_CASE_WITHOUT_HEAD(test_case__ctor_and_getters)
ATF_TEST_CASE_BODY(test_case__ctor_and_getters)
{
    const model::metadata md = model::metadata_builder()
        .add_custom("first", "value")
        .build();
    const model::test_case test_case("foo", md);
    ATF_REQUIRE_EQ("foo", test_case.name());
    ATF_REQUIRE_EQ(md, test_case.get_metadata());
    ATF_REQUIRE_EQ(md, test_case.get_raw_metadata());
}


ATF_TEST_CASE_WITHOUT_HEAD(test_case__fake_result)
ATF_TEST_CASE_BODY(test_case__fake_result)
{
    const model::test_result result(model::test_result_skipped,
                                    "Some reason");
    const model::test_case test_case("__foo__", "Some description", result);
    ATF_REQUIRE_EQ("__foo__", test_case.name());
    ATF_REQUIRE_EQ(result, test_case.fake_result().get());

    const model::metadata exp_metadata = model::metadata_builder()
        .set_description("Some description")
        .build();
    ATF_REQUIRE_EQ(exp_metadata, test_case.get_metadata());
    ATF_REQUIRE_EQ(exp_metadata, test_case.get_raw_metadata());
}


ATF_TEST_CASE_WITHOUT_HEAD(test_case__apply_metadata_overrides__real_test_case)
ATF_TEST_CASE_BODY(test_case__apply_metadata_overrides__real_test_case)
{
    const model::metadata overrides = model::metadata_builder()
        .add_required_config("the-variable")
        .set_description("The test case")
        .build();
    const model::test_case base_test_case("foo", overrides);

    const model::metadata defaults = model::metadata_builder()
        .set_description("Default description")
        .set_timeout(datetime::delta(10, 0))
        .build();

    const model::test_case test_case = base_test_case.apply_metadata_defaults(
        &defaults);

    const model::metadata expected = model::metadata_builder()
        .add_required_config("the-variable")
        .set_description("The test case")
        .set_timeout(datetime::delta(10, 0))
        .build();
    ATF_REQUIRE_EQ(expected, test_case.get_metadata());
    ATF_REQUIRE_EQ(overrides, test_case.get_raw_metadata());

    // Ensure the original (although immutable) test case was not touched.
    ATF_REQUIRE_EQ(overrides, base_test_case.get_metadata());
}


ATF_TEST_CASE_WITHOUT_HEAD(test_case__apply_metadata_overrides__fake_test_case)
ATF_TEST_CASE_BODY(test_case__apply_metadata_overrides__fake_test_case)
{
    const model::test_result result(model::test_result_skipped, "Irrelevant");
    const model::test_case base_test_case("__foo__", "Fake test", result);

    const model::metadata overrides = model::metadata_builder()
        .set_description("Fake test")
        .build();

    const model::metadata defaults = model::metadata_builder()
        .add_allowed_platform("some-value")
        .set_description("Default description")
        .build();

    const model::test_case test_case = base_test_case.apply_metadata_defaults(
        &defaults);

    const model::metadata expected = model::metadata_builder()
        .add_allowed_platform("some-value")
        .set_description("Fake test")
        .build();
    ATF_REQUIRE_EQ(expected, test_case.get_metadata());
    ATF_REQUIRE_EQ(overrides, test_case.get_raw_metadata());
}


ATF_TEST_CASE_WITHOUT_HEAD(test_case__operators_eq_and_ne__copy);
ATF_TEST_CASE_BODY(test_case__operators_eq_and_ne__copy)
{
    const model::test_case tc1("name", model::metadata_builder().build());
    const model::test_case tc2 = tc1;
    ATF_REQUIRE(  tc1 == tc2);
    ATF_REQUIRE(!(tc1 != tc2));
}


ATF_TEST_CASE_WITHOUT_HEAD(test_case__operators_eq_and_ne__not_copy);
ATF_TEST_CASE_BODY(test_case__operators_eq_and_ne__not_copy)
{
    const std::string base_name("name");
    const model::metadata base_metadata = model::metadata_builder()
        .add_custom("foo", "bar")
        .build();

    const model::test_case base_tc(base_name, base_metadata);

    // Construct with all same values.
    {
        const model::test_case other_tc(base_name, base_metadata);

        ATF_REQUIRE(  base_tc == other_tc);
        ATF_REQUIRE(!(base_tc != other_tc));
    }

    // Construct with all same values but different metadata objects.
    {
        const model::metadata other_metadata = model::metadata_builder()
            .add_custom("foo", "bar")
            .set_timeout(base_metadata.timeout())
            .build();
        const model::test_case other_tc(base_name, other_metadata);

        ATF_REQUIRE(  base_tc == other_tc);
        ATF_REQUIRE(!(base_tc != other_tc));
    }

    // Different name.
    {
        const model::test_case other_tc("other", base_metadata);

        ATF_REQUIRE(!(base_tc == other_tc));
        ATF_REQUIRE(  base_tc != other_tc);
    }

    // Different metadata.
    {
        const model::test_case other_tc(base_name,
                                        model::metadata_builder().build());

        ATF_REQUIRE(!(base_tc == other_tc));
        ATF_REQUIRE(  base_tc != other_tc);
    }
}


ATF_TEST_CASE_WITHOUT_HEAD(test_case__output);
ATF_TEST_CASE_BODY(test_case__output)
{
    const model::test_case tc1(
        "the-name", model::metadata_builder()
        .add_allowed_platform("foo").add_custom("bar", "baz").build());
    std::ostringstream str;
    str << tc1;
    ATF_REQUIRE_EQ(
        "test_case{name='the-name', "
        "metadata=metadata{allowed_architectures='', allowed_platforms='foo', "
        "custom.bar='baz', description='', has_cleanup='false', "
        "is_exclusive='false', "
        "required_configs='', required_disk_space='0', required_files='', "
        "required_memory='0', "
        "required_programs='', required_user='', timeout='300'}}",
        str.str());
}


ATF_TEST_CASE_WITHOUT_HEAD(test_cases_map__builder);
ATF_TEST_CASE_BODY(test_cases_map__builder)
{
    model::test_cases_map_builder builder;
    model::test_cases_map exp_test_cases;

    ATF_REQUIRE_EQ(exp_test_cases, builder.build());

    builder.add("default-metadata");
    {
        const model::test_case tc1("default-metadata",
                                   model::metadata_builder().build());
        exp_test_cases.insert(
            model::test_cases_map::value_type(tc1.name(), tc1));
    }
    ATF_REQUIRE_EQ(exp_test_cases, builder.build());

    builder.add("with-metadata",
                model::metadata_builder().set_description("text").build());
    {
        const model::test_case tc1("with-metadata",
                                   model::metadata_builder()
                                   .set_description("text").build());
        exp_test_cases.insert(
            model::test_cases_map::value_type(tc1.name(), tc1));
    }
    ATF_REQUIRE_EQ(exp_test_cases, builder.build());

    const model::test_case tc1("fully_built",
                               model::metadata_builder()
                               .set_description("something else").build());
    builder.add(tc1);
    exp_test_cases.insert(model::test_cases_map::value_type(tc1.name(), tc1));
    ATF_REQUIRE_EQ(exp_test_cases, builder.build());
}


ATF_INIT_TEST_CASES(tcs)
{
    ATF_ADD_TEST_CASE(tcs, test_case__ctor_and_getters);
    ATF_ADD_TEST_CASE(tcs, test_case__fake_result);

    ATF_ADD_TEST_CASE(tcs, test_case__apply_metadata_overrides__real_test_case);
    ATF_ADD_TEST_CASE(tcs, test_case__apply_metadata_overrides__fake_test_case);

    ATF_ADD_TEST_CASE(tcs, test_case__operators_eq_and_ne__copy);
    ATF_ADD_TEST_CASE(tcs, test_case__operators_eq_and_ne__not_copy);

    ATF_ADD_TEST_CASE(tcs, test_case__output);

    ATF_ADD_TEST_CASE(tcs, test_cases_map__builder);
}