atf-src/atf-c++/tests.hpp

a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt// Copyright (c) 2007 The NetBSD Foundation, Inc.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// All rights reserved.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt//
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// Redistribution and use in source and binary forms, with or without
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// modification, are permitted provided that the following conditions
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// are met:
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// 1. Redistributions of source code must retain the above copyright
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt//    notice, this list of conditions and the following disclaimer.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// 2. Redistributions in binary form must reproduce the above copyright
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt//    notice, this list of conditions and the following disclaimer in the
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt//    documentation and/or other materials provided with the distribution.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt//
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#if !defined(ATF_CXX_TESTS_HPP)
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#define ATF_CXX_TESTS_HPP
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#include <map>
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#include <memory>
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#include <string>
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntextern "C" {
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#include <atf-c/defs.h>
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt}
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntnamespace atf {
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntnamespace tests {
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntnamespace detail {
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntclass atf_tp_writer {
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    std::ostream& m_os;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    bool m_is_first;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntpublic:
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    atf_tp_writer(std::ostream&);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    void start_tc(const std::string&);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    void end_tc(void);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    void tc_meta_data(const std::string&, const std::string&);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt};
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntbool match(const std::string&, const std::string&);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt} // namespace
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// ------------------------------------------------------------------------
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// The "vars_map" class.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// ------------------------------------------------------------------------
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunttypedef std::map< std::string, std::string > vars_map;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// ------------------------------------------------------------------------
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// The "tc" class.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// ------------------------------------------------------------------------
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntstruct tc_impl;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrewsclass tc {
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews    // Non-copyable.
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews    tc(const tc&);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews    tc& operator=(const tc&);
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    std::auto_ptr< tc_impl > pimpl;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntprotected:
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    virtual void head(void);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    virtual void body(void) const = 0;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    virtual void cleanup(void) const;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    void require_prog(const std::string&) const;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    friend struct tc_impl;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntpublic:
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    tc(const std::string&, const bool);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    virtual ~tc(void);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    void init(const vars_map&);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    const std::string get_config_var(const std::string&) const;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    const std::string get_config_var(const std::string&, const std::string&)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt        const;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    const std::string get_md_var(const std::string&) const;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    const vars_map get_md_vars(void) const;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    bool has_config_var(const std::string&) const;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    bool has_md_var(const std::string&) const;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    void set_md_var(const std::string&, const std::string&);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    void run(const std::string&) const;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    void run_cleanup(void) const;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    // To be called from the child process only.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    static void pass(void) ATF_DEFS_ATTRIBUTE_NORETURN;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    static void fail(const std::string&) ATF_DEFS_ATTRIBUTE_NORETURN;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    static void fail_nonfatal(const std::string&);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    static void skip(const std::string&) ATF_DEFS_ATTRIBUTE_NORETURN;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    static void check_errno(const char*, const int, const int, const char*,
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt                            const bool);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    static void require_errno(const char*, const int, const int, const char*,
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt                              const bool);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    static void expect_pass(void);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    static void expect_fail(const std::string&);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    static void expect_exit(const int, const std::string&);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    static void expect_signal(const int, const std::string&);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    static void expect_death(const std::string&);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt    static void expect_timeout(const std::string&);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt};
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt} // namespace tests
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt} // namespace atf
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#endif // !defined(ATF_CXX_TESTS_HPP)