rabbitmq-backup-core 0.1.0

Core engine for RabbitMQ backup and restore operations
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
//! Configuration structures for RabbitMQ backup and restore.

use std::collections::HashMap;
use std::env;
use std::path::PathBuf;

use serde::{Deserialize, Serialize};

use crate::storage::StorageBackendConfig;

/// Load a configuration from YAML after expanding `${ENV_VAR}` placeholders.
pub fn config_from_yaml_str(input: &str) -> crate::Result<Config> {
    let interpolated = interpolate_env_vars(input)?;
    Ok(serde_yaml::from_str(&interpolated)?)
}

/// Expand `${ENV_VAR}` placeholders in YAML configuration.
pub fn interpolate_env_vars(input: &str) -> crate::Result<String> {
    let re = regex::Regex::new(r"\$\{([A-Za-z_][A-Za-z0-9_]*)\}")
        .map_err(|e| crate::Error::Config(format!("Invalid env interpolation regex: {e}")))?;

    let mut output = String::with_capacity(input.len());
    let mut last = 0;
    for captures in re.captures_iter(input) {
        let whole = captures
            .get(0)
            .expect("regex capture 0 should always exist");
        let var = captures
            .get(1)
            .expect("regex capture 1 should always exist")
            .as_str();

        output.push_str(&input[last..whole.start()]);
        let value = env::var(var)
            .map_err(|_| crate::Error::Config(format!("Environment variable {var} is not set")))?;
        output.push_str(&value);
        last = whole.end();
    }
    output.push_str(&input[last..]);
    Ok(output)
}

/// Top-level configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Config {
    /// Operating mode: backup or restore
    pub mode: Mode,

    /// Unique identifier for this backup
    pub backup_id: String,

    /// Source RabbitMQ connection (for backup)
    #[serde(default)]
    pub source: Option<SourceConfig>,

    /// Target RabbitMQ connection (for restore)
    #[serde(default)]
    pub target: Option<TargetConfig>,

    /// Storage backend configuration
    pub storage: StorageBackendConfig,

    /// Backup-specific options
    #[serde(default)]
    pub backup: Option<BackupOptions>,

    /// Restore-specific options
    #[serde(default)]
    pub restore: Option<RestoreOptions>,

    /// Offset/checkpoint storage configuration
    #[serde(default)]
    pub offset_storage: Option<OffsetStorageConfig>,

    /// Prometheus metrics configuration
    #[serde(default)]
    pub metrics: Option<MetricsConfig>,
}

/// Operating mode.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Mode {
    Backup,
    Restore,
}

/// Source RabbitMQ connection configuration (for backup).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SourceConfig {
    /// AMQP connection URL (e.g., "amqp://user:pass@host:5672/%2f")
    pub amqp_url: String,

    /// Management API URL (e.g., "http://host:15672")
    pub management_url: String,

    /// Management API username
    pub management_username: String,

    /// Management API password (supports ${ENV_VAR} interpolation)
    pub management_password: String,

    /// Stream protocol port (default: 5552)
    #[serde(default = "default_stream_port")]
    pub stream_port: u16,

    /// TLS configuration
    #[serde(default)]
    pub tls: Option<TlsConfig>,

    /// Queue selection criteria
    #[serde(default)]
    pub queues: Option<QueueSelection>,
}

/// Target RabbitMQ connection configuration (for restore).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TargetConfig {
    /// AMQP connection URL
    pub amqp_url: String,

    /// Management API URL
    #[serde(default)]
    pub management_url: Option<String>,

    /// Management API username
    #[serde(default)]
    pub management_username: Option<String>,

    /// Management API password
    #[serde(default)]
    pub management_password: Option<String>,
}

/// TLS configuration for AMQP and Stream Protocol connections.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TlsConfig {
    /// Enable TLS
    #[serde(default)]
    pub enabled: bool,

    /// Path to CA certificate PEM file
    #[serde(default)]
    pub ca_cert: Option<PathBuf>,

    /// Path to client certificate PEM file
    #[serde(default)]
    pub client_cert: Option<PathBuf>,

    /// Path to client private key PEM file
    #[serde(default)]
    pub client_key: Option<PathBuf>,
}

