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

use chumsky::prelude::*;

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

use super::ParserInput;
use super::ast::AstStartDecl;
use super::ident::ident_aliased_effect_shell;
use super::overlay::overlay;
use super::ws::newline;
use super::ws::ws;

// ─── L5: Start Combinator ──────────────────────────────────

/// `start Effect [as alias] [{ overlay }]` — start declaration.
pub fn start_decl<'a>()
-> impl Parser<'a, ParserInput<'a>, Spanned<AstStartDecl>, extra::Err<Rich<'a, Token<'a>>>> + Clone
{
    just(Token::Start)
        .ignore_then(ws())
        .ignore_then(ident_aliased_effect_shell())
        .then(ws().ignore_then(overlay()).or_not())
        .map_with(|(aliased, overlay), e| {
            let span = Span::from(e.span());
            Spanned::new(
                AstStartDecl {
                    effect: aliased.name,
                    alias: aliased.alias,
                    overlay: overlay.unwrap_or_default(),
                    span,
                },
                span,
            )
        })
        .then_ignore(newline())
        .labelled("start declaration")
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::dsl::parser::lex_to_pairs;
    use crate::dsl::parser::make_input;

    fn parse_start(source: &str) -> AstStartDecl {
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        start_decl().parse(input).into_result().unwrap().node
    }

    #[test]
    fn bare_start() {
        let n = parse_start("start Db\n");
        assert_eq!(n.effect.node.name, "Db");
        assert!(n.alias.is_none());
        assert!(n.overlay.is_empty());
    }

    #[test]
    fn start_with_alias() {
        let n = parse_start("start Db as db\n");
        assert_eq!(n.effect.node.name, "Db");
        assert_eq!(n.alias.as_ref().unwrap().node.name, "db");
        assert!(n.overlay.is_empty());
    }

    #[test]
    fn start_with_overlay() {
        let n = parse_start("start Db { PORT = \"5433\" }\n");
        assert_eq!(n.effect.node.name, "Db");
        assert!(n.alias.is_none());
        assert_eq!(n.overlay.len(), 1);
        assert_eq!(n.overlay[0].node.key.node.name, "PORT");
    }

    #[test]
    fn start_with_alias_and_overlay() {
        let n = parse_start("start Db as db { PORT = \"5433\" }\n");
        assert_eq!(n.effect.node.name, "Db");
        assert_eq!(n.alias.as_ref().unwrap().node.name, "db");
        assert_eq!(n.overlay.len(), 1);
    }

    #[test]
    fn start_with_trailing_comma_overlay() {
        let n = parse_start("start Db as db { PORT = \"5433\", HOST = \"localhost\", }\n");
        assert_eq!(n.overlay.len(), 2);
    }

    #[test]
    fn start_rejects_snake_case_effect() {
        let source = "start my_db\n";
        let pairs = lex_to_pairs(source);
        let input = make_input(&pairs, source.len());
        assert!(start_decl().parse(input).into_result().is_err());
    }

    #[test]
    fn start_with_multiline_overlay() {
        let n = parse_start(
            r#"start Db {
  PORT = "5433"
  HOST = "localhost"
}
"#,
        );
        assert_eq!(n.effect.node.name, "Db");
        assert_eq!(n.overlay.len(), 2);
    }

    #[test]
    fn start_alias_with_digit() {
        let n = parse_start("start Db as db2\n");
        assert_eq!(n.effect.node.name, "Db");
        assert_eq!(n.alias.as_ref().unwrap().node.name, "db2");
    }

    #[test]
    fn start_with_shorthand_overlay() {
        let n = parse_start(
            r#"start Node as n1 {
  NODE_PORT
  NODE_NAME = "node1"
}
"#,
        );
        assert_eq!(n.effect.node.name, "Node");
        assert_eq!(n.alias.as_ref().unwrap().node.name, "n1");
        assert_eq!(n.overlay.len(), 2);
        // First entry is shorthand: NODE_PORT desugared to NODE_PORT = NODE_PORT
        assert_eq!(n.overlay[0].node.key.node.name, "NODE_PORT");
        assert!(matches!(
            n.overlay[0].node.value.node,
            crate::dsl::parser::ast::AstExpr::Var { .. }
        ));
    }
}