test_timeouts.h revision 5821806d5e7f356e8fa4b058a389a808ea183019
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef BASE_TEST_TEST_TIMEOUTS_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define BASE_TEST_TEST_TIMEOUTS_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/time.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Returns common timeouts to use in tests. Makes it possible to adjust 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the timeouts for different environments (like Valgrind). 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TestTimeouts { 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Initializes the timeouts. Non thread-safe. Should be called exactly once 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // by the test suite. 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void Initialize(); 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Timeout for actions that are expected to finish "almost instantly". 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static base::TimeDelta tiny_timeout() { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK(initialized_); 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return base::TimeDelta::FromMilliseconds(tiny_timeout_ms_); 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Timeout to wait for something to happen. If you are not sure 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // which timeout to use, this is the one you want. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static base::TimeDelta action_timeout() { 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK(initialized_); 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return base::TimeDelta::FromMilliseconds(action_timeout_ms_); 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Timeout longer than the above, but still suitable to use 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // multiple times in a single test. Use if the timeout above 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is not sufficient. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static base::TimeDelta action_max_timeout() { 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK(initialized_); 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return base::TimeDelta::FromMilliseconds(action_max_timeout_ms_); 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Timeout for a large test that may take a few minutes to run. 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static base::TimeDelta large_test_timeout() { 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK(initialized_); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return base::TimeDelta::FromMilliseconds(large_test_timeout_ms_); 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool initialized_; 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static int tiny_timeout_ms_; 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static int action_timeout_ms_; 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static int action_max_timeout_ms_; 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static int large_test_timeout_ms_; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_IMPLICIT_CONSTRUCTORS(TestTimeouts); 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // BASE_TEST_TEST_TIMEOUTS_H_ 59