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
use std::time::{Duration, Instant};
use tracing::warn;
pub struct Progress {
name: String,
pub work_done: u64,
started_at: Instant,
work_total: u64,
}
impl Progress {
pub fn new(name: &str, work_todo: u64) -> Self {
Self {
name: name.to_owned(),
started_at: Instant::now(),
work_done: 0,
work_total: work_todo,
}
}
pub fn inc_work_done(&mut self) {
self.work_done = self.work_done + 1;
}
pub fn inc_work_done_by(&mut self, units: u64) {
self.work_done = self.work_done + units;
}
pub fn set_work_done(&mut self, units: u64) {
self.work_done = units;
}
fn estimate_time_left(&self) -> Duration {
if self.work_done > self.work_total {
warn!(self.work_done, self.work_total, "work done is larger than work total, using work done == work total to calculate time left");
}
let work_not_done = self
.work_total
.checked_sub(self.work_done)
.unwrap_or(self.work_total);
let not_done_to_done_ratio = work_not_done as f64 / self.work_done as f64;
let seconds_since_start = Instant::now() - self.started_at;
let eta_seconds = not_done_to_done_ratio * seconds_since_start.as_secs() as f64;
Duration::from_secs(eta_seconds as u64)
}
pub fn get_progress_string(&self) -> String {
let time_elapsed = format!("{:.0?}", Instant::now().duration_since(self.started_at));
let eta = if self.work_done == self.work_total {
"done!".to_string()
} else {
humantime::format_duration(self.estimate_time_left()).to_string()
};
format!(
"{} {}/{} - {:.1}% started {} ago, eta: {}",
self.name,
self.work_done,
self.work_total,
self.work_done as f64 / self.work_total as f64 * 100f64,
time_elapsed,
eta
)
}
}
#[cfg(test)]
mod tests {
use std::thread;
use super::*;
#[test]
fn inc_work_done_test() {
let mut progress = Progress::new("test progress", 100);
progress.inc_work_done();
assert_eq!(progress.work_done, 1);
}
#[test]
fn inc_work_done_by_test() {
let mut progress = Progress::new("test progress", 100);
progress.inc_work_done_by(10);
assert_eq!(progress.work_done, 10);
}
#[test]
fn set_work_done_test() {
let mut progress = Progress::new("test progress", 100);
progress.set_work_done(50);
assert_eq!(progress.work_done, 50);
}
#[test]
fn estimate_eta_test() {
let mut progress = Progress::new("test progress", 100);
progress.set_work_done(50);
thread::sleep(Duration::from_secs(1));
let eta = progress.estimate_time_left();
assert_eq!(eta, Duration::from_secs(1));
}
#[test]
fn get_progress_string_test() {
let mut progress = Progress::new("test progress", 100);
progress.set_work_done(50);
let progress_string = progress.get_progress_string();
assert!(progress_string.starts_with("test progress 50/100 - 50.0% started"));
assert!(progress_string.ends_with("ago, eta: 0s"));
}
#[test]
fn work_complete_string_test() {
let mut progress = Progress::new("test progress", 100);
progress.set_work_done(100);
let progress_string = progress.get_progress_string();
assert!(progress_string.starts_with("test progress 100/100 - 100.0% started"));
assert!(progress_string.ends_with("ago, eta: done!"));
}
#[test]
fn guard_against_work_done_overflow_test() {
let mut progress = Progress::new("test progress", 2);
progress.inc_work_done();
progress.inc_work_done();
progress.inc_work_done();
progress.estimate_time_left();
}
}