locket 0.17.3

Helper tool for secret injection as a process dependency
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

use crate::cmd::Cli;
use crate::compose::MetadataError;
use crate::error::LocketError;
use clap::{Arg, Command, CommandFactory};
use serde::Serialize;

#[derive(Serialize)]
#[serde(rename_all = "lowercase")]
enum ParamType {
    String,
    Boolean,
}

#[derive(Serialize)]
struct ProviderMetadata {
    description: String,
    up: CommandMetadata,
    down: CommandMetadata,
}

#[derive(Serialize)]
struct CommandMetadata {
    parameters: Vec<Parameter>,
}

#[derive(Serialize)]
struct Parameter {
    name: String,
    description: String,
    required: bool,
    #[serde(rename = "type")]
    param_type: ParamType,
    #[serde(skip_serializing_if = "Option::is_none")]
    default: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "enum")]
    enum_values: Option<String>,
}

pub async fn metadata(_project: String) -> Result<(), LocketError> {
    let cmd = Cli::command();
    let compose = get_subcommand(&cmd, "compose")?;

    let meta = ProviderMetadata {
        description: cmd.get_about().unwrap_or_default().to_string(),
        up: extract_metadata(get_subcommand(compose, "up")?),
        down: extract_metadata(get_subcommand(compose, "down")?),
    };

    serde_json::to_writer_pretty(std::io::stdout(), &meta).map_err(MetadataError::from)?;

    Ok(())
}

fn get_subcommand<'a>(cmd: &'a Command, name: &str) -> Result<&'a Command, MetadataError> {
    cmd.get_subcommands()
        .find(|s| s.get_name() == name)
        .ok_or_else(|| MetadataError::MissingSubcommand(name.to_string()))
}

fn extract_metadata(cmd: &Command) -> CommandMetadata {
    let parameters = cmd
        .get_arguments()
        .filter_map(Parameter::from_arg)
        .collect();

    CommandMetadata { parameters }
}

impl Parameter {
    fn from_arg(arg: &Arg) -> Option<Self> {
        // Skip positional args, help, version, and hidden args
        if arg.is_positional()
            || arg.get_id() == "help"
            || arg.get_id() == "version"
            || arg.is_hide_set()
        {
            return None;
        }

        let name = arg.get_long()?.to_string();

        let param_type = if arg.get_action().takes_values() {
            ParamType::String
        } else {
            ParamType::Boolean
        };

        let description = arg.get_help().map(|s| s.to_string()).unwrap_or_default();

        let default = arg
            .get_default_values()
            .first()
            .map(|v| v.to_string_lossy().to_string());

        let enum_values = if !arg.get_possible_values().is_empty() {
            Some(
                arg.get_possible_values()
                    .iter()
                    .map(|v| v.get_name())
                    .collect::<Vec<_>>()
                    .join(","),
            )
        } else {
            None
        };

        Some(Parameter {
            name,
            description,
            required: arg.is_required_set(),
            param_type,
            default,
            enum_values,
        })
    }
}