• 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/logging.h"
9 #include "base/macros.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   // Argument that can be passed on the command line to indicate "no timeout".
17   static constexpr const char kNoTimeoutSwitchValue[] = "-1";
18 
19   // Initializes the timeouts. Non thread-safe. Should be called exactly once
20   // by the test suite.
21   static void Initialize();
22 
23   // Timeout for actions that are expected to finish "almost instantly".
tiny_timeout()24   static base::TimeDelta tiny_timeout() {
25     DCHECK(initialized_);
26     return base::TimeDelta::FromMilliseconds(tiny_timeout_ms_);
27   }
28 
29   // Timeout to wait for something to happen. If you are not sure
30   // which timeout to use, this is the one you want.
action_timeout()31   static base::TimeDelta action_timeout() {
32     DCHECK(initialized_);
33     return base::TimeDelta::FromMilliseconds(action_timeout_ms_);
34   }
35 
36   // Timeout longer than the above, but still suitable to use
37   // multiple times in a single test. Use if the timeout above
38   // is not sufficient.
action_max_timeout()39   static base::TimeDelta action_max_timeout() {
40     DCHECK(initialized_);
41     return base::TimeDelta::FromMilliseconds(action_max_timeout_ms_);
42   }
43 
44   // Timeout for a single test launched used built-in test launcher.
45   // Do not use outside of the test launcher.
test_launcher_timeout()46   static base::TimeDelta test_launcher_timeout() {
47     DCHECK(initialized_);
48     return base::TimeDelta::FromMilliseconds(test_launcher_timeout_ms_);
49   }
50 
51  private:
52   static bool initialized_;
53 
54   static int tiny_timeout_ms_;
55   static int action_timeout_ms_;
56   static int action_max_timeout_ms_;
57   static int test_launcher_timeout_ms_;
58 
59   DISALLOW_IMPLICIT_CONSTRUCTORS(TestTimeouts);
60 };
61 
62 #endif  // BASE_TEST_TEST_TIMEOUTS_H_
63