bugreport 0.6.0

Collect system and environment information for bug reports
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

use std::fmt::Write;
use std::fs::{self, DirEntry};
use std::io::ErrorKind;
use std::path::{Path, PathBuf};

use crate::{Collector, CrateInfo, Result, report::ReportEntry};

use super::CollectionError;

/// List information about entries in a directory.
///
/// Limitations:
/// * Is not recursive
/// * Does not handle symbolic links
/// * Only sizes of files are printed and not e.g. time of last modification
///
/// # Example
///
/// ```md
/// #### File and dir
///
/// - file.txt, 14 bytes
/// - some_dir/
///
/// ```
pub struct DirectoryEntries {
    title: String,
    path: PathBuf,
}

impl DirectoryEntries {
    pub fn new<P: AsRef<Path>>(title: &str, path: P) -> Self {
        Self {
            title: title.into(),
            path: path.as_ref().to_path_buf(),
        }
    }
}

impl Collector for DirectoryEntries {
    fn description(&self) -> &str {
        &self.title
    }

    fn collect(&mut self, _: &CrateInfo) -> Result<ReportEntry> {
        let path_str = &self.path.to_string_lossy();

        let mut entries = fs::read_dir(&self.path)
            .map_err(|e| read_dir_error_to_report_entry(e, path_str))?
            .map(|e| match e {
                Ok(dir_entry) => dir_entry_to_report_entry(dir_entry),
                Err(e) => format!("Error: {}", e),
            })
            .collect::<Vec<_>>();

        // For stable ordering
        entries.sort();

        if entries.is_empty() {
            Ok(ReportEntry::Text(format!("'{}' is empty", path_str)))
        } else {
            Ok(ReportEntry::List(
                entries.into_iter().map(ReportEntry::Text).collect(),
            ))
        }
    }
}

fn read_dir_error_to_report_entry(error: std::io::Error, path_str: &str) -> CollectionError {
    CollectionError::CouldNotRetrieve(if error.kind() == ErrorKind::NotFound {
        format!("'{}' not found", path_str)
    } else {
        format!("'{}' not read: {}", path_str, error)
    })
}

fn dir_entry_to_report_entry(dir_entry: DirEntry) -> String {
    let mut text = String::new();

    text.push_str(&dir_entry.file_name().to_string_lossy());

    if let Ok(metadata) = dir_entry.metadata() {
        if metadata.is_file() {
            let _ = write!(text, ", {} bytes", metadata.len());
        } else if metadata.is_dir() {
            text.push(std::path::MAIN_SEPARATOR);
        }
    }

    text
}