tvc 0.11.0

CLI for Turnkey Verifiable Cloud
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

//! Deploy get-status command.

use anyhow::{Context, anyhow};
use clap::Args as ClapArgs;
use turnkey_client::generated::{
    GetAppStatusRequest,
    external::data::v1::{AppStatus, DeploymentStatus},
};

use crate::{
    client::{fetch_tvc_app, fetch_tvc_deployment},
    commands::display::format_egress_enabled,
};

/// Get the live status of a deployment from the app status API.
#[derive(Debug, ClapArgs)]
#[command(about, long_about = None)]
pub struct Args {
    /// ID of the deployment.
    #[arg(short, long, env = "TVC_DEPLOY_ID")]
    pub deploy_id: String,
}

/// Run the deploy get-status command.
pub async fn run(args: Args) -> anyhow::Result<()> {
    let Args {
        deploy_id: deployment_id,
    } = args;

    // TODO (TVC-154):
    // this is a little backwards, all the variables that are needed to build the client
    // are resolved INSIDE the `build-client`. Instead, all the necessary data for the client
    // should be resolved, then passed into an infallible constructor
    let auth = crate::client::build_client().await?;
    let org_id = auth.org_id.clone();

    let deployment = fetch_tvc_deployment(&auth, org_id.clone(), deployment_id.clone()).await?;

    let app_request = GetAppStatusRequest {
        organization_id: org_id.clone(),
        app_id: deployment.app_id.clone(),
    };

    let app_response = auth
        .client
        .get_app_status(app_request)
        .await
        .context("failed to fetch app status")?;

    let app_status = crate::commands::app_status::sanitize_app_status(
        app_response
            .app_status
            .ok_or_else(|| anyhow!("no status returned for app: {}", deployment.app_id))?,
    );
    let app = fetch_tvc_app(&auth, &deployment.app_id).await?;

    println!("Deployment: {}", deployment.id);
    println!("App ID: {}", app_status.app_id);
    println!("{}", format_egress_enabled(app.enable_egress));
    println!(
        "Is Targeted Deployment: {}",
        if app_status.targeted_deployment_id == deployment_id {
            "yes"
        } else {
            "no"
        }
    );
    if let Some(deployment_status) = find_deployment_status(&app_status, &deployment_id) {
        println!(
            "{}",
            crate::commands::app_status::format_replica_status(deployment_status)
        );

        if let Some(updated) = &deployment_status.last_updated_time {
            println!("Last Updated: {}.{:09}s", updated.seconds, updated.nanos);
        }
    } else {
        println!("Live Status: unavailable");
        println!("Reason: deployment not present in current app status");
    }

    Ok(())
}

fn find_deployment_status<'a>(
    app_status: &'a AppStatus,
    deploy_id: &str,
) -> Option<&'a DeploymentStatus> {
    app_status
        .deployments
        .iter()
        .find(|status| status.deployment_id == deploy_id)
}

#[cfg(test)]
mod tests {
    use super::find_deployment_status;
    use turnkey_client::generated::external::data::v1::{AppStatus, DeploymentStatus};

    #[test]
    fn find_deployment_status_matches_sanitized_ids() {
        let app_status = AppStatus {
            app_id: "app-123".to_string(),
            deployments: vec![DeploymentStatus {
                deployment_id: "5376f492-d014-4e01-a6bb-20fc97448e25".to_string(),
                ready_replicas: 3,
                desired_replicas: 3,
                last_updated_time: None,
            }],
            targeted_deployment_id: "5376f492-d014-4e01-a6bb-20fc97448e25".to_string(),
        };

        let deployment_status =
            find_deployment_status(&app_status, "5376f492-d014-4e01-a6bb-20fc97448e25");

        assert!(deployment_status.is_some());
    }
}