folk-builder 0.2.0

Custom binary builder for Folk — generates and compiles a Folk server with selected plugins
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

use folk_builder::codegen::{generate_cargo_toml, generate_lib_rs};
use folk_builder::config::{BuildConfig, BuildMeta, PluginEntry};

fn two_plugin_config() -> BuildConfig {
    BuildConfig {
        build: BuildMeta {
            output: "my-folk".into(),
            rust_version: "1.85".into(),
            folk_ext_path: None,
            folk_api_path: None,
        },
        plugin: vec![
            PluginEntry {
                crate_name: "folk_plugin_http".into(),
                version: Some("0.1".into()),
                path: None,
                git: None,
                config_key: "http".into(),
            },
            PluginEntry {
                crate_name: "folk_plugin_jobs".into(),
                version: Some("0.1".into()),
                path: None,
                git: None,
                config_key: "jobs".into(),
            },
        ],
    }
}

#[test]
fn codegen_main_contains_both_plugins() {
    let main_rs = generate_lib_rs(&two_plugin_config());
    assert!(main_rs.contains("folk_plugin_http_factory"));
    assert!(main_rs.contains("folk_plugin_jobs_factory"));
}

#[test]
fn codegen_main_contains_config_keys() {
    let main_rs = generate_lib_rs(&two_plugin_config());
    assert!(main_rs.contains(r#"raw_cfg.get("http")"#));
    assert!(main_rs.contains(r#"raw_cfg.get("jobs")"#));
}

#[test]
fn codegen_cargo_toml_contains_plugins() {
    let cargo = generate_cargo_toml(&two_plugin_config());
    assert!(cargo.contains(r#"folk_plugin_http = "0.1""#));
    assert!(cargo.contains(r#"folk_plugin_jobs = "0.1""#));
    assert!(cargo.contains(r#"name = "my-folk""#));
}

#[test]
fn codegen_cargo_toml_path_override() {
    let cfg = BuildConfig {
        build: BuildMeta {
            output: "test".into(),
            rust_version: "1.85".into(),
            folk_ext_path: None,
            folk_api_path: None,
        },
        plugin: vec![PluginEntry {
            crate_name: "my_plugin".into(),
            version: None,
            path: Some("../my-plugin".into()),
            git: None,
            config_key: String::new(),
        }],
    };
    let cargo = generate_cargo_toml(&cfg);
    assert!(cargo.contains(r#"my_plugin = { path = "../my-plugin" }"#));
}

#[test]
fn codegen_cargo_toml_git_override() {
    let cfg = BuildConfig {
        build: BuildMeta {
            output: "test".into(),
            rust_version: "1.85".into(),
            folk_ext_path: None,
            folk_api_path: None,
        },
        plugin: vec![PluginEntry {
            crate_name: "my_plugin".into(),
            version: Some("0.2".into()),
            path: None,
            git: Some("https://github.com/example/plugin".into()),
            config_key: String::new(),
        }],
    };
    let cargo = generate_cargo_toml(&cfg);
    assert!(
        cargo.contains(
            r#"my_plugin = { git = "https://github.com/example/plugin", version = "0.2" }"#
        )
    );
}

#[test]
fn codegen_main_uses_crate_name_as_config_key_when_empty() {
    let cfg = BuildConfig {
        build: BuildMeta {
            output: "test".into(),
            rust_version: "1.85".into(),
            folk_ext_path: None,
            folk_api_path: None,
        },
        plugin: vec![PluginEntry {
            crate_name: "folk_plugin_http".into(),
            version: Some("0.1".into()),
            path: None,
            git: None,
            config_key: String::new(),
        }],
    };
    let main_rs = generate_lib_rs(&cfg);
    assert!(main_rs.contains(r#"raw_cfg.get("folk_plugin_http")"#));
}