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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
/// Provides structs used for getting time.
///
/// DEPRECATION WARNING: This module is DEPRECATED. Use `unc_primitives::time` instead.
///
/// WARNING WARNING WARNING
/// WARNING WARNING WARNING
/// Use at your own risk. The implementation is not complete, we have a places in code not mocked properly.
/// For example, it's possible to call `::elapsed()` on `Instant` returned by `Instant::now()`.
/// We use that that function, throughout the code, and the current mocking of `Instant` is not done properly.
///
/// Example:
/// ```rust, ignore
/// fn some_production_function() {
/// let start = Clock::instant();
/// // some computation
/// let end = Clock::instant();
/// assert!(end.duration_since(start) == Duration::from_secs(1));
/// }
///
/// Test:
/// fn test() {
/// let mock_clock_guard = MockClockGuard::default();
/// mock_clock_guard.add_instant(Instant::now());
/// mock_clock_guard.add_instant(Instant::now() + Duration::from_secs(1));
///
/// // This won't crash anymore as long as mock works.
/// some_production_function();
/// }
/// ```
use chrono;
use chrono::DateTime;
use chrono::Utc;
use std::cell::RefCell;
use std::collections::VecDeque;
use std::default::Default;
use std::time::Instant;
#[derive(Default)]
struct MockClockPerState {
/// List of timestamps, we will return one timestamp for each call of `Clock::utc()`.
utc_list: VecDeque<DateTime<Utc>>,
/// List of timestamps, we will return one timestamp to each call of `Clock::instant()`.
instant_list: VecDeque<Instant>,
/// Number of times `Clock::utc()` method was called since we started mocking.
utc_call_count: u64,
/// Number of times `Clock::instant()` method was called since we started mocking.
instant_call_count: u64,
}
/// Stores the mocking state.
#[derive(Default)]
struct MockClockPerThread {
mock: Option<MockClockPerState>,
}
impl MockClockPerThread {
fn with<F, T>(f: F) -> T
where
F: FnOnce(&mut MockClockPerThread) -> T,
{
thread_local! {
static INSTANCE: RefCell<MockClockPerThread> = RefCell::default()
}
INSTANCE.with(|it| f(&mut *it.borrow_mut()))
}
}
pub struct MockClockGuard {}
impl MockClockGuard {
/// Adds timestamp to queue, it will be returned in `Self::utc()`.
pub fn add_utc(&self, mock_date: DateTime<chrono::Utc>) {
MockClockPerThread::with(|clock| match &mut clock.mock {
Some(clock) => {
clock.utc_list.push_back(mock_date);
}
None => {
panic!("Use MockClockGuard in your test");
}
});
}
/// Adds timestamp to queue, it will be returned in `Self::utc()`.
pub fn add_instant(&self, mock_date: Instant) {
MockClockPerThread::with(|clock| match &mut clock.mock {
Some(clock) => {
clock.instant_list.push_back(mock_date);
}
None => {
panic!("Use MockClockGuard in your test");
}
});
}
/// Returns number of calls to `Self::utc` since `Self::mock()` was called.
pub fn utc_call_count(&self) -> u64 {
MockClockPerThread::with(|clock| match &mut clock.mock {
Some(clock) => clock.utc_call_count,
None => {
panic!("Use MockClockGuard in your test");
}
})
}
/// Returns number of calls to `Self::instant` since `Self::mock()` was called.
pub fn instant_call_count(&self) -> u64 {
MockClockPerThread::with(|clock| match &mut clock.mock {
Some(clock) => clock.instant_call_count,
None => {
panic!("Use MockClockGuard in your test");
}
})
}
}
impl Default for MockClockGuard {
fn default() -> Self {
StaticClock::set_mock();
Self {}
}
}
impl Drop for MockClockGuard {
fn drop(&mut self) {
StaticClock::reset();
}
}
/// Depreciated.
pub struct StaticClock {}
impl StaticClock {
/// Turns the mocking logic on.
fn set_mock() {
MockClockPerThread::with(|clock| {
assert!(clock.mock.is_none());
clock.mock = Some(MockClockPerState::default())
})
}
/// Resets mocks to default state.
fn reset() {
MockClockPerThread::with(|clock| clock.mock = None);
}
/// This methods gets current time as `std::Instant`
/// unless it's mocked, then returns time added by `Self::add_utc(...)`
pub fn instant() -> Instant {
MockClockPerThread::with(|clock| match &mut clock.mock {
Some(clock) => {
clock.instant_call_count += 1;
let x = clock.instant_list.pop_front();
match x {
Some(t) => t,
None => {
panic!("Mock clock run out of samples");
}
}
}
None => Instant::now(),
})
}
/// This methods gets current time as `std::Instant`
/// unless it's mocked, then returns time added by `Self::add_instant(...)`
pub fn utc() -> DateTime<chrono::Utc> {
MockClockPerThread::with(|clock| match &mut clock.mock {
Some(clock) => {
clock.utc_call_count += 1;
let x = clock.utc_list.pop_front();
match x {
Some(t) => t,
None => {
panic!("Mock clock run out of samples");
}
}
}
None => chrono::Utc::now(),
})
}
}