refactor: Split the cli-core crate

Cargo.toml

@@ -19,7 +19,7 @@ members = [
   "openstack_tui",
   "openstack_types",
   "xtask",
-  "fuzz", 
+  "fuzz", "cli-core", 
 ]
 default-members = ["openstack_cli", "openstack_sdk", "openstack_tui", "openstack_types"]
 

Dockerfile

@@ -27,6 +27,7 @@ COPY auth-receipt/Cargo.toml /usr/src/openstack/auth-receipt/
 COPY auth-token/Cargo.toml /usr/src/openstack/auth-token/
 COPY auth-totp/Cargo.toml /usr/src/openstack/auth-totp/
 COPY auth-websso/Cargo.toml /usr/src/openstack/auth-websso/
+COPY cli-core/Cargo.toml /usr/src/openstack/cli-core/
 COPY openstack_sdk/Cargo.toml /usr/src/openstack/openstack_sdk/
 COPY openstack_cli/Cargo.toml /usr/src/openstack/openstack_cli/
 COPY openstack_tui/Cargo.toml /usr/src/openstack/openstack_tui/
@@ -62,7 +63,8 @@ RUN mkdir -p openstack/openstack_cli/src/bin && touch openstack/openstack_cli/sr
     mkdir -p openstack/auth-receipt/src && touch openstack/auth-receipt/src/lib.rs &&\
     mkdir -p openstack/auth-token/src && touch openstack/auth-token/src/lib.rs &&\
     mkdir -p openstack/auth-totp/src && touch openstack/auth-totp/src/lib.rs &&\
-    mkdir -p openstack/auth-websso/src && touch openstack/auth-websso/src/lib.rs
+    mkdir -p openstack/auth-websso/src && touch openstack/auth-websso/src/lib.rs &&\
+    mkdir -p openstack/cli-core/src && touch openstack/cli-core/src/lib.rs
 
 # Set the working directory
 WORKDIR /usr/src/openstack

cli-core/Cargo.toml

@@ -0,0 +1,48 @@
+[package]
+name = "openstack-cli-core"
+description = "OpenStack CLI core"
+version = "0.13.5"
+license.workspace = true
+edition.workspace = true
+authors.workspace = true
+rust-version.workspace = true
+homepage.workspace = true
+repository.workspace = true
+
+[dependencies]
+base64 = { workspace = true }
+clap = { workspace = true }
+clap_complete = { workspace = true }
+comfy-table = { version = "^7.2" }
+config.workspace = true
+dialoguer = { workspace = true }
+dirs = { workspace = true }
+eyre = { workspace = true }
+http = { workspace = true }
+indicatif = "^0.18"
+itertools = { workspace = true }
+#openstack_sdk = { path="../openstack_sdk", version = "^0.22", default-features = false }
+openstack-sdk-auth-core = { path="../auth-core", version = "^0.22", default-features = false }
+openstack-sdk-core = { path="../sdk-core", version = "^0.22", default-features = false }
+owo-colors = { version = "^4.3", features = ["supports-colors"] }
+rand = { version = "^0.10" }
+reqwest = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
+serde_json = {workspace = true}
+structable = { workspace = true }
+thiserror = { workspace = true }
+tokio = { workspace = true, features = ["fs", "io-std"]}
+tokio-util = {workspace = true}
+tracing = { workspace = true}
+tracing-subscriber = { workspace = true }
+url = { workspace = true }
+
+[dev-dependencies]
+#assert_cmd = "^2.2"
+#futures.workspace = true
+#md5 = "^0.8.0"
+#rand = "^0.10"
+tempfile = { workspace = true }
+
+[lints]
+workspace = true

cli-core/src/cli.rs

