torrust-tracker-deployer 0.1.0-beta.2

Torrust Tracker Deployer - Deployment Infrastructure with Ansible and OpenTofu
Documentation 
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

//! Mock clock for testing
//!
//! This module provides a mock clock implementation that allows
//! controlling time in tests for deterministic behavior.

use chrono::{DateTime, Duration, Utc};
use std::sync::Arc;

use parking_lot::Mutex;

use crate::shared::Clock;

/// Mock clock for testing that allows controlling time
///
/// This clock implementation allows tests to:
/// - Set a fixed time point
/// - Advance time manually without actual delays
/// - Make time-dependent tests deterministic
///
/// The clock uses interior mutability to allow advancing time
/// while implementing the `Clock` trait which takes `&self`.
///
/// # Example
///
/// ```rust
/// use torrust_tracker_deployer_lib::testing::MockClock;
/// use torrust_tracker_deployer_lib::shared::Clock;
/// use chrono::{TimeZone, Utc};
///
/// let fixed_time = Utc.with_ymd_and_hms(2025, 10, 7, 12, 0, 0).unwrap();
/// let clock = MockClock::new(fixed_time);
///
/// // Time is fixed
/// assert_eq!(clock.now(), fixed_time);
/// assert_eq!(clock.now(), fixed_time); // Still the same
///
/// // Advance time
/// clock.advance_secs(60);
/// let expected = Utc.with_ymd_and_hms(2025, 10, 7, 12, 1, 0).unwrap();
/// assert_eq!(clock.now(), expected);
/// ```
#[derive(Debug, Clone)]
pub struct MockClock {
    /// Current time maintained by the mock clock
    current_time: Arc<Mutex<DateTime<Utc>>>,
}

impl MockClock {
    /// Create a new mock clock with a fixed starting time
    ///
    /// # Example
    ///
    /// ```rust
    /// use torrust_tracker_deployer_lib::testing::MockClock;
    /// use chrono::{TimeZone, Utc};
    ///
    /// let fixed_time = Utc.with_ymd_and_hms(2025, 10, 7, 12, 0, 0).unwrap();
    /// let clock = MockClock::new(fixed_time);
    /// ```
    #[must_use]
    pub fn new(initial_time: DateTime<Utc>) -> Self {
        Self {
            current_time: Arc::new(Mutex::new(initial_time)),
        }
    }

    /// Advance the clock by the specified duration
    ///
    /// # Panics
    ///
    /// Panics if the internal mutex is poisoned (which would indicate a panic occurred
    /// while holding the lock in another thread).
    ///
    /// # Example
    ///
    /// ```rust
    /// use torrust_tracker_deployer_lib::testing::MockClock;
    /// use torrust_tracker_deployer_lib::shared::Clock;
    /// use chrono::{Duration, TimeZone, Utc};
    ///
    /// let initial = Utc.with_ymd_and_hms(2025, 10, 7, 12, 0, 0).unwrap();
    /// let clock = MockClock::new(initial);
    ///
    /// clock.advance(Duration::hours(2));
    /// let expected = Utc.with_ymd_and_hms(2025, 10, 7, 14, 0, 0).unwrap();
    /// assert_eq!(clock.now(), expected);
    /// ```
    pub fn advance(&self, duration: Duration) {
        let mut time = self.current_time.lock();
        *time += duration;
    }

    /// Advance the clock by the specified number of seconds
    ///
    /// Convenience method for advancing time without creating a `Duration`.
    ///
    /// # Example
    ///
    /// ```rust
    /// use torrust_tracker_deployer_lib::testing::MockClock;
    /// use torrust_tracker_deployer_lib::shared::Clock;
    /// use chrono::{TimeZone, Utc};
    ///
    /// let initial = Utc.with_ymd_and_hms(2025, 10, 7, 12, 0, 0).unwrap();
    /// let clock = MockClock::new(initial);
    ///
    /// clock.advance_secs(30);
    /// let expected = Utc.with_ymd_and_hms(2025, 10, 7, 12, 0, 30).unwrap();
    /// assert_eq!(clock.now(), expected);
    /// ```
    pub fn advance_secs(&self, secs: i64) {
        self.advance(Duration::seconds(secs));
    }

