113481Sgiacomo.travaglini@arm.com// Copyright 2009 Google Inc. All Rights Reserved. 213481Sgiacomo.travaglini@arm.com// 313481Sgiacomo.travaglini@arm.com// Redistribution and use in source and binary forms, with or without 413481Sgiacomo.travaglini@arm.com// modification, are permitted provided that the following conditions are 513481Sgiacomo.travaglini@arm.com// met: 613481Sgiacomo.travaglini@arm.com// 713481Sgiacomo.travaglini@arm.com// * Redistributions of source code must retain the above copyright 813481Sgiacomo.travaglini@arm.com// notice, this list of conditions and the following disclaimer. 913481Sgiacomo.travaglini@arm.com// * Redistributions in binary form must reproduce the above 1013481Sgiacomo.travaglini@arm.com// copyright notice, this list of conditions and the following disclaimer 1113481Sgiacomo.travaglini@arm.com// in the documentation and/or other materials provided with the 1213481Sgiacomo.travaglini@arm.com// distribution. 1313481Sgiacomo.travaglini@arm.com// * Neither the name of Google Inc. nor the names of its 1413481Sgiacomo.travaglini@arm.com// contributors may be used to endorse or promote products derived from 1513481Sgiacomo.travaglini@arm.com// this software without specific prior written permission. 1613481Sgiacomo.travaglini@arm.com// 1713481Sgiacomo.travaglini@arm.com// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1813481Sgiacomo.travaglini@arm.com// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1913481Sgiacomo.travaglini@arm.com// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2013481Sgiacomo.travaglini@arm.com// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2113481Sgiacomo.travaglini@arm.com// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2213481Sgiacomo.travaglini@arm.com// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2313481Sgiacomo.travaglini@arm.com// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2413481Sgiacomo.travaglini@arm.com// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2513481Sgiacomo.travaglini@arm.com// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2613481Sgiacomo.travaglini@arm.com// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2713481Sgiacomo.travaglini@arm.com// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2813481Sgiacomo.travaglini@arm.com// 2913481Sgiacomo.travaglini@arm.com// Author: vladl@google.com (Vlad Losev) 3013481Sgiacomo.travaglini@arm.com 3113481Sgiacomo.travaglini@arm.com// This sample shows how to use Google Test listener API to implement 3213481Sgiacomo.travaglini@arm.com// an alternative console output and how to use the UnitTest reflection API 3313481Sgiacomo.travaglini@arm.com// to enumerate test cases and tests and to inspect their results. 3413481Sgiacomo.travaglini@arm.com 3513481Sgiacomo.travaglini@arm.com#include <stdio.h> 3613481Sgiacomo.travaglini@arm.com 3713481Sgiacomo.travaglini@arm.com#include "gtest/gtest.h" 3813481Sgiacomo.travaglini@arm.com 3913481Sgiacomo.travaglini@arm.comusing ::testing::EmptyTestEventListener; 4013481Sgiacomo.travaglini@arm.comusing ::testing::InitGoogleTest; 4113481Sgiacomo.travaglini@arm.comusing ::testing::Test; 4213481Sgiacomo.travaglini@arm.comusing ::testing::TestCase; 4313481Sgiacomo.travaglini@arm.comusing ::testing::TestEventListeners; 4413481Sgiacomo.travaglini@arm.comusing ::testing::TestInfo; 4513481Sgiacomo.travaglini@arm.comusing ::testing::TestPartResult; 4613481Sgiacomo.travaglini@arm.comusing ::testing::UnitTest; 4713481Sgiacomo.travaglini@arm.com 4813481Sgiacomo.travaglini@arm.comnamespace { 4913481Sgiacomo.travaglini@arm.com 5013481Sgiacomo.travaglini@arm.com// Provides alternative output mode which produces minimal amount of 5113481Sgiacomo.travaglini@arm.com// information about tests. 5213481Sgiacomo.travaglini@arm.comclass TersePrinter : public EmptyTestEventListener { 5313481Sgiacomo.travaglini@arm.com private: 5413481Sgiacomo.travaglini@arm.com // Called before any test activity starts. 5513481Sgiacomo.travaglini@arm.com virtual void OnTestProgramStart(const UnitTest& /* unit_test */) {} 5613481Sgiacomo.travaglini@arm.com 5713481Sgiacomo.travaglini@arm.com // Called after all test activities have ended. 5813481Sgiacomo.travaglini@arm.com virtual void OnTestProgramEnd(const UnitTest& unit_test) { 5913481Sgiacomo.travaglini@arm.com fprintf(stdout, "TEST %s\n", unit_test.Passed() ? "PASSED" : "FAILED"); 6013481Sgiacomo.travaglini@arm.com fflush(stdout); 6113481Sgiacomo.travaglini@arm.com } 6213481Sgiacomo.travaglini@arm.com 6313481Sgiacomo.travaglini@arm.com // Called before a test starts. 6413481Sgiacomo.travaglini@arm.com virtual void OnTestStart(const TestInfo& test_info) { 6513481Sgiacomo.travaglini@arm.com fprintf(stdout, 6613481Sgiacomo.travaglini@arm.com "*** Test %s.%s starting.\n", 6713481Sgiacomo.travaglini@arm.com test_info.test_case_name(), 6813481Sgiacomo.travaglini@arm.com test_info.name()); 6913481Sgiacomo.travaglini@arm.com fflush(stdout); 7013481Sgiacomo.travaglini@arm.com } 7113481Sgiacomo.travaglini@arm.com 7213481Sgiacomo.travaglini@arm.com // Called after a failed assertion or a SUCCEED() invocation. 7313481Sgiacomo.travaglini@arm.com virtual void OnTestPartResult(const TestPartResult& test_part_result) { 7413481Sgiacomo.travaglini@arm.com fprintf(stdout, 7513481Sgiacomo.travaglini@arm.com "%s in %s:%d\n%s\n", 7613481Sgiacomo.travaglini@arm.com test_part_result.failed() ? "*** Failure" : "Success", 7713481Sgiacomo.travaglini@arm.com test_part_result.file_name(), 7813481Sgiacomo.travaglini@arm.com test_part_result.line_number(), 7913481Sgiacomo.travaglini@arm.com test_part_result.summary()); 8013481Sgiacomo.travaglini@arm.com fflush(stdout); 8113481Sgiacomo.travaglini@arm.com } 8213481Sgiacomo.travaglini@arm.com 8313481Sgiacomo.travaglini@arm.com // Called after a test ends. 8413481Sgiacomo.travaglini@arm.com virtual void OnTestEnd(const TestInfo& test_info) { 8513481Sgiacomo.travaglini@arm.com fprintf(stdout, 8613481Sgiacomo.travaglini@arm.com "*** Test %s.%s ending.\n", 8713481Sgiacomo.travaglini@arm.com test_info.test_case_name(), 8813481Sgiacomo.travaglini@arm.com test_info.name()); 8913481Sgiacomo.travaglini@arm.com fflush(stdout); 9013481Sgiacomo.travaglini@arm.com } 9113481Sgiacomo.travaglini@arm.com}; // class TersePrinter 9213481Sgiacomo.travaglini@arm.com 9313481Sgiacomo.travaglini@arm.comTEST(CustomOutputTest, PrintsMessage) { 9413481Sgiacomo.travaglini@arm.com printf("Printing something from the test body...\n"); 9513481Sgiacomo.travaglini@arm.com} 9613481Sgiacomo.travaglini@arm.com 9713481Sgiacomo.travaglini@arm.comTEST(CustomOutputTest, Succeeds) { 9813481Sgiacomo.travaglini@arm.com SUCCEED() << "SUCCEED() has been invoked from here"; 9913481Sgiacomo.travaglini@arm.com} 10013481Sgiacomo.travaglini@arm.com 10113481Sgiacomo.travaglini@arm.comTEST(CustomOutputTest, Fails) { 10213481Sgiacomo.travaglini@arm.com EXPECT_EQ(1, 2) 10313481Sgiacomo.travaglini@arm.com << "This test fails in order to demonstrate alternative failure messages"; 10413481Sgiacomo.travaglini@arm.com} 10513481Sgiacomo.travaglini@arm.com 10613481Sgiacomo.travaglini@arm.com} // namespace 10713481Sgiacomo.travaglini@arm.com 10813481Sgiacomo.travaglini@arm.comint main(int argc, char **argv) { 10913481Sgiacomo.travaglini@arm.com InitGoogleTest(&argc, argv); 11013481Sgiacomo.travaglini@arm.com 11113481Sgiacomo.travaglini@arm.com bool terse_output = false; 11213481Sgiacomo.travaglini@arm.com if (argc > 1 && strcmp(argv[1], "--terse_output") == 0 ) 11313481Sgiacomo.travaglini@arm.com terse_output = true; 11413481Sgiacomo.travaglini@arm.com else 11513481Sgiacomo.travaglini@arm.com printf("%s\n", "Run this program with --terse_output to change the way " 11613481Sgiacomo.travaglini@arm.com "it prints its output."); 11713481Sgiacomo.travaglini@arm.com 11813481Sgiacomo.travaglini@arm.com UnitTest& unit_test = *UnitTest::GetInstance(); 11913481Sgiacomo.travaglini@arm.com 12013481Sgiacomo.travaglini@arm.com // If we are given the --terse_output command line flag, suppresses the 12113481Sgiacomo.travaglini@arm.com // standard output and attaches own result printer. 12213481Sgiacomo.travaglini@arm.com if (terse_output) { 12313481Sgiacomo.travaglini@arm.com TestEventListeners& listeners = unit_test.listeners(); 12413481Sgiacomo.travaglini@arm.com 12513481Sgiacomo.travaglini@arm.com // Removes the default console output listener from the list so it will 12613481Sgiacomo.travaglini@arm.com // not receive events from Google Test and won't print any output. Since 12713481Sgiacomo.travaglini@arm.com // this operation transfers ownership of the listener to the caller we 12813481Sgiacomo.travaglini@arm.com // have to delete it as well. 12913481Sgiacomo.travaglini@arm.com delete listeners.Release(listeners.default_result_printer()); 13013481Sgiacomo.travaglini@arm.com 13113481Sgiacomo.travaglini@arm.com // Adds the custom output listener to the list. It will now receive 13213481Sgiacomo.travaglini@arm.com // events from Google Test and print the alternative output. We don't 13313481Sgiacomo.travaglini@arm.com // have to worry about deleting it since Google Test assumes ownership 13413481Sgiacomo.travaglini@arm.com // over it after adding it to the list. 13513481Sgiacomo.travaglini@arm.com listeners.Append(new TersePrinter); 13613481Sgiacomo.travaglini@arm.com } 13713481Sgiacomo.travaglini@arm.com int ret_val = RUN_ALL_TESTS(); 13813481Sgiacomo.travaglini@arm.com 13913481Sgiacomo.travaglini@arm.com // This is an example of using the UnitTest reflection API to inspect test 14013481Sgiacomo.travaglini@arm.com // results. Here we discount failures from the tests we expected to fail. 14113481Sgiacomo.travaglini@arm.com int unexpectedly_failed_tests = 0; 14213481Sgiacomo.travaglini@arm.com for (int i = 0; i < unit_test.total_test_case_count(); ++i) { 14313481Sgiacomo.travaglini@arm.com const TestCase& test_case = *unit_test.GetTestCase(i); 14413481Sgiacomo.travaglini@arm.com for (int j = 0; j < test_case.total_test_count(); ++j) { 14513481Sgiacomo.travaglini@arm.com const TestInfo& test_info = *test_case.GetTestInfo(j); 14613481Sgiacomo.travaglini@arm.com // Counts failed tests that were not meant to fail (those without 14713481Sgiacomo.travaglini@arm.com // 'Fails' in the name). 14813481Sgiacomo.travaglini@arm.com if (test_info.result()->Failed() && 14913481Sgiacomo.travaglini@arm.com strcmp(test_info.name(), "Fails") != 0) { 15013481Sgiacomo.travaglini@arm.com unexpectedly_failed_tests++; 15113481Sgiacomo.travaglini@arm.com } 15213481Sgiacomo.travaglini@arm.com } 15313481Sgiacomo.travaglini@arm.com } 15413481Sgiacomo.travaglini@arm.com 15513481Sgiacomo.travaglini@arm.com // Test that were meant to fail should not affect the test program outcome. 15613481Sgiacomo.travaglini@arm.com if (unexpectedly_failed_tests == 0) 15713481Sgiacomo.travaglini@arm.com ret_val = 0; 15813481Sgiacomo.travaglini@arm.com 15913481Sgiacomo.travaglini@arm.com return ret_val; 16013481Sgiacomo.travaglini@arm.com} 161