Expose two more node-specific commands under 'nodes'

Author: michaelklishin

CHANGELOG.md

@@ -4,10 +4,13 @@
 
 ### Enhancements
 
- * `vhosts` is a new command group that aggregates all the existing
-   commands directly related to virtual hosts: `list vhosts`, `declare vhost`, `delete vhost`
+ * `vhosts` is a new command group for operations on virtual hosts
+ * `nodes` is a new command group for operations on nodes 
 
- * `nodes` is a new command group for operations on nodes: `nodes list`
+### Bug Fixes
+
+ * Both `-h` and `--help` now display relevant doc guide URLs.
+   Previously it was only the case for `--help`.
 
 
 ## v2.0.0 (Mar 31, 2024)

src/cli.rs

@@ -1591,15 +1591,46 @@ pub fn deprecated_features_subcommands(pre_flight_settings: PreFlightSettings) -
         .map(|cmd| cmd.infer_long_args(pre_flight_settings.infer_long_options))
 }
 
-pub fn nodes_subcommands(pre_flight_settings: PreFlightSettings) -> [Command; 1] {
+pub fn nodes_subcommands(pre_flight_settings: PreFlightSettings) -> [Command; 3] {
     let list_cmd = Command::new("list")
         .long_about("Lists cluster nodes")
         .after_help(color_print::cformat!(
             "<bold>Doc guide</bold>: {}",
             CLUSTERING_GUIDE_URL
         ));
 
-    [list_cmd].map(|cmd| cmd.infer_long_args(pre_flight_settings.infer_long_options))
+    let memory_breakdown_in_bytes_cmd = Command::new("memory_breakdown_in_bytes")
+        .about("Provides a memory footprint breakdown (in bytes) for the target node")
+        .arg(
+            Arg::new("node")
+                .long("node")
+                .help("target node, must be a cluster member")
+                .required(true),
+        )
+        .after_help(color_print::cformat!(
+            "<bold>Doc guide:</bold>: {}",
+            MEMORY_FOOTPRINT_GUIDE_URL
+        ));
+
+    let memory_breakdown_in_percent_cmd = Command::new("memory_breakdown_in_percent")
+        .about("Provides a memory footprint breakdown (in percent) for the target node")
+        .arg(
+            Arg::new("node")
+                .long("node")
+                .help("target node, must be a cluster member")
+                .required(true),
+        )
+        .after_help(color_print::cformat!(
+            "<bold>Doc guide:</bold>: {}",
+            MEMORY_FOOTPRINT_GUIDE_URL
+        ));
+
+    [
+        list_cmd,
+        memory_breakdown_in_percent_cmd,
+        memory_breakdown_in_bytes_cmd,
+    ]
+    .map(|cmd| cmd.infer_long_args(pre_flight_settings.infer_long_options))
 }
 
 pub fn vhosts_subcommands(pre_flight_settings: PreFlightSettings) -> [Command; 3] {

src/main.rs

@@ -291,14 +291,14 @@ fn dispatch_common_subcommand(
             println!("Using endpoint: {}", endpoint);
             res_handler.no_output_on_success(Ok(()))
         }
-        ("show", "memory_breakdown_in_bytes") => {
-            let result = commands::show_memory_breakdown(client, second_level_args);
-            res_handler.memory_breakdown_in_bytes_result(result)
-        }
         ("show", "memory_breakdown_in_percent") => {
             let result = commands::show_memory_breakdown(client, second_level_args);
             res_handler.memory_breakdown_in_percent_result(result)
         }
+        ("show", "memory_breakdown_in_bytes") => {
+            let result = commands::show_memory_breakdown(client, second_level_args);
+            res_handler.memory_breakdown_in_bytes_result(result)
+        }
 
         ("list", "nodes") => {
             let result = commands::list_nodes(client);
@@ -492,6 +492,14 @@ fn dispatch_common_subcommand(
             let result = commands::list_nodes(client);
             res_handler.tabular_result(result)
         }
+        ("nodes", "memory_breakdown_in_percent") => {
+            let result = commands::show_memory_breakdown(client, second_level_args);
+            res_handler.memory_breakdown_in_percent_result(result)
+        }
+        ("nodes", "memory_breakdown_in_bytes") => {
+            let result = commands::show_memory_breakdown(client, second_level_args);
+            res_handler.memory_breakdown_in_bytes_result(result)
+        }
         ("purge", "queue") => {
             let result = commands::purge_queue(client, &vhost, second_level_args);
             res_handler.no_output_on_success(result);

tests/memory_breakdown_tests.rs

@@ -17,7 +17,7 @@ mod test_helpers;
 use crate::test_helpers::*;
 
 #[test]
-fn test_memory_breakdown_in_bytes_succeeds() -> Result<(), Box<dyn std::error::Error>> {
+fn test_show_memory_breakdown_in_bytes_succeeds() -> Result<(), Box<dyn std::error::Error>> {
     let rc = api_client();
     let nodes = rc.list_nodes()?;
     let first = nodes.first().unwrap();
@@ -39,7 +39,7 @@ fn test_memory_breakdown_in_bytes_succeeds() -> Result<(), Box<dyn std::error::E
 }
 
 #[test]
-fn test_memory_breakdown_in_percent_succeeds() -> Result<(), Box<dyn std::error::Error>> {
+fn test_show_memory_breakdown_in_percent_succeeds() -> Result<(), Box<dyn std::error::Error>> {
     let rc = api_client();
     let nodes = rc.list_nodes()?;
     let first = nodes.first().unwrap();

tests/nodes_tests.rs

@@ -24,3 +24,47 @@ fn test_list_nodes() -> Result<(), Box<dyn std::error::Error>> {
 
     Ok(())
 }
+
+#[test]
+fn test_nodes_memory_breakdown_in_bytes_succeeds() -> Result<(), Box<dyn std::error::Error>> {
+    let rc = api_client();
+    let nodes = rc.list_nodes()?;
+    let first = nodes.first().unwrap();
+
+    run_succeeds([
+        "nodes",
+        "memory_breakdown_in_bytes",
+        "--node",
+        first.name.as_str(),
+    ])
+    .stdout(
+        predicates::str::contains("Allocated but unused")
+            .and(predicates::str::contains("Quorum queue ETS tables"))
+            .and(predicates::str::contains("Client connections"))
+            .and(predicates::str::contains("Metadata store")),
+    );
+
+    Ok(())
+}
+
+#[test]
+fn test_nodes_memory_breakdown_in_percent_succeeds() -> Result<(), Box<dyn std::error::Error>> {
+    let rc = api_client();
+    let nodes = rc.list_nodes()?;
+    let first = nodes.first().unwrap();
+
+    run_succeeds([
+        "nodes",
+        "memory_breakdown_in_bytes",
+        "--node",
+        first.name.as_str(),
+    ])
+    .stdout(
+        predicates::str::contains("Allocated but unused")
+            .and(predicates::str::contains("Quorum queue ETS tables"))
+            .and(predicates::str::contains("Client connections"))
+            .and(predicates::str::contains("Metadata store")),
+    );
+
+    Ok(())
+}