archimedes_crontab_parser 0.5.0

Crontab parsing package for archimedes, a high performance Rust/PostgreSQL job queue
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

use nom::{
    bytes::complete::take_while,
    character::complete::{self, line_ending, multispace0, space0, space1},
    combinator::opt,
    multi::separated_list0,
    sequence::{delimited, preceded},
    IResult,
};

use crate::{
    nom_crontab_opts::nom_crontab_opts, nom_crontab_payload::nom_crontab_payload,
    nom_crontab_timer::nom_crontab_timer, nom_task_identifier::nom_task_identifier, Crontab,
};

fn crontab_line(input: &str) -> IResult<&str, Option<Crontab>> {
    let (input, timer) = preceded(space0, nom_crontab_timer)(input)?;

    let (input, task_identifier) = preceded(space1, nom_task_identifier)(input)?;
    let (input, options) = opt(preceded(space1, nom_crontab_opts))(input)?;
    let (input, payload) = opt(preceded(space1, nom_crontab_payload))(input)?;

    Ok((
        input,
        Some(Crontab {
            timer,
            task_identifier,
            options: options.unwrap_or_default(),
            payload,
        }),
    ))
}

fn crontab_comment(input: &str) -> IResult<&str, Option<Crontab>> {
    let (input, _) = preceded(
        preceded(space0, complete::char('#')),
        take_while(|c: char| c != '\n' && c != '\r'),
    )(input)?;

    Ok((input, None))
}

pub(crate) fn nom_crontab(input: &str) -> IResult<&str, Vec<Crontab>> {
    let (input, crontabs) = delimited(
        multispace0,
        separated_list0(
            line_ending,
            nom::branch::alt((crontab_comment, crontab_line)),
        ),
        multispace0,
    )(input)?;

    Ok((input, crontabs.into_iter().flatten().collect()))
}

#[cfg(test)]
mod tests {
    use serde_json::json;

    use archimedes_crontab_types::{CrontabFill, CrontabOptions, CrontabTimer, CrontabValue};

    use super::*;

    #[test]
    fn valid_crontab() {
        let input = r#"
            # ┌───────────── UTC minute (0 - 59)
            # │ ┌───────────── UTC hour (0 - 23)
            # │ │ ┌───────────── UTC day of the month (1 - 31)
            # │ │ │ ┌───────────── UTC month (1 - 12)
            # │ │ │ │ ┌───────────── UTC day of the week (0 - 6) (Sunday to Saturday)
            # │ │ │ │ │ ┌───────────── task (identifier) to schedule
            # │ │ │ │ │ │    ┌────────── optional scheduling options
            # │ │ │ │ │ │    │     ┌────── optional payload to merge
            # │ │ │ │ │ │    │     │
            # │ │ │ │ │ │    │     │
            # * * * * * task ?opts {payload}
            30 4 * * 1 send_weekly_email
            30 4,10-15 * * 1 send_weekly_email ?fill=2d&max=10 {onboarding:false}
            0 */4 * * * rollup
        "#;

        assert_eq!(
            Ok((
                "",
                vec![
                    Crontab {
                        timer: CrontabTimer {
                            minutes: vec![CrontabValue::Number(30)],
                            hours: vec![CrontabValue::Number(4)],
                            days: vec![CrontabValue::Any],
                            months: vec![CrontabValue::Any],
                            dows: vec![CrontabValue::Number(1)],
                        },
                        task_identifier: String::from("send_weekly_email"),
                        options: CrontabOptions::default(),
                        payload: None,
                    },
                    Crontab {
                        timer: CrontabTimer {
                            minutes: vec![CrontabValue::Number(30)],
                            hours: vec![CrontabValue::Number(4), CrontabValue::Range(10, 15)],
                            days: vec![CrontabValue::Any],
                            months: vec![CrontabValue::Any],
                            dows: vec![CrontabValue::Number(1)],
                        },
                        task_identifier: String::from("send_weekly_email"),
                        options: CrontabOptions {
                            fill: Some(CrontabFill {
                                s: 0,
                                m: 0,
                                h: 0,
                                d: 2,
                                w: 0,
                            }),
                            max: Some(10),
                            ..Default::default()
                        },
                        payload: Some(json!({ "onboarding": false })),
                    },
                    Crontab {
                        timer: CrontabTimer {
                            minutes: vec![CrontabValue::Number(0)],
                            hours: vec![CrontabValue::Step(4)],
                            days: vec![CrontabValue::Any],
                            months: vec![CrontabValue::Any],
                            dows: vec![CrontabValue::Any],
                        },
                        task_identifier: String::from("rollup"),
                        options: CrontabOptions::default(),
                        payload: None,
                    },
                ]
            )),
            nom_crontab(input)
        );
    }
}