[eclipse-iceoryx#98] Make CLI tools a single easy-to-install crate

orecham · Sep 21, 2024 · 7248091 · 7248091
1 parent 0f78951
commit 7248091
Show file tree

Hide file tree

Showing 18 changed files with 56 additions and 119 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -22,10 +22,7 @@ members = [
     "iceoryx2-pal/posix/",
     "iceoryx2-pal/configuration/",
 
-    "iceoryx2-cli/iox2",
-    "iceoryx2-cli/iox2-node",
-    "iceoryx2-cli/iox2-service",
-    "iceoryx2-cli/utils",
+    "iceoryx2-cli",
 
     "examples",
 
@@ -62,15 +59,15 @@ iceoryx2-pal-concurrency-sync = { version = "0.3.0", path = "iceoryx2-pal/concur
 iceoryx2-pal-posix = { version = "0.3.0", path = "iceoryx2-pal/posix/" }
 iceoryx2-pal-configuration = { version = "0.3.0", path = "iceoryx2-pal/configuration/" }
 
-iceoryx2-cli-utils = { version = "0.3.0", path = "iceoryx2-cli/utils/" }
-
 iceoryx2-cal = { version = "0.3.0", path = "iceoryx2-cal" }
 
 iceoryx2-ffi = { version = "0.3.0", path = "iceoryx2-ffi/ffi" }
 iceoryx2-ffi-macros = { version = "0.3.0", path = "iceoryx2-ffi/ffi-macros" }
 
 iceoryx2 = { version = "0.3.0", path = "iceoryx2/" }
 
+iceoryx2-cli = { version = "0.3.0", path = "iceoryx2_cli/"}
+
 anyhow = { version = "1.0.86" }
 bindgen = { version = "0.69.4" }
 bitflags = { version = "2.5.0" }

diff --git a/iceoryx2-cli/iox2/Cargo.toml → iceoryx2-cli/Cargo.toml b/iceoryx2-cli/iox2/Cargo.toml → iceoryx2-cli/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
-name = "iox2"
-description = "CLI entry-point"
+name = "iceoryx2-cli"
+description = "CLI tools for iceoryx2"
+
 categories = { workspace = true }
 edition = { workspace = true }
 homepage = { workspace = true }
@@ -10,15 +11,40 @@ repository = { workspace = true }
 rust-version = { workspace = true }
 version = { workspace = true }
 
+[package.metadata]
+default-run = "iox2"
+
+[[bin]]
+name = "iox2"
+path = "iox2/src/main.rs"
+
+[[bin]]
+name = "iox2-node"
+path = "iox2-node/src/main.rs"
+
+[[bin]]
+name = "iox2-service"
+path = "iox2-service/src/main.rs"
+
+[lib]
+name = "iceoryx2_cli"
+path = "lib/src/lib.rs"
+
 [dependencies]
-iceoryx2-cli-utils = { workspace = true }
+iceoryx2 = { workspace = true }
+iceoryx2-bb-log = { workspace = true }
+iceoryx2-pal-posix = {workspace = true}
 
 anyhow = { workspace = true }
 better-panic = { workspace = true }
-colored = { workspace = true }
+cargo_metadata = { workspace = true }
 clap = { workspace = true }
+colored = { workspace = true }
 human-panic = { workspace = true }
-cargo_metadata = { workspace = true }
+serde = { workspace = true }
+serde_yaml = { workspace = true }
+serde_json = { workspace = true }
+ron = { workspace = true }
 
 [dev-dependencies]
 iceoryx2-bb-testing = { workspace = true }

diff --git a/iceoryx2-cli/iox2-node/Cargo.toml b/iceoryx2-cli/iox2-node/Cargo.toml
diff --git a/iceoryx2-cli/iox2-node/src/cli.rs b/iceoryx2-cli/iox2-node/src/cli.rs
@@ -17,19 +17,19 @@ use clap::Parser;
 use clap::Subcommand;
 use clap::ValueEnum;
 
-use iceoryx2_cli_utils::help_template;
-use iceoryx2_cli_utils::Format;
+use iceoryx2_cli::help_template;
+use iceoryx2_cli::Format;
 use iceoryx2_pal_posix::posix::pid_t;
 
 #[derive(Parser)]
 #[command(
-    name = "iox2-nodes",
+    name = "iox2-node",
     about = "Query information about iceoryx2 nodes",
     long_about = None,
     version = env!("CARGO_PKG_VERSION"),
     disable_help_subcommand = true,
     arg_required_else_help = false,
-    help_template = help_template("iox2-nodes", false),
+    help_template = help_template("iox2 node", false),
 )]
 pub struct Cli {
     #[clap(subcommand)]

diff --git a/iceoryx2-cli/iox2-node/src/commands.rs b/iceoryx2-cli/iox2-node/src/commands.rs
@@ -12,11 +12,11 @@
 
 use anyhow::{Context, Error, Result};
 use iceoryx2::prelude::*;
-use iceoryx2_cli_utils::output::NodeDescription;
-use iceoryx2_cli_utils::output::NodeDescriptor;
-use iceoryx2_cli_utils::output::NodeList;
-use iceoryx2_cli_utils::Filter;
-use iceoryx2_cli_utils::Format;
+use iceoryx2_cli::output::NodeDescription;
+use iceoryx2_cli::output::NodeDescriptor;
+use iceoryx2_cli::output::NodeList;
+use iceoryx2_cli::Filter;
+use iceoryx2_cli::Format;
 
 use crate::cli::NodeIdentifier;
 use crate::cli::OutputFilter;

diff --git a/iceoryx2-cli/iox2-node/src/filter.rs b/iceoryx2-cli/iox2-node/src/filter.rs
@@ -16,8 +16,8 @@ use crate::cli::StateFilter;
 use iceoryx2::node::NodeState;
 use iceoryx2::node::NodeView;
 use iceoryx2::service::ipc::Service;
-use iceoryx2_cli_utils::output::NodeIdString;
-use iceoryx2_cli_utils::Filter;
+use iceoryx2_cli::output::NodeIdString;
+use iceoryx2_cli::Filter;
 
 impl Filter<NodeState<Service>> for NodeIdentifier {
     fn matches(&self, node: &NodeState<Service>) -> bool {

diff --git a/iceoryx2-cli/iox2-service/Cargo.toml b/iceoryx2-cli/iox2-service/Cargo.toml
diff --git a/iceoryx2-cli/iox2-service/src/cli.rs b/iceoryx2-cli/iox2-service/src/cli.rs
@@ -15,18 +15,18 @@ use clap::Parser;
 use clap::Subcommand;
 use clap::ValueEnum;
 
-use iceoryx2_cli_utils::help_template;
-use iceoryx2_cli_utils::Format;
+use iceoryx2_cli::help_template;
+use iceoryx2_cli::Format;
 
 #[derive(Parser)]
 #[command(
-    name = "iox2-services",
+    name = "iox2-service",
     about = "Query information about iceoryx2 services",
     long_about = None,
     version = env!("CARGO_PKG_VERSION"),
     disable_help_subcommand = true,
     arg_required_else_help = false,
-    help_template = help_template("iox2-services", false),
+    help_template = help_template("iox2 service", false),
 )]
 pub struct Cli {
     #[clap(subcommand)]

diff --git a/iceoryx2-cli/iox2-service/src/commands.rs b/iceoryx2-cli/iox2-service/src/commands.rs
@@ -12,11 +12,11 @@
 
 use anyhow::{Context, Error, Result};
 use iceoryx2::prelude::*;
-use iceoryx2_cli_utils::output::ServiceDescription;
-use iceoryx2_cli_utils::output::ServiceDescriptor;
-use iceoryx2_cli_utils::output::ServiceList;
-use iceoryx2_cli_utils::Filter;
-use iceoryx2_cli_utils::Format;
+use iceoryx2_cli::output::ServiceDescription;
+use iceoryx2_cli::output::ServiceDescriptor;
+use iceoryx2_cli::output::ServiceList;
+use iceoryx2_cli::Filter;
+use iceoryx2_cli::Format;
 
 use crate::cli::OutputFilter;
 

diff --git a/iceoryx2-cli/iox2-service/src/filter.rs b/iceoryx2-cli/iox2-service/src/filter.rs
@@ -15,7 +15,7 @@ use crate::cli::OutputFilter;
 use iceoryx2::service::ipc::Service;
 use iceoryx2::service::static_config::messaging_pattern::MessagingPattern;
 use iceoryx2::service::ServiceDetails;
-use iceoryx2_cli_utils::Filter;
+use iceoryx2_cli::Filter;
 
 impl Filter<ServiceDetails<Service>> for MessagingPatternFilter {
     fn matches(&self, service: &ServiceDetails<Service>) -> bool {

diff --git a/iceoryx2-cli/iox2/src/cli.rs b/iceoryx2-cli/iox2/src/cli.rs
@@ -12,7 +12,7 @@
 
 use clap::Parser;
 
-use iceoryx2_cli_utils::help_template;
+use iceoryx2_cli::help_template;
 
 #[derive(Parser, Debug)]
 #[command(

diff --git a/iceoryx2-cli/iox2/src/lib.rs b/iceoryx2-cli/iox2/src/lib.rs
diff --git a/iceoryx2-cli/utils/src/cli.rs → iceoryx2-cli/lib/src/cli.rs b/iceoryx2-cli/utils/src/cli.rs → iceoryx2-cli/lib/src/cli.rs
diff --git a/iceoryx2-cli/utils/src/filter.rs → iceoryx2-cli/lib/src/filter.rs b/iceoryx2-cli/utils/src/filter.rs → iceoryx2-cli/lib/src/filter.rs
diff --git a/iceoryx2-cli/utils/src/format.rs → iceoryx2-cli/lib/src/format.rs b/iceoryx2-cli/utils/src/format.rs → iceoryx2-cli/lib/src/format.rs
diff --git a/iceoryx2-cli/utils/src/lib.rs → iceoryx2-cli/lib/src/lib.rs b/iceoryx2-cli/utils/src/lib.rs → iceoryx2-cli/lib/src/lib.rs
diff --git a/iceoryx2-cli/utils/src/output.rs → iceoryx2-cli/lib/src/output.rs b/iceoryx2-cli/utils/src/output.rs → iceoryx2-cli/lib/src/output.rs
diff --git a/iceoryx2-cli/utils/Cargo.toml b/iceoryx2-cli/utils/Cargo.toml