osp-cli 1.5.1

CLI and REPL for querying and managing OSP infrastructure data
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

#![allow(missing_docs)]

#[cfg(unix)]
use crate::support::{ReplPtyConfig, ReplPtySession, write_executable_script};
#[cfg(unix)]
use crate::temp_support::make_temp_dir;
#[cfg(unix)]
use std::path::{Path, PathBuf};
#[cfg(unix)]
use std::time::Duration;

#[cfg(unix)]
fn spawn_repl(plugins: &Path) -> ReplPtySession {
    ReplPtySession::spawn(ReplPtyConfig::default().with_plugins_dir(plugins))
}

#[cfg(unix)]
fn write_provider_plugin(
    dir: &Path,
    plugin_id: &str,
    command_name: &str,
    message: &str,
) -> PathBuf {
    let plugin_path = dir.join(format!("osp-{plugin_id}"));
    let script = format!(
        r#"#!/bin/sh
PATH=/usr/bin:/bin:$PATH
if [ "$1" = "--describe" ]; then
  cat <<'JSON'
{{"protocol_version":1,"plugin_id":"{plugin_id}","plugin_version":"0.1.0","min_osp_version":"0.1.0","commands":[{{"name":"{command_name}","about":"{plugin_id} plugin","args":[],"flags":{{}},"subcommands":[]}}]}}
JSON
  exit 0
fi

cat <<'JSON'
{{"protocol_version":1,"ok":true,"data":{{"message":"{message}-from-plugin"}},"error":null,"meta":{{"format_hint":"table","columns":["message"]}}}}
JSON
"#,
        plugin_id = plugin_id,
        command_name = command_name,
        message = message
    );

    write_executable_script(&plugin_path, &script);
    plugin_path
}

#[cfg(unix)]
#[test]
fn repl_requires_explicit_provider_selection_for_conflicted_commands() {
    let plugins = make_temp_dir("osp-cli-pty-conflict-plugins");
    let _alpha = write_provider_plugin(&plugins, "alpha-provider", "hello", "alpha");
    let _beta = write_provider_plugin(&plugins, "beta-provider", "hello", "beta");
    let mut session = spawn_repl(&plugins);

    assert!(
        session.wait_for_output_since(0, "> ", Duration::from_secs(3)),
        "expected prompt before dispatch; output:\n{}",
        session.output_snapshot(2000),
    );

    let start = session.output_len();
    session.write_bytes(b"hello\r");
    assert!(
        session.wait_for_output_since(
            start,
            "command `hello` is provided by multiple plugins",
            Duration::from_secs(3)
        ),
        "expected ambiguity error in repl output; output:\n{}",
        session.output_snapshot(4000),
    );
    assert!(
        session.wait_for_output_since(start, "--plugin-provider", Duration::from_secs(3)),
        "expected provider-selection hint in repl output; output:\n{}",
        session.output_snapshot(4000),
    );
    assert!(
        !session.output_snapshot(4000).contains("alpha-from-plugin"),
        "did not expect implicit provider execution; output:\n{}",
        session.output_snapshot(4000),
    );

    session.write_bytes(b"exit\r\r");
    if !session.wait_for_exit(Duration::from_secs(3)) {
        session.kill();
    }
}