git-hook-commit-ref 1.4.1

Git hook to verify that makes sure the commit message contains a reference to the issue.
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

use super::config::Config;
use git2;
use regex::Regex;

#[cfg(test)]
mod tests;

pub fn get_current_branch(repo: &git2::Repository) -> Result<String, String> {
    let current_branch = match repo.head() {
        Ok(cb) => cb,
        Err(_) => return Err(String::from("Unable to get branch name")),
    };

    match current_branch.name() {
        Some(branch) => Ok(String::from(branch)),
        None => Err(String::from("Unable to get branch name")),
    }
}

pub fn get_commit_msg(commit_msg_file: &String) -> String {
    std::fs::read_to_string(commit_msg_file).expect("Unable to read commit file msg")
}

pub fn make_ref(config: Config, branch: String) -> Result<String, String> {
    let re = match Regex::new(config.branch_pattern.as_str()) {
        Ok(r) => r,
        Err(_) => {
            return Err(String::from(
                "Invalid pattern in your git config: please check branchpattern value",
            ));
        }
    };

    let cap = match re.captures(branch.as_str()) {
        Some(c) => c,
        None => {
            return Err(
                String::from(
                    format!(
                        "Wrong branch name, missing organization should be formatted follwing this pattern: {}", 
                        config.branch_pattern
                    )
                )
            );
        }
    };

    match cap.name("org") {
        Some(matched_org) => {
            // check if it's the same as org
            match config.org.clone() {
                Some(org) => {
                    if matched_org.as_str() != org {
                        return Err(
                            String::from(
                               format!(
                                   "Wrong branch name, missing organization should be formatted follwing this pattern: {}", 
                                   config.branch_pattern
                               )
                            )
                        );
                    }
                }
                None => {
                    // all good
                }
            }
        }
        None => {
            // there is no match
            // check if org is required,
            // if it's required, then return an error,
            // otherwise continue
            if config.org.clone() == None {
                // all good
            } else {
                return Err(format!("Branch name is missing the org, please make sure your branch name matches this pattern: {}", config.branch_pattern));
            }
        }
    }

    let issue_number_part = match cap.name("issue_number") {
        Some(part) => String::from(part.as_str()),
        None => {
            return Err(String::from(format!(
                "Wrong branch name, unable to find the issue number, make sure it's formatted: {}",
                config.branch_pattern
            )))
        }
    };

    match issue_number_part.parse::<u16>() {
        Ok(issue_number) => {
            let org = match config.org {
                Some(org) => org,
                None => {
                    return Ok(String::from(format!("{}#{}", config.project, issue_number)));
                }
            };

            Ok(String::from(format!(
                "{}/{}#{}",
                org, config.project, issue_number
            )))
        }

        Err(_) => Err(String::from(
            "Wrong branch name, should be formatted <org>-<issue_number>",
        )),
    }
}

pub fn check_commit_msg(
    config: Config,
    commit_msg: &String,
    branch: String,
) -> Result<String, String> {
    if config.forbidden_branches.contains(&branch) {
        return Err(String::from(
            "Branch name is forbidden, you can't commit here",
        ));
    }

    match make_ref(config, branch) {
        Ok(branch_ref) => {
            if !commit_msg.contains(&branch_ref) {
                Ok(String::from(format!(
                    "{} - {}",
                    commit_msg.trim(),
                    branch_ref
                )))
            } else {
                Ok(String::from(commit_msg))
            }
        }
        Err(e) => Err(e),
    }
}