Breaking change: use --snake-case for arguments

unlike the original rabbitmqadmin v1, which
used --lower_case.

That is, with this change, --auto_delete becomes
--auto-delete on the command line.

--snake-case is more typical than --lower_case,
at least that's how I see it.

Author: michaelklishin

README.md

@@ -195,7 +195,7 @@ rabbitmqadmin --vhost "events" declare queue --name "target.stream.name" --type
 ```
 
 ```shell
-rabbitmqadmin --vhost "events" declare queue --name "target.classic.queue.name" --type "classic" --durable false --auto_delete true
+rabbitmqadmin --vhost "events" declare queue --name "target.classic.queue.name" --type "classic" --durable false --auto-delete true
 ```
 
 ### Delete a queue

src/cli.rs

@@ -347,7 +347,7 @@ fn declare_subcommands() -> [Command; 11] {
             .arg(
                 Arg::new("password_hash")
                     .help("salted password hash, see https://rabbitmq.com/docs/passwords")
-                    .long("password_hash")
+                    .long("password-hash")
                     .required(false)
                     .default_value(""),
             )
@@ -439,7 +439,7 @@ fn declare_subcommands() -> [Command; 11] {
             )
             .arg(
                 Arg::new("auto_delete")
-                    .long("auto_delete")
+                    .long("auto-delete")
                     .help("should it be deleted when the last consumer disconnects")
                     .required(false)
                     .value_parser(clap::value_parser!(bool)),
@@ -477,7 +477,7 @@ fn declare_subcommands() -> [Command; 11] {
             )
             .arg(
                 Arg::new("auto_delete")
-                    .long("auto_delete")
+                    .long("auto-delete")
                     .help("should it be deleted when the last queue is unbound")
                     .required(false)
                     .value_parser(clap::value_parser!(bool)),
@@ -501,7 +501,7 @@ fn declare_subcommands() -> [Command; 11] {
             )
             .arg(
                 Arg::new("destination_type")
-                    .long("destination_type")
+                    .long("destination-type")
                     .help("destination type: exchange or queue")
                     .required(true)
                     .value_parser(clap::value_parser!(BindingDestinationType)),
@@ -514,7 +514,7 @@ fn declare_subcommands() -> [Command; 11] {
             )
             .arg(
                 Arg::new("routing_key")
-                    .long("routing_key")
+                    .long("routing-key")
                     .help("routing key")
                     .required(true),
             )
@@ -560,7 +560,7 @@ fn declare_subcommands() -> [Command; 11] {
                     .required(true),
             )
             .arg(
-                Arg::new("apply-to")
+                Arg::new("apply_to")
                     .long("apply-to")
                     .help("entities to apply to (queues, classic_queues, quorum_queues, streams, exchanges, all)")
                     .required(true),
@@ -594,7 +594,7 @@ fn declare_subcommands() -> [Command; 11] {
                     .required(true),
             )
             .arg(
-                Arg::new("apply-to")
+                Arg::new("apply_to")
                     .long("apply-to")
                     .help("entities to apply to (queues, classic_queues, quorum_queues, streams, exchanges, all)")
                     .required(true),
@@ -736,7 +736,7 @@ fn delete_subcommands() -> [Command; 11] {
             )
             .arg(
                 Arg::new("destination_type")
-                    .long("destination_type")
+                    .long("destination-type")
                     .help("destination type: exchange or queue")
                     .required(true),
             )
@@ -748,7 +748,7 @@ fn delete_subcommands() -> [Command; 11] {
             )
             .arg(
                 Arg::new("routing_key")
-                    .long("routing_key")
+                    .long("routing-key")
                     .help("routing key")
                     .required(true),
             )
@@ -918,7 +918,7 @@ pub fn publish_subcommands() -> [Command; 1] {
     [Command::new("message")
         .about("Publishes a message to an exchange")
         .arg(
-            Arg::new("routing-key")
+            Arg::new("routing_key")
                 .short('k')
                 .long("routing-key")
                 .required(false)
@@ -970,7 +970,7 @@ pub fn get_subcommands() -> [Command; 1] {
                 .help("Maximum number of messages to consume"),
         )
         .arg(
-            Arg::new("ack-mode")
+            Arg::new("ack_mode")
                 .short('a')
                 .long("ack-mode")
                 .required(false)

src/commands.rs

@@ -319,7 +319,7 @@ pub fn declare_user(client: APIClient, command_args: &ArgMatches) -> ClientResul
     if password.is_empty() && provided_hash.is_empty()
         || !password.is_empty() && !provided_hash.is_empty()
     {
-        eprintln!("Please provide either --password or --password_hash");
+        eprintln!("Please provide either --password or --password-hash");
         process::exit(1)
     }
 
@@ -617,7 +617,7 @@ pub fn publish_message(
     command_args: &ArgMatches,
 ) -> ClientResult<responses::MessageRouted> {
     let exchange = command_args.get_one::<String>("exchange").unwrap();
-    let routing_key = command_args.get_one::<String>("routing-key").unwrap();
+    let routing_key = command_args.get_one::<String>("routing_key").unwrap();
     let payload = command_args.get_one::<String>("payload").unwrap();
     let properties = command_args.get_one::<String>("properties").unwrap();
     let parsed_properties = serde_json::from_str::<requests::MessageProperties>(properties)
@@ -636,6 +636,6 @@ pub fn get_messages(
 ) -> ClientResult<Vec<responses::GetMessage>> {
     let queue = command_args.get_one::<String>("queue").unwrap();
     let count = command_args.get_one::<String>("count").unwrap();
-    let ack_mode = command_args.get_one::<String>("ack-mode").unwrap();
+    let ack_mode = command_args.get_one::<String>("ack_mode").unwrap();
     client.get_messages(vhost, queue, count.parse::<u32>().unwrap(), ack_mode)
 }

tests/combined_integration_tests.rs

@@ -123,7 +123,7 @@ fn combined_integration_test4() -> Result<(), Box<dyn std::error::Error>> {
         "fanout",
         "--durable",
         "true",
-        "--auto_delete",
+        "--auto-delete",
         "false",
     ]);
     run_succeeds([
@@ -141,7 +141,7 @@ fn combined_integration_test4() -> Result<(), Box<dyn std::error::Error>> {
         "quorum",
         "--durable",
         "true",
-        "--auto_delete",
+        "--auto-delete",
         "false",
     ]);
     run_succeeds([
@@ -159,7 +159,7 @@ fn combined_integration_test4() -> Result<(), Box<dyn std::error::Error>> {
         "quorum",
         "--durable",
         "true",
-        "--auto_delete",
+        "--auto-delete",
         "false",
     ]);
     run_succeeds([
@@ -173,11 +173,11 @@ fn combined_integration_test4() -> Result<(), Box<dyn std::error::Error>> {
         "binding",
         "--source",
         x,
-        "--destination_type",
+        "--destination-type",
         "queue",
         "--destination",
         q,
-        "--routing_key",
+        "--routing-key",
         "rk",
     ]);
 
@@ -194,11 +194,11 @@ fn combined_integration_test4() -> Result<(), Box<dyn std::error::Error>> {
         "binding",
         "--source",
         x,
-        "--destination_type",
+        "--destination-type",
         "queue",
         "--destination",
         q,
-        "--routing_key",
+        "--routing-key",
         "rk",
     ]);
     run_succeeds(["-V", vh, "delete", "exchange", "--name", x]);

tests/list_bindings_tests.rs

@@ -50,11 +50,11 @@ fn test_list_bindings() -> Result<(), Box<dyn std::error::Error>> {
         "binding",
         "--source",
         "amq.direct",
-        "--destination_type",
+        "--destination-type",
         "queue",
         "--destination",
         q1,
-        "--routing_key",
+        "--routing-key",
         "routing_key_queue",
     ]);
 
@@ -66,11 +66,11 @@ fn test_list_bindings() -> Result<(), Box<dyn std::error::Error>> {
         "binding",
         "--source",
         "amq.direct",
-        "--destination_type",
+        "--destination-type",
         "exchange",
         "--destination",
         "amq.topic",
-        "--routing_key",
+        "--routing-key",
         "routing_key_exchange",
     ]);
 

tests/test_commands_recommended_against_tests.rs

@@ -1,4 +1,3 @@
-use std::process::Command;
 // Copyright (C) 2023-2024 RabbitMQ Core Team ([email protected])
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,50 +11,35 @@ use std::process::Command;
 // 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.
-use assert_cmd::prelude::*;
 use predicates::prelude::*;
 
+mod test_helpers;
+use crate::test_helpers::*;
+
 #[test]
 fn test_messages() -> Result<(), Box<dyn std::error::Error>> {
     // declare a new queue
-    let mut cmd = Command::cargo_bin("rabbitmqadmin")?;
-    cmd.arg("declare")
-        .arg("queue")
-        .arg("--name")
-        .arg("publish_consume")
-        .arg("--type")
-        .arg("classic");
-    cmd.assert().success();
+    let q = "publish_consume";
+    run_succeeds(["declare", "queue", "--name", q, "--type", "classic"]);
 
     // publish a message
-    let mut cmd = Command::cargo_bin("rabbitmqadmin")?;
-    cmd.arg("publish")
-        .arg("message")
-        .arg("--routing-key")
-        .arg("publish_consume")
-        .arg("--payload")
-        .arg("test_messages_1")
-        .arg("--properties")
-        .arg("{\"timestamp\": 1234, \"message_id\": \"foo\"}");
-    cmd.assert().success();
+    let payload = "test_messages_1";
+    run_succeeds([
+        "publish",
+        "message",
+        "--routing-key",
+        q,
+        "--payload",
+        payload,
+        "--properties",
+        "{\"timestamp\": 1234, \"message_id\": \"foo\"}",
+    ]);
 
     // consume a message
-    let mut cmd = Command::cargo_bin("rabbitmqadmin")?;
-    cmd.arg("get")
-        .arg("messages")
-        .arg("--queue")
-        .arg("publish_consume");
-    cmd.assert()
-        .success()
-        .stdout(predicate::str::contains("test_messages_1"));
+    run_succeeds(["get", "messages", "--queue", q]).stdout(predicate::str::contains(payload));
 
     // delete the test queue
-    let mut cmd = Command::cargo_bin("rabbitmqadmin")?;
-    cmd.arg("delete")
-        .arg("queue")
-        .arg("--name")
-        .arg("publish_consume");
-    cmd.assert().success();
+    run_succeeds(["delete", "queue", "--name", q]);
 
     Ok(())
 }