teravars 0.1.4

Tera templating + smart [vars] handling for self-rendering TOML configs
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

use std::error::Error as StdError;

use thiserror::Error;

#[derive(Debug, Error)]
pub enum Error {
    #[error("template render failed: {0}")]
    Render(String),

    #[error("vars resolution did not converge after {iterations} iterations")]
    ResolveNotConverged { iterations: usize },

    #[error("vars extraction failed: {0}")]
    Extract(String),

    #[error("include cycle detected at: {path}")]
    IncludeCycle { path: std::path::PathBuf },

    #[error(
        "conflicting include directives: both root `include` and `[teravars] include` are set in {path}"
    )]
    IncludeConflict { path: std::path::PathBuf },

    #[error(transparent)]
    Toml(#[from] toml::de::Error),

    #[error(transparent)]
    Io(#[from] std::io::Error),
}

impl From<tera::Error> for Error {
    fn from(err: tera::Error) -> Self {
        let mut messages = vec![err.to_string()];
        let mut current: &dyn StdError = &err;
        while let Some(source) = current.source() {
            messages.push(source.to_string());
            current = source;
        }
        Error::Render(messages.join(": "))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn tera_error_chain_is_flattened_into_render_message() {
        let mut tera = tera::Tera::default();
        let err = tera
            .render_str("{{ vars.missing }}", &tera::Context::new())
            .unwrap_err();
        let converted: Error = err.into();
        let msg = converted.to_string();

        assert!(msg.contains("template render failed"));
        // The whole point of walking err.source(): the actual cause must reach the user,
        // not just the bare top-level "Failed to render '__tera_one_off'" message.
        assert!(
            msg.contains("vars.missing"),
            "expected the missing-variable name to be surfaced, got: {msg}"
        );
        assert!(
            msg.contains("not found"),
            "expected the cause description to be surfaced, got: {msg}"
        );
    }
}