3 # Copyright 2006, Google Inc.
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions are
10 # * Redistributions of source code must retain the above copyright
11 # notice, this list of conditions and the following disclaimer.
12 # * Redistributions in binary form must reproduce the above
13 # copyright notice, this list of conditions and the following disclaimer
14 # in the documentation and/or other materials provided with the
16 # * Neither the name of Google Inc. nor the names of its
17 # contributors may be used to endorse or promote products derived from
18 # this software without specific prior written permission.
20 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 """gen_gtest_pred_impl.py v0.1
34 Generates the implementation of Google Test predicate assertions and
39 gen_gtest_pred_impl.py MAX_ARITY
41 where MAX_ARITY is a positive integer.
43 The command generates the implementation of up-to MAX_ARITY-ary
44 predicate assertions, and writes it to file gtest_pred_impl.h in the
45 directory where the script is. It also generates the accompanying
46 unit test in file gtest_pred_impl_unittest.cc.
49 __author__ = 'wan@google.com (Zhanyong Wan)'
55 # Where this script is.
56 SCRIPT_DIR = os.path.dirname(sys.argv[0])
58 # Where to store the generated header.
59 HEADER = os.path.join(SCRIPT_DIR, '../include/gtest/gtest_pred_impl.h')
61 # Where to store the generated unit test.
62 UNIT_TEST = os.path.join(SCRIPT_DIR, '../test/gtest_pred_impl_unittest.cc')
65 def HeaderPreamble(n):
66 """Returns the preamble for the header file.
69 n: the maximum arity of the predicate macros to be generated.
72 # A map that defines the values used in the preamble template.
74 'today' : time.strftime('%m/%d/%Y'),
75 'year' : time.strftime('%Y'),
76 'command' : '%s %s' % (os.path.basename(sys.argv[0]), n),
81 """// Copyright 2006, Google Inc.
82 // All rights reserved.
84 // Redistribution and use in source and binary forms, with or without
85 // modification, are permitted provided that the following conditions are
88 // * Redistributions of source code must retain the above copyright
89 // notice, this list of conditions and the following disclaimer.
90 // * Redistributions in binary form must reproduce the above
91 // copyright notice, this list of conditions and the following disclaimer
92 // in the documentation and/or other materials provided with the
94 // * Neither the name of Google Inc. nor the names of its
95 // contributors may be used to endorse or promote products derived from
96 // this software without specific prior written permission.
98 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
99 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
100 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
101 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
102 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
103 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
104 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
105 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
106 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
107 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
108 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
110 // This file is AUTOMATICALLY GENERATED on %(today)s by command
111 // '%(command)s'. DO NOT EDIT BY HAND!
113 // Implements a family of generic predicate assertion macros.""" +
114 """#ifndef GOOGLETEST_INCLUDE_GTEST_GTEST_PRED_IMPL_H_
115 #define GOOGLETEST_INCLUDE_GTEST_GTEST_PRED_IMPL_H_
117 #include "gtest/gtest.h"
121 // This header implements a family of generic predicate assertion
124 // ASSERT_PRED_FORMAT1(pred_format, v1)
125 // ASSERT_PRED_FORMAT2(pred_format, v1, v2)
128 // where pred_format is a function or functor that takes n (in the
129 // case of ASSERT_PRED_FORMATn) values and their source expression
130 // text, and returns a testing::AssertionResult. See the definition
131 // of ASSERT_EQ in gtest.h for an example.
133 // If you don't care about formatting, you can use the more
134 // restrictive version:
136 // ASSERT_PRED1(pred, v1)
137 // ASSERT_PRED2(pred, v1, v2)
140 // where pred is an n-ary function or functor that returns bool,
141 // and the values v1, v2, ..., must support the << operator for
142 // streaming to std::ostream.
144 // We also define the EXPECT_* variations.
146 // For now we only support predicates whose arity is at most %(n)s.
147 // Please email googletestframework@googlegroups.com if you need
148 // support for higher arities.
150 // GTEST_ASSERT_ is the basic statement to which all of the assertions
151 // in this file reduce. Don't use this in your code.
153 #define GTEST_ASSERT_(expression, on_failure) \\
154 GTEST_AMBIGUOUS_ELSE_BLOCKER_ \\
155 if (const ::testing::AssertionResult gtest_ar = (expression)) \\
158 on_failure(gtest_ar.failure_message())
163 """Returns the English name of the given arity."""
168 return ['nullary', 'unary', 'binary', 'ternary'][n]
174 """Returns the given word in title case. The difference between
175 this and string's title() method is that Title('4-ary') is '4-ary'
176 while '4-ary'.title() is '4-Ary'."""
178 return word[0].upper() + word[1:]
182 """Returns the list [1, 2, 3, ..., n]."""
184 return range(1, n + 1)
187 def Iter(n, format, sep=''):
188 """Given a positive integer n, a format string that contains 0 or
189 more '%s' format specs, and optionally a separator string, returns
190 the join of n strings, each formatted with the format string on an
191 iterator ranged from 1 to n.
195 Iter(3, 'v%s', sep=', ') returns 'v1, v2, v3'.
198 # How many '%s' specs are in format?
199 spec_count = len(format.split('%s')) - 1
200 return sep.join([format % (spec_count * (i,)) for i in OneTo(n)])
203 def ImplementationForArity(n):
204 """Returns the implementation of n-ary predicate assertions."""
206 # A map the defines the values used in the implementation template.
209 'vs' : Iter(n, 'v%s', sep=', '),
210 'vts' : Iter(n, '#v%s', sep=', '),
212 'Arity' : Title(Arity(n))
217 // Helper function for implementing {EXPECT|ASSERT}_PRED%(n)s. Don't use
218 // this in your code.
219 template <typename Pred""" % DEFS
225 AssertionResult AssertPred%(n)sHelper(const char* pred_text""" % DEFS
237 if (pred(%(vs)s)) return AssertionSuccess();
241 impl += ' return AssertionFailure() << pred_text << "("'
244 << e%s""", sep=' << ", "')
246 impl += ' << ") evaluates to false, where"'
250 << "\\n" << e%s << " evaluates to " << ::testing::PrintToString(v%s)"""
256 // Internal macro for implementing {EXPECT|ASSERT}_PRED_FORMAT%(n)s.
257 // Don't use this in your code.
258 #define GTEST_PRED_FORMAT%(n)s_(pred_format, %(vs)s, on_failure)\\
259 GTEST_ASSERT_(pred_format(%(vts)s, %(vs)s), \\
262 // Internal macro for implementing {EXPECT|ASSERT}_PRED%(n)s. Don't use
263 // this in your code.
264 #define GTEST_PRED%(n)s_(pred, %(vs)s, on_failure)\\
265 GTEST_ASSERT_(::testing::AssertPred%(n)sHelper(#pred""" % DEFS
267 impl += Iter(n, """, \\
273 impl += Iter(n, """, \\
276 impl += """), on_failure)
278 // %(Arity)s predicate assertion macros.
279 #define EXPECT_PRED_FORMAT%(n)s(pred_format, %(vs)s) \\
280 GTEST_PRED_FORMAT%(n)s_(pred_format, %(vs)s, GTEST_NONFATAL_FAILURE_)
281 #define EXPECT_PRED%(n)s(pred, %(vs)s) \\
282 GTEST_PRED%(n)s_(pred, %(vs)s, GTEST_NONFATAL_FAILURE_)
283 #define ASSERT_PRED_FORMAT%(n)s(pred_format, %(vs)s) \\
284 GTEST_PRED_FORMAT%(n)s_(pred_format, %(vs)s, GTEST_FATAL_FAILURE_)
285 #define ASSERT_PRED%(n)s(pred, %(vs)s) \\
286 GTEST_PRED%(n)s_(pred, %(vs)s, GTEST_FATAL_FAILURE_)
293 def HeaderPostamble():
294 """Returns the postamble for the header file."""
298 } // namespace testing
300 #endif // GOOGLETEST_INCLUDE_GTEST_GTEST_PRED_IMPL_H_
304 def GenerateFile(path, content):
305 """Given a file path and a content string
306 overwrites it with the given content.
308 print 'Updating file %s . . .' % path
313 print 'File %s has been updated.' % path
316 def GenerateHeader(n):
317 """Given the maximum arity n, updates the header file that implements
318 the predicate assertions.
322 + ''.join([ImplementationForArity(i) for i in OneTo(n)])
326 def UnitTestPreamble():
327 """Returns the preamble for the unit test file."""
329 # A map that defines the values used in the preamble template.
331 'today' : time.strftime('%m/%d/%Y'),
332 'year' : time.strftime('%Y'),
333 'command' : '%s %s' % (os.path.basename(sys.argv[0]), sys.argv[1]),
337 """// Copyright 2006, Google Inc.
338 // All rights reserved.
340 // Redistribution and use in source and binary forms, with or without
341 // modification, are permitted provided that the following conditions are
344 // * Redistributions of source code must retain the above copyright
345 // notice, this list of conditions and the following disclaimer.
346 // * Redistributions in binary form must reproduce the above
347 // copyright notice, this list of conditions and the following disclaimer
348 // in the documentation and/or other materials provided with the
350 // * Neither the name of Google Inc. nor the names of its
351 // contributors may be used to endorse or promote products derived from
352 // this software without specific prior written permission.
354 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
355 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
356 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
357 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
358 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
359 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
360 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
361 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
362 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
363 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
364 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
366 // This file is AUTOMATICALLY GENERATED on %(today)s by command
367 // '%(command)s'. DO NOT EDIT BY HAND!
369 // Regression test for gtest_pred_impl.h
371 // This file is generated by a script and quite long. If you intend to
372 // learn how Google Test works by reading its unit tests, read
373 // gtest_unittest.cc instead.
375 // This is intended as a regression test for the Google Test predicate
376 // assertions. We compile it as part of the gtest_unittest target
377 // only to keep the implementation tidy and compact, as it is quite
378 // involved to set up the stage for testing Google Test using Google
381 // Currently, gtest_unittest takes ~11 seconds to run in the testing
382 // daemon. In the future, if it grows too large and needs much more
383 // time to finish, we should consider separating this file into a
384 // stand-alone regression test.
388 #include "gtest/gtest.h"
389 #include "gtest/gtest-spi.h"
391 // A user-defined data type.
393 explicit Bool(int val) : value(val != 0) {}
395 bool operator>(int n) const { return value > Bool(n).value; }
397 Bool operator+(const Bool& rhs) const { return Bool(value + rhs.value); }
399 bool operator==(const Bool& rhs) const { return value == rhs.value; }
404 // Enables Bool to be used in assertions.
405 std::ostream& operator<<(std::ostream& os, const Bool& x) {
406 return os << (x.value ? "true" : "false");
412 def TestsForArity(n):
413 """Returns the tests for n-ary predicate assertions."""
415 # A map that defines the values used in the template for the tests.
418 'es' : Iter(n, 'e%s', sep=', '),
419 'vs' : Iter(n, 'v%s', sep=', '),
420 'vts' : Iter(n, '#v%s', sep=', '),
421 'tvs' : Iter(n, 'T%s v%s', sep=', '),
422 'int_vs' : Iter(n, 'int v%s', sep=', '),
423 'Bool_vs' : Iter(n, 'Bool v%s', sep=', '),
424 'types' : Iter(n, 'typename T%s', sep=', '),
425 'v_sum' : Iter(n, 'v%s', sep=' + '),
427 'Arity' : Title(Arity(n)),
431 """// Sample functions/functors for testing %(arity)s predicate assertions.
433 // A %(arity)s predicate function.
435 bool PredFunction%(n)s(%(tvs)s) {
436 return %(v_sum)s > 0;
439 // The following two functions are needed because a compiler doesn't have
440 // a context yet to know which template function must be instantiated.
441 bool PredFunction%(n)sInt(%(int_vs)s) {
442 return %(v_sum)s > 0;
444 bool PredFunction%(n)sBool(%(Bool_vs)s) {
445 return %(v_sum)s > 0;
450 // A %(arity)s predicate functor.
451 struct PredFunctor%(n)s {
453 bool operator()(""" % DEFS
455 tests += Iter(n, 'const T%s& v%s', sep=""",
459 return %(v_sum)s > 0;
465 // A %(arity)s predicate-formatter function.
467 testing::AssertionResult PredFormatFunction%(n)s(""" % DEFS
469 tests += Iter(n, 'const char* e%s', sep=""",
472 tests += Iter(n, """,
476 if (PredFunction%(n)s(%(vs)s))
477 return testing::AssertionSuccess();
479 return testing::AssertionFailure()
482 tests += Iter(n, 'e%s', sep=' << " + " << ')
485 << " is expected to be positive, but evaluates to "
491 // A %(arity)s predicate-formatter functor.
492 struct PredFormatFunctor%(n)s {
494 testing::AssertionResult operator()(""" % DEFS
496 tests += Iter(n, 'const char* e%s', sep=""",
499 tests += Iter(n, """,
502 tests += """) const {
503 return PredFormatFunction%(n)s(%(es)s, %(vs)s);
509 // Tests for {EXPECT|ASSERT}_PRED_FORMAT%(n)s.
511 class Predicate%(n)sTest : public testing::Test {
513 void SetUp() override {
514 expected_to_finish_ = true;
515 finished_ = false;""" % DEFS
518 """ + Iter(n, 'n%s_ = ') + """0;
523 void TearDown() override {
524 // Verifies that each of the predicate's arguments was evaluated
527 tests += ''.join(["""
528 EXPECT_EQ(1, n%s_) <<
529 "The predicate assertion didn't evaluate argument %s "
530 "exactly once.";""" % (i, i + 1) for i in OneTo(n)])
534 // Verifies that the control flow in the test function is expected.
535 if (expected_to_finish_ && !finished_) {
536 FAIL() << "The predicate assertion unexpactedly aborted the test.";
537 } else if (!expected_to_finish_ && finished_) {
538 FAIL() << "The failed predicate assertion didn't abort the test "
543 // true if and only if the test function is expected to run to finish.
544 static bool expected_to_finish_;
546 // true if and only if the test function did run to finish.
547 static bool finished_;
556 bool Predicate%(n)sTest::expected_to_finish_;
557 bool Predicate%(n)sTest::finished_;
560 tests += Iter(n, """int Predicate%%(n)sTest::n%s_;
564 typedef Predicate%(n)sTest EXPECT_PRED_FORMAT%(n)sTest;
565 typedef Predicate%(n)sTest ASSERT_PRED_FORMAT%(n)sTest;
566 typedef Predicate%(n)sTest EXPECT_PRED%(n)sTest;
567 typedef Predicate%(n)sTest ASSERT_PRED%(n)sTest;
570 def GenTest(use_format, use_assert, expect_failure,
571 use_functor, use_user_type):
572 """Returns the test for a predicate assertion macro.
575 use_format: true if and only if the assertion is a *_PRED_FORMAT*.
576 use_assert: true if and only if the assertion is a ASSERT_*.
577 expect_failure: true if and only if the assertion is expected to fail.
578 use_functor: true if and only if the first argument of the assertion is
579 a functor (as opposed to a function)
580 use_user_type: true if and only if the predicate functor/function takes
581 argument(s) of a user-defined type.
585 GenTest(1, 0, 0, 1, 0) returns a test that tests the behavior
586 of a successful EXPECT_PRED_FORMATn() that takes a functor
587 whose arguments have built-in types."""
590 assrt = 'ASSERT' # 'assert' is reserved, so we cannot use
591 # that identifier here.
595 assertion = assrt + '_PRED'
598 pred_format = 'PredFormat'
599 assertion += '_FORMAT'
603 assertion += '%(n)s' % DEFS
606 pred_format_type = 'functor'
607 pred_format += 'Functor%(n)s()'
609 pred_format_type = 'function'
610 pred_format += 'Function%(n)s'
613 pred_format += 'Bool'
617 test_name = pred_format_type.title()
620 arg_type = 'user-defined type (Bool)'
621 test_name += 'OnUserType'
627 arg_type = 'built-in type (int)'
628 test_name += 'OnBuiltInType'
635 successful_or_failed = 'failed'
636 expected_or_not = 'expected.'
637 test_name += 'Failure'
639 successful_or_failed = 'successful'
640 expected_or_not = 'UNEXPECTED!'
641 test_name += 'Success'
643 # A map that defines the values used in the test template.
647 'assertion' : assertion,
648 'test_name' : test_name,
649 'pf_type' : pred_format_type,
651 'arg_type' : arg_type,
653 'successful' : successful_or_failed,
654 'expected' : expected_or_not,
658 // Tests a %(successful)s %(assertion)s where the
659 // predicate-formatter is a %(pf_type)s on a %(arg_type)s.
660 TEST_F(%(assertion)sTest, %(test_name)s) {""" % defs
662 indent = (len(assertion) + 3)*' '
669 expected_to_finish_ = false;
670 EXPECT_FATAL_FAILURE({ // NOLINT"""
673 EXPECT_NONFATAL_FAILURE({ // NOLINT"""
675 test += '\n' + extra_indent + """ %(assertion)s(%(pf)s""" % defs
678 test += Iter(n, ',\n' + indent + extra_indent + '%(arg)s' % defs)
679 test += ');\n' + extra_indent + ' finished_ = true;\n'
687 # Generates tests for all 2**6 = 64 combinations.
688 tests += ''.join([GenTest(use_format, use_assert, expect_failure,
689 use_functor, use_user_type)
690 for use_format in [0, 1]
691 for use_assert in [0, 1]
692 for expect_failure in [0, 1]
693 for use_functor in [0, 1]
694 for use_user_type in [0, 1]
700 def UnitTestPostamble():
701 """Returns the postamble for the tests."""
706 def GenerateUnitTest(n):
707 """Returns the tests for up-to n-ary predicate assertions."""
709 GenerateFile(UNIT_TEST,
711 + ''.join([TestsForArity(i) for i in OneTo(n)])
712 + UnitTestPostamble())
716 """The entry point of the script. Generates the header file and its
719 if len(sys.argv) != 2:
721 print 'Author: ' + __author__
729 if __name__ == '__main__':