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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
extern crate nix;
extern crate cargo;
extern crate gimli;
extern crate object;
extern crate memmap;
extern crate coveralls_api;
extern crate fallible_iterator;
extern crate rustc_demangle;
extern crate regex;
#[macro_use]
extern crate clap;
extern crate serde;
extern crate serde_json;
use std::env;
use std::io;
use std::io::{Error, ErrorKind};
use std::ffi::CString;
use std::path::Path;
use std::collections::HashMap;
use nix::unistd::*;
use nix::libc::pid_t;
use nix::sys::signal;
use nix::sys::wait::*;
use cargo::util::Config as CargoConfig;
use cargo::core::Workspace;
use cargo::ops;
pub mod config;
pub mod tracer;
pub mod breakpoint;
pub mod report;
mod personality;
mod ptrace_control;
use config::*;
use tracer::*;
use breakpoint::*;
use ptrace_control::*;
pub fn launch_tarpaulin(config: Config) {
let cargo_config = CargoConfig::default().unwrap();
let flag_quiet = if config.verbose {
None
} else {
Some(true)
};
let _ = cargo_config.configure(0u32,
flag_quiet,
&None,
false,
false);
let workspace = match Workspace::new(config.manifest.as_path(), &cargo_config) {
Ok(w) => w,
Err(_) => panic!("Invalid project directory specified"),
};
let filter = ops::CompileFilter::Everything;
let rustflags = "RUSTFLAGS";
let mut value = "-Crelocation-model=dynamic-no-pic -Clink-dead-code".to_string();
if let Ok(vtemp) = env::var(rustflags) {
value.push_str(vtemp.as_ref());
}
env::set_var(rustflags, value);
let clean_opt = ops::CleanOptions {
config: &cargo_config,
spec: &[],
target: None,
release: false,
};
let copt = ops::CompileOptions {
config: &cargo_config,
jobs: None,
target: None,
features: &[],
all_features: true,
no_default_features:false ,
spec: ops::Packages::All,
release: false,
mode: ops::CompileMode::Test,
filter: filter,
message_format: ops::MessageFormat::Human,
target_rustdoc_args: None,
target_rustc_args: None,
};
let mut result:Vec<TracerData> = Vec::new();
if config.verbose {
println!("Running Tarpaulin");
}
let _ = ops::clean(&workspace, &clean_opt);
let compilation = ops::compile(&workspace, &copt);
match compilation {
Ok(comp) => {
for c in comp.tests.iter() {
if config.verbose {
println!("Processing {}", c.1);
}
let res = get_test_coverage(workspace.root(), c.2.as_path(), false)
.unwrap_or(vec![]);
merge_test_results(&mut result, &res);
if config.run_ignored {
let res = get_test_coverage(workspace.root(), c.2.as_path(), true)
.unwrap_or(vec![]);
merge_test_results(&mut result, &res);
}
}
},
Err(e) => {
if config.verbose{
println!("Error: failed to compile: {}", e);
}
},
}
report_coverage(&config, &result);
}
pub fn merge_test_results(master: &mut Vec<TracerData>, new: &Vec<TracerData>) {
let mut unmerged:Vec<TracerData> = Vec::new();
for t in new.iter() {
let mut update = master.iter_mut()
.filter(|x| x.path== t.path && x.line == t.line)
.collect::<Vec<_>>();
for ref mut u in update.iter_mut() {
u.hits += t.hits;
}
if update.iter().count() == 0 {
unmerged.push(t.clone());
}
}
master.append(&mut unmerged);
}
fn strip_project_path<'a>(config: &'a Config, path: &'a Path) -> &'a Path {
if let Some(root) = config.manifest.parent() {
&path.strip_prefix(root).unwrap_or(path)
} else {
path
}
}
pub fn report_coverage(config: &Config, result: &Vec<TracerData>) {
if result.len() > 0 {
println!("Coverage Results");
if config.verbose {
for r in result.iter() {
let path = strip_project_path(config, r.path.as_path());
println!("{}:{} - hits: {}", path.display(), r.line, r.hits);
}
println!("");
}
let mut file_map: HashMap<&Path, (u64, u64)> = HashMap::new();
for r in result.iter() {
if file_map.contains_key(r.path.as_path()) {
if let Some(v) = file_map.get_mut(r.path.as_path()) {
(*v).0 += (r.hits > 0) as u64;
(*v).1 += 1u64;
}
} else {
file_map.insert(r.path.as_path(), ((r.hits > 0) as u64, 1));
}
}
for (k, v) in file_map.iter() {
let path = strip_project_path(config, k);
println!("{}: {}/{}", path.display(), v.0, v.1);
}
let covered = result.iter().filter(|&x| (x.hits > 0 )).count();
let total = result.iter().count();
let percent = (covered as f64)/(total as f64) * 100.0f64;
println!("\n{:.2}% coverage, {}/{} lines covered", percent, covered, total);
if config.is_coveralls() {
println!("Sending coverage data to coveralls.io");
report::coveralls::export(&result, config);
println!("Coverage data sent");
}
} else {
println!("No coverage results collected.");
}
}
pub fn get_test_coverage(root: &Path, test: &Path, ignored: bool) -> Option<Vec<TracerData>> {
if !test.exists() {
return None;
}
match fork() {
Ok(ForkResult::Parent{ child }) => {
match collect_coverage(root, test, child) {
Ok(t) => {
Some(t)
},
Err(e) => {
println!("Error occurred: {}", e);
None
},
}
}
Ok(ForkResult::Child) => {
println!("Launching test");
execute_test(test, ignored, true);
None
}
Err(err) => {
println!("Failed to run {}", test.display());
println!("Error {}", err);
None
}
}
}
fn collect_coverage(project_path: &Path,
test_path: &Path,
test: pid_t) -> io::Result<Vec<TracerData>> {
let mut traces = generate_tracer_data(project_path, test_path)?;
let mut bps: HashMap<u64, Breakpoint> = HashMap::new();
match waitpid(test, None) {
Ok(WaitStatus::Stopped(child, signal::SIGTRAP)) => {
let child_trace = trace_children(child);
if let Err(c) = child_trace {
println!("Failed to trace child threads: {}", c);
}
for trace in traces.iter() {
match Breakpoint::new(child, trace.address) {
Ok(bp) => {
let _ = bps.insert(trace.address, bp);
},
Err(e) => println!("Failed to instrument {}", e),
}
}
},
Ok(_) => println!("Unexpected grab"),
Err(err) => println!("Error on start: {}", err)
}
match run_function(test, u64::max_value(), &mut traces, &mut bps) {
Err(e) => println!("Error while collecting coverage. {}", e),
_ => {},
}
Ok(traces)
}
fn run_function(pid: pid_t,
end: u64,
mut traces: &mut Vec<TracerData>,
mut breakpoints: &mut HashMap<u64, Breakpoint>) -> Result<i8, Error> {
let mut res = 0i8;
continue_exec(pid)?;
loop {
match waitpid(-1, Some(__WALL)) {
Ok(WaitStatus::Exited(child, sig)) => {
res = sig;
if child == pid {
break;
} else {
let _ =continue_exec(pid);
}
},
Ok(WaitStatus::Stopped(child, signal::SIGTRAP)) => {
if let Ok(rip) = current_instruction_pointer(child) {
let rip = (rip - 1) as u64;
if breakpoints.contains_key(&rip) {
let ref mut bp = breakpoints.get_mut(&rip).unwrap();
let updated = if let Ok(x) = bp.process(Some(child)) {
x
} else {
rip == end
};
if updated {
for mut t in traces.iter_mut()
.filter(|ref x| x.address == rip) {
(*t).hits += 1;
}
}
} else {
continue_exec(child)?;
}
}
},
Ok(WaitStatus::Stopped(child, signal::SIGSTOP)) => {
continue_exec(child)?;
},
Ok(WaitStatus::Stopped(child, sig)) => {
println!("Unexpected signal {:?}", sig);
continue_exec(child)?;
},
Ok(WaitStatus::PtraceEvent(child, signal::SIGTRAP, 3)) => {
if let Ok(_) = get_event_data(child) {
continue_exec(child)?;
}
},
Ok(WaitStatus::Signaled(_, signal::SIGTRAP, true)) => break,
Ok(_) => {
println!("Unexpected stop");
break;
},
Err(e) => {
return Err(Error::new(ErrorKind::Other, e))
},
}
}
Ok(res)
}
fn execute_test(test: &Path, ignored: bool, backtrace_on: bool) {
let exec_path = CString::new(test.to_str().unwrap()).unwrap();
match personality::disable_aslr() {
Ok(_) => {},
Err(e) => println!("ASLR disable failed: {}", e),
}
request_trace().ok()
.expect("Failed to trace");
let mut envars: Vec<CString> = vec![CString::new("RUST_TEST_THREADS=1").unwrap()];
for (key, value) in env::vars() {
let mut temp = String::new();
temp.push_str(key.as_str());
temp.push('=');
temp.push_str(value.as_str());
envars.push(CString::new(temp).unwrap());
}
if backtrace_on {
envars.push(CString::new("RUST_BACKTRACE=1").unwrap());
}
let argv = if ignored {
vec![exec_path.clone(), CString::new("--ignored").unwrap()]
} else {
vec![exec_path.clone()]
};
execve(&exec_path, &argv, envars.as_slice())
.unwrap();
}
#[cfg(test)]
mod tests {
use std::path::PathBuf;
use ::*;
#[test]
fn result_merge_test() {
let mut master:Vec<TracerData> = vec![];
master.push(TracerData {
path: PathBuf::from("testing/test.rs"),
line: 2,
address: 0,
trace_type: LineType::Unknown,
hits: 1
});
master.push(TracerData {
path: PathBuf::from("testing/test.rs"),
line: 3,
address: 1,
trace_type: LineType::Unknown,
hits: 1
});
master.push(TracerData {
path: PathBuf::from("testing/not.rs"),
line: 2,
address: 0,
trace_type: LineType::Unknown,
hits: 7
});
let other:Vec<TracerData> = vec![
TracerData {
path:PathBuf::from("testing/test.rs"),
line: 2,
address: 0,
trace_type: LineType::Unknown,
hits: 2
}];
merge_test_results(&mut master, &other);
let expected = vec![3, 1, 7];
for (act, exp) in master.iter().zip(expected) {
assert_eq!(act.hits, exp);
}
}
}