    /// Set the clock to a specific time
    ///
    /// # Panics
    ///
    /// Panics if the internal mutex is poisoned (which would indicate a panic occurred
    /// while holding the lock in another thread).
    ///
    /// # Example
    ///
    /// ```rust
    /// use torrust_tracker_deployer_lib::testing::MockClock;
    /// use torrust_tracker_deployer_lib::shared::Clock;
    /// use chrono::{TimeZone, Utc};
    ///
    /// let initial = Utc.with_ymd_and_hms(2025, 10, 7, 12, 0, 0).unwrap();
    /// let clock = MockClock::new(initial);
    ///
    /// let new_time = Utc.with_ymd_and_hms(2025, 12, 25, 18, 30, 0).unwrap();
    /// clock.set_time(new_time);
    /// assert_eq!(clock.now(), new_time);
    /// ```
    pub fn set_time(&self, time: DateTime<Utc>) {
        let mut current = self.current_time.lock();
        *current = time;
    }
}

impl Clock for MockClock {
    fn now(&self) -> DateTime<Utc> {
        *self.current_time.lock()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use chrono::TimeZone;

    #[test]
    fn it_should_return_fixed_time_when_not_advanced() {
        let fixed_time = Utc.with_ymd_and_hms(2025, 10, 7, 12, 0, 0).unwrap();
        let clock = MockClock::new(fixed_time);

        assert_eq!(clock.now(), fixed_time);
        assert_eq!(clock.now(), fixed_time);
        assert_eq!(clock.now(), fixed_time);
    }

    #[test]
    fn it_should_advance_time_by_duration() {
        let initial = Utc.with_ymd_and_hms(2025, 10, 7, 12, 0, 0).unwrap();
        let clock = MockClock::new(initial);

        clock.advance(Duration::hours(2) + Duration::minutes(30));

        let expected = Utc.with_ymd_and_hms(2025, 10, 7, 14, 30, 0).unwrap();
        assert_eq!(clock.now(), expected);
    }

    #[test]
    fn it_should_advance_time_by_seconds() {
        let initial = Utc.with_ymd_and_hms(2025, 10, 7, 12, 0, 0).unwrap();
        let clock = MockClock::new(initial);

        clock.advance_secs(90);

        let expected = Utc.with_ymd_and_hms(2025, 10, 7, 12, 1, 30).unwrap();
        assert_eq!(clock.now(), expected);
    }

    #[test]
    fn it_should_set_time_to_specific_point() {
        let initial = Utc.with_ymd_and_hms(2025, 10, 7, 12, 0, 0).unwrap();
        let clock = MockClock::new(initial);

        let new_time = Utc.with_ymd_and_hms(2025, 12, 25, 18, 30, 0).unwrap();
        clock.set_time(new_time);

        assert_eq!(clock.now(), new_time);
    }

    #[test]
    fn it_should_support_multiple_advances() {
        let initial = Utc.with_ymd_and_hms(2025, 10, 7, 12, 0, 0).unwrap();
        let clock = MockClock::new(initial);

        clock.advance_secs(30);
        clock.advance_secs(30);
        clock.advance_secs(30);

        let expected = Utc.with_ymd_and_hms(2025, 10, 7, 12, 1, 30).unwrap();
        assert_eq!(clock.now(), expected);
    }

    #[test]
    fn it_should_be_clonable() {
        let initial = Utc.with_ymd_and_hms(2025, 10, 7, 12, 0, 0).unwrap();
        let clock1 = MockClock::new(initial);
        let clock2 = clock1.clone();

        // Both clones share the same time
        clock1.advance_secs(60);
        assert_eq!(clock1.now(), clock2.now());
    }
}