envision 0.16.0

A ratatui framework for collaborative TUI development with headless testing support
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

use super::*;
use crate::component::context::RenderContext;
use crate::component::test_utils;

#[test]
fn test_snapshot_empty() {
    let state = DiagramState::new();
    let (mut terminal, theme) = test_utils::setup_render(60, 10);
    terminal
        .draw(|frame| {
            Diagram::view(&state, &mut RenderContext::new(frame, frame.area(), &theme));
        })
        .unwrap();
    insta::assert_snapshot!(terminal.backend().to_string());
}

#[test]
fn test_snapshot_single_node() {
    let state = DiagramState::new()
        .with_node(DiagramNode::new("api", "API Gateway").with_status(NodeStatus::Healthy))
        .with_title("Service Graph");
    let (mut terminal, theme) = test_utils::setup_render(60, 10);
    terminal
        .draw(|frame| {
            Diagram::view(&state, &mut RenderContext::new(frame, frame.area(), &theme));
        })
        .unwrap();
    insta::assert_snapshot!(terminal.backend().to_string());
}

#[test]
fn test_snapshot_linear_graph() {
    let state = DiagramState::new()
        .with_node(DiagramNode::new("api", "API").with_status(NodeStatus::Healthy))
        .with_node(DiagramNode::new("db", "Database").with_status(NodeStatus::Degraded))
        .with_edge(DiagramEdge::new("api", "db"))
        .with_title("Linear");
    let (mut terminal, theme) = test_utils::setup_render(80, 12);
    terminal
        .draw(|frame| {
            Diagram::view(&state, &mut RenderContext::new(frame, frame.area(), &theme));
        })
        .unwrap();
    insta::assert_snapshot!(terminal.backend().to_string());
}

#[test]
fn test_snapshot_diamond() {
    let state = DiagramState::new()
        .with_node(DiagramNode::new("a", "Source").with_status(NodeStatus::Healthy))
        .with_node(DiagramNode::new("b", "Left").with_status(NodeStatus::Healthy))
        .with_node(DiagramNode::new("c", "Right").with_status(NodeStatus::Degraded))
        .with_node(DiagramNode::new("d", "Sink").with_status(NodeStatus::Down))
        .with_edge(DiagramEdge::new("a", "b"))
        .with_edge(DiagramEdge::new("a", "c"))
        .with_edge(DiagramEdge::new("b", "d"))
        .with_edge(DiagramEdge::new("c", "d"))
        .with_title("Diamond");
    let (mut terminal, theme) = test_utils::setup_render(80, 16);
    terminal
        .draw(|frame| {
            Diagram::view(&state, &mut RenderContext::new(frame, frame.area(), &theme));
        })
        .unwrap();
    insta::assert_snapshot!(terminal.backend().to_string());
}

#[test]
fn test_snapshot_with_selection() {
    let mut state = DiagramState::new()
        .with_node(DiagramNode::new("api", "API").with_status(NodeStatus::Healthy))
        .with_node(DiagramNode::new("db", "DB").with_status(NodeStatus::Healthy))
        .with_edge(DiagramEdge::new("api", "db"));
    state.select_next(); // Select first node

    let (mut terminal, theme) = test_utils::setup_render(60, 10);
    terminal
        .draw(|frame| {
            let mut ctx = RenderContext::new(frame, frame.area(), &theme);
            ctx.focused = true;
            Diagram::view(&state, &mut ctx);
        })
        .unwrap();
    insta::assert_snapshot!(terminal.backend().to_string());
}

#[test]
fn test_snapshot_with_statuses() {
    let state = DiagramState::new()
        .with_node(DiagramNode::new("a", "Healthy").with_status(NodeStatus::Healthy))
        .with_node(DiagramNode::new("b", "Degraded").with_status(NodeStatus::Degraded))
        .with_node(DiagramNode::new("c", "Down").with_status(NodeStatus::Down))
        .with_node(DiagramNode::new("d", "Unknown").with_status(NodeStatus::Unknown))
        .with_edge(DiagramEdge::new("a", "b"))
        .with_edge(DiagramEdge::new("b", "c"))
        .with_edge(DiagramEdge::new("c", "d"));
    let (mut terminal, theme) = test_utils::setup_render(80, 12);
    terminal
        .draw(|frame| {
            Diagram::view(&state, &mut RenderContext::new(frame, frame.area(), &theme));
        })
        .unwrap();
    insta::assert_snapshot!(terminal.backend().to_string());
}

#[test]
fn test_snapshot_top_to_bottom() {
    let state = DiagramState::new()
        .with_node(DiagramNode::new("a", "Top").with_status(NodeStatus::Healthy))
        .with_node(DiagramNode::new("b", "Bottom").with_status(NodeStatus::Healthy))
        .with_edge(DiagramEdge::new("a", "b"))
        .with_orientation(Orientation::TopToBottom)
        .with_title("Vertical");
    let (mut terminal, theme) = test_utils::setup_render(40, 16);
    terminal
        .draw(|frame| {
            Diagram::view(&state, &mut RenderContext::new(frame, frame.area(), &theme));
        })
        .unwrap();
    insta::assert_snapshot!(terminal.backend().to_string());
}

#[test]
fn test_snapshot_edge_styles() {
    let state = DiagramState::new()
        .with_node(DiagramNode::new("a", "A").with_status(NodeStatus::Healthy))
        .with_node(DiagramNode::new("b", "B").with_status(NodeStatus::Healthy))
        .with_node(DiagramNode::new("c", "C").with_status(NodeStatus::Healthy))
        .with_edge(DiagramEdge::new("a", "b").with_style(EdgeStyle::Dashed))
        .with_edge(DiagramEdge::new("a", "c").with_style(EdgeStyle::Dotted))
        .with_show_edge_labels(true);
    let (mut terminal, theme) = test_utils::setup_render(80, 12);
    terminal
        .draw(|frame| {
            Diagram::view(&state, &mut RenderContext::new(frame, frame.area(), &theme));
        })
        .unwrap();
    insta::assert_snapshot!(terminal.backend().to_string());
}

#[test]
fn test_snapshot_rounded_nodes() {
    let state = DiagramState::new()
        .with_node(
            DiagramNode::new("api", "API Gateway")
                .with_status(NodeStatus::Healthy)
                .with_shape(NodeShape::RoundedRectangle),
        )
        .with_node(
            DiagramNode::new("db", "Database")
                .with_status(NodeStatus::Healthy)
                .with_shape(NodeShape::RoundedRectangle),
        )
        .with_edge(DiagramEdge::new("api", "db"));
    let (mut terminal, theme) = test_utils::setup_render(60, 10);
    terminal
        .draw(|frame| {
            Diagram::view(&state, &mut RenderContext::new(frame, frame.area(), &theme));
        })
        .unwrap();
    insta::assert_snapshot!(terminal.backend().to_string());
}