integra8_tree_formatter 0.0.5-rc1

Tree structured output formatters for displaying test results for the Integra8 test framework. 
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

use indexmap::IndexMap;
use indicatif::{ProgressBar, ProgressStyle};
use std::io::Write;

use crate::styles::ProgressBarStyle;

use integra8::formatters::models::report::ComponentRunReport;
use integra8::formatters::models::summary::{ComponentTypeCountSummary, RunSummary};
use integra8::formatters::models::{ComponentDescription, ComponentId, ComponentType};

pub struct TestProgressFormatter {
    progress: ProgressBar,
    style: ProgressBarStyle,
    in_progress: IndexMap<ComponentId, String>, // Use index map to ensure newest item is always shown first
}

impl TestProgressFormatter {
    pub fn new(style: ProgressBarStyle) -> Self {
        let progress = ProgressBar::new(0);
        progress.set_style(
            ProgressStyle::default_spinner()
                .template(&style.template)
                .with_key("len", |state| format!("{}", (state.len + 1) / 2))
                .with_key("pos", |state| format!("{}", (state.pos + 1) / 2))
                .progress_chars(&style.progress_chars),
        );

        Self {
            progress,
            style,
            in_progress: IndexMap::new(),
        }
    }

    pub fn notify_run_start<W: Write>(
        &mut self,
        writer: &mut W,
        summary: &ComponentTypeCountSummary,
    ) -> std::io::Result<()> {
        let noun = if summary.tests() != 1 {
            "components"
        } else {
            "component"
        };

        let total_component_count = summary.tests() + summary.setups() + summary.tear_downs();
        self.writeln(
            writer,
            &format!("\nrunning {} {}\n", total_component_count, noun),
        )?;
        self.progress.set_length((total_component_count * 2) as u64);
        Ok(())
    }

    pub fn notify_run_finished<W: Write>(
        &mut self,
        writer: &mut W,
        _state: &RunSummary,
    ) -> std::io::Result<()> {
        self.writeln(writer, self.style.finished.clone())?;
        if !self.progress.is_hidden() {
            self.progress.finish_and_clear();
        }

        Ok(())
    }

    pub fn notify_component_start<W: Write>(
        &mut self,
        writer: &mut W,
        desc: &ComponentDescription,
    ) -> std::io::Result<()> {
        if desc.component_type() == &ComponentType::Suite {
            return Ok(());
        }

        self.writeln(
            writer,
            &format!("{} {}", self.style.running, desc.full_name()),
        )?;
        if !self.progress.is_hidden() {
            self.add_in_progress(desc.id(), desc.friendly_name());
        }
        Ok(())
    }

    pub fn notify_component_finished<W: Write>(
        &mut self,
        writer: &mut W,
        report: &ComponentRunReport,
    ) -> std::io::Result<()> {
        if report.description.component_type() == &ComponentType::Suite {
            return Ok(());
        }

        if report.result.has_failed() {
            self.writeln(
                writer,
                &format!("{} {}", self.style.failed, report.description.full_name()),
            )?;
        }

        if !self.progress.is_hidden() {
            self.remove_in_progress(report.description.id());
        }
        Ok(())
    }

    fn writeln<W: Write, S: AsRef<str>>(&mut self, writer: &mut W, msg: S) -> std::io::Result<()> {
        if self.progress.is_hidden() {
            writeln!(writer, "{}", msg.as_ref())?;
        } else {
            self.progress.println(msg);
        }
        Ok(())
    }

    fn remove_in_progress(&mut self, id: &ComponentId) {
        self.in_progress.remove(id);
        self.update_in_progress();
        self.progress.inc(1);
    }

    fn add_in_progress(&mut self, id: &ComponentId, name: String) {
        self.in_progress.insert(id.clone(), name);
        self.update_in_progress();
        self.progress.inc(1);
    }

    fn update_in_progress(&self) {
        self.progress.set_message(
            self.in_progress
                .values()
                .rev()
                .map(|s| &**s)
                .collect::<Vec<&str>>()
                .join(", "),
        );
    }
}