@@ -0,0 +1,198 @@
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
+//! CLI top level command and processing
+//!
+use clap::builder::{
+    Styles,
+    styling::{AnsiColor, Effects},
+};
+use clap::{Args, Parser, ValueEnum, ValueHint};
+use clap_complete::Shell;
+
+use crate::error::OpenStackCliError;
+
+use crate::config::{Config, ConfigError};
+
+pub fn styles() -> Styles {
+    Styles::styled()
+        .header(AnsiColor::Green.on_default() | Effects::BOLD)
+        .usage(AnsiColor::Green.on_default() | Effects::BOLD)
+        .literal(AnsiColor::White.on_default() | Effects::BOLD)
+        .placeholder(AnsiColor::Cyan.on_default())
+}
+
+/// Trait for getting Command execution context.
+pub trait CliArgs {
+    fn global_opts(&self) -> &GlobalOpts;
+    fn config(&self) -> &Config;
+}
+
+/// Parse config file
+pub fn parse_config(s: &str) -> Result<Config, OpenStackCliError> {
+    let mut builder = Config::builder()?;
+    if !s.is_empty() {
+        builder = builder.add_source(s).map_err(ConfigError::builder)?;
+    }
+    Ok(builder.build()?)
+}
+
+/// Connection options.
+#[derive(Args)]
+#[command(next_display_order = 800, next_help_heading = "Connection options")]
+pub struct ConnectionOpts {
+    /// Name reference to the clouds.yaml entry for the cloud configuration.
+    #[arg(long, env = "OS_CLOUD", global = true, display_order = 801, conflicts_with_all(["cloud_config_from_env", "os_cloud_name"]))]
+    pub os_cloud: Option<String>,
+
+    /// Get the cloud config from environment variables.
+    ///
+    /// Conflicts with the `--os-cloud` option. No merging of environment variables with the
+    /// options from the `clouds.yaml` file done. It is possible to rely on the `--auth-helper-cmd`
+    /// command, but than the `--os-cloud-name` should be specified to give a reasonable connection
+    /// name.
+    #[arg(long, global = true, action = clap::ArgAction::SetTrue, display_order = 802)]
+    pub cloud_config_from_env: bool,
+
+    /// Cloud name used when configuration is retrieved from environment variables. When not
+    /// specified the `envvars` would be used as a default. This value will be used eventually by
+    /// the authentication helper when data need to be provided dynamically.
+    #[arg(long, env = "OS_CLOUD_NAME", global = true, display_order = 802)]
+    pub os_cloud_name: Option<String>,
+
+    /// Project ID to use instead of the one in connection profile.
+    #[arg(long, env = "OS_PROJECT_ID", global = true, display_order = 803)]
+    pub os_project_id: Option<String>,
+
+    /// Project Name to use instead of the one in the connection profile.
+    #[arg(long, env = "OS_PROJECT_NAME", global = true, display_order = 803)]
+    pub os_project_name: Option<String>,
+
+    /// Region Name to use instead of the one in the connection profile.
+    #[arg(long, env = "OS_REGION_NAME", global = true, display_order = 804)]
+    pub os_region_name: Option<String>,
+
+    /// Custom path to the `clouds.yaml` config file.
+    #[arg(
+        long,
+        env = "OS_CLIENT_CONFIG_FILE",
+        global = true,
+        value_hint = ValueHint::FilePath,
+        display_order = 805
+    )]
+    pub os_client_config_file: Option<String>,
+
+    /// Custom path to the `secure.yaml` config file.
+    #[arg(
+        long,
+        env = "OS_CLIENT_SECURE_FILE",
+        global = true,
+        value_hint = ValueHint::FilePath,
+        display_order = 805
+    )]
+    pub os_client_secure_file: Option<String>,
+
+    /// External authentication helper command.
+    ///
+    /// Invoke external command to obtain necessary connection parameters. This is a path to the
+    /// executable, which is called with first parameter being the attribute key (i.e. `password`)
+    /// and a second parameter a cloud name (whatever is used in `--os-cloud` or
+    /// `--os-cloud-name`).
+    #[arg(long, global = true, value_hint = ValueHint::ExecutablePath, display_order = 810)]
+    pub auth_helper_cmd: Option<String>,
+}
+
+/// Output configuration.
+#[derive(Args)]
+#[command(next_display_order = 900, next_help_heading = "Output options")]
+pub struct OutputOpts {
+    /// Output format.
+    #[arg(short, long, global = true, value_enum, display_order = 910)]
+    pub output: Option<OutputFormat>,
+
+    /// Fields to return in the output (only in normal and wide mode).
+    #[arg(short, long, global=true, action=clap::ArgAction::Append, display_order = 910)]
+    pub fields: Vec<String>,
+
+    /// Pretty print the output.
+    #[arg(short, long, global=true, action = clap::ArgAction::SetTrue, display_order = 910)]
+    pub pretty: bool,
+
+    /// Verbosity level. Repeat to increase level.
+    #[arg(short, long, global=true, action = clap::ArgAction::Count, display_order = 920)]
+    pub verbose: u8,
+
+    /// Output Table arrangement.
+    #[arg(long, global=true, default_value_t = TableArrangement::Dynamic, value_enum, display_order = 930)]
+    pub table_arrangement: TableArrangement,
+
+    /// Record HTTP request timings.
+    #[arg(long, global=true, action = clap::ArgAction::SetTrue, display_order = 950)]
+    pub timing: bool,
+}
+
+/// Global CLI options.
+#[derive(Args)]
+#[command(next_display_order = 900)]
+pub struct GlobalOpts {
+    /// Connection options.
+    #[command(flatten)]
+    pub connection: ConnectionOpts,
+
+    /// Output config.
+    #[command(flatten)]
+    pub output: OutputOpts,
+}
+
+/// Output format.
+#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, ValueEnum)]
+pub enum OutputFormat {
+    /// Json output.
+    Json,
+    /// Wide (Human readable table with extra attributes). Note: this has
+    /// effect only in list operations.
+    Wide,
+}
+
+/// Table arrangement.
+#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, ValueEnum)]
+pub enum TableArrangement {
+    /// Dynamically determine the width of columns in regard to terminal width and content length.
+    /// With this mode, the content in cells will wrap dynamically to get the the best column
+    /// layout for the given content.
+    #[default]
+    Dynamic,
+    /// This is mode is the same as the `Dynamic` arrangement, but it will always use as much space
+    /// as it’s given. Any surplus space will be distributed between all columns.
+    DynamicFullWidth,
+    /// Don’t do any content arrangement. Tables with this mode might become wider than your output
+    /// and look ugly.
+    Disabled,
+}
+
+/// Output shell completion code for the specified shell (bash, zsh, fish, or powershell). The
+/// shell code must be evaluated to provide interactive completion of `osc` commands.  This can
+/// be done by sourcing it from the .bash_profile.
+///
+/// Examples:
+///
+///  Enable completion at a shell start:
+///
+/// `echo 'source <(osc completion bash)' >>~/.bashrc`
+///
+#[derive(Parser, Debug)]
+pub struct CompletionCommand {
+    /// If provided, outputs the completion file for given shell.
+    #[arg(default_value_t = Shell::Bash)]
+    pub shell: Shell,
+}