godlint-cli 0.3.0

Command-line interface for Godlint.
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

use std::path::{Path, PathBuf};

use godlint_core::{
    config::Config,
    paths,
    scan::{ScanReport, scan},
};

const CONFIG_NAME: &str = "godlint.yaml";

pub struct Workspace {
    pub config: Config,
    root: PathBuf,
    scan_paths: Vec<PathBuf>,
}

impl Workspace {
    pub fn prepare(paths: &[String]) -> Result<Self, String> {
        let located = Located::new(paths)?;
        let config = Config::load(located.root.join(CONFIG_NAME))
            .map_err(|error| format!("Configuration is invalid: {error}"))?;

        Ok(Self {
            config,
            root: located.root,
            scan_paths: located.scan_paths,
        })
    }

    pub fn scan(&self) -> Result<ScanReport, String> {
        scan(&self.root, &self.scan_paths, &self.config.excludes())
            .map_err(|error| format!("Unable to scan source files: {error}"))
    }
}

struct Located {
    root: PathBuf,
    scan_paths: Vec<PathBuf>,
}

impl Located {
    fn new(paths: &[String]) -> Result<Self, String> {
        let current_directory = std::env::current_dir()
            .map_err(|error| format!("Unable to determine the scan root: {error}"))?;
        let requested = requested_paths(paths, &current_directory)?;
        let root = config_root(&requested)?;

        Ok(Self {
            scan_paths: scan_paths(&requested, &root)?,
            root,
        })
    }
}

fn requested_paths(arguments: &[String], current_directory: &Path) -> Result<Vec<PathBuf>, String> {
    if arguments.is_empty() {
        return Ok(vec![current_directory.to_path_buf()]);
    }

    arguments
        .iter()
        .map(|argument| requested_path(current_directory, Path::new(argument)))
        .collect()
}

fn requested_path(current_directory: &Path, path: &Path) -> Result<PathBuf, String> {
    let absolute = if path.is_absolute() {
        path.to_path_buf()
    } else {
        current_directory.join(path)
    };

    paths::normalize(&absolute).ok_or_else(|| {
        format!(
            "Invalid scan path: {} escapes the filesystem root",
            path.display()
        )
    })
}

fn config_root(requested: &[PathBuf]) -> Result<PathBuf, String> {
    let path = requested
        .first()
        .ok_or_else(|| "Invalid scan path: no scan paths were provided".to_owned())?;
    let directory = if path.is_file() {
        path.parent().unwrap_or(path)
    } else {
        path.as_path()
    };

    paths::find_upward(directory, CONFIG_NAME).ok_or_else(|| {
        format!(
            "No {CONFIG_NAME} found in {} or any parent directory within the repository.",
            directory.display()
        )
    })
}

fn scan_paths(requested: &[PathBuf], root: &Path) -> Result<Vec<PathBuf>, String> {
    if paths::is_symlink(root) {
        return Err(format!(
            "Invalid scan path: {} is a symbolic link",
            root.display()
        ));
    }

    requested.iter().map(|path| scan_path(root, path)).collect()
}

fn scan_path(root: &Path, path: &Path) -> Result<PathBuf, String> {
    if path.strip_prefix(root).is_err() {
        return Err(format!(
            "Invalid scan path: {} is outside {}",
            path.display(),
            root.display()
        ));
    }

    if paths::contains_symlink(root, path) {
        return Err(format!(
            "Invalid scan path: {} contains a symbolic link",
            path.display()
        ));
    }

    Ok(path.to_path_buf())
}