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

/// \file engine/test_program.hpp
/// Interface to interact with test programs.
///
/// A test program is purely a collection of test cases.  The test program has
/// no identity by itself: it only exists to provide a consistent entry point
/// for all the test cases it contains and to group such test cases
/// semantically.  Therefore, this module provides no data type to represent the
/// test program.

#if !defined(ENGINE_TEST_PROGRAM_HPP)
#define ENGINE_TEST_PROGRAM_HPP

#include <ostream>
#include <string>
#include <vector>

#include "engine/test_case.hpp"
#include "utils/fs/path.hpp"
#include "utils/shared_ptr.hpp"

namespace engine {


/// Collection of test cases.
typedef std::vector< test_case_ptr > test_cases_vector;


std::ostream& operator<<(std::ostream&, const test_cases_vector&);


/// Representation of a test program.
class test_program {
    struct impl;

    /// Pointer to the shared internal implementation.
    std::shared_ptr< impl > _pimpl;

public:
    test_program(const std::string&, const utils::fs::path&,
                 const utils::fs::path&, const std::string&,
                 const metadata&);
    ~test_program(void);

    const std::string& interface_name(void) const;
    const utils::fs::path& root(void) const;
    const utils::fs::path& relative_path(void) const;
    const utils::fs::path absolute_path(void) const;
    const std::string& test_suite_name(void) const;
    const metadata& get_metadata(void) const;

    const test_case_ptr& find(const std::string&) const;
    const test_cases_vector& test_cases(void) const;
    void set_test_cases(const test_cases_vector&);

    bool operator==(const test_program&) const;
    bool operator!=(const test_program&) const;
};


std::ostream& operator<<(std::ostream&, const test_program&);


/// Pointer to a test program.
typedef std::shared_ptr< test_program > test_program_ptr;


/// Collection of test programs.
typedef std::vector< test_program_ptr > test_programs_vector;


}  // namespace engine

#endif  // !defined(ENGINE_TEST_PROGRAM_HPP)