cuttlefish-core 0.9.0

Cuttlefish.spec parsing and the typed job description
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

use cuttlefish_core::graph::{GraphParser, InputExpr};
use cuttlefish_core::lex::lex;

fn parse_graph(src: &str) -> cuttlefish_core::graph::NodeGraph {
    let tokens = lex(src).unwrap();
    let (graph, consumed) = GraphParser {
        tokens: &tokens,
        at: 0,
    }
    .node_graph()
    .unwrap();
    assert_eq!(
        consumed,
        tokens.len(),
        "should consume every token in these single-value tests"
    );
    graph
}

#[test]
fn a_single_node_with_no_input_parses() {
    let g = parse_graph(r#"{ files = { block = "list-dir@1" }; }"#);
    assert_eq!(g.nodes.len(), 1);
    assert_eq!(
        g.get("files").unwrap().block,
        std::path::PathBuf::from("list-dir@1")
    );
    assert!(g.get("files").unwrap().input.is_none());
}

#[test]
fn from_node_input_parses() {
    let g = parse_graph(
        r#"{ files = { block = "list-dir@1" }; chunk = { block = "chunker@1"; in = files.out; }; }"#,
    );
    assert_eq!(
        g.get("chunk").unwrap().input,
        Some(InputExpr::FromNode("files".into()))
    );
}

#[test]
fn record_fan_in_parses() {
    let g = parse_graph(
        r#"{
          docs = { block = "load-docs@1" };
          images = { block = "load-images@1" };
          report = { block = "report-writer@1"; in = { docs = docs.out; images = images.out }; };
        }"#,
    );
    match g.get("report").unwrap().input.as_ref().unwrap() {
        InputExpr::Record(fields) => {
            assert_eq!(
                fields.get("docs"),
                Some(&InputExpr::FromNode("docs".into()))
            );
            assert_eq!(
                fields.get("images"),
                Some(&InputExpr::FromNode("images".into()))
            );
        }
        other => panic!("expected Record, got {other:?}"),
    }
}

#[test]
fn list_fan_in_parses_in_order() {
    let g = parse_graph(
        r#"{
          a = { block = "a@1" };
          b = { block = "b@1" };
          combined = { block = "merge@1"; in = [a.out, b.out]; };
        }"#,
    );
    assert_eq!(
        g.get("combined").unwrap().input,
        Some(InputExpr::List(vec![
            InputExpr::FromNode("a".into()),
            InputExpr::FromNode("b".into()),
        ]))
    );
}

#[test]
fn repeat_until_without_max_iterations_is_rejected() {
    let tokens =
        lex(r#"{ refine = { block = "refiner@1"; in = draft.out; repeat_until = "done"; }; }"#)
            .unwrap();
    let result = GraphParser {
        tokens: &tokens,
        at: 0,
    }
    .node_graph();
    assert!(result.is_err());
}

#[test]
fn repeat_until_with_max_iterations_parses() {
    let g = parse_graph(
        r#"{ refine = { block = "refiner@1"; in = draft.out; repeat_until = "done"; max_iterations = 5; }; }"#,
    );
    let node = g.get("refine").unwrap();
    assert_eq!(node.repeat_until.as_deref(), Some("done"));
    assert_eq!(node.max_iterations, Some(5));
}

#[test]
fn branches_parse() {
    use cuttlefish_core::graph::Branches;
    let src = r#"{ classify = { "pdf" -> handle_pdf; "scan" -> handle_scan; }; }"#;
    let tokens = lex(src).unwrap();
    let (branches, consumed) = GraphParser {
        tokens: &tokens,
        at: 0,
    }
    .branches()
    .unwrap();
    assert_eq!(consumed, tokens.len());
    assert_eq!(
        branches.decisions,
        vec![(
            "classify".to_string(),
            vec![
                ("pdf".to_string(), "handle_pdf".to_string()),
                ("scan".to_string(), "handle_scan".to_string()),
            ]
        )]
    );
    let _ = Branches::default(); // keep type imported/used if the above changes
}

#[test]
fn a_bare_ident_not_ending_in_dot_out_is_rejected_as_an_input() {
    let tokens = lex(r#"{ chunk = { block = "chunker@1"; in = files; }; }"#).unwrap();
    assert!(GraphParser {
        tokens: &tokens,
        at: 0
    }
    .node_graph()
    .is_err());
}

#[test]
fn an_unknown_node_field_is_rejected_as_unknown_not_malformed() {
    use cuttlefish_core::spec::SpecError;
    let tokens = lex(r#"{ chunk = { block = "chunker@1"; frobnicate = "x"; }; }"#).unwrap();
    let result = GraphParser {
        tokens: &tokens,
        at: 0,
    }
    .node_graph();
    assert!(matches!(result, Err(SpecError::UnknownField(f)) if f == "frobnicate"));
}