-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(bors): merge pull request #720
720: refactor(rest-plugin): make it more modular r=tiagolobocastro a=tiagolobocastro Adds common cli args to the library, which the binary then makes use of. Tidies up the error scenario with common error handling and implicit trace flushing. Add execute trait to allow for tidier composition of operations, which will be especially useful to reduce code duplication in the kubectl plugin. Co-authored-by: Tiago Castro <tiagolobocastro@gmail.com>
- Loading branch information
Showing
5 changed files
with
223 additions
and
139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,141 +1,55 @@ | ||
| use clap::Parser; | ||
| use openapi::tower::client::Url; | ||
| use plugin::{ | ||
| operations::{ | ||
| Cordoning, Drain, Get, GetBlockDevices, GetSnapshots, List, ListExt, Operations, | ||
| RebuildHistory, ReplicaTopology, Scale, | ||
| }, | ||
| resources::{ | ||
| blockdevice, cordon, drain, node, pool, snapshot, volume, CordonResources, DrainResources, | ||
| GetCordonArgs, GetDrainArgs, GetResources, ScaleResources, | ||
| }, | ||
| rest_wrapper::RestClient, | ||
| }; | ||
| use plugin::{operations::Operations, rest_wrapper::RestClient, ExecuteOperation}; | ||
| use snafu::ResultExt; | ||
| use std::env; | ||
|
|
||
| #[derive(clap::Parser, Debug)] | ||
| #[clap(name = utils::package_description!(), version = utils::version_info_str!())] | ||
| #[group(skip)] | ||
| struct CliArgs { | ||
| /// The rest endpoint to connect to. | ||
| #[clap(global = true, long, short, default_value = "http://localhost:8081")] | ||
| rest: Url, | ||
|
|
||
| /// The operation to be performed. | ||
| #[clap(subcommand)] | ||
| operations: Operations, | ||
| operation: Operations, | ||
|
|
||
| /// The Output, viz yaml, json. | ||
| #[clap(global = true, default_value = plugin::resources::utils::OutputFormat::None.as_ref(), short, long)] | ||
| output: plugin::resources::utils::OutputFormat, | ||
|
|
||
| /// Trace rest requests to the Jaeger endpoint agent. | ||
| #[clap(global = true, long, short)] | ||
| jaeger: Option<String>, | ||
|
|
||
| /// Timeout for the REST operations. | ||
| #[clap(long, short, default_value = "10s")] | ||
| timeout: humantime::Duration, | ||
| } | ||
| impl CliArgs { | ||
| fn args() -> Self { | ||
| CliArgs::parse() | ||
| } | ||
| #[clap(flatten)] | ||
| args: plugin::CliArgs, | ||
| } | ||
|
|
||
| #[tokio::main] | ||
| async fn main() { | ||
| plugin::init_tracing(CliArgs::args().jaeger.as_ref()); | ||
| let cli_args = CliArgs::args(); | ||
| let _trace_flush = cli_args.args.init_tracing(); | ||
|
|
||
| execute(CliArgs::args()).await; | ||
| if let Err(error) = cli_args.execute().await { | ||
| eprintln!("{error}"); | ||
| std::process::exit(1); | ||
| } | ||
| } | ||
|
|
||
| utils::tracing_telemetry::flush_traces(); | ||
| #[derive(Debug, snafu::Snafu)] | ||
| enum Error { | ||
| #[snafu(display("Failed to initialise the REST client. Error {source}"))] | ||
| RestClient { source: anyhow::Error }, | ||
| #[snafu(display("{source}"))] | ||
| Resources { source: plugin::resources::Error }, | ||
| } | ||
|
|
||
| async fn execute(cli_args: CliArgs) { | ||
| // Initialise the REST client. | ||
| if let Err(e) = RestClient::init(cli_args.rest.clone(), *cli_args.timeout) { | ||
| println!("Failed to initialise the REST client. Error {e}"); | ||
| impl CliArgs { | ||
| fn args() -> Self { | ||
| CliArgs::parse() | ||
| } | ||
| async fn execute(&self) -> Result<(), Error> { | ||
| // todo: client connection is lazy, we should do sanity connection test here. | ||
| // Example, we can use use rest liveness probe. | ||
| RestClient::init(self.rest.clone(), *self.args.timeout).context(RestClientSnafu)?; | ||
| self.operation | ||
| .execute(&self.args) | ||
| .await | ||
| .context(ResourcesSnafu) | ||
| } | ||
|
|
||
| // Perform the operations based on the subcommand, with proper output format. | ||
| let result = match &cli_args.operations { | ||
| Operations::Drain(resource) => match resource { | ||
| DrainResources::Node(drain_node_args) => { | ||
| node::Node::drain( | ||
| &drain_node_args.node_id(), | ||
| drain_node_args.label(), | ||
| drain_node_args.drain_timeout(), | ||
| &cli_args.output, | ||
| ) | ||
| .await | ||
| } | ||
| }, | ||
| Operations::Get(resource) => match resource { | ||
| GetResources::Cordon(get_cordon_resource) => match get_cordon_resource { | ||
| GetCordonArgs::Node { id: node_id } => { | ||
| cordon::NodeCordon::get(node_id, &cli_args.output).await | ||
| } | ||
| GetCordonArgs::Nodes => cordon::NodeCordons::list(&cli_args.output).await, | ||
| }, | ||
| GetResources::Drain(get_drain_resource) => match get_drain_resource { | ||
| GetDrainArgs::Node { id: node_id } => { | ||
| drain::NodeDrain::get(node_id, &cli_args.output).await | ||
| } | ||
| GetDrainArgs::Nodes => drain::NodeDrains::list(&cli_args.output).await, | ||
| }, | ||
| GetResources::Volumes(vol_args) => { | ||
| volume::Volumes::list(&cli_args.output, vol_args).await | ||
| } | ||
| GetResources::Volume { id } => volume::Volume::get(id, &cli_args.output).await, | ||
| GetResources::RebuildHistory { id } => { | ||
| volume::Volume::rebuild_history(id, &cli_args.output).await | ||
| } | ||
| GetResources::VolumeReplicaTopologies(vol_args) => { | ||
| volume::Volume::topologies(&cli_args.output, vol_args).await | ||
| } | ||
| GetResources::VolumeReplicaTopology { id } => { | ||
| volume::Volume::topology(id, &cli_args.output).await | ||
| } | ||
| GetResources::Pools => pool::Pools::list(&cli_args.output).await, | ||
| GetResources::Pool { id } => pool::Pool::get(id, &cli_args.output).await, | ||
| GetResources::Nodes => node::Nodes::list(&cli_args.output).await, | ||
| GetResources::Node(args) => node::Node::get(&args.node_id(), &cli_args.output).await, | ||
| GetResources::BlockDevices(bdargs) => { | ||
| blockdevice::BlockDevice::get_blockdevices( | ||
| &bdargs.node_id(), | ||
| &bdargs.all(), | ||
| &cli_args.output, | ||
| ) | ||
| .await | ||
| } | ||
| GetResources::VolumeSnapshots(snapargs) => { | ||
| snapshot::VolumeSnapshots::get_snapshots( | ||
| &snapargs.volume(), | ||
| &snapargs.snapshot(), | ||
| &cli_args.output, | ||
| ) | ||
| .await | ||
| } | ||
| }, | ||
| Operations::Scale(resource) => match resource { | ||
| ScaleResources::Volume { id, replica_count } => { | ||
| volume::Volume::scale(id, *replica_count, &cli_args.output).await | ||
| } | ||
| }, | ||
| Operations::Cordon(resource) => match resource { | ||
| CordonResources::Node { id, label } => { | ||
| node::Node::cordon(id, label, &cli_args.output).await | ||
| } | ||
| }, | ||
| Operations::Uncordon(resource) => match resource { | ||
| CordonResources::Node { id, label } => { | ||
| node::Node::uncordon(id, label, &cli_args.output).await | ||
| } | ||
| }, | ||
| }; | ||
|
|
||
| if let Err(error) = result { | ||
| eprintln!("{error}"); | ||
| std::process::exit(1); | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.