• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef BASE_TEST_TEST_TIMEOUTS_H_
6 #define BASE_TEST_TEST_TIMEOUTS_H_
7 
8 #include "base/basictypes.h"
9 #include "base/logging.h"
10 #include "base/time/time.h"
11 
12 // Returns common timeouts to use in tests. Makes it possible to adjust
13 // the timeouts for different environments (like Valgrind).
14 class TestTimeouts {
15  public:
16   // Initializes the timeouts. Non thread-safe. Should be called exactly once
17   // by the test suite.
18   static void Initialize();
19 
20   // Timeout for actions that are expected to finish "almost instantly".
tiny_timeout()21   static base::TimeDelta tiny_timeout() {
22     DCHECK(initialized_);
23     return base::TimeDelta::FromMilliseconds(tiny_timeout_ms_);
24   }
25 
26   // Timeout to wait for something to happen. If you are not sure
27   // which timeout to use, this is the one you want.
action_timeout()28   static base::TimeDelta action_timeout() {
29     DCHECK(initialized_);
30     return base::TimeDelta::FromMilliseconds(action_timeout_ms_);
31   }
32 
33   // Timeout longer than the above, but still suitable to use
34   // multiple times in a single test. Use if the timeout above
35   // is not sufficient.
action_max_timeout()36   static base::TimeDelta action_max_timeout() {
37     DCHECK(initialized_);
38     return base::TimeDelta::FromMilliseconds(action_max_timeout_ms_);
39   }
40 
41   // Timeout for a large test that may take a few minutes to run.
large_test_timeout()42   static base::TimeDelta large_test_timeout() {
43     DCHECK(initialized_);
44     return base::TimeDelta::FromMilliseconds(large_test_timeout_ms_);
45   }
46 
47   // Timeout for a single test launched used built-in test launcher.
48   // Do not use outside of the test launcher.
test_launcher_timeout()49   static base::TimeDelta test_launcher_timeout() {
50     DCHECK(initialized_);
51     return base::TimeDelta::FromMilliseconds(test_launcher_timeout_ms_);
52   }
53 
54  private:
55   static bool initialized_;
56 
57   static int tiny_timeout_ms_;
58   static int action_timeout_ms_;
59   static int action_max_timeout_ms_;
60   static int large_test_timeout_ms_;
61   static int test_launcher_timeout_ms_;
62 
63   DISALLOW_IMPLICIT_CONSTRUCTORS(TestTimeouts);
64 };
65 
66 #endif  // BASE_TEST_TEST_TIMEOUTS_H_
67