hk 1.44.2

A tool for managing git hooks
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

use crate::Result;
use std::fs;
use std::path::PathBuf;

#[derive(Debug, clap::Args)]
pub struct CheckSymlinks {
    /// Files to check
    #[clap(required = true)]
    pub files: Vec<PathBuf>,
}

impl CheckSymlinks {
    pub async fn run(&self) -> Result<()> {
        let mut found_broken = false;

        for file_path in &self.files {
            if is_broken_symlink(file_path)? {
                println!("{}", file_path.display());
                found_broken = true;
            }
        }

        if found_broken {
            return Err(eyre::eyre!("Broken symlinks found"));
        }

        Ok(())
    }
}

fn is_broken_symlink(path: &PathBuf) -> Result<bool> {
    // Check if path is a symlink
    let metadata = match fs::symlink_metadata(path) {
        Ok(m) => m,
        Err(_) => return Ok(false), // File doesn't exist or can't be accessed
    };

    if !metadata.is_symlink() {
        return Ok(false);
    }

    // If it's a symlink, check if target exists
    // Using fs::metadata (not symlink_metadata) will follow the symlink
    match fs::metadata(path) {
        Ok(_) => Ok(false), // Target exists, symlink is valid
        Err(_) => Ok(true), // Target doesn't exist, symlink is broken
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::fs;
    use tempfile::TempDir;

    #[cfg(unix)]
    use std::os::unix::fs::symlink;

    #[test]
    #[cfg(unix)]
    fn test_valid_symlink() {
        let dir = TempDir::new().unwrap();
        let target = dir.path().join("target.txt");
        let link = dir.path().join("link");

        fs::write(&target, "content").unwrap();
        symlink(&target, &link).unwrap();

        let result = is_broken_symlink(&link).unwrap();
        assert!(!result);
    }

    #[test]
    #[cfg(unix)]
    fn test_broken_symlink() {
        let dir = TempDir::new().unwrap();
        let target = dir.path().join("target.txt");
        let link = dir.path().join("link");

        // Create symlink to non-existent target
        symlink(&target, &link).unwrap();

        let result = is_broken_symlink(&link).unwrap();
        assert!(result);
    }

    #[test]
    fn test_regular_file() {
        let dir = TempDir::new().unwrap();
        let file = dir.path().join("file.txt");
        fs::write(&file, "content").unwrap();

        let result = is_broken_symlink(&file).unwrap();
        assert!(!result);
    }

    #[test]
    fn test_nonexistent_file() {
        let dir = TempDir::new().unwrap();
        let file = dir.path().join("nonexistent");

        let result = is_broken_symlink(&file).unwrap();
        assert!(!result); // Not a broken symlink, just doesn't exist
    }

    #[test]
    #[cfg(unix)]
    fn test_symlink_to_directory() {
        let dir = TempDir::new().unwrap();
        let target_dir = dir.path().join("target_dir");
        let link = dir.path().join("link");

        fs::create_dir(&target_dir).unwrap();
        symlink(&target_dir, &link).unwrap();

        let result = is_broken_symlink(&link).unwrap();
        assert!(!result);
    }

    #[test]
    #[cfg(unix)]
    fn test_broken_symlink_to_directory() {
        let dir = TempDir::new().unwrap();
        let target_dir = dir.path().join("nonexistent_dir");
        let link = dir.path().join("link");

        symlink(&target_dir, &link).unwrap();

        let result = is_broken_symlink(&link).unwrap();
        assert!(result);
    }
}