ockam_command 0.150.0

End-to-end encryption and mutual authentication for distributed applications.
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
119
120
121
122
123
124
125
126
127
128

use miette::miette;

/// Return true if the list of arguments contains a help flag
pub fn has_help_flag(input: &[String]) -> bool {
    input.contains(&"-h".to_string()) || input.contains(&"--help".to_string())
}

/// Return true if the list of arguments contains a version flag
pub fn has_version_flag(input: &[String]) -> bool {
    input.contains(&"-V".to_string()) || input.contains(&"--version".to_string())
}

/// Return a list of every `--env KEY=VALUE` attribute parameter in the list of arguments
/// and a list of the remaining arguments
#[allow(clippy::type_complexity)]
pub fn get_env_attributes(
    input: &[String],
) -> miette::Result<Option<(Vec<(String, String)>, Vec<String>)>> {
    let mut attributes = Vec::new();
    let mut remaining = Vec::new();
    let mut iter = input.iter();

    while let Some(arg) = iter.next() {
        if arg == "--env" {
            let key_value = iter
                .next()
                .ok_or_else(|| miette!("Missing value for --env, expected KEY=VALUE"))?;
            let mut key_value = key_value.split('=');
            let key = key_value
                .next()
                .ok_or_else(|| miette!("Missing key for --env, expected KEY=VALUE"))?;
            let value = key_value
                .next()
                .ok_or_else(|| miette!("Missing value for --env, expected KEY=VALUE"))?;
            attributes.push((key.to_string(), value.to_string()));
        } else {
            remaining.push(arg.to_string());
        }
    }

    if attributes.is_empty() {
        Ok(None)
    } else {
        Ok(Some((attributes, remaining)))
    }
}

/// Replaces the '-' placeholder character with a string value coming from stdin
/// This is useful to be able to pipe the output of a command to another command.
///
/// For example:
///
/// ockam secure-channel create --from me --to /node/node-1/service/api |
///     ockam message send hello --from me --to -/service/uppercase
///
pub fn replace_hyphen_with_stdin(s: String) -> String {
    let input_stream = std::io::stdin();
    if s.contains("/-") {
        let mut buffer = String::new();
        input_stream
            .read_line(&mut buffer)
            .expect("could not read from standard input");
        let args_from_stdin = buffer
            .trim()
            .split('/')
            .filter(|&s| !s.is_empty())
            .fold("".to_owned(), |acc, s| format!("{acc}/{s}"));

        s.replace("/-", &args_from_stdin)
    } else if s.contains("-/") {
        let mut buffer = String::new();
        input_stream
            .read_line(&mut buffer)
            .expect("could not read from standard input");

        let args_from_stdin = buffer
            .trim()
            .split('/')
            .filter(|&s| !s.is_empty())
            .fold("/".to_owned(), |acc, s| format!("{acc}{s}/"));

        s.replace("-/", &args_from_stdin)
    } else {
        s
    }
}

#[cfg(test)]
mod tests {
    #[test]
    pub fn environment_attributes_replaced() {
        let input = vec![
            "ockam".to_string(),
            "--env".to_string(),
            "KEY1=VALUE1".to_string(),
            "command".to_string(),
            "arg1".to_string(),
            "arg2".to_string(),
            "--env".to_string(),
            "KEY2=VALUE2".to_string(),
        ];

        let (attributes, remaining) = super::get_env_attributes(&input).unwrap().unwrap();

        assert_eq!(attributes.len(), 2);
        assert_eq!(attributes[0], ("KEY1".to_string(), "VALUE1".to_string()));
        assert_eq!(attributes[1], ("KEY2".to_string(), "VALUE2".to_string()));

        assert_eq!(remaining.len(), 4);
        assert_eq!(remaining[0], "ockam".to_string());
        assert_eq!(remaining[1], "command".to_string());
        assert_eq!(remaining[2], "arg1".to_string());
        assert_eq!(remaining[3], "arg2".to_string());
    }

    #[test]
    pub fn environment_attributes_not_replaced() {
        let input = vec![
            "ockam".to_string(),
            "command".to_string(),
            "arg1".to_string(),
            "arg2".to_string(),
        ];

        let result = super::get_env_attributes(&input).unwrap();
        assert!(result.is_none());
    }
}