relux 0.3.0

Expect-style integration test framework for interactive shell programs
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206

use chumsky::prelude::*;

use crate::Span;
use crate::Spanned;
use crate::dsl::lexer::Token;

use super::ParserInput;
use super::ast::AstTimeout;
use super::timeout::timeout;

// ─── L2: Untimed Operators ──────────────────────────────────

/// `>` — send
pub fn op_send<'a>()
-> impl Parser<'a, ParserInput<'a>, SimpleSpan, extra::Err<Rich<'a, Token<'a>>>> + Clone {
    just(Token::Gt)
        .map_with(|_, e| e.span())
        .labelled("send operator (>)")
}

/// `=>` — send raw
pub fn op_send_raw<'a>()
-> impl Parser<'a, ParserInput<'a>, SimpleSpan, extra::Err<Rich<'a, Token<'a>>>> + Clone {
    just(Token::Eq)
        .map_with(|_, e| e.span())
        .then(just(Token::Gt).map_with(|_, e| e.span()))
        .map(|(a, b): (SimpleSpan, SimpleSpan)| SimpleSpan::from(a.start..b.end))
        .labelled("send raw operator (=>)")
}

/// `<?` — match regex
pub fn op_match_regex<'a>()
-> impl Parser<'a, ParserInput<'a>, SimpleSpan, extra::Err<Rich<'a, Token<'a>>>> + Clone {
    just(Token::Lt)
        .map_with(|_, e| e.span())
        .then(just(Token::Question).map_with(|_, e| e.span()))
        .map(|(a, b): (SimpleSpan, SimpleSpan)| SimpleSpan::from(a.start..b.end))
        .labelled("match regex operator (<?)")
}

/// `<=` — match literal
pub fn op_match_literal<'a>()
-> impl Parser<'a, ParserInput<'a>, SimpleSpan, extra::Err<Rich<'a, Token<'a>>>> + Clone {
    just(Token::Lt)
        .map_with(|_, e| e.span())
        .then(just(Token::Eq).map_with(|_, e| e.span()))
        .map(|(a, b): (SimpleSpan, SimpleSpan)| SimpleSpan::from(a.start..b.end))
        .labelled("match literal operator (<=)")
}

/// `!?` — fail regex
pub fn op_fail_regex<'a>()
-> impl Parser<'a, ParserInput<'a>, SimpleSpan, extra::Err<Rich<'a, Token<'a>>>> + Clone {
    just(Token::Bang)
        .map_with(|_, e| e.span())
        .then(just(Token::Question).map_with(|_, e| e.span()))
        .map(|(a, b): (SimpleSpan, SimpleSpan)| SimpleSpan::from(a.start..b.end))
        .labelled("fail regex operator (!?)")
}

/// `!=` — fail literal
pub fn op_fail_literal<'a>()
-> impl Parser<'a, ParserInput<'a>, SimpleSpan, extra::Err<Rich<'a, Token<'a>>>> + Clone {
    just(Token::Bang)
        .map_with(|_, e| e.span())
        .then(just(Token::Eq).map_with(|_, e| e.span()))
        .map(|(a, b): (SimpleSpan, SimpleSpan)| SimpleSpan::from(a.start..b.end))
        .labelled("fail literal operator (!=)")
}

// ─── L3: Timed Operators ────────────────────────────────────

/// `<~5s=` or `<@2s=` — timed match literal
pub fn op_timed_match_literal<'a>()
-> impl Parser<'a, ParserInput<'a>, Spanned<AstTimeout>, extra::Err<Rich<'a, Token<'a>>>> + Clone {
    just(Token::Lt)
        .map_with(|_, e| e.span())
        .then(timeout())
        .then(just(Token::Eq).map_with(|_, e| e.span()))
        .map(|((lt_span, t), eq_span)| {
            let full_span = Span::new(lt_span.start, eq_span.end);
            Spanned::new(t.node, full_span)
        })
        .labelled("timed match literal operator (<~Ns= or <@Ns=)")
}

/// `<~5s?` or `<@2s?` — timed match regex
pub fn op_timed_match_regex<'a>()
-> impl Parser<'a, ParserInput<'a>, Spanned<AstTimeout>, extra::Err<Rich<'a, Token<'a>>>> + Clone {
    just(Token::Lt)
        .map_with(|_, e| e.span())
        .then(timeout())
        .then(just(Token::Question).map_with(|_, e| e.span()))
        .map(|((lt_span, t), q_span)| {
            let full_span = Span::new(lt_span.start, q_span.end);
            Spanned::new(t.node, full_span)
        })
        .labelled("timed match regex operator (<~Ns? or <@Ns?)")
}

#[cfg(test)]
mod tests {
    use std::time::Duration;

    use super::*;
    use crate::dsl::parser::lex_to_pairs;
    use crate::dsl::parser::make_input;

    #[test]
    fn send_operator() {
        let source = ">";
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        assert!(op_send().parse(input).into_result().is_ok());
    }

    #[test]
    fn send_raw_operator() {
        let source = "=>";
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        assert!(op_send_raw().parse(input).into_result().is_ok());
    }

    #[test]
    fn match_regex_operator() {
        let source = "<?";
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        assert!(op_match_regex().parse(input).into_result().is_ok());
    }

    #[test]
    fn match_literal_operator() {
        let source = "<=";
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        assert!(op_match_literal().parse(input).into_result().is_ok());
    }

    #[test]
    fn fail_regex_operator() {
        let source = "!?";
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        assert!(op_fail_regex().parse(input).into_result().is_ok());
    }

    #[test]
    fn fail_literal_operator() {
        let source = "!=";
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        assert!(op_fail_literal().parse(input).into_result().is_ok());
    }

    #[test]
    fn timed_match_regex() {
        let source = "<~5s?";
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        let result = op_timed_match_regex().parse(input).into_result();
        assert!(result.is_ok());
        let t = result.unwrap();
        assert!(matches!(t.node, AstTimeout::Tolerance { .. }));
        assert_eq!(t.node.duration(), Duration::from_secs(5));
        assert_eq!(t.span, Span::new(0, 5));
    }

    #[test]
    fn send_raw_rejects_single_eq() {
        let source = "=";
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        assert!(op_send_raw().parse(input).into_result().is_err());
    }

    #[test]
    fn match_regex_rejects_single_lt() {
        let source = "<";
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        assert!(op_match_regex().parse(input).into_result().is_err());
    }

    #[test]
    fn fail_regex_rejects_single_bang() {
        let source = "!";
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        assert!(op_fail_regex().parse(input).into_result().is_err());
    }

    #[test]
    fn timed_match_literal() {
        let source = "<@2s=";
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        let result = op_timed_match_literal().parse(input).into_result();
        assert!(result.is_ok());
        let t = result.unwrap();
        assert!(matches!(t.node, AstTimeout::Assertion { .. }));
        assert_eq!(t.node.duration(), Duration::from_secs(2));
        assert_eq!(t.span, Span::new(0, 5));
    }
}