rabbitmqadmin 2.31.0

rabbitmqadmin v2 is a modern CLI tool for the RabbitMQ HTTP API
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
// Copyright (C) 2023-2026 RabbitMQ Core Team (teamrabbitmq@gmail.com)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// 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 crate::skip_if_rabbitmq_version_below;
use crate::test_helpers::*;
use std::error::Error;

#[test]
fn test_vhosts_delete_multiple_basic() -> Result<(), Box<dyn Error>> {
    let prefix = "rabbitmqadmin.test-vhosts-delete-multiple-basic";

    // Clean up any existing test vhosts first (only our specific ones)
    delete_vhosts_with_prefix("rabbitmqadmin.test-vhosts-delete-multiple").ok();

    // Create 5 test virtual hosts
    for i in 1..=5 {
        let vh_name = format!("{}-{}", prefix, i);
        run_succeeds(["vhosts", "declare", "--name", &vh_name]);
    }

    // Verify they exist
    let client = api_client();
    let vhosts_before = client.list_vhosts()?;
    let test_vhosts_before: Vec<_> = vhosts_before
        .iter()
        .filter(|vh| vh.name.starts_with(prefix))
        .collect();
    assert_eq!(test_vhosts_before.len(), 5);

    // Delete them using the new command with idempotently flag
    run_succeeds([
        "vhosts",
        "delete_multiple",
        "--name-pattern",
        &format!("{}.*", prefix),
        "--approve",
        "--idempotently",
    ]);

    // Verify they're gone
    let vhosts_after = client.list_vhosts()?;
    let test_vhosts_after: Vec<_> = vhosts_after
        .iter()
        .filter(|vh| vh.name.starts_with(prefix))
        .collect();
    assert_eq!(test_vhosts_after.len(), 0);

    Ok(())
}

#[test]
fn test_vhosts_delete_multiple_dry_run() -> Result<(), Box<dyn Error>> {
    let prefix = "rabbitmqadmin.test-vhosts-delete-multiple-dry-run";

    // Clean up any existing test vhosts first (only our specific ones)
    delete_vhosts_with_prefix("rabbitmqadmin.test-vhosts-delete-multiple").ok();

    // Create 3 test virtual hosts
    for i in 1..=3 {
        let vh_name = format!("{}-{}", prefix, i);
        run_succeeds(["vhosts", "declare", "--name", &vh_name]);
    }

    // Verify they exist
    let client = api_client();
    let vhosts_before = client.list_vhosts()?;
    let test_vhosts_before: Vec<_> = vhosts_before
        .iter()
        .filter(|vh| vh.name.starts_with(prefix))
        .collect();
    assert_eq!(test_vhosts_before.len(), 3);

    // Run dry-run (should not delete anything)
    run_succeeds([
        "vhosts",
        "delete_multiple",
        "--name-pattern",
        &format!("{}.*", prefix),
        "--dry-run",
    ]);

    // Verify they still exist
    let vhosts_after = client.list_vhosts()?;
    let test_vhosts_after: Vec<_> = vhosts_after
        .iter()
        .filter(|vh| vh.name.starts_with(prefix))
        .collect();
    assert_eq!(test_vhosts_after.len(), 3);

    // Clean up
    delete_vhosts_with_prefix("rabbitmqadmin.test-vhosts-delete-multiple").ok();

    Ok(())
}

#[test]
fn test_vhosts_delete_multiple_non_interactive() -> Result<(), Box<dyn Error>> {
    let prefix = "rabbitmqadmin.test-vhosts-delete-multiple-non-interactive";

    // Clean up any existing test vhosts first (only our specific ones)
    delete_vhosts_with_prefix("rabbitmqadmin.test-vhosts-delete-multiple").ok();

    // Create 2 test virtual hosts
    for i in 1..=2 {
        let vh_name = format!("{}-{}", prefix, i);
        run_succeeds(["vhosts", "declare", "--name", &vh_name]);
    }

    // Verify they exist
    let client = api_client();
    let vhosts_before = client.list_vhosts()?;
    let test_vhosts_before: Vec<_> = vhosts_before
        .iter()
        .filter(|vh| vh.name.starts_with(prefix))
        .collect();
    assert_eq!(test_vhosts_before.len(), 2);

    // Delete using non-interactive mode (no --approve needed)
    run_succeeds([
        "--non-interactive",
        "vhosts",
        "delete_multiple",
        "--name-pattern",
        &format!("{}.*", prefix),
        "--idempotently",
    ]);

    // Verify they're gone
    let vhosts_after = client.list_vhosts()?;
    let test_vhosts_after: Vec<_> = vhosts_after
        .iter()
        .filter(|vh| vh.name.starts_with(prefix))
        .collect();
    assert_eq!(test_vhosts_after.len(), 0);

    Ok(())
}

