32"""gen_gtest_pred_impl.py v0.1
34Generates the implementation of Google Test predicate assertions and
39 gen_gtest_pred_impl.py MAX_ARITY
41where MAX_ARITY is a positive integer.
43The command generates the implementation of up-to MAX_ARITY-ary
44predicate assertions,
and writes it to file gtest_pred_impl.h
in the
45directory where the script
is. It also generates the accompanying
46unit test
in file gtest_pred_impl_unittest.cc.
49__author__ = 'wan@google.com (Zhanyong Wan)'
55# Where this script is.
56SCRIPT_DIR = os.path.dirname(sys.argv[0])
58# Where to store the generated header.
59HEADER = os.path.join(SCRIPT_DIR, '../include/gtest/gtest_pred_impl.h')
61# Where to store the generated unit test.
62UNIT_TEST = os.path.join(SCRIPT_DIR, '../test/gtest_pred_impl_unittest.cc')
66 """Returns the preamble for the header file.
69 n: the maximum arity of the predicate macros to be generated.
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// GOOGLETEST_CM0001 DO NOT DELETE
124// This header implements a family of generic predicate assertion
131// where pred_format
is a function
or functor that takes n (
in the
132// case of ASSERT_PRED_FORMATn) values
and their source expression
133// text,
and returns a testing::AssertionResult. See the definition
134// of ASSERT_EQ
in gtest.h
for an example.
136// If you don
't care about formatting, you can use the more
137// restrictive version:
143// where pred is an n-ary function
or functor that returns bool,
144//
and the values v1, v2, ..., must support the << operator
for
145// streaming to std::ostream.
147// We also define the EXPECT_* variations.
149// For now we only support predicates whose arity
is at most %(n)s.
150// Please email googletestframework
@googlegroups.com if you need
151// support
for higher arities.
153// GTEST_ASSERT_
is the basic statement to which all of the assertions
154//
in this file reduce. Don
't use this in your code.
157 GTEST_AMBIGUOUS_ELSE_BLOCKER_ \\
158 if (const ::testing::AssertionResult gtest_ar = (expression)) \\
161 on_failure(gtest_ar.failure_message())
166 """Returns the English name of the given arity."""
171 return [
'nullary',
'unary',
'binary',
'ternary'][n]
177 """Returns the given word in title case. The difference between
178 this and string
's title() method is that Title('4-ary
') is '4-ary
'
179 while '4-ary'.title()
is '4-Ary'.
"""
181 return word[0].upper() + word[1:]
185 """Returns the list [1, 2, 3, ..., n]."""
187 return range(1, n + 1)
191 """Given a positive integer n, a format string that contains 0 or
192 more '%s' format specs,
and optionally a separator string, returns
193 the join of n strings, each formatted
with the format string on an
194 iterator ranged
from 1 to n.
198 Iter(3,
'v%s', sep=
', ') returns
'v1, v2, v3'.
202 spec_count = len(format.split(
'%s')) - 1
203 return sep.join([format % (spec_count * (i,))
for i
in OneTo(n)])
207 """Returns the implementation of n-ary predicate assertions."""
212 'vs' :
Iter(n,
'v%s', sep=
', '),
213 'vts' :
Iter(n,
'#v%s', sep=
', '),
220// Helper function for implementing {EXPECT|ASSERT}_PRED%(n)s. Don't use
222template <typename Pred
""" % DEFS
228AssertionResult AssertPred%(n)sHelper(const char* pred_text""" % DEFS
244 impl += ' return AssertionFailure() << pred_text << "("'
247 << e%s""", sep=' << ", "')
249 impl += ' << ") evaluates to false, where"'
253 << "\\n" << e%s <<
" evaluates to " << ::testing::
PrintToString(v%s)
"""
259// Internal macro for implementing {EXPECT|ASSERT}_PRED_FORMAT%(n)s.
260// Don't use this in your code.
261#define GTEST_PRED_FORMAT%(n)s_(pred_format, %(vs)s, on_failure)\\
265// Internal macro for implementing {EXPECT|ASSERT}_PRED%(n)s. Don
't use
270 impl +=
Iter(n,
""", \\
276 impl += Iter(n, """, \\
279 impl += """), on_failure)
281// %(Arity)s predicate assertion macros.
282#define EXPECT_PRED_FORMAT%(n)s(pred_format, %(vs)s) \\
283 GTEST_PRED_FORMAT%(n)s_(pred_format, %(vs)s, GTEST_NONFATAL_FAILURE_)
285 GTEST_PRED%(n)s_(pred, %(vs)s, GTEST_NONFATAL_FAILURE_)
287 GTEST_PRED_FORMAT%(n)s_(pred_format, %(vs)s, GTEST_FATAL_FAILURE_)
289 GTEST_PRED%(n)s_(pred, %(vs)s, GTEST_FATAL_FAILURE_)
297 """Returns the postamble for the header file."""
301} // namespace testing
307def GenerateFile(path, content):
308 """Given a file path and a content string
309 overwrites it with the given content.
311 print 'Updating file %s . . .' % path
316 print 'File %s has been updated.' % path
320 """Given the maximum arity n, updates the header file that implements
321 the predicate assertions.
330 """Returns the preamble for the unit test file."""
334 'today' : time.strftime(
'%m/%d/%Y'),
335 'year' : time.strftime(
'%Y'),
336 'command' :
'%s %s' % (os.path.basename(sys.argv[0]), sys.argv[1]),
340 """// Copyright 2006, Google Inc.
341// All rights reserved.
343// Redistribution and use in source and binary forms, with or without
344// modification, are permitted provided that the following conditions are
347// * Redistributions of source code must retain the above copyright
348// notice, this list of conditions and the following disclaimer.
349// * Redistributions
in binary form must reproduce the above
350// copyright notice, this list of conditions
and the following disclaimer
351//
in the documentation
and/
or other materials provided
with the
353// * Neither the name of Google Inc. nor the names of its
354// contributors may be used to endorse
or promote products derived
from
355// this software without specific prior written permission.
357// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
358//
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
359// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
360// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
361// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
362// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
363// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
364// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
365// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
366// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
367// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
369// This file
is AUTOMATICALLY GENERATED on %(today)s by command
370//
'%(command)s'. DO NOT EDIT BY HAND!
372// Regression test
for gtest_pred_impl.h
374// This file
is generated by a script
and quite long. If you intend to
375// learn how Google Test works by reading its unit tests, read
376// gtest_unittest.cc instead.
378// This
is intended
as a regression test
for the Google Test predicate
379// assertions. We compile it
as part of the gtest_unittest target
380// only to keep the implementation tidy
and compact,
as it
is quite
381// involved to set up the stage
for testing Google Test using Google
384// Currently, gtest_unittest takes ~11 seconds to run
in the testing
385// daemon. In the future,
if it grows too large
and needs much more
386// time to finish, we should consider separating this file into a
387// stand-alone regression test.
394// A user-defined data type.
396 explicit
Bool(int val) :
value(val != 0) {}
398 bool operator>(int n) const {
return value >
Bool(n).value; }
400 Bool operator+(const Bool& rhs) const {
return Bool(value + rhs.value); }
402 bool operator==(const Bool& rhs) const {
return value == rhs.value; }
407// Enables Bool to be used
in assertions.
408std::ostream& operator<<(std::ostream& os, const Bool& x) {
409 return os << (x.value ?
"true" :
"false");
416 """Returns the tests for n-ary predicate assertions."""
421 'es' :
Iter(n,
'e%s', sep=
', '),
422 'vs' :
Iter(n,
'v%s', sep=
', '),
423 'vts' :
Iter(n,
'#v%s', sep=
', '),
424 'tvs' :
Iter(n,
'T%s v%s', sep=
', '),
425 'int_vs' :
Iter(n,
'int v%s', sep=
', '),
426 'Bool_vs' :
Iter(n,
'Bool v%s', sep=
', '),
427 'types' :
Iter(n,
'typename T%s', sep=
', '),
428 'v_sum' :
Iter(n,
'v%s', sep=
' + '),
434 """// Sample functions/functors for testing %(arity)s predicate assertions.
436// A %(arity)s predicate function.
438bool PredFunction%(n)s(%(tvs)s) {
439 return %(v_sum)s > 0;
442// The following two functions are needed because a compiler doesn
't have
443// a context yet to know which template function must be instantiated.
444bool PredFunction%(n)sInt(%(int_vs)s) {
445 return %(v_sum)s > 0;
447bool PredFunction%(n)sBool(%(Bool_vs)s) {
448 return %(v_sum)s > 0;
453// A %(arity)s predicate functor.
454struct PredFunctor%(n)s {
456 bool operator()(""" % DEFS
458 tests += Iter(n, 'const T%s& v%s', sep=
""",
462 return %(v_sum)s > 0;
468// A %(arity)s predicate-formatter function.
470testing::AssertionResult PredFormatFunction%(n)s(""" % DEFS
472 tests +=
Iter(n,
'const char* e%s', sep=
""",
475 tests += Iter(n, """,
479 if (PredFunction%(n)s(%(vs)s))
485 tests += Iter(n, 'e%s', sep=
' << " + " << ')
488 << " is expected to be positive, but evaluates to "
494// A %(arity)s predicate-formatter functor.
495struct PredFormatFunctor%(n)s {
497 testing::AssertionResult operator()(""" % DEFS
499 tests += Iter(n, 'const char* e%s', sep=
""",
502 tests += Iter(n, """,
505 tests += """) const {
506 return PredFormatFunction%(n)s(%(es)s, %(vs)s);
512// Tests for {EXPECT|ASSERT}_PRED_FORMAT%(n)s.
514class Predicate%(n)sTest : public testing::Test {
516 void SetUp() override {
517 expected_to_finish_ = true;
518 finished_ = false;""" % DEFS
521 """ + Iter(n, 'n%s_ = ') + """0;
526 void TearDown() override {
527 // Verifies that each of the predicate's arguments was evaluated
530 tests += ''.join([
"""
532 "The predicate assertion didn't evaluate argument %s "
533 "exactly once.";
""" % (i, i + 1) for i in OneTo(n)])
537 // Verifies that the control flow in the test function
is expected.
538 if (expected_to_finish_ && !finished_) {
539 FAIL() <<
"The predicate assertion unexpactedly aborted the test.";
540 }
else if (!expected_to_finish_ && finished_) {
541 FAIL() <<
"The failed predicate assertion didn't abort the test "
546 // true
if and only
if the test function
is expected to run to finish.
547 static bool expected_to_finish_;
549 // true
if and only
if the test function did run to finish.
550 static bool finished_;
559bool Predicate%(n)sTest::expected_to_finish_;
560bool Predicate%(n)sTest::finished_;
563 tests +=
Iter(n,
"""int Predicate%%(n)sTest::n%s_;
567typedef Predicate%(n)sTest EXPECT_PRED_FORMAT%(n)sTest;
568typedef Predicate%(n)sTest ASSERT_PRED_FORMAT%(n)sTest;
569typedef Predicate%(n)sTest EXPECT_PRED%(n)sTest;
570typedef Predicate%(n)sTest ASSERT_PRED%(n)sTest;
573 def GenTest(use_format, use_assert, expect_failure,
574 use_functor, use_user_type):
575 """Returns the test for a predicate assertion macro.
578 use_format: true if and only
if the assertion
is a *_PRED_FORMAT*.
579 use_assert: true
if and only
if the assertion
is a ASSERT_*.
580 expect_failure: true
if and only
if the assertion
is expected to fail.
581 use_functor: true
if and only
if the first argument of the assertion
is
582 a functor (
as opposed to a function)
583 use_user_type: true
if and only
if the predicate functor/function takes
584 argument(s) of a user-defined type.
588 GenTest(1, 0, 0, 1, 0) returns a test that tests the behavior
589 of a successful EXPECT_PRED_FORMATn() that takes a functor
590 whose arguments have built-
in types.
"""
598 assertion = assrt +
'_PRED'
601 pred_format =
'PredFormat'
602 assertion +=
'_FORMAT'
606 assertion +=
'%(n)s' % DEFS
609 pred_format_type =
'functor'
610 pred_format +=
'Functor%(n)s()'
612 pred_format_type =
'function'
613 pred_format +=
'Function%(n)s'
616 pred_format +=
'Bool'
620 test_name = pred_format_type.title()
623 arg_type =
'user-defined type (Bool)'
624 test_name +=
'OnUserType'
630 arg_type =
'built-in type (int)'
631 test_name +=
'OnBuiltInType'
638 successful_or_failed =
'failed'
639 expected_or_not =
'expected.'
640 test_name +=
'Failure'
642 successful_or_failed =
'successful'
643 expected_or_not =
'UNEXPECTED!'
644 test_name +=
'Success'
650 'assertion' : assertion,
651 'test_name' : test_name,
652 'pf_type' : pred_format_type,
654 'arg_type' : arg_type,
656 'successful' : successful_or_failed,
657 'expected' : expected_or_not,
661// Tests a %(successful)s %(assertion)s where the
662// predicate-formatter is a %(pf_type)s on a %(arg_type)s.
663TEST_F(%(assertion)sTest, %(test_name)s) {""" % defs
665 indent = (len(assertion) + 3)*
' '
672 expected_to_finish_ = false;
673 EXPECT_FATAL_FAILURE({ // NOLINT"""
676 EXPECT_NONFATAL_FAILURE({ // NOLINT"""
678 test += '\n' + extra_indent +
""" %(assertion)s(%(pf)s""" % defs
681 test += Iter(n, ',\n' + indent + extra_indent +
'%(arg)s' % defs)
682 test +=
');\n' + extra_indent +
' finished_ = true;\n'
691 tests +=
''.join([GenTest(use_format, use_assert, expect_failure,
692 use_functor, use_user_type)
693 for use_format
in [0, 1]
694 for use_assert
in [0, 1]
695 for expect_failure
in [0, 1]
696 for use_functor
in [0, 1]
697 for use_user_type
in [0, 1]
704 """Returns the postamble for the tests."""
710 """Returns the tests for up-to n-ary predicate assertions."""
719 """The entry point of the script. Generates the header file and its
722 if len(sys.argv) != 2:
724 print 'Author: ' + __author__
732if __name__ ==
'__main__':
#define EXPECT_EQ(val1, val2)
#define ASSERT_PRED_FORMAT1(pred_format, v1)
#define ASSERT_PRED2(pred, v1, v2)
#define ASSERT_PRED1(pred, v1)
#define GTEST_ASSERT_(expression, on_failure)
#define ASSERT_PRED_FORMAT2(pred_format, v1, v2)
AssertionResult AssertionFailure()
::std::string PrintToString(const T &value)
AssertionResult AssertionSuccess()
def GenerateFile(path, content)
def ImplementationForArity(n)
def Iter(n, format, sep='')