rustfs-cli 0.1.30

A Rust S3 CLI client for S3-compatible object storage
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

//! Public RustFS readiness probe command.

use clap::Args;

use super::ping;
use crate::exit_code::ExitCode;
use crate::output::OutputConfig;

/// Check whether the service and required dependencies are ready.
#[derive(Args, Debug)]
pub struct ReadyArgs {
    /// Alias name of the service endpoint
    pub alias: String,

    /// Maximum probe duration in seconds
    #[arg(long, default_value_t = 5, value_parser = clap::value_parser!(u64).range(1..=300))]
    pub timeout: u64,
}

/// Execute a readiness probe.
pub async fn execute(args: ReadyArgs, output_config: OutputConfig) -> ExitCode {
    ping::execute_probe(
        &args.alias,
        args.timeout,
        rc_core::ops::HealthProbe::Readiness,
        output_config,
    )
    .await
}

#[cfg(test)]
mod tests {
    use std::time::Duration;

    use async_trait::async_trait;
    use rc_core::ops::{HealthApi, HealthProbe, HealthReport};
    use rc_core::{Error, Result};

    use super::*;
    use crate::output::Formatter;

    struct ReadyApi {
        report: Option<HealthReport>,
        error: Option<String>,
    }

    #[async_trait]
    impl HealthApi for ReadyApi {
        async fn check_health(
            &self,
            _probe: HealthProbe,
            _timeout: Duration,
        ) -> Result<HealthReport> {
            if let Some(error) = &self.error {
                return Err(Error::Network(error.clone()));
            }
            self.report
                .clone()
                .ok_or_else(|| Error::General("missing test report".to_string()))
        }
    }

    fn ready_report(healthy: bool, status_code: u16) -> HealthReport {
        HealthReport {
            probe: HealthProbe::Readiness,
            endpoint: "http://127.0.0.1:9000".to_string(),
            path: "/health/ready".to_string(),
            status_code,
            healthy,
            latency_ms: 4,
            status: Some(if healthy { "ok" } else { "degraded" }.to_string()),
            service: Some("rustfs-endpoint".to_string()),
            server_version: Some("1.0.0-beta.10".to_string()),
        }
    }

    #[tokio::test]
    async fn ready_returns_success_when_dependencies_are_ready() {
        let api = ReadyApi {
            report: Some(ready_report(true, 200)),
            error: None,
        };
        assert_eq!(
            ping::execute_with_api(
                "local",
                5,
                HealthProbe::Readiness,
                &api,
                &Formatter::default(),
            )
            .await,
            ExitCode::Success
        );
    }

    #[tokio::test]
    async fn ready_maps_service_unavailable_to_network_exit() {
        let api = ReadyApi {
            report: Some(ready_report(false, 503)),
            error: None,
        };
        assert_eq!(
            ping::execute_with_api(
                "local",
                5,
                HealthProbe::Readiness,
                &api,
                &Formatter::default(),
            )
            .await,
            ExitCode::NetworkError
        );
    }

    #[tokio::test]
    async fn ready_maps_timeout_to_network_exit() {
        let api = ReadyApi {
            report: None,
            error: Some("readiness probe timed out".to_string()),
        };
        assert_eq!(
            ping::execute_with_api(
                "local",
                5,
                HealthProbe::Readiness,
                &api,
                &Formatter::default(),
            )
            .await,
            ExitCode::NetworkError
        );
    }
}