#[test]
fn test_vhosts_delete_multiple_protects_default_vhost() -> Result<(), Box<dyn Error>> {
    let prefix = "rabbitmqadmin.test-vhosts-delete-multiple-protects-default";

    // Clean up any existing test vhosts first (only our specific ones)
    delete_vhosts_with_prefix("rabbitmqadmin.test-vhosts-delete-multiple").ok();

    // Create test virtual hosts
    for i in 1..=2 {
        let vh_name = format!("{}-{}", prefix, i);
        run_succeeds(["vhosts", "declare", "--name", &vh_name]);
    }

    // Verify they exist
    let client = api_client();
    let vhosts_before = client.list_vhosts()?;
    let test_vhosts_before: Vec<_> = vhosts_before
        .iter()
        .filter(|vh| vh.name.starts_with(prefix))
        .collect();
    assert_eq!(test_vhosts_before.len(), 2);

    // Verify default vhost exists
    let default_vhost_before = vhosts_before.iter().find(|vh| vh.name == "/");
    assert!(default_vhost_before.is_some());

    // Try to delete everything including default vhost
    run_succeeds([
        "vhosts",
        "delete_multiple",
        "--name-pattern",
        ".*", // This would match everything including "/"
        "--approve",
        "--idempotently",
    ]);

    // Verify test vhosts are gone but default vhost still exists
    let vhosts_after = client.list_vhosts()?;
    let test_vhosts_after: Vec<_> = vhosts_after
        .iter()
        .filter(|vh| vh.name.starts_with(prefix))
        .collect();
    assert_eq!(test_vhosts_after.len(), 0);

    let default_vhost_after = vhosts_after.iter().find(|vh| vh.name == "/");
    assert!(default_vhost_after.is_some());

    Ok(())
}

#[test]
fn test_vhosts_delete_multiple_with_invalid_regex() -> Result<(), Box<dyn Error>> {
    let prefix = "rabbitmqadmin.test-vhosts-delete-multiple-invalid-regex";

    // Clean up any existing test vhosts first (only our specific ones)
    delete_vhosts_with_prefix("rabbitmqadmin.test-vhosts-delete-multiple").ok();

    // Create a test virtual host
    let vh_name = format!("{}-1", prefix);
    run_succeeds(["vhosts", "declare", "--name", &vh_name]);

    // Try to delete with invalid regex pattern
    run_fails([
        "vhosts",
        "delete_multiple",
        "--name-pattern",
        "[invalid", // Invalid regex
        "--approve",
    ]);

    // Verify the vhost still exists
    let client = api_client();
    let vhosts = client.list_vhosts()?;
    let test_vhost = vhosts.iter().find(|vh| vh.name == vh_name);
    assert!(test_vhost.is_some());

    // Clean up
    delete_vhosts_with_prefix("rabbitmqadmin.test-vhosts-delete-multiple").ok();

    Ok(())
}

