0,0 → 1,259 |
// Copyright 2008 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. |
// |
// Author: wan@google.com (Zhanyong Wan) |
|
#ifndef GTEST_INCLUDE_GTEST_GTEST_TYPED_TEST_H_ |
#define GTEST_INCLUDE_GTEST_GTEST_TYPED_TEST_H_ |
|
// This header implements typed tests and type-parameterized tests. |
|
// Typed (aka type-driven) tests repeat the same test for types in a |
// list. You must know which types you want to test with when writing |
// typed tests. Here's how you do it: |
|
#if 0 |
|
// First, define a fixture class template. It should be parameterized |
// by a type. Remember to derive it from testing::Test. |
template <typename T> |
class FooTest : public testing::Test { |
public: |
... |
typedef std::list<T> List; |
static T shared_; |
T value_; |
}; |
|
// Next, associate a list of types with the test case, which will be |
// repeated for each type in the list. The typedef is necessary for |
// the macro to parse correctly. |
typedef testing::Types<char, int, unsigned int> MyTypes; |
TYPED_TEST_CASE(FooTest, MyTypes); |
|
// If the type list contains only one type, you can write that type |
// directly without Types<...>: |
// TYPED_TEST_CASE(FooTest, int); |
|
// Then, use TYPED_TEST() instead of TEST_F() to define as many typed |
// tests for this test case as you want. |
TYPED_TEST(FooTest, DoesBlah) { |
// Inside a test, refer to TypeParam to get the type parameter. |
// Since we are inside a derived class template, C++ requires use to |
// visit the members of FooTest via 'this'. |
TypeParam n = this->value_; |
|
// To visit static members of the fixture, add the TestFixture:: |
// prefix. |
n += TestFixture::shared_; |
|
// To refer to typedefs in the fixture, add the "typename |
// TestFixture::" prefix. |
typename TestFixture::List values; |
values.push_back(n); |
... |
} |
|
TYPED_TEST(FooTest, HasPropertyA) { ... } |
|
#endif // 0 |
|
// Type-parameterized tests are abstract test patterns parameterized |
// by a type. Compared with typed tests, type-parameterized tests |
// allow you to define the test pattern without knowing what the type |
// parameters are. The defined pattern can be instantiated with |
// different types any number of times, in any number of translation |
// units. |
// |
// If you are designing an interface or concept, you can define a |
// suite of type-parameterized tests to verify properties that any |
// valid implementation of the interface/concept should have. Then, |
// each implementation can easily instantiate the test suite to verify |
// that it conforms to the requirements, without having to write |
// similar tests repeatedly. Here's an example: |
|
#if 0 |
|
// First, define a fixture class template. It should be parameterized |
// by a type. Remember to derive it from testing::Test. |
template <typename T> |
class FooTest : public testing::Test { |
... |
}; |
|
// Next, declare that you will define a type-parameterized test case |
// (the _P suffix is for "parameterized" or "pattern", whichever you |
// prefer): |
TYPED_TEST_CASE_P(FooTest); |
|
// Then, use TYPED_TEST_P() to define as many type-parameterized tests |
// for this type-parameterized test case as you want. |
TYPED_TEST_P(FooTest, DoesBlah) { |
// Inside a test, refer to TypeParam to get the type parameter. |
TypeParam n = 0; |
... |
} |
|
TYPED_TEST_P(FooTest, HasPropertyA) { ... } |
|
// Now the tricky part: you need to register all test patterns before |
// you can instantiate them. The first argument of the macro is the |
// test case name; the rest are the names of the tests in this test |
// case. |
REGISTER_TYPED_TEST_CASE_P(FooTest, |
DoesBlah, HasPropertyA); |
|
// Finally, you are free to instantiate the pattern with the types you |
// want. If you put the above code in a header file, you can #include |
// it in multiple C++ source files and instantiate it multiple times. |
// |
// To distinguish different instances of the pattern, the first |
// argument to the INSTANTIATE_* macro is a prefix that will be added |
// to the actual test case name. Remember to pick unique prefixes for |
// different instances. |
typedef testing::Types<char, int, unsigned int> MyTypes; |
INSTANTIATE_TYPED_TEST_CASE_P(My, FooTest, MyTypes); |
|
// If the type list contains only one type, you can write that type |
// directly without Types<...>: |
// INSTANTIATE_TYPED_TEST_CASE_P(My, FooTest, int); |
|
#endif // 0 |
|
#include "gtest/internal/gtest-port.h" |
#include "gtest/internal/gtest-type-util.h" |
|
// Implements typed tests. |
|
#if GTEST_HAS_TYPED_TEST |
|
// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. |
// |
// Expands to the name of the typedef for the type parameters of the |
// given test case. |
# define GTEST_TYPE_PARAMS_(TestCaseName) gtest_type_params_##TestCaseName##_ |
|
// The 'Types' template argument below must have spaces around it |
// since some compilers may choke on '>>' when passing a template |
// instance (e.g. Types<int>) |
# define TYPED_TEST_CASE(CaseName, Types) \ |
typedef ::testing::internal::TypeList< Types >::type \ |
GTEST_TYPE_PARAMS_(CaseName) |
|
# define TYPED_TEST(CaseName, TestName) \ |
template <typename gtest_TypeParam_> \ |
class GTEST_TEST_CLASS_NAME_(CaseName, TestName) \ |
: public CaseName<gtest_TypeParam_> { \ |
private: \ |
typedef CaseName<gtest_TypeParam_> TestFixture; \ |
typedef gtest_TypeParam_ TypeParam; \ |
virtual void TestBody(); \ |
}; \ |
bool gtest_##CaseName##_##TestName##_registered_ GTEST_ATTRIBUTE_UNUSED_ = \ |
::testing::internal::TypeParameterizedTest< \ |
CaseName, \ |
::testing::internal::TemplateSel< \ |
GTEST_TEST_CLASS_NAME_(CaseName, TestName)>, \ |
GTEST_TYPE_PARAMS_(CaseName)>::Register(\ |
"", #CaseName, #TestName, 0); \ |
template <typename gtest_TypeParam_> \ |
void GTEST_TEST_CLASS_NAME_(CaseName, TestName)<gtest_TypeParam_>::TestBody() |
|
#endif // GTEST_HAS_TYPED_TEST |
|
// Implements type-parameterized tests. |
|
#if GTEST_HAS_TYPED_TEST_P |
|
// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. |
// |
// Expands to the namespace name that the type-parameterized tests for |
// the given type-parameterized test case are defined in. The exact |
// name of the namespace is subject to change without notice. |
# define GTEST_CASE_NAMESPACE_(TestCaseName) \ |
gtest_case_##TestCaseName##_ |
|
// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. |
// |
// Expands to the name of the variable used to remember the names of |
// the defined tests in the given test case. |
# define GTEST_TYPED_TEST_CASE_P_STATE_(TestCaseName) \ |
gtest_typed_test_case_p_state_##TestCaseName##_ |
|
// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE DIRECTLY. |
// |
// Expands to the name of the variable used to remember the names of |
// the registered tests in the given test case. |
# define GTEST_REGISTERED_TEST_NAMES_(TestCaseName) \ |
gtest_registered_test_names_##TestCaseName##_ |
|
// The variables defined in the type-parameterized test macros are |
// static as typically these macros are used in a .h file that can be |
// #included in multiple translation units linked together. |
# define TYPED_TEST_CASE_P(CaseName) \ |
static ::testing::internal::TypedTestCasePState \ |
GTEST_TYPED_TEST_CASE_P_STATE_(CaseName) |
|
# define TYPED_TEST_P(CaseName, TestName) \ |
namespace GTEST_CASE_NAMESPACE_(CaseName) { \ |
template <typename gtest_TypeParam_> \ |
class TestName : public CaseName<gtest_TypeParam_> { \ |
private: \ |
typedef CaseName<gtest_TypeParam_> TestFixture; \ |
typedef gtest_TypeParam_ TypeParam; \ |
virtual void TestBody(); \ |
}; \ |
static bool gtest_##TestName##_defined_ GTEST_ATTRIBUTE_UNUSED_ = \ |
GTEST_TYPED_TEST_CASE_P_STATE_(CaseName).AddTestName(\ |
__FILE__, __LINE__, #CaseName, #TestName); \ |
} \ |
template <typename gtest_TypeParam_> \ |
void GTEST_CASE_NAMESPACE_(CaseName)::TestName<gtest_TypeParam_>::TestBody() |
|
# define REGISTER_TYPED_TEST_CASE_P(CaseName, ...) \ |
namespace GTEST_CASE_NAMESPACE_(CaseName) { \ |
typedef ::testing::internal::Templates<__VA_ARGS__>::type gtest_AllTests_; \ |
} \ |
static const char* const GTEST_REGISTERED_TEST_NAMES_(CaseName) = \ |
GTEST_TYPED_TEST_CASE_P_STATE_(CaseName).VerifyRegisteredTestNames(\ |
__FILE__, __LINE__, #__VA_ARGS__) |
|
// The 'Types' template argument below must have spaces around it |
// since some compilers may choke on '>>' when passing a template |
// instance (e.g. Types<int>) |
# define INSTANTIATE_TYPED_TEST_CASE_P(Prefix, CaseName, Types) \ |
bool gtest_##Prefix##_##CaseName GTEST_ATTRIBUTE_UNUSED_ = \ |
::testing::internal::TypeParameterizedTestCase<CaseName, \ |
GTEST_CASE_NAMESPACE_(CaseName)::gtest_AllTests_, \ |
::testing::internal::TypeList< Types >::type>::Register(\ |
#Prefix, #CaseName, GTEST_REGISTERED_TEST_NAMES_(CaseName)) |
|
#endif // GTEST_HAS_TYPED_TEST_P |
|
#endif // GTEST_INCLUDE_GTEST_GTEST_TYPED_TEST_H_ |