create-grafana-plugin 0.2.6

CLI tool to scaffold production-ready Grafana plugin projects
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

//! Template rendering: substitution, conditionals, derived fields (9.5).

use create_grafana_plugin::config::{PluginType, ProjectConfig};
use create_grafana_plugin::template::{TemplateContext, render_string};

fn sample_config() -> ProjectConfig {
    ProjectConfig {
        name: "my-plugin".to_string(),
        description: "Test plugin".to_string(),
        author: "Jane Doe".to_string(),
        org: "acme".to_string(),
        plugin_type: PluginType::Panel,
        has_wasm: true,
        has_docker: false,
        has_mock: false,
        port_offset: 0,
    }
}

#[test]
fn render_string_substitutes_variables() {
    let cfg = sample_config();
    let ctx = TemplateContext::from_config(&cfg);
    let out = render_string(
        "id={{ plugin_id }} name={{ plugin_name }} org={{ org }}",
        &ctx,
    )
    .expect("render");
    assert_eq!(out, "id=acme-my-plugin name=my-plugin org=acme");
}

#[test]
fn render_string_conditional_includes_when_true() {
    let cfg = sample_config();
    let ctx = TemplateContext::from_config(&cfg);
    let tpl = "{% if has_wasm %}WASM{% else %}NO{% endif %}";
    assert_eq!(render_string(tpl, &ctx).expect("render"), "WASM");
}

#[test]
fn render_string_conditional_excludes_when_false() {
    let mut cfg = sample_config();
    cfg.has_wasm = false;
    let ctx = TemplateContext::from_config(&cfg);
    let tpl = "{% if has_wasm %}WASM{% else %}NO{% endif %}";
    assert_eq!(render_string(tpl, &ctx).expect("render"), "NO");
}

#[test]
fn template_context_derived_fields() {
    let cfg = ProjectConfig {
        name: "foo-bar-baz".to_string(),
        description: "d".to_string(),
        author: "a".to_string(),
        org: "orgx".to_string(),
        plugin_type: PluginType::Datasource,
        has_wasm: true,
        has_docker: true,
        has_mock: true,
        port_offset: 0,
    };
    let ctx = TemplateContext::from_config(&cfg);
    assert_eq!(ctx.plugin_id, "orgx-foo-bar-baz");
    assert_eq!(ctx.crate_name, "foo_bar_baz");
    assert_eq!(ctx.pascal_case_name, "FooBarBaz");
    assert_eq!(ctx.plugin_type, "datasource");
    assert!(!ctx.current_year.is_empty());
    assert!(!ctx.today.is_empty());
}