/// Queue selection criteria for backup.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct QueueSelection {
    /// Queue name patterns to include (glob syntax)
    #[serde(default)]
    pub include: Vec<String>,

    /// Queue name patterns to exclude (glob syntax)
    #[serde(default)]
    pub exclude: Vec<String>,

    /// Virtual hosts to include
    #[serde(default)]
    pub vhosts: Vec<String>,

    /// Queue types to include
    #[serde(default)]
    pub types: Vec<QueueType>,

    /// Minimum message count (skip queues with fewer messages)
    #[serde(default)]
    pub min_messages: u64,
}

/// RabbitMQ queue type.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum QueueType {
    Classic,
    Quorum,
    Stream,
}

/// Backup-specific options.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BackupOptions {
    /// Maximum segment size in bytes (default: 128MB)
    #[serde(default = "default_segment_max_bytes")]
    pub segment_max_bytes: u64,

    /// Maximum segment time interval in milliseconds (default: 60000)
    #[serde(default = "default_segment_max_interval_ms")]
    pub segment_max_interval_ms: u64,

    /// Compression algorithm
    #[serde(default)]
    pub compression: CompressionType,

    /// Compression level (for zstd: 1-22, default: 3)
    #[serde(default = "default_compression_level")]
    pub compression_level: i32,

    /// AMQP prefetch count (messages to prefetch per channel)
    #[serde(default = "default_prefetch_count")]
    pub prefetch_count: u16,

    /// Strategy for returning messages to the queue after reading
    #[serde(default)]
    pub requeue_strategy: RequeueStrategy,

    /// Maximum number of queues to back up concurrently
    #[serde(default = "default_max_concurrent_queues")]
    pub max_concurrent_queues: usize,

    /// Checkpoint interval in seconds
    #[serde(default = "default_checkpoint_interval_secs")]
    pub checkpoint_interval_secs: u64,

    /// Remote sync interval in seconds
    #[serde(default = "default_sync_interval_secs")]
    pub sync_interval_secs: u64,

    /// Include definitions export in backup
    #[serde(default = "default_true")]
    pub include_definitions: bool,

    /// Stop after backing up current queue depth (one-shot mode)
    #[serde(default = "default_true")]
    pub stop_at_current_depth: bool,

    /// Enable stream protocol for stream-type queues
    #[serde(default)]
    pub stream_enabled: bool,
}

impl Default for BackupOptions {
    fn default() -> Self {
        Self {
            segment_max_bytes: default_segment_max_bytes(),
            segment_max_interval_ms: default_segment_max_interval_ms(),
            compression: CompressionType::default(),
            compression_level: default_compression_level(),
            prefetch_count: default_prefetch_count(),
            requeue_strategy: RequeueStrategy::default(),
            max_concurrent_queues: default_max_concurrent_queues(),
            checkpoint_interval_secs: default_checkpoint_interval_secs(),
            sync_interval_secs: default_sync_interval_secs(),
            include_definitions: true,
            stop_at_current_depth: true,
            stream_enabled: false,
        }
    }
}

/// Compression algorithm.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
#[derive(Default)]
pub enum CompressionType {
    #[default]
    Zstd,
    Lz4,
    None,
}

/// Strategy for returning messages to the queue after reading.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
#[derive(Default)]
pub enum RequeueStrategy {
    /// basic.nack(requeue=true) after recording each message
    Nack,
    /// basic.reject(requeue=true) per message
    Reject,
    /// basic.consume then basic.cancel — all unacked messages requeue on cancel
    #[default]
    Cancel,
    /// basic.get (pull mode) + nack — one message at a time
    Get,
}

