2 $var n = 50 $$ Maximum length of Values arguments we want to support.
3 $var maxtuple = 10 $$ Maximum number of Combine arguments we want to support.
4 // Copyright 2008, Google Inc.
5 // All rights reserved.
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions are
11 // * Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 // * Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
17 // * Neither the name of Google Inc. nor the names of its
18 // contributors may be used to endorse or promote products derived from
19 // this software without specific prior written permission.
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 // Macros and functions for implementing parameterized tests
34 // in Google C++ Testing and Mocking Framework (Google Test)
36 // This file is generated by a SCRIPT. DO NOT EDIT BY HAND!
38 // GOOGLETEST_CM0001 DO NOT DELETE
39 #ifndef GTEST_INCLUDE_GTEST_GTEST_PARAM_TEST_H_
40 #define GTEST_INCLUDE_GTEST_GTEST_PARAM_TEST_H_
43 // Value-parameterized tests allow you to test your code with different
44 // parameters without writing multiple copies of the same test.
46 // Here is how you use value-parameterized tests:
50 // To write value-parameterized tests, first you should define a fixture
51 // class. It is usually derived from testing::TestWithParam<T> (see below for
52 // another inheritance scheme that's sometimes useful in more complicated
53 // class hierarchies), where the type of your parameter values.
54 // TestWithParam<T> is itself derived from testing::Test. T can be any
55 // copyable type. If it's a raw pointer, you are responsible for managing the
56 // lifespan of the pointed values.
58 class FooTest : public ::testing::TestWithParam<const char*> {
59 // You can implement all the usual class fixture members here.
62 // Then, use the TEST_P macro to define as many parameterized tests
63 // for this fixture as you want. The _P suffix is for "parameterized"
64 // or "pattern", whichever you prefer to think.
66 TEST_P(FooTest, DoesBlah) {
67 // Inside a test, access the test parameter with the GetParam() method
68 // of the TestWithParam<T> class:
69 EXPECT_TRUE(foo.Blah(GetParam()));
73 TEST_P(FooTest, HasBlahBlah) {
77 // Finally, you can use INSTANTIATE_TEST_CASE_P to instantiate the test
78 // case with any set of parameters you want. Google Test defines a number
79 // of functions for generating test parameters. They return what we call
80 // (surprise!) parameter generators. Here is a summary of them, which
81 // are all in the testing namespace:
84 // Range(begin, end [, step]) - Yields values {begin, begin+step,
85 // begin+step+step, ...}. The values do not
86 // include end. step defaults to 1.
87 // Values(v1, v2, ..., vN) - Yields values {v1, v2, ..., vN}.
88 // ValuesIn(container) - Yields values from a C-style array, an STL
89 // ValuesIn(begin,end) container, or an iterator range [begin, end).
90 // Bool() - Yields sequence {false, true}.
91 // Combine(g1, g2, ..., gN) - Yields all combinations (the Cartesian product
92 // for the math savvy) of the values generated
93 // by the N generators.
95 // For more details, see comments at the definitions of these functions below
98 // The following statement will instantiate tests from the FooTest test case
99 // each with parameter values "meeny", "miny", and "moe".
101 INSTANTIATE_TEST_CASE_P(InstantiationName,
103 Values("meeny", "miny", "moe"));
105 // To distinguish different instances of the pattern, (yes, you
106 // can instantiate it more then once) the first argument to the
107 // INSTANTIATE_TEST_CASE_P macro is a prefix that will be added to the
108 // actual test case name. Remember to pick unique prefixes for different
109 // instantiations. The tests from the instantiation above will have
112 // * InstantiationName/FooTest.DoesBlah/0 for "meeny"
113 // * InstantiationName/FooTest.DoesBlah/1 for "miny"
114 // * InstantiationName/FooTest.DoesBlah/2 for "moe"
115 // * InstantiationName/FooTest.HasBlahBlah/0 for "meeny"
116 // * InstantiationName/FooTest.HasBlahBlah/1 for "miny"
117 // * InstantiationName/FooTest.HasBlahBlah/2 for "moe"
119 // You can use these names in --gtest_filter.
121 // This statement will instantiate all tests from FooTest again, each
122 // with parameter values "cat" and "dog":
124 const char* pets[] = {"cat", "dog"};
125 INSTANTIATE_TEST_CASE_P(AnotherInstantiationName, FooTest, ValuesIn(pets));
127 // The tests from the instantiation above will have these names:
129 // * AnotherInstantiationName/FooTest.DoesBlah/0 for "cat"
130 // * AnotherInstantiationName/FooTest.DoesBlah/1 for "dog"
131 // * AnotherInstantiationName/FooTest.HasBlahBlah/0 for "cat"
132 // * AnotherInstantiationName/FooTest.HasBlahBlah/1 for "dog"
134 // Please note that INSTANTIATE_TEST_CASE_P will instantiate all tests
135 // in the given test case, whether their definitions come before or
136 // AFTER the INSTANTIATE_TEST_CASE_P statement.
138 // Please also note that generator expressions (including parameters to the
139 // generators) are evaluated in InitGoogleTest(), after main() has started.
140 // This allows the user on one hand, to adjust generator parameters in order
141 // to dynamically determine a set of tests to run and on the other hand,
142 // give the user a chance to inspect the generated tests with Google Test
143 // reflection API before RUN_ALL_TESTS() is executed.
145 // You can see samples/sample7_unittest.cc and samples/sample8_unittest.cc
146 // for more examples.
148 // In the future, we plan to publish the API for defining new parameter
149 // generators. But for now this interface remains part of the internal
150 // implementation and is subject to change.
153 // A parameterized test fixture must be derived from testing::Test and from
154 // testing::WithParamInterface<T>, where T is the type of the parameter
155 // values. Inheriting from TestWithParam<T> satisfies that requirement because
156 // TestWithParam<T> inherits from both Test and WithParamInterface. In more
157 // complicated hierarchies, however, it is occasionally useful to inherit
158 // separately from Test and WithParamInterface. For example:
160 class BaseTest : public ::testing::Test {
161 // You can inherit all the usual members for a non-parameterized test
165 class DerivedTest : public BaseTest, public ::testing::WithParamInterface<int> {
166 // The usual test fixture members go here too.
169 TEST_F(BaseTest, HasFoo) {
170 // This is an ordinary non-parameterized test.
173 TEST_P(DerivedTest, DoesBlah) {
174 // GetParam works just the same here as if you inherit from TestWithParam.
175 EXPECT_TRUE(foo.Blah(GetParam()));
180 #include "gtest/internal/gtest-port.h"
182 #if !GTEST_OS_SYMBIAN
186 #include "gtest/internal/gtest-internal.h"
187 #include "gtest/internal/gtest-param-util.h"
188 #include "gtest/internal/gtest-param-util-generated.h"
192 // Functions producing parameter generators.
194 // Google Test uses these generators to produce parameters for value-
195 // parameterized tests. When a parameterized test case is instantiated
196 // with a particular generator, Google Test creates and runs tests
197 // for each element in the sequence produced by the generator.
199 // In the following sample, tests from test case FooTest are instantiated
200 // each three times with parameter values 3, 5, and 8:
202 // class FooTest : public TestWithParam<int> { ... };
204 // TEST_P(FooTest, TestThis) {
206 // TEST_P(FooTest, TestThat) {
208 // INSTANTIATE_TEST_CASE_P(TestSequence, FooTest, Values(3, 5, 8));
211 // Range() returns generators providing sequences of values in a range.
215 // - returns a generator producing a sequence of values {start, start+1,
217 // Range(start, end, step)
218 // - returns a generator producing a sequence of values {start, start+step,
219 // start+step+step, ..., }.
221 // * The generated sequences never include end. For example, Range(1, 5)
222 // returns a generator producing a sequence {1, 2, 3, 4}. Range(1, 9, 2)
223 // returns a generator producing {1, 3, 5, 7}.
224 // * start and end must have the same type. That type may be any integral or
225 // floating-point type or a user defined type satisfying these conditions:
226 // * It must be assignable (have operator=() defined).
227 // * It must have operator+() (operator+(int-compatible type) for
228 // two-operand version).
229 // * It must have operator<() defined.
230 // Elements in the resulting sequences will also have that type.
231 // * Condition start < end must be satisfied in order for resulting sequences
232 // to contain any elements.
234 template <typename T, typename IncrementT>
235 internal::ParamGenerator<T> Range(T start, T end, IncrementT step) {
236 return internal::ParamGenerator<T>(
237 new internal::RangeGenerator<T, IncrementT>(start, end, step));
240 template <typename T>
241 internal::ParamGenerator<T> Range(T start, T end) {
242 return Range(start, end, 1);
245 // ValuesIn() function allows generation of tests with parameters coming from
249 // ValuesIn(const T (&array)[N])
250 // - returns a generator producing sequences with elements from
252 // ValuesIn(const Container& container)
253 // - returns a generator producing sequences with elements from
254 // an STL-style container.
255 // ValuesIn(Iterator begin, Iterator end)
256 // - returns a generator producing sequences with elements from
257 // a range [begin, end) defined by a pair of STL-style iterators. These
258 // iterators can also be plain C pointers.
260 // Please note that ValuesIn copies the values from the containers
261 // passed in and keeps them to generate tests in RUN_ALL_TESTS().
265 // This instantiates tests from test case StringTest
266 // each with C-string values of "foo", "bar", and "baz":
268 // const char* strings[] = {"foo", "bar", "baz"};
269 // INSTANTIATE_TEST_CASE_P(StringSequence, StringTest, ValuesIn(strings));
271 // This instantiates tests from test case StlStringTest
272 // each with STL strings with values "a" and "b":
274 // ::std::vector< ::std::string> GetParameterStrings() {
275 // ::std::vector< ::std::string> v;
281 // INSTANTIATE_TEST_CASE_P(CharSequence,
283 // ValuesIn(GetParameterStrings()));
286 // This will also instantiate tests from CharTest
287 // each with parameter values 'a' and 'b':
289 // ::std::list<char> GetParameterChars() {
290 // ::std::list<char> list;
291 // list.push_back('a');
292 // list.push_back('b');
295 // ::std::list<char> l = GetParameterChars();
296 // INSTANTIATE_TEST_CASE_P(CharSequence2,
298 // ValuesIn(l.begin(), l.end()));
300 template <typename ForwardIterator>
301 internal::ParamGenerator<
302 typename ::testing::internal::IteratorTraits<ForwardIterator>::value_type>
303 ValuesIn(ForwardIterator begin, ForwardIterator end) {
304 typedef typename ::testing::internal::IteratorTraits<ForwardIterator>
305 ::value_type ParamType;
306 return internal::ParamGenerator<ParamType>(
307 new internal::ValuesInIteratorRangeGenerator<ParamType>(begin, end));
310 template <typename T, size_t N>
311 internal::ParamGenerator<T> ValuesIn(const T (&array)[N]) {
312 return ValuesIn(array, array + N);
315 template <class Container>
316 internal::ParamGenerator<typename Container::value_type> ValuesIn(
317 const Container& container) {
318 return ValuesIn(container.begin(), container.end());
321 // Values() allows generating tests from explicitly specified list of
325 // Values(T v1, T v2, ..., T vN)
326 // - returns a generator producing sequences with elements v1, v2, ..., vN.
328 // For example, this instantiates tests from test case BarTest each
329 // with values "one", "two", and "three":
331 // INSTANTIATE_TEST_CASE_P(NumSequence, BarTest, Values("one", "two", "three"));
333 // This instantiates tests from test case BazTest each with values 1, 2, 3.5.
334 // The exact type of values will depend on the type of parameter in BazTest.
336 // INSTANTIATE_TEST_CASE_P(FloatingNumbers, BazTest, Values(1, 2, 3.5));
338 // Currently, Values() supports from 1 to $n parameters.
344 template <$for j, [[typename T$j]]>
345 internal::ValueArray$i<$for j, [[T$j]]> Values($for j, [[T$j v$j]]) {
346 return internal::ValueArray$i<$for j, [[T$j]]>($for j, [[v$j]]);
351 // Bool() allows generating tests with parameters in a set of (false, true).
355 // - returns a generator producing sequences with elements {false, true}.
357 // It is useful when testing code that depends on Boolean flags. Combinations
358 // of multiple flags can be tested when several Bool()'s are combined using
359 // Combine() function.
361 // In the following example all tests in the test case FlagDependentTest
362 // will be instantiated twice with parameters false and true.
364 // class FlagDependentTest : public testing::TestWithParam<bool> {
365 // virtual void SetUp() {
366 // external_flag = GetParam();
369 // INSTANTIATE_TEST_CASE_P(BoolSequence, FlagDependentTest, Bool());
371 inline internal::ParamGenerator<bool> Bool() {
372 return Values(false, true);
375 # if GTEST_HAS_COMBINE
376 // Combine() allows the user to combine two or more sequences to produce
377 // values of a Cartesian product of those sequences' elements.
380 // Combine(gen1, gen2, ..., genN)
381 // - returns a generator producing sequences with elements coming from
382 // the Cartesian product of elements from the sequences generated by
383 // gen1, gen2, ..., genN. The sequence elements will have a type of
384 // tuple<T1, T2, ..., TN> where T1, T2, ..., TN are the types
385 // of elements from sequences produces by gen1, gen2, ..., genN.
387 // Combine can have up to $maxtuple arguments. This number is currently limited
388 // by the maximum number of elements in the tuple implementation used by Google
393 // This will instantiate tests in test case AnimalTest each one with
394 // the parameter values tuple("cat", BLACK), tuple("cat", WHITE),
395 // tuple("dog", BLACK), and tuple("dog", WHITE):
397 // enum Color { BLACK, GRAY, WHITE };
399 // : public testing::TestWithParam<tuple<const char*, Color> > {...};
401 // TEST_P(AnimalTest, AnimalLooksNice) {...}
403 // INSTANTIATE_TEST_CASE_P(AnimalVariations, AnimalTest,
404 // Combine(Values("cat", "dog"),
405 // Values(BLACK, WHITE)));
407 // This will instantiate tests in FlagDependentTest with all variations of two
410 // class FlagDependentTest
411 // : public testing::TestWithParam<tuple<bool, bool> > {
412 // virtual void SetUp() {
413 // // Assigns external_flag_1 and external_flag_2 values from the tuple.
414 // tie(external_flag_1, external_flag_2) = GetParam();
418 // TEST_P(FlagDependentTest, TestFeature1) {
419 // // Test your code using external_flag_1 and external_flag_2 here.
421 // INSTANTIATE_TEST_CASE_P(TwoBoolSequence, FlagDependentTest,
422 // Combine(Bool(), Bool()));
428 template <$for j, [[typename Generator$j]]>
429 internal::CartesianProductHolder$i<$for j, [[Generator$j]]> Combine(
430 $for j, [[const Generator$j& g$j]]) {
431 return internal::CartesianProductHolder$i<$for j, [[Generator$j]]>(
436 # endif // GTEST_HAS_COMBINE
438 # define TEST_P(test_case_name, test_name) \
439 class GTEST_TEST_CLASS_NAME_(test_case_name, test_name) \
440 : public test_case_name { \
442 GTEST_TEST_CLASS_NAME_(test_case_name, test_name)() {} \
443 virtual void TestBody(); \
445 static int AddToRegistry() { \
446 ::testing::UnitTest::GetInstance()->parameterized_test_registry(). \
447 GetTestCasePatternHolder<test_case_name>(\
449 ::testing::internal::CodeLocation(\
450 __FILE__, __LINE__))->AddTestPattern(\
451 GTEST_STRINGIFY_(test_case_name), \
452 GTEST_STRINGIFY_(test_name), \
453 new ::testing::internal::TestMetaFactory< \
454 GTEST_TEST_CLASS_NAME_(\
455 test_case_name, test_name)>()); \
458 static int gtest_registering_dummy_ GTEST_ATTRIBUTE_UNUSED_; \
459 GTEST_DISALLOW_COPY_AND_ASSIGN_(\
460 GTEST_TEST_CLASS_NAME_(test_case_name, test_name)); \
462 int GTEST_TEST_CLASS_NAME_(test_case_name, \
463 test_name)::gtest_registering_dummy_ = \
464 GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::AddToRegistry(); \
465 void GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::TestBody()
467 // The optional last argument to INSTANTIATE_TEST_CASE_P allows the user
468 // to specify a function or functor that generates custom test name suffixes
469 // based on the test parameters. The function should accept one argument of
470 // type testing::TestParamInfo<class ParamType>, and return std::string.
472 // testing::PrintToStringParamName is a builtin test suffix generator that
473 // returns the value of testing::PrintToString(GetParam()).
475 // Note: test names must be non-empty, unique, and may only contain ASCII
476 // alphanumeric characters or underscore. Because PrintToString adds quotes
477 // to std::string and C strings, it won't work for these types.
479 # define INSTANTIATE_TEST_CASE_P(prefix, test_case_name, generator, ...) \
480 static ::testing::internal::ParamGenerator<test_case_name::ParamType> \
481 gtest_##prefix##test_case_name##_EvalGenerator_() { return generator; } \
482 static ::std::string gtest_##prefix##test_case_name##_EvalGenerateName_( \
483 const ::testing::TestParamInfo<test_case_name::ParamType>& info) { \
484 return ::testing::internal::GetParamNameGen<test_case_name::ParamType> \
485 (__VA_ARGS__)(info); \
487 static int gtest_##prefix##test_case_name##_dummy_ GTEST_ATTRIBUTE_UNUSED_ = \
488 ::testing::UnitTest::GetInstance()->parameterized_test_registry(). \
489 GetTestCasePatternHolder<test_case_name>(\
491 ::testing::internal::CodeLocation(\
492 __FILE__, __LINE__))->AddTestCaseInstantiation(\
494 >est_##prefix##test_case_name##_EvalGenerator_, \
495 >est_##prefix##test_case_name##_EvalGenerateName_, \
498 } // namespace testing
500 #endif // GTEST_INCLUDE_GTEST_GTEST_PARAM_TEST_H_