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

use crate::core::table::FileId;
use crate::diagnostics::IrSpan;
use crate::diagnostics::LoweringBail;
use crate::dsl::parser::ast::AstCleanupBlock;
use crate::dsl::parser::ast::AstShellBlock;

use super::IrNode;
use super::IrNodeLowering;
use super::LoweringContext;
use super::ident::IrIdent;
use super::stmt::IrShellStmt;

#[derive(Debug, Clone)]
pub struct IrShellBlock {
    qualifier: Option<IrIdent>,
    name: IrIdent,
    body: Vec<IrShellStmt>,
    span: IrSpan,
}

impl IrShellBlock {
    pub fn new(
        qualifier: Option<IrIdent>,
        name: IrIdent,
        body: Vec<IrShellStmt>,
        span: IrSpan,
    ) -> Self {
        Self {
            qualifier,
            name,
            body,
            span,
        }
    }

    pub fn qualifier(&self) -> Option<&IrIdent> {
        self.qualifier.as_ref()
    }

    pub fn name(&self) -> &IrIdent {
        &self.name
    }

    pub fn body(&self) -> &[IrShellStmt] {
        &self.body
    }
}

impl_ir_node_struct!(IrShellBlock);

#[derive(Debug, Clone)]
pub struct IrCleanupBlock {
    body: Vec<IrShellStmt>,
    span: IrSpan,
}

impl IrCleanupBlock {
    pub fn new(body: Vec<IrShellStmt>, span: IrSpan) -> Self {
        Self { body, span }
    }

    pub fn body(&self) -> &[IrShellStmt] {
        &self.body
    }
}

impl_ir_node_struct!(IrCleanupBlock);

impl IrNodeLowering for IrShellBlock {
    type Ast = AstShellBlock;
    fn lower(
        ast: &AstShellBlock,
        file: &FileId,
        ctx: &mut LoweringContext,
    ) -> Result<Self, LoweringBail> {
        let qualifier = ast
            .qualifier
            .as_ref()
            .map(|q| IrIdent::lower(&q.node, file, ctx))
            .transpose()?;
        let name = IrIdent::lower(&ast.name.node, file, ctx)?;
        let body = ast
            .stmts
            .iter()
            .map(|s| IrShellStmt::lower(&s.node, file, ctx))
            .collect::<Result<Vec<_>, _>>()?;
        Ok(IrShellBlock::new(
            qualifier,
            name,
            body,
            IrSpan::new(file.clone(), ast.span),
        ))
    }
}

impl IrNodeLowering for IrCleanupBlock {
    type Ast = AstCleanupBlock;
    fn lower(
        ast: &AstCleanupBlock,
        file: &FileId,
        ctx: &mut LoweringContext,
    ) -> Result<Self, LoweringBail> {
        let body = ast
            .stmts
            .iter()
            .map(|s| IrShellStmt::lower(&s.node, file, ctx))
            .collect::<Result<Vec<_>, _>>()?;
        Ok(IrCleanupBlock::new(
            body,
            IrSpan::new(file.clone(), ast.span),
        ))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::core::table::FileId;
    use std::path::PathBuf;

    fn test_file_id() -> FileId {
        FileId::new(PathBuf::from("test.relux"))
    }

    fn test_span() -> IrSpan {
        IrSpan::new(test_file_id(), crate::Span::new(0, 10))
    }

    fn test_ident(name: &str) -> IrIdent {
        IrIdent::new(name, test_span())
    }

    #[test]
    fn ir_shell_block() {
        let s = test_span();
        let block = IrShellBlock::new(
            None,
            test_ident("sh"),
            vec![IrShellStmt::BufferReset { span: s.clone() }],
            s,
        );
        assert_eq!(block.name().name(), "sh");
        assert_eq!(block.body().len(), 1);
    }

    #[test]
    fn ir_shell_block_empty_body() {
        let block = IrShellBlock::new(None, test_ident("sh"), vec![], test_span());
        assert!(block.body().is_empty());
    }

    #[test]
    fn ir_cleanup_block() {
        let s = test_span();
        let block = IrCleanupBlock::new(vec![IrShellStmt::BufferReset { span: s.clone() }], s);
        assert_eq!(block.body().len(), 1);
    }

    #[test]
    fn ir_cleanup_block_empty_body() {
        let block = IrCleanupBlock::new(vec![], test_span());
        assert!(block.body().is_empty());
    }
}