/// Restore-specific options.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RestoreOptions {
    /// PITR start timestamp (epoch millis)
    #[serde(default)]
    pub time_window_start: Option<i64>,

    /// PITR end timestamp (epoch millis)
    #[serde(default)]
    pub time_window_end: Option<i64>,

    /// Queue name remapping: source -> target
    #[serde(default)]
    pub queue_mapping: HashMap<String, String>,

    /// Vhost remapping: source -> target
    #[serde(default)]
    pub vhost_mapping: HashMap<String, String>,

    /// Exchange remapping: source -> target
    #[serde(default)]
    pub exchange_mapping: HashMap<String, String>,

    /// Message publish mode
    #[serde(default)]
    pub publish_mode: PublishMode,

    /// Enable publisher confirms
    #[serde(default = "default_true")]
    pub publisher_confirms: bool,

    /// Maximum number of queues to restore concurrently
    #[serde(default = "default_max_concurrent_queues")]
    pub max_concurrent_queues: usize,

    /// Batch size for publishing messages
    #[serde(default = "default_produce_batch_size")]
    pub produce_batch_size: usize,

    /// Rate limit: max messages per second (0 = unlimited)
    #[serde(default)]
    pub rate_limit_messages_per_sec: u64,

    /// Restore definitions before messages
    #[serde(default = "default_true")]
    pub restore_definitions: bool,

    /// Dry-run mode for definitions import
    #[serde(default)]
    pub definitions_dry_run: bool,

    /// Optional definitions selection for partial topology restore
    #[serde(default)]
    pub definitions_selection: DefinitionsSelection,

    /// Auto-create missing queues on target
    #[serde(default)]
    pub create_missing_queues: bool,

    /// Checkpoint state database path
    #[serde(default)]
    pub checkpoint_state: Option<PathBuf>,

    /// Checkpoint interval in seconds
    #[serde(default = "default_restore_checkpoint_interval")]
    pub checkpoint_interval_secs: u64,

    /// Dry-run mode (validate without publishing)
    #[serde(default)]
    pub dry_run: bool,
}

impl Default for RestoreOptions {
    fn default() -> Self {
        Self {
            time_window_start: None,
            time_window_end: None,
            queue_mapping: HashMap::new(),
            vhost_mapping: HashMap::new(),
            exchange_mapping: HashMap::new(),
            publish_mode: PublishMode::default(),
            publisher_confirms: true,
            max_concurrent_queues: default_max_concurrent_queues(),
            produce_batch_size: default_produce_batch_size(),
            rate_limit_messages_per_sec: 0,
            restore_definitions: true,
            definitions_dry_run: false,
            definitions_selection: DefinitionsSelection::default(),
            create_missing_queues: false,
            checkpoint_state: None,
            checkpoint_interval_secs: default_restore_checkpoint_interval(),
            dry_run: false,
        }
    }
}

/// Optional filters for definitions restore. Empty selection restores all definitions.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DefinitionsSelection {
    /// Vhosts to restore. If set without queues or exchanges, restore all topology in those vhosts.
    #[serde(default)]
    pub vhosts: Vec<String>,

    /// Queue names to restore.
    #[serde(default)]
    pub queues: Vec<String>,

    /// Exchange names to restore.
    #[serde(default)]
    pub exchanges: Vec<String>,
}

impl DefinitionsSelection {
    pub fn is_empty(&self) -> bool {
        self.vhosts.is_empty() && self.queues.is_empty() && self.exchanges.is_empty()
    }
}

/// Message publish mode for restore.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
#[derive(Default)]
pub enum PublishMode {
    /// Publish to original exchange with original routing key
    #[default]
    Exchange,
    /// Publish directly to queue via default exchange
    DirectToQueue,
}

/// Offset/checkpoint storage configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OffsetStorageConfig {
    /// Storage backend type
    #[serde(default)]
    pub backend: OffsetStorageBackend,

    /// Path to SQLite database
    #[serde(default = "default_db_path")]
    pub db_path: PathBuf,

    /// Remote storage key for syncing checkpoint
    #[serde(default)]
    pub s3_key: Option<String>,

    /// Sync interval in seconds
    #[serde(default = "default_sync_interval_secs")]
    pub sync_interval_secs: u64,
}

impl Default for OffsetStorageConfig {
    fn default() -> Self {
        Self {
            backend: OffsetStorageBackend::default(),
            db_path: default_db_path(),
            s3_key: None,
            sync_interval_secs: default_sync_interval_secs(),
        }
    }
}

/// Offset storage backend type.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
#[derive(Default)]
pub enum OffsetStorageBackend {
    #[default]
    Sqlite,
    Memory,
}

/// Prometheus metrics configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MetricsConfig {
    /// Enable metrics endpoint
    #[serde(default = "default_true")]
    pub enabled: bool,

    /// Port for metrics HTTP server
    #[serde(default = "default_metrics_port")]
    pub port: u16,

    /// Bind address for metrics HTTP server
    #[serde(default = "default_bind_address")]
    pub bind_address: String,

    /// HTTP path for metrics endpoint
    #[serde(default = "default_metrics_path")]
    pub path: String,
}

impl Default for MetricsConfig {
    fn default() -> Self {
        Self {
            enabled: true,
            port: default_metrics_port(),
            bind_address: default_bind_address(),
            path: default_metrics_path(),
        }
    }
}

