Home | History | Annotate | Download | only in test
      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 TSan).
     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".  This
     21   // is used in various tests to post delayed tasks and usually functions more
     22   // like a delay value than a timeout.
     23   static base::TimeDelta tiny_timeout() {
     24     DCHECK(initialized_);
     25     return base::TimeDelta::FromMilliseconds(tiny_timeout_ms_);
     26   }
     27 
     28   // Timeout to wait for something to happen. If you are not sure
     29   // which timeout to use, this is the one you want.
     30   static base::TimeDelta action_timeout() {
     31     DCHECK(initialized_);
     32     return base::TimeDelta::FromMilliseconds(action_timeout_ms_);
     33   }
     34 
     35   // Timeout longer than the above, but still suitable to use
     36   // multiple times in a single test. Use if the timeout above
     37   // is not sufficient.
     38   static base::TimeDelta action_max_timeout() {
     39     DCHECK(initialized_);
     40     return base::TimeDelta::FromMilliseconds(action_max_timeout_ms_);
     41   }
     42 
     43   // Timeout for a single test launched used built-in test launcher.
     44   // Do not use outside of the test launcher.
     45   static base::TimeDelta test_launcher_timeout() {
     46     DCHECK(initialized_);
     47     return base::TimeDelta::FromMilliseconds(test_launcher_timeout_ms_);
     48   }
     49 
     50  private:
     51   static bool initialized_;
     52 
     53   static int tiny_timeout_ms_;
     54   static int action_timeout_ms_;
     55   static int action_max_timeout_ms_;
     56   static int test_launcher_timeout_ms_;
     57 
     58   DISALLOW_IMPLICIT_CONSTRUCTORS(TestTimeouts);
     59 };
     60 
     61 #endif  // BASE_TEST_TEST_TIMEOUTS_H_
     62