macros.hpp revision ef421f66f47224a42073deaf087378c5d0c9952e
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt//
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// Automated Testing Framework (atf)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt//
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt// Copyright (c) 2007, 2008, 2010 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//
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#if !defined(_ATF_CXX_MACROS_HPP_)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define _ATF_CXX_MACROS_HPP_
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#include <sstream>
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#include <stdexcept>
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#include <vector>
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#include <atf-c++/tests.hpp>
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_TEST_CASE_WITHOUT_HEAD(name) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt class atfu_tc_ ## name : public atf::tests::tc { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt void body(void) const; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt public: \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_tc_ ## name(void) : atf::tests::tc(#name, false) {} \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt };
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_TEST_CASE(name) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt class atfu_tc_ ## name : public atf::tests::tc { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt void head(void); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt void body(void) const; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt public: \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_tc_ ## name(void) : atf::tests::tc(#name, false) {} \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt };
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_TEST_CASE_WITH_CLEANUP(name) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt class atfu_tc_ ## name : public atf::tests::tc { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt void head(void); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt void body(void) const; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt void cleanup(void) const; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt public: \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_tc_ ## name(void) : atf::tests::tc(#name, true) {} \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt };
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_TEST_CASE_NAME(name) atfu_tc_ ## name
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_TEST_CASE_HEAD(name) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt void \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_tc_ ## name::head(void)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_TEST_CASE_BODY(name) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt void \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_tc_ ## name::body(void) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt const
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_TEST_CASE_CLEANUP(name) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt void \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_tc_ ## name::cleanup(void) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt const
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_FAIL(reason) atf::tests::tc::fail(reason)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_SKIP(reason) atf::tests::tc::skip(reason)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_PASS() atf::tests::tc::pass()
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_REQUIRE(x) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt do { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt if (!(x)) { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt std::ostringstream atfu_ss; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_ss << "Line " << __LINE__ << ": " << #x << " not met"; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc::fail(atfu_ss.str()); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } while (false)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_REQUIRE_EQ(x, y) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt do { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt if ((x) != (y)) { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt std::ostringstream atfu_ss; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_ss << "Line " << __LINE__ << ": " << #x << " != " << #y \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt << " (" << (x) << " != " << (y) << ")"; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc::fail(atfu_ss.str()); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } while (false)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_REQUIRE_MATCH(regexp, string) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt do { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt if (!atf::tests::detail::match(regexp, string)) { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt std::ostringstream atfu_ss; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_ss << "Line " << __LINE__ << ": '" << string << "' does not " \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt << "match regexp '" << regexp << "'"; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc::fail(atfu_ss.str()); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } while (false)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_REQUIRE_THROW(e, x) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt do { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt try { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt x; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt std::ostringstream atfu_ss; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_ss << "Line " << __LINE__ << ": " #x " did not throw " \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt #e " as expected"; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc::fail(atfu_ss.str()); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } catch (const e&) { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } catch (const std::exception& atfu_e) { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt std::ostringstream atfu_ss; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_ss << "Line " << __LINE__ << ": " #x " threw an " \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt "unexpected error (not " #e "): " << atfu_e.what(); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc::fail(atfu_ss.str()); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } catch (...) { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt std::ostringstream atfu_ss; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_ss << "Line " << __LINE__ << ": " #x " threw an " \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt "unexpected error (not " #e ")"; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc::fail(atfu_ss.str()); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } while (false)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_REQUIRE_THROW_RE(type, regexp, x) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt do { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt try { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt x; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt std::ostringstream atfu_ss; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_ss << "Line " << __LINE__ << ": " #x " did not throw " \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt #type " as expected"; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc::fail(atfu_ss.str()); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } catch (const type& e) { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt if (!atf::tests::detail::match(regexp, e.what())) { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt std::ostringstream atfu_ss; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_ss << "Line " << __LINE__ << ": " #x " threw " #type "(" \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt << e.what() << "), but does not match '" << regexp \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt << "'"; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc::fail(atfu_ss.str()); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } catch (const std::exception& atfu_e) { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt std::ostringstream atfu_ss; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_ss << "Line " << __LINE__ << ": " #x " threw an " \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt "unexpected error (not " #type "): " << atfu_e.what(); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc::fail(atfu_ss.str()); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } catch (...) { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt std::ostringstream atfu_ss; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_ss << "Line " << __LINE__ << ": " #x " threw an " \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt "unexpected error (not " #type ")"; \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc::fail(atfu_ss.str()); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } while (false)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_CHECK_ERRNO(exp_errno, bool_expr) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc::check_errno(__FILE__, __LINE__, exp_errno, #bool_expr, \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt bool_expr)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_REQUIRE_ERRNO(exp_errno, bool_expr) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc::require_errno(__FILE__, __LINE__, exp_errno, #bool_expr, \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt bool_expr)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_INIT_TEST_CASES(tcs) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt namespace atf { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt namespace tests { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt int run_tp(int, char* const*, \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt void (*)(std::vector< atf::tests::tc * >&)); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt static void atfu_init_tcs(std::vector< atf::tests::tc * >&); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt int \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt main(int argc, char* const* argv) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt return atf::tests::run_tp(argc, argv, atfu_init_tcs); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt static \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt void \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atfu_init_tcs(std::vector< atf::tests::tc * >& tcs)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_ADD_TEST_CASE(tcs, tcname) \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt do { \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf::tests::tc* tcptr = new atfu_tc_ ## tcname(); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt (tcs).push_back(tcptr); \
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt } while (0);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#endif // !defined(_ATF_CXX_MACROS_HPP_)