113481Sgiacomo.travaglini@arm.com// Copyright 2007, Google Inc. 213481Sgiacomo.travaglini@arm.com// All rights reserved. 313481Sgiacomo.travaglini@arm.com// 413481Sgiacomo.travaglini@arm.com// Redistribution and use in source and binary forms, with or without 513481Sgiacomo.travaglini@arm.com// modification, are permitted provided that the following conditions are 613481Sgiacomo.travaglini@arm.com// met: 713481Sgiacomo.travaglini@arm.com// 813481Sgiacomo.travaglini@arm.com// * Redistributions of source code must retain the above copyright 913481Sgiacomo.travaglini@arm.com// notice, this list of conditions and the following disclaimer. 1013481Sgiacomo.travaglini@arm.com// * Redistributions in binary form must reproduce the above 1113481Sgiacomo.travaglini@arm.com// copyright notice, this list of conditions and the following disclaimer 1213481Sgiacomo.travaglini@arm.com// in the documentation and/or other materials provided with the 1313481Sgiacomo.travaglini@arm.com// distribution. 1413481Sgiacomo.travaglini@arm.com// * Neither the name of Google Inc. nor the names of its 1513481Sgiacomo.travaglini@arm.com// contributors may be used to endorse or promote products derived from 1613481Sgiacomo.travaglini@arm.com// this software without specific prior written permission. 1713481Sgiacomo.travaglini@arm.com// 1813481Sgiacomo.travaglini@arm.com// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1913481Sgiacomo.travaglini@arm.com// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2013481Sgiacomo.travaglini@arm.com// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2113481Sgiacomo.travaglini@arm.com// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2213481Sgiacomo.travaglini@arm.com// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2313481Sgiacomo.travaglini@arm.com// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2413481Sgiacomo.travaglini@arm.com// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2513481Sgiacomo.travaglini@arm.com// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2613481Sgiacomo.travaglini@arm.com// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2713481Sgiacomo.travaglini@arm.com// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2813481Sgiacomo.travaglini@arm.com// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2913481Sgiacomo.travaglini@arm.com// 3013481Sgiacomo.travaglini@arm.com// Author: wan@google.com (Zhanyong Wan) 3113481Sgiacomo.travaglini@arm.com 3213481Sgiacomo.travaglini@arm.com// Tests that SCOPED_TRACE() and various Google Test assertions can be 3313481Sgiacomo.travaglini@arm.com// used in a large number of threads concurrently. 3413481Sgiacomo.travaglini@arm.com 3513481Sgiacomo.travaglini@arm.com#include "gtest/gtest.h" 3613481Sgiacomo.travaglini@arm.com 3713481Sgiacomo.travaglini@arm.com#include <iostream> 3813481Sgiacomo.travaglini@arm.com#include <vector> 3913481Sgiacomo.travaglini@arm.com 4013481Sgiacomo.travaglini@arm.com// We must define this macro in order to #include 4113481Sgiacomo.travaglini@arm.com// gtest-internal-inl.h. This is how Google Test prevents a user from 4213481Sgiacomo.travaglini@arm.com// accidentally depending on its internal implementation. 4313481Sgiacomo.travaglini@arm.com#define GTEST_IMPLEMENTATION_ 1 4413481Sgiacomo.travaglini@arm.com#include "src/gtest-internal-inl.h" 4513481Sgiacomo.travaglini@arm.com#undef GTEST_IMPLEMENTATION_ 4613481Sgiacomo.travaglini@arm.com 4713481Sgiacomo.travaglini@arm.com#if GTEST_IS_THREADSAFE 4813481Sgiacomo.travaglini@arm.com 4913481Sgiacomo.travaglini@arm.comnamespace testing { 5013481Sgiacomo.travaglini@arm.comnamespace { 5113481Sgiacomo.travaglini@arm.com 5213481Sgiacomo.travaglini@arm.comusing internal::Notification; 5313481Sgiacomo.travaglini@arm.comusing internal::TestPropertyKeyIs; 5413481Sgiacomo.travaglini@arm.comusing internal::ThreadWithParam; 5513481Sgiacomo.travaglini@arm.comusing internal::scoped_ptr; 5613481Sgiacomo.travaglini@arm.com 5713481Sgiacomo.travaglini@arm.com// In order to run tests in this file, for platforms where Google Test is 5813481Sgiacomo.travaglini@arm.com// thread safe, implement ThreadWithParam. See the description of its API 5913481Sgiacomo.travaglini@arm.com// in gtest-port.h, where it is defined for already supported platforms. 6013481Sgiacomo.travaglini@arm.com 6113481Sgiacomo.travaglini@arm.com// How many threads to create? 6213481Sgiacomo.travaglini@arm.comconst int kThreadCount = 50; 6313481Sgiacomo.travaglini@arm.com 6413481Sgiacomo.travaglini@arm.comstd::string IdToKey(int id, const char* suffix) { 6513481Sgiacomo.travaglini@arm.com Message key; 6613481Sgiacomo.travaglini@arm.com key << "key_" << id << "_" << suffix; 6713481Sgiacomo.travaglini@arm.com return key.GetString(); 6813481Sgiacomo.travaglini@arm.com} 6913481Sgiacomo.travaglini@arm.com 7013481Sgiacomo.travaglini@arm.comstd::string IdToString(int id) { 7113481Sgiacomo.travaglini@arm.com Message id_message; 7213481Sgiacomo.travaglini@arm.com id_message << id; 7313481Sgiacomo.travaglini@arm.com return id_message.GetString(); 7413481Sgiacomo.travaglini@arm.com} 7513481Sgiacomo.travaglini@arm.com 7613481Sgiacomo.travaglini@arm.comvoid ExpectKeyAndValueWereRecordedForId( 7713481Sgiacomo.travaglini@arm.com const std::vector<TestProperty>& properties, 7813481Sgiacomo.travaglini@arm.com int id, const char* suffix) { 7913481Sgiacomo.travaglini@arm.com TestPropertyKeyIs matches_key(IdToKey(id, suffix).c_str()); 8013481Sgiacomo.travaglini@arm.com const std::vector<TestProperty>::const_iterator property = 8113481Sgiacomo.travaglini@arm.com std::find_if(properties.begin(), properties.end(), matches_key); 8213481Sgiacomo.travaglini@arm.com ASSERT_TRUE(property != properties.end()) 8313481Sgiacomo.travaglini@arm.com << "expecting " << suffix << " value for id " << id; 8413481Sgiacomo.travaglini@arm.com EXPECT_STREQ(IdToString(id).c_str(), property->value()); 8513481Sgiacomo.travaglini@arm.com} 8613481Sgiacomo.travaglini@arm.com 8713481Sgiacomo.travaglini@arm.com// Calls a large number of Google Test assertions, where exactly one of them 8813481Sgiacomo.travaglini@arm.com// will fail. 8913481Sgiacomo.travaglini@arm.comvoid ManyAsserts(int id) { 9013481Sgiacomo.travaglini@arm.com GTEST_LOG_(INFO) << "Thread #" << id << " running..."; 9113481Sgiacomo.travaglini@arm.com 9213481Sgiacomo.travaglini@arm.com SCOPED_TRACE(Message() << "Thread #" << id); 9313481Sgiacomo.travaglini@arm.com 9413481Sgiacomo.travaglini@arm.com for (int i = 0; i < kThreadCount; i++) { 9513481Sgiacomo.travaglini@arm.com SCOPED_TRACE(Message() << "Iteration #" << i); 9613481Sgiacomo.travaglini@arm.com 9713481Sgiacomo.travaglini@arm.com // A bunch of assertions that should succeed. 9813481Sgiacomo.travaglini@arm.com EXPECT_TRUE(true); 9913481Sgiacomo.travaglini@arm.com ASSERT_FALSE(false) << "This shouldn't fail."; 10013481Sgiacomo.travaglini@arm.com EXPECT_STREQ("a", "a"); 10113481Sgiacomo.travaglini@arm.com ASSERT_LE(5, 6); 10213481Sgiacomo.travaglini@arm.com EXPECT_EQ(i, i) << "This shouldn't fail."; 10313481Sgiacomo.travaglini@arm.com 10413481Sgiacomo.travaglini@arm.com // RecordProperty() should interact safely with other threads as well. 10513481Sgiacomo.travaglini@arm.com // The shared_key forces property updates. 10613481Sgiacomo.travaglini@arm.com Test::RecordProperty(IdToKey(id, "string").c_str(), IdToString(id).c_str()); 10713481Sgiacomo.travaglini@arm.com Test::RecordProperty(IdToKey(id, "int").c_str(), id); 10813481Sgiacomo.travaglini@arm.com Test::RecordProperty("shared_key", IdToString(id).c_str()); 10913481Sgiacomo.travaglini@arm.com 11013481Sgiacomo.travaglini@arm.com // This assertion should fail kThreadCount times per thread. It 11113481Sgiacomo.travaglini@arm.com // is for testing whether Google Test can handle failed assertions in a 11213481Sgiacomo.travaglini@arm.com // multi-threaded context. 11313481Sgiacomo.travaglini@arm.com EXPECT_LT(i, 0) << "This should always fail."; 11413481Sgiacomo.travaglini@arm.com } 11513481Sgiacomo.travaglini@arm.com} 11613481Sgiacomo.travaglini@arm.com 11713481Sgiacomo.travaglini@arm.comvoid CheckTestFailureCount(int expected_failures) { 11813481Sgiacomo.travaglini@arm.com const TestInfo* const info = UnitTest::GetInstance()->current_test_info(); 11913481Sgiacomo.travaglini@arm.com const TestResult* const result = info->result(); 12013481Sgiacomo.travaglini@arm.com GTEST_CHECK_(expected_failures == result->total_part_count()) 12113481Sgiacomo.travaglini@arm.com << "Logged " << result->total_part_count() << " failures " 12213481Sgiacomo.travaglini@arm.com << " vs. " << expected_failures << " expected"; 12313481Sgiacomo.travaglini@arm.com} 12413481Sgiacomo.travaglini@arm.com 12513481Sgiacomo.travaglini@arm.com// Tests using SCOPED_TRACE() and Google Test assertions in many threads 12613481Sgiacomo.travaglini@arm.com// concurrently. 12713481Sgiacomo.travaglini@arm.comTEST(StressTest, CanUseScopedTraceAndAssertionsInManyThreads) { 12813481Sgiacomo.travaglini@arm.com { 12913481Sgiacomo.travaglini@arm.com scoped_ptr<ThreadWithParam<int> > threads[kThreadCount]; 13013481Sgiacomo.travaglini@arm.com Notification threads_can_start; 13113481Sgiacomo.travaglini@arm.com for (int i = 0; i != kThreadCount; i++) 13213481Sgiacomo.travaglini@arm.com threads[i].reset(new ThreadWithParam<int>(&ManyAsserts, 13313481Sgiacomo.travaglini@arm.com i, 13413481Sgiacomo.travaglini@arm.com &threads_can_start)); 13513481Sgiacomo.travaglini@arm.com 13613481Sgiacomo.travaglini@arm.com threads_can_start.Notify(); 13713481Sgiacomo.travaglini@arm.com 13813481Sgiacomo.travaglini@arm.com // Blocks until all the threads are done. 13913481Sgiacomo.travaglini@arm.com for (int i = 0; i != kThreadCount; i++) 14013481Sgiacomo.travaglini@arm.com threads[i]->Join(); 14113481Sgiacomo.travaglini@arm.com } 14213481Sgiacomo.travaglini@arm.com 14313481Sgiacomo.travaglini@arm.com // Ensures that kThreadCount*kThreadCount failures have been reported. 14413481Sgiacomo.travaglini@arm.com const TestInfo* const info = UnitTest::GetInstance()->current_test_info(); 14513481Sgiacomo.travaglini@arm.com const TestResult* const result = info->result(); 14613481Sgiacomo.travaglini@arm.com 14713481Sgiacomo.travaglini@arm.com std::vector<TestProperty> properties; 14813481Sgiacomo.travaglini@arm.com // We have no access to the TestResult's list of properties but we can 14913481Sgiacomo.travaglini@arm.com // copy them one by one. 15013481Sgiacomo.travaglini@arm.com for (int i = 0; i < result->test_property_count(); ++i) 15113481Sgiacomo.travaglini@arm.com properties.push_back(result->GetTestProperty(i)); 15213481Sgiacomo.travaglini@arm.com 15313481Sgiacomo.travaglini@arm.com EXPECT_EQ(kThreadCount * 2 + 1, result->test_property_count()) 15413481Sgiacomo.travaglini@arm.com << "String and int values recorded on each thread, " 15513481Sgiacomo.travaglini@arm.com << "as well as one shared_key"; 15613481Sgiacomo.travaglini@arm.com for (int i = 0; i < kThreadCount; ++i) { 15713481Sgiacomo.travaglini@arm.com ExpectKeyAndValueWereRecordedForId(properties, i, "string"); 15813481Sgiacomo.travaglini@arm.com ExpectKeyAndValueWereRecordedForId(properties, i, "int"); 15913481Sgiacomo.travaglini@arm.com } 16013481Sgiacomo.travaglini@arm.com CheckTestFailureCount(kThreadCount*kThreadCount); 16113481Sgiacomo.travaglini@arm.com} 16213481Sgiacomo.travaglini@arm.com 16313481Sgiacomo.travaglini@arm.comvoid FailingThread(bool is_fatal) { 16413481Sgiacomo.travaglini@arm.com if (is_fatal) 16513481Sgiacomo.travaglini@arm.com FAIL() << "Fatal failure in some other thread. " 16613481Sgiacomo.travaglini@arm.com << "(This failure is expected.)"; 16713481Sgiacomo.travaglini@arm.com else 16813481Sgiacomo.travaglini@arm.com ADD_FAILURE() << "Non-fatal failure in some other thread. " 16913481Sgiacomo.travaglini@arm.com << "(This failure is expected.)"; 17013481Sgiacomo.travaglini@arm.com} 17113481Sgiacomo.travaglini@arm.com 17213481Sgiacomo.travaglini@arm.comvoid GenerateFatalFailureInAnotherThread(bool is_fatal) { 17313481Sgiacomo.travaglini@arm.com ThreadWithParam<bool> thread(&FailingThread, is_fatal, NULL); 17413481Sgiacomo.travaglini@arm.com thread.Join(); 17513481Sgiacomo.travaglini@arm.com} 17613481Sgiacomo.travaglini@arm.com 17713481Sgiacomo.travaglini@arm.comTEST(NoFatalFailureTest, ExpectNoFatalFailureIgnoresFailuresInOtherThreads) { 17813481Sgiacomo.travaglini@arm.com EXPECT_NO_FATAL_FAILURE(GenerateFatalFailureInAnotherThread(true)); 17913481Sgiacomo.travaglini@arm.com // We should only have one failure (the one from 18013481Sgiacomo.travaglini@arm.com // GenerateFatalFailureInAnotherThread()), since the EXPECT_NO_FATAL_FAILURE 18113481Sgiacomo.travaglini@arm.com // should succeed. 18213481Sgiacomo.travaglini@arm.com CheckTestFailureCount(1); 18313481Sgiacomo.travaglini@arm.com} 18413481Sgiacomo.travaglini@arm.com 18513481Sgiacomo.travaglini@arm.comvoid AssertNoFatalFailureIgnoresFailuresInOtherThreads() { 18613481Sgiacomo.travaglini@arm.com ASSERT_NO_FATAL_FAILURE(GenerateFatalFailureInAnotherThread(true)); 18713481Sgiacomo.travaglini@arm.com} 18813481Sgiacomo.travaglini@arm.comTEST(NoFatalFailureTest, AssertNoFatalFailureIgnoresFailuresInOtherThreads) { 18913481Sgiacomo.travaglini@arm.com // Using a subroutine, to make sure, that the test continues. 19013481Sgiacomo.travaglini@arm.com AssertNoFatalFailureIgnoresFailuresInOtherThreads(); 19113481Sgiacomo.travaglini@arm.com // We should only have one failure (the one from 19213481Sgiacomo.travaglini@arm.com // GenerateFatalFailureInAnotherThread()), since the EXPECT_NO_FATAL_FAILURE 19313481Sgiacomo.travaglini@arm.com // should succeed. 19413481Sgiacomo.travaglini@arm.com CheckTestFailureCount(1); 19513481Sgiacomo.travaglini@arm.com} 19613481Sgiacomo.travaglini@arm.com 19713481Sgiacomo.travaglini@arm.comTEST(FatalFailureTest, ExpectFatalFailureIgnoresFailuresInOtherThreads) { 19813481Sgiacomo.travaglini@arm.com // This statement should fail, since the current thread doesn't generate a 19913481Sgiacomo.travaglini@arm.com // fatal failure, only another one does. 20013481Sgiacomo.travaglini@arm.com EXPECT_FATAL_FAILURE(GenerateFatalFailureInAnotherThread(true), "expected"); 20113481Sgiacomo.travaglini@arm.com CheckTestFailureCount(2); 20213481Sgiacomo.travaglini@arm.com} 20313481Sgiacomo.travaglini@arm.com 20413481Sgiacomo.travaglini@arm.comTEST(FatalFailureOnAllThreadsTest, ExpectFatalFailureOnAllThreads) { 20513481Sgiacomo.travaglini@arm.com // This statement should succeed, because failures in all threads are 20613481Sgiacomo.travaglini@arm.com // considered. 20713481Sgiacomo.travaglini@arm.com EXPECT_FATAL_FAILURE_ON_ALL_THREADS( 20813481Sgiacomo.travaglini@arm.com GenerateFatalFailureInAnotherThread(true), "expected"); 20913481Sgiacomo.travaglini@arm.com CheckTestFailureCount(0); 21013481Sgiacomo.travaglini@arm.com // We need to add a failure, because main() checks that there are failures. 21113481Sgiacomo.travaglini@arm.com // But when only this test is run, we shouldn't have any failures. 21213481Sgiacomo.travaglini@arm.com ADD_FAILURE() << "This is an expected non-fatal failure."; 21313481Sgiacomo.travaglini@arm.com} 21413481Sgiacomo.travaglini@arm.com 21513481Sgiacomo.travaglini@arm.comTEST(NonFatalFailureTest, ExpectNonFatalFailureIgnoresFailuresInOtherThreads) { 21613481Sgiacomo.travaglini@arm.com // This statement should fail, since the current thread doesn't generate a 21713481Sgiacomo.travaglini@arm.com // fatal failure, only another one does. 21813481Sgiacomo.travaglini@arm.com EXPECT_NONFATAL_FAILURE(GenerateFatalFailureInAnotherThread(false), 21913481Sgiacomo.travaglini@arm.com "expected"); 22013481Sgiacomo.travaglini@arm.com CheckTestFailureCount(2); 22113481Sgiacomo.travaglini@arm.com} 22213481Sgiacomo.travaglini@arm.com 22313481Sgiacomo.travaglini@arm.comTEST(NonFatalFailureOnAllThreadsTest, ExpectNonFatalFailureOnAllThreads) { 22413481Sgiacomo.travaglini@arm.com // This statement should succeed, because failures in all threads are 22513481Sgiacomo.travaglini@arm.com // considered. 22613481Sgiacomo.travaglini@arm.com EXPECT_NONFATAL_FAILURE_ON_ALL_THREADS( 22713481Sgiacomo.travaglini@arm.com GenerateFatalFailureInAnotherThread(false), "expected"); 22813481Sgiacomo.travaglini@arm.com CheckTestFailureCount(0); 22913481Sgiacomo.travaglini@arm.com // We need to add a failure, because main() checks that there are failures, 23013481Sgiacomo.travaglini@arm.com // But when only this test is run, we shouldn't have any failures. 23113481Sgiacomo.travaglini@arm.com ADD_FAILURE() << "This is an expected non-fatal failure."; 23213481Sgiacomo.travaglini@arm.com} 23313481Sgiacomo.travaglini@arm.com 23413481Sgiacomo.travaglini@arm.com} // namespace 23513481Sgiacomo.travaglini@arm.com} // namespace testing 23613481Sgiacomo.travaglini@arm.com 23713481Sgiacomo.travaglini@arm.comint main(int argc, char **argv) { 23813481Sgiacomo.travaglini@arm.com testing::InitGoogleTest(&argc, argv); 23913481Sgiacomo.travaglini@arm.com 24013481Sgiacomo.travaglini@arm.com const int result = RUN_ALL_TESTS(); // Expected to fail. 24113481Sgiacomo.travaglini@arm.com GTEST_CHECK_(result == 1) << "RUN_ALL_TESTS() did not fail as expected"; 24213481Sgiacomo.travaglini@arm.com 24313481Sgiacomo.travaglini@arm.com printf("\nPASS\n"); 24413481Sgiacomo.travaglini@arm.com return 0; 24513481Sgiacomo.travaglini@arm.com} 24613481Sgiacomo.travaglini@arm.com 24713481Sgiacomo.travaglini@arm.com#else 24813481Sgiacomo.travaglini@arm.comTEST(StressTest, 24913481Sgiacomo.travaglini@arm.com DISABLED_ThreadSafetyTestsAreSkippedWhenGoogleTestIsNotThreadSafe) { 25013481Sgiacomo.travaglini@arm.com} 25113481Sgiacomo.travaglini@arm.com 25213481Sgiacomo.travaglini@arm.comint main(int argc, char **argv) { 25313481Sgiacomo.travaglini@arm.com testing::InitGoogleTest(&argc, argv); 25413481Sgiacomo.travaglini@arm.com return RUN_ALL_TESTS(); 25513481Sgiacomo.travaglini@arm.com} 25613481Sgiacomo.travaglini@arm.com#endif // GTEST_IS_THREADSAFE 257