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

use crate::util::parsers::duration_parser;
use clap::Args;
use ockam::identity::models::ChangeHistory;
use ockam_core::env::get_env;
use ockam_multiaddr::MultiAddr;
use std::time::Duration;

#[derive(Clone, Debug, Args)]
pub struct IdentityOpts {
    /// Run the command as the given Identity
    #[arg(global = true, value_name = "IDENTITY_NAME", long = "identity")]
    pub identity_name: Option<String>,
}

#[derive(Clone, Debug, Args, Default, PartialEq)]
pub struct TrustOpts {
    /// Project name to use for the command
    #[arg(long = "project", value_name = "PROJECT_NAME")]
    pub project_name: Option<String>,

    /// Hex encoded Identity
    #[arg(long, value_name = "IDENTITY", value_parser = ChangeHistory::import_from_string)]
    pub authority_identity: Option<ChangeHistory>,

    /// Address to the Authority node
    #[arg(long)]
    pub authority_route: Option<MultiAddr>,

    /// Expect credential manually saved to the storage
    #[arg(long)]
    pub credential_scope: Option<String>,
}

#[derive(Clone, Debug, Args, Default, PartialEq)]
pub struct RetryOpts {
    /// Number of times to retry the command
    #[arg(hide = true, long, alias = "retry")]
    retry_count: Option<u32>,

    /// Delay between retries
    #[arg(hide = true, long, value_parser = duration_parser)]
    retry_delay: Option<Duration>,

    /// Disable retry for the command,
    /// no matter if it's enabled via arguments or environment variables
    #[arg(hide = true, long, default_value_t = false)]
    no_retry: bool,
}

impl RetryOpts {
    /// Get the number of times to retry the command
    ///
    /// If the value is not set, it will try to get the value from
    /// the `OCKAM_COMMAND_RETRY_COUNT` environment variable
    pub fn retry_count(&self) -> Option<u32> {
        if self.no_retry {
            return None;
        }
        match self.retry_count {
            Some(count) => Some(count),
            None => get_env::<String>("OCKAM_COMMAND_RETRY_COUNT")
                .ok()
                .flatten()
                .and_then(|v| v.parse().ok()),
        }
    }

    /// Get the delay between retries
    ///
    /// If the value is not set, it will try to get the value from
    /// the `OCKAM_COMMAND_RETRY_DELAY` environment variable
    pub fn retry_delay(&self) -> Option<Duration> {
        if self.no_retry {
            return None;
        }
        match self.retry_delay {
            Some(delay) => Some(delay),
            None => get_env::<String>("OCKAM_COMMAND_RETRY_DELAY")
                .ok()
                .flatten()
                .and_then(|v| duration_parser(&v).ok()),
        }
    }
}

#[derive(Debug, Clone, Args)]
pub struct TimeoutArg {
    /// Override the default timeout duration that the command will wait for a response
    #[arg(long, value_name = "TIMEOUT", default_value = "10s", value_parser = duration_parser)]
    pub(crate) timeout: Duration,
}

#[derive(Debug, Clone, Args)]
pub struct OptionalTimeoutArg {
    /// Override the default timeout duration that the command will wait for a response
    #[arg(long, value_name = "TIMEOUT", default_value = "10s", value_parser = duration_parser)]
    pub(crate) timeout: Option<Duration>,
}