File: mock_clock.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (58 lines) | stat: -rw-r--r-- 1,820 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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROMEOS_ASH_COMPONENTS_BOCA_ON_TASK_UTIL_MOCK_CLOCK_H_
#define CHROMEOS_ASH_COMPONENTS_BOCA_ON_TASK_UTIL_MOCK_CLOCK_H_

#include <memory>

#include "base/no_destructor.h"
#include "base/synchronization/lock.h"
#include "base/thread_annotations.h"
#include "base/time/time.h"
#include "base/time/time_override.h"

namespace ash::boca {

// Mock clock that supplies a mock time and can be advanced for testing
// purposes. Only applicable for browser tests where a `TaskEnvironment` is
// unavailable.
class MockClock {
 public:
  // Returns a MockClock which will not be deleted. Should be called once while
  // single-threaded to initialize ScopedTimeClockOverrides to avoid threading
  // issues.
  static MockClock& Get();

  MockClock(const MockClock&) = delete;
  MockClock& operator=(const MockClock&) = delete;
  ~MockClock();

  // Advances clock by the specified duration.
  void Advance(base::TimeDelta duration);

 private:
  friend base::NoDestructor<MockClock>;

  // Static helpers that return the current time based on the offset duration.
  // This is used to set up the time override.
  static base::Time MockedNow();
  static base::TimeTicks MockedTicksNow();

  MockClock();

  // Returns the offset duration.
  base::TimeDelta Offset();
  const std::unique_ptr<base::subtle::ScopedTimeClockOverrides> time_override_;

  // A lock is necessary because `MockedNow` and `MockedTicksNow` can be
  // accessed by components from different threads when they retrieve the
  // current time.
  base::Lock lock_;
  base::TimeDelta offset_ GUARDED_BY(lock_);
};

}  // namespace ash::boca

#endif  // CHROMEOS_ASH_COMPONENTS_BOCA_ON_TASK_UTIL_MOCK_CLOCK_H_