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 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
use crate::config::{Config, RunType};
use crate::path_utils::{get_source_walker, is_source_file};
use lazy_static::lazy_static;
use proc_macro2::{Span, TokenStream};
use quote::ToTokens;
use regex::Regex;
use serde::{Deserialize, Serialize};
use std::cell::RefCell;
use std::collections::{HashMap, HashSet};
use std::ffi::OsStr;
use std::fs::File;
use std::io::{self, BufRead, BufReader, Read};
use std::path::{Path, PathBuf};
use syn::spanned::Spanned;
use syn::*;
use tracing::{debug, trace, warn};
use walkdir::WalkDir;
mod attributes;
mod expressions;
mod items;
mod macros;
mod statements;
#[cfg(test)]
mod tests;
pub(crate) mod prelude {
pub(crate) use super::*;
pub(crate) use attributes::*;
pub(crate) use macros::*;
}
/// Enumeration representing which lines to ignore
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
pub enum Lines {
/// Ignore all lines in the file
All,
/// A single line to ignore in the file
Line(usize),
}
/// Represents the results of analysis of a single file. Does not store the file
/// in question as this is expected to be maintained by the user.
#[derive(Clone, Debug, Default)]
pub struct LineAnalysis {
/// This represents lines that should be ignored in coverage
/// but may be identifed as coverable in the DWARF tables
pub ignore: HashSet<Lines>,
/// This represents lines that should be included in coverage
/// But may be ignored. Doesn't make sense to cover ALL the lines so this
/// is just an index.
pub cover: HashSet<usize>,
/// Some logical lines may be split between physical lines this shows the
/// mapping from physical line to logical line to prevent false positives
/// from expressions split across physical lines
pub logical_lines: HashMap<usize, usize>,
/// Shows the line length of the provided file
max_line: usize,
pub functions: HashMap<String, (usize, usize)>,
}
/// Provides context to the source analysis stage including the tarpaulin
/// config and the source code being analysed.
pub(crate) struct Context<'a> {
/// Program config
config: &'a Config,
/// Contents of the source file
file_contents: &'a str,
/// path to the file being analysed
file: &'a Path,
/// Other parts of context are immutable like tarpaulin config and users
/// source code. This is discovered during hence use of interior mutability
ignore_mods: RefCell<HashSet<PathBuf>>,
/// As we traverse the structures we want to grab module names etc so we can get proper names
/// for our functions etc
pub(crate) symbol_stack: RefCell<Vec<String>>,
}
pub(crate) struct StackGuard<'a>(&'a RefCell<Vec<String>>);
impl<'a> Drop for StackGuard<'a> {
fn drop(&mut self) {
self.0.borrow_mut().pop();
}
}
impl<'a> Context<'a> {
pub(crate) fn push_to_symbol_stack(&self, mut ident: String) -> StackGuard<'_> {
if !(ident.starts_with("<") && ident.ends_with(">")) {
ident = ident.replace(' ', "");
}
self.symbol_stack.borrow_mut().push(ident);
StackGuard(&self.symbol_stack)
}
pub(crate) fn get_qualified_name(&self) -> String {
let stack = self.symbol_stack.borrow();
let name = stack.join("::");
debug!("Found function: {}", name);
name
}
}
/// When the `LineAnalysis` results are mapped to their files there needs to be
/// an easy way to get the information back. For the container used implement
/// this trait
pub trait SourceAnalysisQuery {
/// Returns true if the line in the given file should be ignored
fn should_ignore(&self, path: &Path, l: &usize) -> bool;
/// Takes a path and line number and normalises it to the logical line
/// that should be represented in the statistics
fn normalise(&self, path: &Path, l: usize) -> (PathBuf, usize);
}
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub(crate) enum SubResult {
/// Expression should be a reachable one (or we don't care to check further)
Ok,
/// Expression definitely reachable - reserved for early returns from functions to stop
/// unreachable expressions wiping them out
Definite,
/// Unreachable expression i.e. unreachable!()
Unreachable,
}
// Addition works for this by forcing anything + definite to definite, otherwise prioritising
// unreachable.
impl std::ops::AddAssign for SubResult {
fn add_assign(&mut self, other: Self) {
if *self == Self::Definite || other == Self::Definite {
*self = Self::Definite;
} else if *self == Self::Unreachable || other == Self::Unreachable {
*self = Self::Unreachable;
} else {
*self = Self::Ok;
}
}
}
impl std::ops::Add for SubResult {
type Output = Self;
fn add(mut self, rhs: Self) -> Self::Output {
self += rhs;
self
}
}
impl SubResult {
pub fn is_reachable(&self) -> bool {
*self != Self::Unreachable
}
pub fn is_unreachable(&self) -> bool {
!self.is_reachable()
}
}
impl SourceAnalysisQuery for HashMap<PathBuf, LineAnalysis> {
fn should_ignore(&self, path: &Path, l: &usize) -> bool {
if self.contains_key(path) {
self.get(path).unwrap().should_ignore(*l)
} else {
false
}
}
fn normalise(&self, path: &Path, l: usize) -> (PathBuf, usize) {
let pb = path.to_path_buf();
match self.get(path) {
Some(s) => match s.logical_lines.get(&l) {
Some(o) => (pb, *o),
_ => (pb, l),
},
_ => (pb, l),
}
}
}
impl LineAnalysis {
/// Creates a new LineAnalysis object
fn new() -> Self {
Default::default()
}
fn new_from_file(path: &Path) -> io::Result<Self> {
let file = BufReader::new(File::open(path)?);
Ok(Self {
max_line: file.lines().count(),
..Default::default()
})
}
/// Ignore all lines in the file
pub fn ignore_all(&mut self) {
self.ignore.clear();
self.cover.clear();
self.ignore.insert(Lines::All);
}
/// Ignore all tokens in the given token stream
pub fn ignore_tokens<T>(&mut self, tokens: T)
where
T: ToTokens,
{
for token in tokens.into_token_stream() {
self.ignore_span(token.span());
}
}
/// Adds the lines of the provided span to the ignore set
pub fn ignore_span(&mut self, span: Span) {
// If we're already ignoring everything no need to ignore this span
if !self.ignore.contains(&Lines::All) {
for i in span.start().line..=span.end().line {
self.ignore.insert(Lines::Line(i));
if self.cover.contains(&i) {
self.cover.remove(&i);
}
}
}
}
/// Cover all tokens in the given tokenstream
pub fn cover_token_stream(&mut self, tokens: TokenStream, contents: Option<&str>) {
for token in tokens {
self.cover_span(token.span(), contents);
}
}
/// Adds the lines of the provided span to the cover set
pub fn cover_span(&mut self, span: Span, contents: Option<&str>) {
// Not checking for Lines::All because I trust we've called cover_span
// for a reason.
let mut useful_lines: HashSet<usize> = HashSet::new();
if let Some(c) = contents {
lazy_static! {
static ref SINGLE_LINE: Regex = Regex::new(r"\s*//").unwrap();
}
const MULTI_START: &str = "/*";
const MULTI_END: &str = "*/";
let len = span.end().line - span.start().line;
let mut is_comment = false;
for (i, line) in c.lines().enumerate().skip(span.start().line - 1).take(len) {
let is_code = if line.contains(MULTI_START) {
if !line.contains(MULTI_END) {
is_comment = true;
}
false
} else if is_comment {
if line.contains(MULTI_END) {
is_comment = false;
}
false
} else {
true
};
if is_code && !SINGLE_LINE.is_match(line) {
useful_lines.insert(i + 1);
}
}
}
for i in span.start().line..=span.end().line {
if !self.ignore.contains(&Lines::Line(i)) && useful_lines.contains(&i) {
self.cover.insert(i);
}
}
}
/// Shows whether the line should be ignored by tarpaulin
pub fn should_ignore(&self, line: usize) -> bool {
self.ignore.contains(&Lines::Line(line))
|| self.ignore.contains(&Lines::All)
|| (self.max_line > 0 && self.max_line < line)
}
/// Adds a line to the list of lines to ignore
fn add_to_ignore(&mut self, lines: impl IntoIterator<Item = usize>) {
if !self.ignore.contains(&Lines::All) {
for l in lines {
self.ignore.insert(Lines::Line(l));
if self.cover.contains(&l) {
self.cover.remove(&l);
}
}
}
}
}
impl Function {
fn new(name: &str, span: (usize, usize)) -> Self {
Self {
name: name.to_string(),
start: span.0 as u64,
end: span.1 as u64,
}
}
}
#[derive(Clone, Debug, Default, Eq, PartialEq, Ord, PartialOrd, Deserialize, Serialize)]
pub struct Function {
pub name: String,
pub start: u64,
pub end: u64,
}
#[derive(Default)]
pub struct SourceAnalysis {
pub lines: HashMap<PathBuf, LineAnalysis>,
ignored_modules: Vec<PathBuf>,
}
impl SourceAnalysis {
pub fn new() -> Self {
Default::default()
}
pub fn create_function_map(&self) -> HashMap<PathBuf, Vec<Function>> {
self.lines
.iter()
.map(|(file, analysis)| {
let mut functions: Vec<Function> = analysis
.functions
.iter()
.map(|(function, span)| Function::new(function, *span))
.collect();
functions.sort_unstable_by(|a, b| a.start.cmp(&b.start));
(file.to_path_buf(), functions)
})
.collect()
}
pub fn get_line_analysis(&mut self, path: PathBuf) -> &mut LineAnalysis {
self.lines
.entry(path.clone())
.or_insert_with(|| LineAnalysis::new_from_file(&path).unwrap_or_default())
}
fn is_ignored_module(&self, path: &Path) -> bool {
self.ignored_modules.iter().any(|x| path.starts_with(x))
}
pub fn get_analysis(config: &Config) -> Self {
let mut result = Self::new();
let mut ignored_files: HashSet<PathBuf> = HashSet::new();
let root = config.root();
for e in get_source_walker(config) {
if !ignored_files.contains(e.path()) {
result.analyse_package(e.path(), &root, config, &mut ignored_files);
} else {
let mut analysis = LineAnalysis::new();
analysis.ignore_all();
result.lines.insert(e.path().to_path_buf(), analysis);
ignored_files.remove(e.path());
}
}
for e in &ignored_files {
let mut analysis = LineAnalysis::new();
analysis.ignore_all();
result.lines.insert(e.clone(), analysis);
}
result.debug_printout(config);
result
}
/// Analyses a package of the target crate.
fn analyse_package(
&mut self,
path: &Path,
root: &Path,
config: &Config,
filtered_files: &mut HashSet<PathBuf>,
) {
if let Some(file) = path.to_str() {
let skip_cause_test = !config.include_tests() && path.starts_with(root.join("tests"));
let skip_cause_example = path.starts_with(root.join("examples"))
&& !config.run_types.contains(&RunType::Examples);
if (skip_cause_test || skip_cause_example) || self.is_ignored_module(path) {
let mut analysis = LineAnalysis::new();
analysis.ignore_all();
self.lines.insert(path.to_path_buf(), analysis);
} else {
let file = File::open(file);
if let Ok(mut file) = file {
let mut content = String::new();
let res = file.read_to_string(&mut content);
if let Err(e) = res {
warn!(
"Unable to read file into string, skipping source analysis: {}",
e
);
return;
}
let file = parse_file(&content);
if let Ok(file) = file {
let ctx = Context {
config,
file_contents: &content,
file: path,
ignore_mods: RefCell::new(HashSet::new()),
symbol_stack: RefCell::new(vec![]),
};
if self.check_attr_list(&file.attrs, &ctx) {
self.find_ignorable_lines(&ctx);
self.process_items(&file.items, &ctx);
let mut ignored_files = ctx.ignore_mods.into_inner();
for f in ignored_files.drain() {
if f.is_file() {
filtered_files.insert(f);
} else {
let walker = WalkDir::new(f).into_iter();
for e in walker
.filter_map(std::result::Result::ok)
.filter(is_source_file)
{
filtered_files.insert(e.path().to_path_buf());
}
}
}
maybe_ignore_first_line(path, &mut self.lines);
} else {
// Now we need to ignore not only this file but if it is a lib.rs or
// mod.rs we need to get the others
let bad_module =
match (path.parent(), path.file_name().map(OsStr::to_string_lossy))
{
(Some(p), Some(n)) => {
if n == "lib.rs" || n == "mod.rs" {
Some(p.to_path_buf())
} else {
let ignore = p.join(n.trim_end_matches(".rs"));
if ignore.exists() && ignore.is_dir() {
Some(ignore)
} else {
None
}
}
}
_ => None,
};
// Kill it with fire!`
if let Some(module) = bad_module {
self.lines
.iter_mut()
.filter(|(k, _)| k.starts_with(module.as_path()))
.for_each(|(_, v)| v.ignore_all());
self.ignored_modules.push(module);
}
let analysis = self.get_line_analysis(path.to_path_buf());
analysis.ignore_span(file.span());
}
}
}
}
}
}
/// Finds lines from the raw string which are ignorable.
/// These are often things like close braces, semicolons that may register as
/// false positives.
pub(crate) fn find_ignorable_lines(&mut self, ctx: &Context) {
lazy_static! {
static ref IGNORABLE: Regex =
Regex::new(r"^((\s*//)|([\[\]\{\}\(\)\s;\?,/]*$))").unwrap();
}
let analysis = self.get_line_analysis(ctx.file.to_path_buf());
let lines = ctx
.file_contents
.lines()
.enumerate()
.filter(|&(_, x)| IGNORABLE.is_match(x))
.map(|(i, _)| i + 1);
analysis.add_to_ignore(lines);
let lines = ctx
.file_contents
.lines()
.enumerate()
.filter(|&(_, x)| {
let mut x = x.to_string();
x.retain(|c| !c.is_whitespace());
x == "}else{"
})
.map(|(i, _)| i + 1);
analysis.add_to_ignore(lines);
}
pub(crate) fn visit_generics(&mut self, generics: &Generics, ctx: &Context) {
if let Some(ref wh) = generics.where_clause {
let analysis = self.get_line_analysis(ctx.file.to_path_buf());
analysis.ignore_tokens(wh);
}
}
/// Printout a debug summary of the results of source analysis if debug logging
/// is enabled
#[cfg(not(tarpaulin_include))]
pub fn debug_printout(&self, config: &Config) {
if config.debug {
for (path, analysis) in &self.lines {
trace!(
"Source analysis for {}",
config.strip_base_dir(path).display()
);
let mut lines = Vec::new();
for l in &analysis.ignore {
match l {
Lines::All => {
lines.clear();
trace!("All lines are ignorable");
break;
}
Lines::Line(i) => {
lines.push(i);
}
}
}
if !lines.is_empty() {
lines.sort();
trace!("Ignorable lines: {:?}", lines);
lines.clear();
}
for c in &analysis.cover {
lines.push(c);
}
if !lines.is_empty() {
lines.sort();
trace!("Coverable lines: {:?}", lines);
}
}
}
}
}
/// lib.rs:1 can often show up as a coverable line when it's not. This ignores
/// that line as long as it's not a real source line. This can also affect
/// the main files for binaries in a project as well.
fn maybe_ignore_first_line(file: &Path, result: &mut HashMap<PathBuf, LineAnalysis>) {
if let Ok(f) = File::open(file) {
let read_file = BufReader::new(f);
if let Some(Ok(first)) = read_file.lines().next() {
if !(first.starts_with("pub") || first.starts_with("fn")) {
let file = file.to_path_buf();
let line_analysis = result.entry(file).or_default();
line_analysis.add_to_ignore([1]);
}
}
}
}