preamble 0.1.60

First class, scalable rust project generator with batteries included.
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

use std::path::Path;

use anyhow::Result;
use ptree::TreeBuilder;
use tracing::instrument;

/// CI Github Action Workflow String Literal.
pub const CI_YML: &str = include_str!("../etc/workflows/ci.yml");

/// Audit Github Action Workflow String Literal.
pub const AUDIT_YML: &str = include_str!("../etc/workflows/audit.yml");

/// Github Release Github Action Workflow String Literal.
pub const GITHUB_RELEASE_YML: &str = include_str!("../etc/workflows/github-release.yml");

/// Manual Tag Github Action Workflow String Literal.
pub const MANUAL_TAG_YML: &str = include_str!("../etc/workflows/manual-tag.yml");

/// Tag Github Action Workflow String Literal.
pub const TAG_YML: &str = include_str!("../etc/workflows/tag.yml");

/// Release Github Action Workflow String Literal.
pub const RELEASE_YML: &str = include_str!("../etc/workflows/release.yml");

/// Validate Version Github Action Workflow String Literal.
pub const VALIDATE_VERSION_YML: &str = include_str!("../etc/workflows/validate-version.yml");

/// An array of Github Action Workflow String Literals.
pub const WORKFLOWS: [(&str, &str); 7] = [
    ("ci.yml", CI_YML),
    ("audit.yml", AUDIT_YML),
    ("github-release.yml", GITHUB_RELEASE_YML),
    ("manual-tag.yml", MANUAL_TAG_YML),
    ("tag.yml", TAG_YML),
    ("release.yml", RELEASE_YML),
    ("validate-version.yml", VALIDATE_VERSION_YML),
];

/// Copy all [WORKFLOWS] to the project `.github/workflows/` directory.
#[instrument(name = "workflows", skip(dir, dry, tree))]
pub fn write_github_workflows(
    dir: &Path,
    dry: bool,
    tree: &mut Option<&mut TreeBuilder>,
) -> Result<()> {
    tracing::info!("Writing github workflows");
    for (workflow_name, workflow_contents) in WORKFLOWS.iter() {
        let workflow_path_buf = dir.join(workflow_name);
        if !dry {
            tracing::debug!("Writing {:?}", workflow_path_buf);
            std::fs::write(&workflow_path_buf, workflow_contents)?;
        }
        tree.as_deref_mut().map(|t| t.add_empty_child(workflow_name.to_string()));
    }
    Ok(())
}

/// Creates github action ci workflows.
#[instrument(name = "ci", skip(dir, dry, ci, tree))]
pub fn create(
    dir: &Path,
    dry: bool,
    ci: Option<String>,
    mut tree: Option<&mut TreeBuilder>,
) -> Result<()> {
    tracing::info!("Creating ci");

    let workflows_dir = dir.join(".github").join("workflows");
    let ci_yml_path_buf = workflows_dir.join("ci.yml");
    crate::utils::create_dir_gracefully!(&workflows_dir, dry);

    tree.as_deref_mut().map(|t| t.begin_child(".github".to_string()));
    tree.as_deref_mut().map(|t| t.begin_child("workflows".to_string()));

    if ci.is_none() {
        tracing::debug!("Writing {:?}", ci_yml_path_buf);
        write_github_workflows(&workflows_dir, dry, &mut tree)?;
    }
    if !dry && ci.is_some() {
        tracing::debug!("Copying {:?} to {:?}", ci.as_ref().unwrap(), ci_yml_path_buf);
        std::fs::copy(ci.as_ref().unwrap(), ci_yml_path_buf)?;
        tree.as_deref_mut().map(|t| t.add_empty_child(ci.unwrap()));
    }

    tree.as_deref_mut().map(|t| t.end_child()); // <- workflows/
    tree.map(|t| t.end_child()); // <- .github/

    Ok(())
}

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

    #[test]
    fn test_write_github_workflows() {
        let dir = tempdir().unwrap();
        let dir_path_buf = dir.path().to_path_buf();
        write_github_workflows(&dir_path_buf, false, &mut None).unwrap();
        for (workflow_name, workflow_contents) in WORKFLOWS.iter() {
            let workflow_path_buf = dir_path_buf.join(workflow_name);
            assert!(workflow_path_buf.exists());
            let workflow_contents_string = std::fs::read_to_string(&workflow_path_buf).unwrap();
            assert_eq!(workflow_contents_string, *workflow_contents);
        }
    }

    #[test]
    fn test_create() {
        let dir = tempdir().unwrap();
        let dir_path_buf = dir.path().to_path_buf();
        create(&dir_path_buf, false, None, None).unwrap();
        let workflows_dir = dir_path_buf.join(".github").join("workflows");
        assert!(workflows_dir.exists());
        let ci_yml_path_buf = workflows_dir.join("ci.yml");
        assert!(ci_yml_path_buf.exists());
        let ci_yml_contents = std::fs::read_to_string(&ci_yml_path_buf).unwrap();
        assert_eq!(ci_yml_contents, CI_YML);
    }
}