specfold-core 0.3.0

Library behind specfold: typed Markdown documents, owners, a derived graph and checks.
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

//! Plugins: external programs that add rules, importers, exporters, audits and event handlers
//! over a JSON protocol. Only programs named in spec.toml ever run.

pub mod payload;
pub mod process;
pub mod protocol;
pub mod registry;
pub mod rules;

pub use protocol::{Description, PROTOCOL};
pub use registry::{Loaded, load};

#[cfg(all(test, unix))]
mod tests {
    use super::*;
    use crate::config::{Config, PluginDef, RawConfig};

    #[test]
    fn describes_and_times_out() {
        let tmp = tempfile::tempdir().unwrap();
        let r = tmp.path();
        let script = r.join("plugin.sh");
        std::fs::write(&script, "#!/bin/sh\nread req\ncase \"$req\" in\n*describe*) echo '{\"protocol\":\"specfold.plugin.v1\",\"name\":\"demo\",\"provides\":{\"rules\":[{\"id\":\"r1\",\"title\":\"t\"}]}}';;\n*) sleep 5;;\nesac\n").unwrap();
        let raw = RawConfig {
            plugins: vec![PluginDef {
                name: "demo".into(),
                cmd: vec!["sh".into(), script.to_string_lossy().into_owned()],
                timeout_ms: 300,
            }],
            ..Default::default()
        };
        let cfg = Config::from_raw(r.to_path_buf(), raw, false);
        let loaded = load(&cfg);
        let d = loaded[0].description.as_ref().unwrap();
        assert_eq!(d.provides.rules[0].id, "r1");
        let slow: anyhow::Result<serde_json::Value> =
            process::call(&cfg, &cfg.raw.plugins[0], "rule.run", serde_json::Value::Null);
        assert!(slow.unwrap_err().to_string().contains("did not answer"));
    }
}