1c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Copyright 2005, Google Inc. 2c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// All rights reserved. 3c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 4c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Redistribution and use in source and binary forms, with or without 5c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// modification, are permitted provided that the following conditions are 6c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// met: 7c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 8c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// * Redistributions of source code must retain the above copyright 9c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// notice, this list of conditions and the following disclaimer. 10c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// * Redistributions in binary form must reproduce the above 11c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// copyright notice, this list of conditions and the following disclaimer 12c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// in the documentation and/or other materials provided with the 13c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// distribution. 14c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// * Neither the name of Google Inc. nor the names of its 15c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// contributors may be used to endorse or promote products derived from 16c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// this software without specific prior written permission. 17c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 18c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 30c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// A sample program demonstrating using Google C++ testing framework. 31c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 32c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Author: wan@google.com (Zhanyong Wan) 33c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 34c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 35c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// This sample shows how to write a simple unit test for a function, 36c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// using Google C++ testing framework. 37c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 38c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Writing a unit test using Google C++ testing framework is easy as 1-2-3: 39c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 40c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 41c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Step 1. Include necessary header files such that the stuff your 42c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// test logic needs is declared. 43c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 44c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Don't forget gtest.h, which declares the testing framework. 45c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 46c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <limits.h> 47c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "sample1.h" 48731df977c0511bca2206b5f333555b1205ff1f43Iain Merrick#include "gtest/gtest.h" 49c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 50c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 51c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Step 2. Use the TEST macro to define your tests. 52c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 53c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// TEST has two parameters: the test case name and the test name. 54c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// After using the macro, you should define your test logic between a 55c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// pair of braces. You can use a bunch of macros to indicate the 56c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// success or failure of a test. EXPECT_TRUE and EXPECT_EQ are 57c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// examples of such macros. For a complete list, see gtest.h. 58c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 59c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// <TechnicalDetails> 60c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 61c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// In Google Test, tests are grouped into test cases. This is how we 62c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// keep test code organized. You should put logically related tests 63c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// into the same test case. 64c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 65c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// The test case name and the test name should both be valid C++ 66c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// identifiers. And you should not use underscore (_) in the names. 67c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 68c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Google Test guarantees that each test you define is run exactly 69c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// once, but it makes no guarantee on the order the tests are 70c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// executed. Therefore, you should write your tests in such a way 71c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// that their results don't depend on their order. 72c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 73c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// </TechnicalDetails> 74c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 75c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 76c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Tests Factorial(). 77c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 78c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Tests factorial of negative numbers. 79c407dc5cd9bdc5668497f21b26b09d988ab439deBen MurdochTEST(FactorialTest, Negative) { 80c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // This test is named "Negative", and belongs to the "FactorialTest" 81c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // test case. 82c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_EQ(1, Factorial(-5)); 83c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_EQ(1, Factorial(-1)); 84c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_TRUE(Factorial(-10) > 0); 85c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 86c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // <TechnicalDetails> 87c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 88c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // EXPECT_EQ(expected, actual) is the same as 89c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 90c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // EXPECT_TRUE((expected) == (actual)) 91c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 92c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // except that it will print both the expected value and the actual 93c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // value when the assertion fails. This is very helpful for 94c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // debugging. Therefore in this case EXPECT_EQ is preferred. 95c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 96c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // On the other hand, EXPECT_TRUE accepts any Boolean expression, 97c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // and is thus more general. 98c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 99c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // </TechnicalDetails> 100c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} 101c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 102c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Tests factorial of 0. 103c407dc5cd9bdc5668497f21b26b09d988ab439deBen MurdochTEST(FactorialTest, Zero) { 104c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_EQ(1, Factorial(0)); 105c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} 106c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 107c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Tests factorial of positive numbers. 108c407dc5cd9bdc5668497f21b26b09d988ab439deBen MurdochTEST(FactorialTest, Positive) { 109c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_EQ(1, Factorial(1)); 110c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_EQ(2, Factorial(2)); 111c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_EQ(6, Factorial(3)); 112c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_EQ(40320, Factorial(8)); 113c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} 114c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 115c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 116c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Tests IsPrime() 117c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 118c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Tests negative input. 119c407dc5cd9bdc5668497f21b26b09d988ab439deBen MurdochTEST(IsPrimeTest, Negative) { 120c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // This test belongs to the IsPrimeTest test case. 121c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 122c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_FALSE(IsPrime(-1)); 123c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_FALSE(IsPrime(-2)); 124c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_FALSE(IsPrime(INT_MIN)); 125c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} 126c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 127c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Tests some trivial cases. 128c407dc5cd9bdc5668497f21b26b09d988ab439deBen MurdochTEST(IsPrimeTest, Trivial) { 129c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_FALSE(IsPrime(0)); 130c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_FALSE(IsPrime(1)); 131c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_TRUE(IsPrime(2)); 132c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_TRUE(IsPrime(3)); 133c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} 134c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 135c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Tests positive input. 136c407dc5cd9bdc5668497f21b26b09d988ab439deBen MurdochTEST(IsPrimeTest, Positive) { 137c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_FALSE(IsPrime(4)); 138c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_TRUE(IsPrime(5)); 139c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_FALSE(IsPrime(6)); 140c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_TRUE(IsPrime(23)); 141c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch} 142c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 143c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Step 3. Call RUN_ALL_TESTS() in main(). 144c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 145c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// We do this by linking in src/gtest_main.cc file, which consists of 146c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// a main() function which calls RUN_ALL_TESTS() for us. 147c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 148c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// This runs all the tests you've defined, prints the result, and 149c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// returns 0 if successful, or 1 otherwise. 150c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// 151c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Did you notice that we didn't register the tests? The 152c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// RUN_ALL_TESTS() macro magically knows about all the tests we 153c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// defined. Isn't this convenient? 154