workflow 0.3.0

Execute complex workflows using simple definition files.
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::error::Error;
use std::path::{Path, PathBuf};
use std::str::FromStr;
use std::{env, process};

use clap::{App, AppSettings, Arg, SubCommand};
use log::LevelFilter;
use simple_logger::SimpleLogger;

use workflow::{Step, Workflow, WorkflowExecutor};

fn main() {
    let matches = App::new("Workflow")
        .version(clap::crate_version!())
        .author(clap::crate_authors!())
        .about(clap::crate_description!())
        .setting(AppSettings::ArgRequiredElseHelp)
        .arg(
            Arg::with_name("log-level")
                .long("log-level")
                .help("Sets the logging level")
                .default_value("info"),
        )
        .subcommand(
            SubCommand::with_name("execute")
                .alias("exec")
                .alias("e")
                .about("Execute given workflow")
                .arg(
                    Arg::with_name("FILE")
                        .help("Sets the workflow file to use")
                        .required(true),
                ),
        )
        .subcommand(
            SubCommand::with_name("validate")
                .alias("v")
                .about("Validate given workflow")
                .arg(
                    Arg::with_name("FILE")
                        .help("Sets the workflow file to use")
                        .required(true),
                ),
        )
        .subcommand(
            SubCommand::with_name("generate")
                .alias("g")
                .about("Generate workflow file"),
        )
        .get_matches();

    configure_logging(matches.value_of("log-level").unwrap()).expect("unable to configure logging");

    if let Some(args) = matches.subcommand_matches("execute") {
        let file = args.value_of("FILE").unwrap();
        match execute_workflow(file) {
            Ok(_) => {}
            Err(e) => {
                log::error!("{}", e);
                process::exit(1);
            }
        }
    } else if let Some(args) = matches.subcommand_matches("validate") {
        let file = args.value_of("FILE").unwrap();
        match validate_workflow(file) {
            Ok(w) => log::info!("Workflow `{}` is valid", w.id),
            Err(e) => {
                log::error!("{}", e);
                process::exit(1);
            }
        }
    } else if matches.subcommand_matches("generate").is_some() {
        match generate_workflow() {
            Ok(w) => {
                let content = serde_yaml::to_string(&w).unwrap();
                println!("{}", content);
            }
            Err(e) => {
                log::error!("{}", e);
                process::exit(1);
            }
        }
    }
}

/// Execute given workflow
fn execute_workflow<P: AsRef<Path>>(path: P) -> Result<(), Box<dyn Error>> {
    let cwd = env::current_dir()?;
    let path = get_workflow_path(path)?;

    let workflow = Workflow::from_file(path)?;
    let executor = WorkflowExecutor::with_cache(cwd.join("workflows"))?;

    executor.execute(&workflow)
}

/// Validate given workflow
fn validate_workflow<P: AsRef<Path>>(path: P) -> Result<Workflow, Box<dyn Error>> {
    let path = get_workflow_path(path)?;

    Workflow::from_file(path)
}

/// Generate sample workflow file
fn generate_workflow() -> Result<Workflow, Box<dyn Error>> {
    let step = Step {
        name: None,
        uses: None,
        exec: Some("echo Hello, world.".to_string()),
        with: None,
    };

    Ok(Workflow {
        id: "hello-world".to_string(),
        name: Some("Hello world".to_string()),
        author: None,
        description: Some("Simple workflow that print `Hello, world.`".to_string()),
        steps: vec![step],
    })
}

fn get_workflow_path<P: AsRef<Path>>(path: P) -> Result<PathBuf, Box<dyn Error>> {
    let cwd = env::current_dir()?;

    if path.as_ref().starts_with(".") {
        // relative path
        Ok(cwd.join(path))
    } else {
        Ok(path.as_ref().to_path_buf())
    }
}

/// Configure the application logging level
/// this will try to resolve given level into a
/// `LevelFilter` type, falling back to `LevelFilter::Debug`
/// if something goes wrong.
///
/// ```rust
/// configure_logging("info").expect("unable to configure logging")
/// ```
fn configure_logging(level: &str) -> Result<(), Box<dyn Error>> {
    SimpleLogger::new()
        .with_level(LevelFilter::from_str(level).unwrap_or(LevelFilter::Debug))
        .init()
        .map_err(|v| v.into())
}