File: run_until.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (38 lines) | stat: -rw-r--r-- 1,262 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef BASE_TEST_RUN_UNTIL_H_
#define BASE_TEST_RUN_UNTIL_H_

#include "base/functional/function_ref.h"

namespace base::test {

// Waits until `condition` evaluates to `true`, by evaluating `condition`
// whenever the current thread becomes idle.
//
// Note: "something" (e.g. a task) must wake the current thread once the
// condition is true. As such testing global conditions which won't wake the
// current thread is flaky.
//
// Returns true if `condition` became true, or false if a timeout happens.
//
// Example usage:
//
//   ChangeColorAsyncTo(object_under_tests, Color::Red);
//
//   // Waits until the color is red, or aborts the tests otherwise.
//   ASSERT_TRUE(RunUntil([&](){
//     return object_under_test.Color() == Color::Red;
//   })) << "Timeout waiting for the color to turn red";
//
//   // When we come here `Color()` is guaranteed to be `Color::Red`.
//
// TODO (crbug.com/376085325): Implement timeout handling for MOCK_TIME to
// manage unmet conditions.
[[nodiscard]] bool RunUntil(base::FunctionRef<bool(void)> condition);

}  // namespace base::test

#endif  // BASE_TEST_RUN_UNTIL_H_