New command: 'policies declare_blanket'

Author: michaelklishin

Cargo.lock

@@ -1775,7 +1775,7 @@ fn operator_policies_subcommands(pre_flight_settings: PreFlightSettings) -> [Com
     .map(|cmd| cmd.infer_long_args(pre_flight_settings.infer_long_options))
 }
 
-fn policies_subcommands(pre_flight_settings: PreFlightSettings) -> [Command; 11] {
+fn policies_subcommands(pre_flight_settings: PreFlightSettings) -> [Command; 12] {
     let declare_cmd = Command::new("declare")
         .visible_aliases(vec!["update", "set"])
         .about("Creates or updates a policy")
@@ -1834,6 +1834,30 @@ fn policies_subcommands(pre_flight_settings: PreFlightSettings) -> [Command; 11]
                 .help("additional definitions to merge into the new overriding policy"),
         );
 
+    let declare_blanket_cmd = Command::new("declare_blanket")
+        .about("Creates a low priority blanket policy, a policy that matches all objects not matched by any other policy")
+        .after_help(color_print::cformat!("<bold>Doc guide:</bold>: {}", POLICY_GUIDE_URL))
+        .arg(
+            Arg::new("name")
+                .long("name")
+                .help("blanket policy name")
+                .required(true),
+        )
+        .arg(
+            Arg::new("apply_to")
+                .long("apply-to")
+                .alias("applies-to")
+                .help("entities to apply to (queues, classic_queues, quorum_queues, streams, exchanges, all)")
+                .value_parser(value_parser!(PolicyTarget))
+                .required(true),
+        )
+        .arg(
+            Arg::new("definition")
+                .long("definition")
+                .help("policy definition")
+                .required(true),
+        );
+
     let list_cmd = Command::new("list")
         .long_about("Lists policies")
         .after_help(color_print::cformat!(
@@ -1948,6 +1972,7 @@ fn policies_subcommands(pre_flight_settings: PreFlightSettings) -> [Command; 11]
     [
         declare_cmd,
         declare_override_cmd,
+        declare_blanket_cmd,
         delete_cmd,
         delete_definition_key_cmd,
         delete_definition_key_from_all_in_cmd,

src/cli.rs

@@ -31,6 +31,7 @@ use std::fs;
 use std::io;
 use std::process;
 
+use crate::constants::DEFAULT_BLANKET_POLICY_PRIORITY;
 use rabbitmq_http_client::commons::BindingDestinationType;
 use rabbitmq_http_client::commons::QueueType;
 use rabbitmq_http_client::responses::PolicyDefinitionOps;
@@ -1096,6 +1097,49 @@ pub fn declare_policy_override(
     client.declare_policy(&params)
 }
 
+pub fn declare_blanket_policy(
+    client: APIClient,
+    vhost: &str,
+    command_args: &ArgMatches,
+) -> ClientResult<()> {
+    // find the lowest policy priority in the target virtual host
+    let existing_policies = client.list_policies_in(vhost)?;
+    let min_priority = existing_policies
+        .iter()
+        .fold(0, |acc, p| if p.priority < acc { p.priority } else { acc });
+
+    // blanket policy priority should be the lowest in the virtual host
+    let priority = [min_priority - 1, DEFAULT_BLANKET_POLICY_PRIORITY]
+        .iter()
+        .min()
+        .cloned()
+        .unwrap();
+
+    let name = command_args.get_one::<String>("name").cloned().unwrap();
+    let apply_to = command_args
+        .get_one::<PolicyTarget>("apply_to")
+        .cloned()
+        .unwrap();
+    let definition = command_args.get_one::<String>("definition").unwrap();
+
+    let parsed_definition = serde_json::from_str::<requests::PolicyDefinition>(definition)
+        .unwrap_or_else(|err| {
+            eprintln!("`{}` is not a valid JSON: {}", definition, err);
+            process::exit(1);
+        });
+
+    let params = requests::PolicyParams {
+        vhost,
+        name: &name,
+        pattern: ".*",
+        apply_to,
+        priority: priority as i32,
+        definition: parsed_definition,
+    };
+
+    client.declare_policy(&params)
+}
+
 pub fn update_policy_definition(
     client: APIClient,
     vhost: &str,

src/commands.rs

@@ -34,3 +34,5 @@ pub const DEFAULT_CONFIG_FILE_PATH: &str = "~/.rabbitmqadmin.conf";
 pub const DEFAULT_CONFIG_SECTION_NAME: &str = "default";
 
 pub const TANZU_COMMAND_PREFIX: &str = "tanzu";
+
+pub const DEFAULT_BLANKET_POLICY_PRIORITY: i16 = -20;

src/constants.rs

@@ -737,6 +737,10 @@ fn dispatch_common_subcommand(
             let result = commands::declare_policy_override(client, &vhost, second_level_args);
             res_handler.no_output_on_success(result);
         }
+        ("policies", "declare_blanket") => {
+            let result = commands::declare_blanket_policy(client, &vhost, second_level_args);
+            res_handler.no_output_on_success(result);
+        }
         ("policies", "delete") => {
             let result = commands::delete_policy(client, &vhost, second_level_args);
             res_handler.no_output_on_success(result);

src/main.rs

@@ -646,3 +646,36 @@ fn test_policies_declare_override() -> Result<(), Box<dyn std::error::Error>> {
 
     Ok(())
 }
+
+#[test]
+fn test_policies_declare_blanket() -> Result<(), Box<dyn std::error::Error>> {
+    let policy_name = "test_policies_declare_blanket.1";
+
+    run_succeeds([
+        "policies",
+        "declare_blanket",
+        "--name",
+        policy_name,
+        "--apply-to",
+        "queues",
+        "--definition",
+        "{\"max-length\": 787876}",
+    ]);
+
+    run_succeeds(["policies", "list"]).stdout(
+        predicate::str::contains(policy_name)
+            // default blanket policy priority
+            .and(predicate::str::contains("787876")),
+    );
+
+    let client = api_client();
+    let pol = client.get_policy("/", policy_name).unwrap();
+
+    assert_eq!(pol.pattern, ".*");
+    assert!(pol.priority < 0);
+
+    run_succeeds(["delete", "policy", "--name", policy_name]);
+    run_succeeds(["policies", "list"]).stdout(predicate::str::contains(policy_name).not());
+
+    Ok(())
+}