1d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// Copyright 2009 Google Inc. All Rights Reserved. 2d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// 3d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// Redistribution and use in source and binary forms, with or without 4d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// modification, are permitted provided that the following conditions are 5d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// met: 6d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// 7d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// * Redistributions of source code must retain the above copyright 8d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// notice, this list of conditions and the following disclaimer. 9d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// * Redistributions in binary form must reproduce the above 10d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// copyright notice, this list of conditions and the following disclaimer 11d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// in the documentation and/or other materials provided with the 12d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// distribution. 13d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// * Neither the name of Google Inc. nor the names of its 14d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// contributors may be used to endorse or promote products derived from 15d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// this software without specific prior written permission. 16d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// 17d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// 29d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// Author: vladl@google.com (Vlad Losev) 30d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 31d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// This sample shows how to use Google Test listener API to implement 32d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// an alternative console output and how to use the UnitTest reflection API 33d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// to enumerate test cases and tests and to inspect their results. 34d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 35d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville#include <stdio.h> 36d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 37d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville#include <gtest/gtest.h> 38d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 39d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleusing ::testing::EmptyTestEventListener; 40d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleusing ::testing::InitGoogleTest; 41d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleusing ::testing::Test; 42d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleusing ::testing::TestCase; 43d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleusing ::testing::TestEventListeners; 44d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleusing ::testing::TestInfo; 45d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleusing ::testing::TestPartResult; 46d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleusing ::testing::UnitTest; 47d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 48d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savillenamespace { 49d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 50d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// Provides alternative output mode which produces minimal amount of 51d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// information about tests. 52d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleclass TersePrinter : public EmptyTestEventListener { 53d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville private: 54d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // Called before any test activity starts. 55d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville virtual void OnTestProgramStart(const UnitTest& unit_test) {} 56d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 57d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // Called after all test activities have ended. 58d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville virtual void OnTestProgramEnd(const UnitTest& unit_test) { 59d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville fprintf(stdout, "TEST %s\n", unit_test.Passed() ? "PASSED" : "FAILED"); 60d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville fflush(stdout); 61d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville } 62d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 63d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // Called before a test starts. 64d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville virtual void OnTestStart(const TestInfo& test_info) { 65d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville fprintf(stdout, 66d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville "*** Test %s.%s starting.\n", 67d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville test_info.test_case_name(), 68d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville test_info.name()); 69d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville fflush(stdout); 70d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville } 71d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 72d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // Called after a failed assertion or a SUCCESS(). 73d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville virtual void OnTestPartResult(const TestPartResult& test_part_result) { 74d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville fprintf(stdout, 75d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville "%s in %s:%d\n%s\n", 76d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville test_part_result.failed() ? "*** Failure" : "Success", 77d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville test_part_result.file_name(), 78d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville test_part_result.line_number(), 79d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville test_part_result.summary()); 80d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville fflush(stdout); 81d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville } 82d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 83d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // Called after a test ends. 84d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville virtual void OnTestEnd(const TestInfo& test_info) { 85d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville fprintf(stdout, 86d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville "*** Test %s.%s ending.\n", 87d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville test_info.test_case_name(), 88d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville test_info.name()); 89d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville fflush(stdout); 90d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville } 91d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville}; // class TersePrinter 92d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 93d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink SavilleTEST(CustomOutputTest, PrintsMessage) { 94d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville printf("Printing something from the test body...\n"); 95d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville} 96d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 97d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink SavilleTEST(CustomOutputTest, Succeeds) { 98d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville SUCCEED() << "SUCCEED() has been invoked from here"; 99d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville} 100d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 101d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink SavilleTEST(CustomOutputTest, Fails) { 102d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville EXPECT_EQ(1, 2) 103d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville << "This test fails in order to demonstrate alternative failure messages"; 104d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville} 105d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 106d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville} // namespace 107d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 108d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleint main(int argc, char **argv) { 109d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville InitGoogleTest(&argc, argv); 110d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 111d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville bool terse_output = false; 112d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville if (argc > 1 && strcmp(argv[1], "--terse_output") == 0 ) 113d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville terse_output = true; 114d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville else 115d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville printf("%s\n", "Run this program with --terse_output to change the way " 116d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville "it prints its output."); 117d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 118d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville UnitTest& unit_test = *UnitTest::GetInstance(); 119d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 120d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // If we are given the --terse_output command line flag, suppresses the 121d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // standard output and attaches own result printer. 122d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville if (terse_output) { 123d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville TestEventListeners& listeners = unit_test.listeners(); 124d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 125d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // Removes the default console output listener from the list so it will 126d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // not receive events from Google Test and won't print any output. Since 127d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // this operation transfers ownership of the listener to the caller we 128d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // have to delete it as well. 129d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville delete listeners.Release(listeners.default_result_printer()); 130d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 131d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // Adds the custom output listener to the list. It will now receive 132d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // events from Google Test and print the alternative output. We don't 133d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // have to worry about deleting it since Google Test assumes ownership 134d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // over it after adding it to the list. 135d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville listeners.Append(new TersePrinter); 136d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville } 137d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville int ret_val = RUN_ALL_TESTS(); 138d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 139d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // This is an example of using the UnitTest reflection API to inspect test 140d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // results. Here we discount failures from the tests we expected to fail. 141d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville int unexpectedly_failed_tests = 0; 142d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville for (int i = 0; i < unit_test.total_test_case_count(); ++i) { 143d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville const TestCase& test_case = *unit_test.GetTestCase(i); 144d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville for (int j = 0; j < test_case.total_test_count(); ++j) { 145d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville const TestInfo& test_info = *test_case.GetTestInfo(j); 146d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // Counts failed tests that were not meant to fail (those without 147d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // 'Fails' in the name). 148d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville if (test_info.result()->Failed() && 149d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville strcmp(test_info.name(), "Fails") != 0) { 150d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville unexpectedly_failed_tests++; 151d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville } 152d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville } 153d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville } 154d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 155d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // Test that were meant to fail should not affect the test program outcome. 156d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville if (unexpectedly_failed_tests == 0) 157d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville ret_val = 0; 158d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 159d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville return ret_val; 160d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville} 161