// Default value functions for serde

fn default_stream_port() -> u16 {
    5552
}

fn default_segment_max_bytes() -> u64 {
    134_217_728 // 128MB
}

fn default_segment_max_interval_ms() -> u64 {
    60_000 // 60 seconds
}

fn default_compression_level() -> i32 {
    3
}

fn default_prefetch_count() -> u16 {
    100
}

fn default_max_concurrent_queues() -> usize {
    4
}

fn default_checkpoint_interval_secs() -> u64 {
    5
}

fn default_sync_interval_secs() -> u64 {
    30
}

fn default_produce_batch_size() -> usize {
    100
}

fn default_restore_checkpoint_interval() -> u64 {
    60
}

fn default_db_path() -> PathBuf {
    PathBuf::from("./offsets.db")
}

fn default_metrics_port() -> u16 {
    8080
}

fn default_bind_address() -> String {
    "0.0.0.0".to_string()
}

fn default_metrics_path() -> String {
    "/metrics".to_string()
}

fn default_true() -> bool {
    true
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_backup_options_defaults() {
        let opts = BackupOptions::default();
        assert_eq!(opts.segment_max_bytes, 134_217_728);
        assert_eq!(opts.compression, CompressionType::Zstd);
        assert_eq!(opts.compression_level, 3);
        assert_eq!(opts.prefetch_count, 100);
        assert_eq!(opts.requeue_strategy, RequeueStrategy::Cancel);
        assert_eq!(opts.max_concurrent_queues, 4);
        assert!(opts.include_definitions);
        assert!(opts.stop_at_current_depth);
    }

    #[test]
    fn test_restore_options_defaults() {
        let opts = RestoreOptions::default();
        assert_eq!(opts.publish_mode, PublishMode::Exchange);
        assert!(opts.publisher_confirms);
        assert!(!opts.dry_run);
        assert!(!opts.create_missing_queues);
    }

    #[test]
    fn test_config_yaml_deserialization() {
        let yaml = r#"
mode: backup
backup_id: "test-backup-001"
source:
  amqp_url: "amqp://guest:guest@localhost:5672/%2f"
  management_url: "http://localhost:15672"
  management_username: guest
  management_password: guest
  queues:
    include:
      - "orders-*"
    exclude:
      - "*-dead-letter"
storage:
  backend: filesystem
  path: /tmp/backups
backup:
  compression: zstd
  prefetch_count: 50
  requeue_strategy: cancel
"#;
        let config: Config = serde_yaml::from_str(yaml).unwrap();
        assert_eq!(config.mode, Mode::Backup);
        assert_eq!(config.backup_id, "test-backup-001");
        assert!(config.source.is_some());
        assert!(config.target.is_none());

        let backup = config.backup.unwrap();
        assert_eq!(backup.compression, CompressionType::Zstd);
        assert_eq!(backup.prefetch_count, 50);
        assert_eq!(backup.requeue_strategy, RequeueStrategy::Cancel);
    }

    #[test]
    fn test_env_interpolation() {
        let var_name = "RABBITMQ_BACKUP_TEST_INTERPOLATION";
        std::env::set_var(var_name, "interpolated-secret");

        let yaml = r#"
mode: backup
backup_id: "test-backup-001"
source:
  amqp_url: "amqp://guest:${RABBITMQ_BACKUP_TEST_INTERPOLATION}@localhost:5672/%2f"
  management_url: "http://localhost:15672"
  management_username: guest
  management_password: ${RABBITMQ_BACKUP_TEST_INTERPOLATION}
storage:
  backend: filesystem
  path: /tmp/backups
"#;

        let config = config_from_yaml_str(yaml).unwrap();
        let source = config.source.unwrap();
        assert_eq!(source.management_password, "interpolated-secret");
        assert_eq!(
            source.amqp_url,
            "amqp://guest:interpolated-secret@localhost:5672/%2f"
        );

        std::env::remove_var(var_name);
    }

    #[test]
    fn test_env_interpolation_missing_var_errors() {
        std::env::remove_var("RABBITMQ_BACKUP_TEST_MISSING_INTERPOLATION");
        let err = interpolate_env_vars("${RABBITMQ_BACKUP_TEST_MISSING_INTERPOLATION}")
            .unwrap_err()
            .to_string();
        assert!(err.contains("RABBITMQ_BACKUP_TEST_MISSING_INTERPOLATION"));
    }
}