'definitions export_from_vhost' now supports --transformations

Closes #82.

Author: michaelklishin

src/cli.rs

@@ -2253,6 +2253,41 @@ Examples:
                 .num_args(0)
                 .action(ArgAction::SetTrue)
                 .conflicts_with("file"),
+        )
+        .arg(
+            Arg::new("transformations")
+                .long("transformations")
+                .short('t')
+                .long_help(
+                    r#"
+A comma-separated list of names of the definition transformations to apply.
+
+Supported transformations:
+
+ * no_op
+ * prepare_for_quorum_queue_migration
+ * strip_cmq_keys_from_policies
+ * drop_empty_policies
+ * obfuscate_usernames
+ * exclude_users
+ * exclude_permissions
+ * exclude_runtime_parameters
+ * exclude_policies
+
+Examples:
+
+ * --transformations prepare_for_quorum_queue_migration,drop_empty_policies
+ * --transformations strip_cmq_keys_from_policies,drop_empty_policies
+ * --transformations exclude_users,exclude_permissions
+ * --transformations obfuscate_usernames
+ * --transformations exclude_runtime_parameters,exclude_policies
+ * --transformations no_op
+                "#,
+                )
+                .num_args(1..)
+                .value_delimiter(',')
+                .action(ArgAction::Append)
+                .required(false),
         );
 
     let import_cmd = Command::new("import")

src/commands.rs

@@ -33,7 +33,7 @@ use rabbitmq_http_client::requests::{
     RuntimeParameterDefinition,
 };
 use rabbitmq_http_client::responses::OptionalArgumentSourceOps;
-use rabbitmq_http_client::transformers::TransformationChain;
+use rabbitmq_http_client::transformers::{TransformationChain, VirtualHostTransformationChain};
 use rabbitmq_http_client::{password_hashing, requests, responses};
 use serde::de::DeserializeOwned;
 use serde_json::Value;
@@ -1638,7 +1638,54 @@ pub fn export_vhost_definitions(
     client: APIClient,
     vhost: &str,
     command_args: &ArgMatches,
-) -> ClientResult<()> {
+) -> Result<(), CommandRunError> {
+    let transformations = command_args
+        .get_many::<String>("transformations")
+        .unwrap_or_default();
+
+    if transformations.len() == 0 {
+        export_vhost_definitions_without_transformations(client, vhost, command_args)
+    } else {
+        let transformations = transformations.map(String::from).collect();
+
+        export_and_transform_vhost_definitions(client, vhost, command_args, transformations)
+    }
+}
+
+fn export_and_transform_vhost_definitions(
+    client: APIClient,
+    vhost: &str,
+    command_args: &ArgMatches,
+    transformations: Vec<String>,
+) -> Result<(), CommandRunError> {
+    match client.export_vhost_definitions_as_data(vhost) {
+        Ok(mut defs0) => {
+            let chain = VirtualHostTransformationChain::from(transformations);
+            chain.apply(&mut defs0);
+
+            let json = serde_json::to_string_pretty(&defs0).unwrap();
+
+            let path = command_args.get_one::<String>("file").unwrap();
+            match path.as_str() {
+                "-" => {
+                    println!("{}", &json);
+                    Ok(())
+                }
+                file => {
+                    fs::write(file, &json)?;
+                    Ok(())
+                }
+            }
+        }
+        Err(err) => Err(err.into()),
+    }
+}
+
+fn export_vhost_definitions_without_transformations(
+    client: APIClient,
+    vhost: &str,
+    command_args: &ArgMatches,
+) -> Result<(), CommandRunError> {
     match client.export_vhost_definitions(vhost) {
         Ok(definitions) => {
             let path = command_args.get_one::<String>("file").unwrap();
@@ -1648,12 +1695,12 @@ pub fn export_vhost_definitions(
                     Ok(())
                 }
                 file => {
-                    _ = fs::write(file, &definitions);
+                    fs::write(file, &definitions)?;
                     Ok(())
                 }
             }
         }
-        Err(err) => Err(err),
+        Err(err) => Err(err.into()),
     }
 }
 

src/main.rs

@@ -517,8 +517,7 @@ fn dispatch_common_subcommand(
             res_handler.no_output_on_success(result);
         }
         ("definitions", "export_from_vhost") => {
-            let result = commands::export_vhost_definitions(client, &vhost, second_level_args)
-                .map_err(Into::into);
+            let result = commands::export_vhost_definitions(client, &vhost, second_level_args);
             res_handler.no_output_on_success(result);
         }
         ("definitions", "import") => {

tests/definitions_export_tests.rs

@@ -78,15 +78,62 @@ fn test_export_cluster_wide_definitions_with_transformations_case1()
 
     run_succeeds(["--vhost", vh, "definitions", "export"]).stdout(predicate::str::contains(p1));
     // These two cannot be tested on 4.x: empty definitions will be rejected
-    // by validation and CMQ keys are no longer recognized as known/valid.
+    // by validation, and CMQ keys are no longer recognized as known/valid.
     // But at least we can test the code path this way.
     run_succeeds([
         "--vhost",
         vh,
         "definitions",
         "export",
         "--transformations",
-        "strip_cmq_keys_from_policies,drop_empty_policies",
+        "prepare_for_quorum_queue_migration,strip_cmq_keys_from_policies,drop_empty_policies",
+    ])
+    .stdout(predicate::str::contains(p1));
+
+    delete_vhost(vh).expect("failed to delete a virtual host");
+
+    Ok(())
+}
+
+#[test]
+fn test_export_vhost_definitions_with_transformations_case1()
+-> Result<(), Box<dyn std::error::Error>> {
+    let vh = "test_export_vhost_definitions.transformations.1";
+    delete_vhost(vh).expect("failed to delete a virtual host");
+    run_succeeds(["declare", "vhost", "--name", vh]);
+
+    let p1 = "test_export_vhost_definitions.transformations.1";
+    run_succeeds([
+        "--vhost",
+        vh,
+        "declare",
+        "policy",
+        "--name",
+        p1,
+        "--pattern",
+        "^matching\\..+",
+        "--apply-to",
+        "classic_queues",
+        "--priority",
+        "10",
+        "--definition",
+        "{\"max-length\": 10}",
+    ]);
+
+    let q = "qq.test_export_vhost_definitions.transformations.1";
+    run_succeeds([
+        "-V", vh, "declare", "queue", "--name", q, "--type", "quorum",
+    ]);
+
+    run_succeeds(["--vhost", vh, "definitions", "export_from_vhost"])
+        .stdout(predicate::str::contains(p1));
+    run_succeeds([
+        "--vhost",
+        vh,
+        "definitions",
+        "export_from_vhost",
+        "--transformations",
+        "prepare_for_quorum_queue_migration,strip_cmq_keys_from_policies,drop_empty_policies",
     ])
     .stdout(predicate::str::contains(p1));