#[test]
fn test_vhosts_delete_multiple_requires_approve_in_interactive_mode() -> Result<(), Box<dyn Error>>
{
    let prefix = "rabbitmqadmin.test-vhosts-delete-multiple-requires-approve";

    // Clean up any existing test vhosts first (only our specific ones)
    delete_vhosts_with_prefix("rabbitmqadmin.test-vhosts-delete-multiple").ok();

    // Create a test virtual host
    let vh_name = format!("{}-1", prefix);
    run_succeeds(["vhosts", "declare", "--name", &vh_name]);

    // Try to delete without --approve flag (should fail)
    run_fails([
        "vhosts",
        "delete_multiple",
        "--name-pattern",
        &format!("{}.*", prefix),
    ]);

    // Verify the vhost still exists
    let client = api_client();
    let vhosts = client.list_vhosts()?;
    let test_vhost = vhosts.iter().find(|vh| vh.name == vh_name);
    assert!(test_vhost.is_some());

    // Clean up
    delete_vhosts_with_prefix("rabbitmqadmin.test-vhosts-delete-multiple").ok();

    Ok(())
}
// This test verifies that the delete_multiple command continues processing
// even when individual vhost deletions fail and shows appropriate progress indicators.
#[test]
fn test_vhosts_delete_multiple_continues_on_individual_failures() -> Result<(), Box<dyn Error>> {
    let prefix = "rabbitmqadmin.test-vhosts-delete-multiple-continues";

    // Clean up any existing test vhosts first (only our specific ones)
    delete_vhosts_with_prefix("rabbitmqadmin.test-vhosts-delete-multiple").ok();

    // Create test virtual hosts
    for i in 1..=3 {
        let vh_name = format!("{}-{}", prefix, i);
        run_succeeds(["vhosts", "declare", "--name", &vh_name]);
    }

    // Verify they exist
    let client = api_client();
    let vhosts_before = client.list_vhosts()?;
    let test_vhosts_before: Vec<_> = vhosts_before
        .iter()
        .filter(|vh| vh.name.starts_with(prefix))
        .collect();
    assert_eq!(test_vhosts_before.len(), 3);

    // Manually delete one vhost to simulate a failure scenario
    // (This would cause a 404 when the command tries to delete it)
    let vh_name_to_predelete = format!("{}-2", prefix);
    delete_vhost(&vh_name_to_predelete).ok();

    // Run delete_multiple - it should:
    // 1. Continue processing even when deleting vh-2 fails (404)
    // 2. Show progress with 'X' for failed deletions
    // 3. Successfully delete vh-1 and vh-3
    run_succeeds([
        "vhosts",
        "delete_multiple",
        "--name-pattern",
        &format!("{}.*", prefix),
        "--approve",
        "--idempotently",
    ]);

    // Verify that only the successfully deleted vhosts are gone
    // (vh-1 and vh-3 should be deleted, vh-2 was already gone)
    let vhosts_after = client.list_vhosts()?;
    let test_vhosts_after: Vec<_> = vhosts_after
        .iter()
        .filter(|vh| vh.name.starts_with(prefix))
        .collect();
    assert_eq!(test_vhosts_after.len(), 0);

    // Clean up any remaining test vhosts to ensure test isolation
    delete_vhosts_with_prefix("rabbitmqadmin.test-vhosts-delete-multiple").ok();

    Ok(())
}

#[test]
fn test_vhosts_delete_multiple_protects_deletion_protected_vhosts() -> Result<(), Box<dyn Error>> {
    skip_if_rabbitmq_version_below!(4, 2, 0);

    let prefix = "rabbitmqadmin.test-vhosts-delete-multiple-protects-protected";

    // Clean up any existing test vhosts first (only our specific ones)
    delete_vhosts_with_prefix("rabbitmqadmin.test-vhosts-delete-multiple").ok();

    // Create test virtual hosts
    for i in 1..=3 {
        let vh_name = format!("{}-{}", prefix, i);
        run_succeeds(["vhosts", "declare", "--name", &vh_name]);
    }

    // Enable deletion protection for the second vhost only
    let protected_vh = format!("{}-2", prefix);
    run_succeeds([
        "vhosts",
        "enable_deletion_protection",
        "--name",
        &protected_vh,
    ]);

    // We begin with this many virtual hosts
    let client = api_client();
    let vhosts_before = client.list_vhosts()?;
    let test_vhosts_before: Vec<_> = vhosts_before
        .iter()
        .filter(|vh| vh.name.starts_with(prefix))
        .collect();
    assert_eq!(test_vhosts_before.len(), 3);

    // Try to delete all using the 'vhosts delete_multiple' command
    run_succeeds([
        "vhosts",
        "delete_multiple",
        "--name-pattern",
        &format!("{}.*", prefix),
        "--approve",
        "--idempotently",
    ]);

    // Verify that the protected vhost still exists, but several others were deleted
    let vhosts_after = client.list_vhosts()?;
    let test_vhosts_after: Vec<_> = vhosts_after
        .iter()
        .filter(|vh| vh.name.starts_with(prefix))
        .collect();

    // Only the protected vhost should remain
    assert_eq!(test_vhosts_after.len(), 1);
    assert_eq!(test_vhosts_after[0].name, protected_vh);

    // Clean up
    run_succeeds([
        "vhosts",
        "disable_deletion_protection",
        "--name",
        &protected_vh,
    ]);
    run_succeeds(["vhosts", "delete", "--name", &protected_vh]);

    Ok(())
}

#[test]
fn test_vhosts_delete_multiple_quiet_produces_no_output() -> Result<(), Box<dyn Error>> {
    let prefix = "rabbitmqadmin.test-vhosts-delete-multiple-quiet";

    delete_vhosts_with_prefix(prefix).ok();

    for i in 1..=3 {
        let vh_name = format!("{}-{}", prefix, i);
        run_succeeds(["vhosts", "declare", "--name", &vh_name]);
    }

    run_succeeds([
        "--quiet",
        "--non-interactive",
        "vhosts",
        "delete_multiple",
        "--name-pattern",
        prefix,
    ])
    .stdout(predicates::str::is_empty());

    Ok(())
}