flowcrafter 0.3.0

Create and manage workflows for GitHub Actions
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
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

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

use anyhow::{anyhow, Error};
#[cfg(test)]
use tempfile::{tempdir, TempDir};

#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
pub struct Project {
    path: PathBuf,
}

impl Project {
    pub fn at(path: PathBuf) -> Result<Self, Error> {
        let git_directory = path.join(".git");

        if !git_directory.exists() {
            return Err(anyhow!("flowcrafter must be run inside a Git repository"));
        }

        Ok(Self { path })
    }

    pub fn find(path: PathBuf) -> Result<Self, Error> {
        let mut current_directory = path;

        loop {
            match Project::at(current_directory.clone()) {
                Ok(project) => return Ok(project),
                Err(error) => {
                    if !current_directory.pop() {
                        return Err(error);
                    }
                }
            }
        }
    }

    pub fn path(&self) -> &Path {
        self.path.as_path()
    }
}

#[cfg(test)]
#[derive(Debug)]
pub struct TestProject {
    temp_dir: TempDir,
    project: Project,
}

#[cfg(test)]
impl TestProject {
    pub fn new() -> Result<Self, Error> {
        // Create project directory
        let temp_dir = tempdir().unwrap();

        // Create .git directory
        let git_dir = temp_dir.path().join(".git");
        std::fs::create_dir(git_dir).unwrap();

        let project = Project::at(temp_dir.path().to_path_buf())?;

        Ok(Self { temp_dir, project })
    }

    pub fn path(&self) -> &Path {
        self.temp_dir.path()
    }

    pub fn project(&self) -> &Project {
        &self.project
    }
}

#[cfg(test)]
mod tests {
    use tempfile::tempdir;

    use super::*;

    #[test]
    fn at() {
        let test_project = TestProject::new().unwrap();

        let project = Project::at(test_project.path().to_path_buf());

        assert!(project.is_ok());
    }

    #[test]
    fn at_returns_error_outside_git_repository() {
        // Create project directory
        let temp_dir = tempdir().unwrap();

        let error = Project::at(temp_dir.path().to_path_buf()).unwrap_err();

        assert_eq!(
            "flowcrafter must be run inside a Git repository",
            error.to_string()
        );
    }

    #[test]
    fn find() {
        let test_project = TestProject::new().unwrap();

        // Create a subdirectory
        let sub_dir = test_project.path().join("sub");
        std::fs::create_dir(sub_dir.clone()).unwrap();

        let project = Project::find(sub_dir);

        assert!(project.is_ok());
    }

    #[test]
    fn find_returns_error_outside_git_repository() {
        // Create project directory
        let temp_dir = tempdir().unwrap();

        // Create a subdirectory
        let sub_dir = temp_dir.path().join("sub");
        std::fs::create_dir(sub_dir.clone()).unwrap();

        let project = Project::find(sub_dir);

        assert!(project.is_err());
    }

    #[test]
    fn trait_send() {
        fn assert_send<T: Send>() {}
        assert_send::<Project>();
    }

    #[test]
    fn trait_sync() {
        fn assert_sync<T: Sync>() {}
        assert_sync::<Project>();
    }

    #[test]
    fn trait_unpin() {
        fn assert_unpin<T: Unpin>() {}
        assert_unpin::<Project>();
    }
}