hexcfg 1.1.4

A hexagonal architecture configuration loading crate with multi-source support
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
// SPDX-License-Identifier: MIT OR Apache-2.0

//! Integration tests for etcd adapter using Docker containers.

mod common;

#[cfg(feature = "etcd")]
mod etcd_tests {
    use hexcfg::adapters::EtcdAdapter;
    use hexcfg::domain::ConfigKey;
    use hexcfg::ports::ConfigSource;
    use testcontainers::{core::WaitFor, runners::AsyncRunner, GenericImage, ImageExt};

    use crate::common as docker_helpers;

    /// Helper to set up an etcd container and adapter for testing.
    async fn setup_etcd_test() -> Option<(testcontainers::ContainerAsync<GenericImage>, EtcdAdapter)>
    {
        if !docker_helpers::is_docker_available() {
            docker_helpers::print_docker_unavailable_warning("etcd integration test");
            return None;
        }

        // Use etcd v3.5.0 image
        let etcd_image = GenericImage::new("quay.io/coreos/etcd", "v3.5.0")
            .with_exposed_port(2379.into())
            .with_wait_for(WaitFor::message_on_stderr("ready to serve client requests"))
            .with_env_var("ETCD_ADVERTISE_CLIENT_URLS", "http://0.0.0.0:2379")
            .with_env_var("ETCD_LISTEN_CLIENT_URLS", "http://0.0.0.0:2379");

        let container = etcd_image.start().await.ok()?;
        let port = container.get_host_port_ipv4(2379).await.ok()?;

        let endpoint = format!("127.0.0.1:{}", port);

        // Give etcd a moment to fully start
        tokio::time::sleep(tokio::time::Duration::from_secs(2)).await;

        // Set up test data
        let client = etcd_client::Client::connect([&endpoint], None).await.ok()?;
        let mut client_clone = client.clone();

        // Put some test values
        client_clone
            .put("test/test.key", "test_value", None)
            .await
            .ok()?;
        client_clone
            .put("test/database/host", "localhost", None)
            .await
            .ok()?;
        client_clone
            .put("test/database/port", "5432", None)
            .await
            .ok()?;

        let adapter = EtcdAdapter::new(vec![endpoint], Some("test/")).await.ok()?;

        Some((container, adapter))
    }

    #[tokio::test]
    async fn test_etcd_get() {
        let Some((_container, adapter)) = setup_etcd_test().await else {
            return;
        };

        let key = ConfigKey::from("test.key");
        let value = adapter.get(&key).unwrap();

        assert!(value.is_some());
        assert_eq!(value.unwrap().as_str(), "test_value");
    }

    #[tokio::test]
    async fn test_etcd_get_nested() {
        let Some((_container, adapter)) = setup_etcd_test().await else {
            return;
        };

        // etcd uses slashes, but our adapter converts them to dots
        let key = ConfigKey::from("database.host");
        let value = adapter.get(&key).unwrap();

        assert!(value.is_some());
        assert_eq!(value.unwrap().as_str(), "localhost");
    }

    #[tokio::test]
    async fn test_etcd_all_keys() {
        let Some((_container, adapter)) = setup_etcd_test().await else {
            return;
        };

        let keys = adapter.all_keys().unwrap();

        assert_eq!(keys.len(), 3);
        assert!(keys.contains(&ConfigKey::from("test.key")));
        assert!(keys.contains(&ConfigKey::from("database.host")));
        assert!(keys.contains(&ConfigKey::from("database.port")));
    }

    #[tokio::test]
    async fn test_etcd_reload() {
        let Some((container, mut adapter)) = setup_etcd_test().await else {
            return;
        };

        // Initial value
        let key = ConfigKey::from("test.key");
        let value = adapter.get(&key).unwrap();
        assert_eq!(value.unwrap().as_str(), "test_value");

        // Update value in etcd
        let port = container.get_host_port_ipv4(2379).await.unwrap();
        let endpoint = format!("127.0.0.1:{}", port);
        let client = etcd_client::Client::connect([&endpoint], None)
            .await
            .unwrap();
        let mut client_clone = client.clone();

        client_clone
            .put("test/test.key", "updated_value", None)
            .await
            .unwrap();

        // Value should still be old before reload
        let value = adapter.get(&key).unwrap();
        assert_eq!(value.unwrap().as_str(), "test_value");

        // Reload adapter
        adapter.reload().unwrap();

        // Value should be updated
        let value = adapter.get(&key).unwrap();
        assert_eq!(value.unwrap().as_str(), "updated_value");
    }

    #[tokio::test]
    async fn test_etcd_priority() {
        let Some((_container, adapter)) = setup_etcd_test().await else {
            return;
        };

        assert_eq!(adapter.priority(), 1);
    }

    #[tokio::test]
    async fn test_etcd_custom_priority() {
        if !docker_helpers::is_docker_available() {
            docker_helpers::print_docker_unavailable_warning("etcd custom priority test");
            return;
        }

        let etcd_image = GenericImage::new("quay.io/coreos/etcd", "v3.5.0")
            .with_exposed_port(2379.into())
            .with_wait_for(WaitFor::message_on_stderr("ready to serve client requests"))
            .with_env_var("ETCD_ADVERTISE_CLIENT_URLS", "http://0.0.0.0:2379")
            .with_env_var("ETCD_LISTEN_CLIENT_URLS", "http://0.0.0.0:2379");

        let container = etcd_image.start().await.unwrap();
        let port = container.get_host_port_ipv4(2379).await.unwrap();
        let endpoint = format!("127.0.0.1:{}", port);

        tokio::time::sleep(tokio::time::Duration::from_secs(2)).await;

        let adapter = EtcdAdapter::with_priority(vec![endpoint], None, 5)
            .await
            .unwrap();

        assert_eq!(adapter.priority(), 5);
    }

    #[tokio::test]
    async fn test_etcd_nonexistent_key() {
        let Some((_container, adapter)) = setup_etcd_test().await else {
            return;
        };

        let key = ConfigKey::from("nonexistent.key");
        let value = adapter.get(&key).unwrap();

        assert!(value.is_none());
    }

    #[tokio::test]
    async fn test_etcd_prefix_filtering() {
        if !docker_helpers::is_docker_available() {
            docker_helpers::print_docker_unavailable_warning("etcd prefix filtering test");
            return;
        }

        let etcd_image = GenericImage::new("quay.io/coreos/etcd", "v3.5.0")
            .with_exposed_port(2379.into())
            .with_wait_for(WaitFor::message_on_stderr("ready to serve client requests"))
            .with_env_var("ETCD_ADVERTISE_CLIENT_URLS", "http://0.0.0.0:2379")
            .with_env_var("ETCD_LISTEN_CLIENT_URLS", "http://0.0.0.0:2379");

        let container = etcd_image.start().await.unwrap();
        let port = container.get_host_port_ipv4(2379).await.unwrap();
        let endpoint = format!("127.0.0.1:{}", port);

        tokio::time::sleep(tokio::time::Duration::from_secs(2)).await;

        // Set up data with different prefixes
        let client = etcd_client::Client::connect([&endpoint], None)
            .await
            .unwrap();
        let mut client_clone = client.clone();

        client_clone.put("app1/key1", "value1", None).await.unwrap();
        client_clone.put("app2/key2", "value2", None).await.unwrap();

        // Create adapter with prefix filtering
        let adapter = EtcdAdapter::new(vec![endpoint], Some("app1/"))
            .await
            .unwrap();

        let keys = adapter.all_keys().unwrap();

        // Should only have app1 keys
        assert_eq!(keys.len(), 1);
        assert!(keys.contains(&ConfigKey::from("key1")));
        assert!(!keys.contains(&ConfigKey::from("key2")));
    }

    #[tokio::test]
    async fn test_cli_overrides_etcd() {
        use hexcfg::adapters::CommandLineAdapter;
        use hexcfg::domain::ConfigurationService;
        use hexcfg::service::ConfigurationServiceBuilder;

        let Some((_container, etcd_adapter)) = setup_etcd_test().await else {
            return;
        };

        // etcd has "test.key" = "test_value"
        // CLI will override with "test.key" = "from_cli"
        let cli_args = vec!["--test.key=from_cli"];
        let cli_adapter = CommandLineAdapter::from_args(cli_args);

        let service = ConfigurationServiceBuilder::new()
            .with_source(Box::new(etcd_adapter))
            .with_source(Box::new(cli_adapter))
            .build()
            .unwrap();

        // CLI (priority 3) should win over etcd (priority 1)
        let value = service.get_str("test.key").unwrap();
        assert_eq!(value.as_str(), "from_cli");
    }

    #[tokio::test]
    async fn test_env_overrides_etcd() {
        use hexcfg::adapters::EnvVarAdapter;
        use hexcfg::domain::ConfigurationService;
        use hexcfg::service::ConfigurationServiceBuilder;
        use std::collections::HashMap;

        let Some((_container, etcd_adapter)) = setup_etcd_test().await else {
            return;
        };

        // etcd has "test.key" = "test_value"
        // Env will override with "test.key" = "from_env"
        let mut env_vars = HashMap::new();
        env_vars.insert("test.key".to_string(), "from_env".to_string());
        let env_adapter = EnvVarAdapter::with_values(env_vars);

        let service = ConfigurationServiceBuilder::new()
            .with_source(Box::new(etcd_adapter))
            .with_source(Box::new(env_adapter))
            .build()
            .unwrap();

        // Env (priority 2) should win over etcd (priority 1)
        let value = service.get_str("test.key").unwrap();
        assert_eq!(value.as_str(), "from_env");
    }

    #[tokio::test]
    async fn test_full_precedence_chain_with_etcd() {
        use hexcfg::adapters::{CommandLineAdapter, EnvVarAdapter};
        use hexcfg::domain::ConfigurationService;
        use hexcfg::service::ConfigurationServiceBuilder;
        use std::collections::HashMap;

        let Some((_container, etcd_adapter)) = setup_etcd_test().await else {
            return;
        };

        // etcd has:
        // - "test.key" = "test_value"
        // - "database.host" = "localhost"
        // - "database.port" = "5432"

        // Env overrides some keys
        let mut env_vars = HashMap::new();
        env_vars.insert("test.key".to_string(), "from_env".to_string());
        env_vars.insert("database.host".to_string(), "env.example.com".to_string());
        let env_adapter = EnvVarAdapter::with_values(env_vars);

        // CLI overrides even more
        let cli_args = vec!["--test.key=from_cli"];
        let cli_adapter = CommandLineAdapter::from_args(cli_args);

        let service = ConfigurationServiceBuilder::new()
            .with_source(Box::new(etcd_adapter))
            .with_source(Box::new(env_adapter))
            .with_source(Box::new(cli_adapter))
            .build()
            .unwrap();

        // test.key: CLI wins (priority 3)
        let value = service.get_str("test.key").unwrap();
        assert_eq!(value.as_str(), "from_cli");

        // database.host: Env wins (priority 2)
        let value = service.get_str("database.host").unwrap();
        assert_eq!(value.as_str(), "env.example.com");

        // database.port: etcd is the only source (priority 1)
        let value = service.get_str("database.port").unwrap();
        assert_eq!(value.as_str(), "5432");
    }

    #[tokio::test]
    async fn test_etcd_with_custom_priority_overrides_env() {
        use hexcfg::adapters::EnvVarAdapter;
        use hexcfg::domain::ConfigurationService;
        use hexcfg::service::ConfigurationServiceBuilder;
        use std::collections::HashMap;

        if !docker_helpers::is_docker_available() {
            docker_helpers::print_docker_unavailable_warning(
                "etcd custom priority precedence test",
            );
            return;
        }

        let etcd_image = GenericImage::new("quay.io/coreos/etcd", "v3.5.0")
            .with_exposed_port(2379.into())
            .with_wait_for(WaitFor::message_on_stderr("ready to serve client requests"))
            .with_env_var("ETCD_ADVERTISE_CLIENT_URLS", "http://0.0.0.0:2379")
            .with_env_var("ETCD_LISTEN_CLIENT_URLS", "http://0.0.0.0:2379");

        let container = etcd_image.start().await.unwrap();
        let port = container.get_host_port_ipv4(2379).await.unwrap();
        let endpoint = format!("127.0.0.1:{}", port);

        tokio::time::sleep(tokio::time::Duration::from_secs(2)).await;

        // Set up etcd with test data
        let client = etcd_client::Client::connect([&endpoint], None)
            .await
            .unwrap();
        let mut client_clone = client.clone();

        client_clone
            .put("special.key", "from_etcd", None)
            .await
            .unwrap();

        // Create etcd adapter with custom priority 3 (same as CLI!)
        let etcd_adapter = EtcdAdapter::with_priority(vec![endpoint], None, 3)
            .await
            .unwrap();

        // Create env adapter with normal priority 2
        let mut env_vars = HashMap::new();
        env_vars.insert("special.key".to_string(), "from_env".to_string());
        let env_adapter = EnvVarAdapter::with_values(env_vars);

        let service = ConfigurationServiceBuilder::new()
            .with_source(Box::new(env_adapter))
            .with_source(Box::new(etcd_adapter))
            .build()
            .unwrap();

        // etcd with priority 3 should win over env with priority 2
        let value = service.get_str("special.key").unwrap();
        assert_eq!(value.as_str(), "from_etcd");
    }

    // === etcd Watcher Tests ===

    /// Helper to set up an etcd container for watcher testing.
    async fn setup_etcd_watcher_test(
    ) -> Option<(testcontainers::ContainerAsync<GenericImage>, String)> {
        if !docker_helpers::is_docker_available() {
            docker_helpers::print_docker_unavailable_warning("etcd watcher test");
            return None;
        }

        let etcd_image = GenericImage::new("quay.io/coreos/etcd", "v3.5.0")
            .with_exposed_port(2379.into())
            .with_wait_for(WaitFor::message_on_stderr("ready to serve client requests"))
            .with_env_var("ETCD_ADVERTISE_CLIENT_URLS", "http://0.0.0.0:2379")
            .with_env_var("ETCD_LISTEN_CLIENT_URLS", "http://0.0.0.0:2379");

        let container = etcd_image.start().await.ok()?;
        let port = container.get_host_port_ipv4(2379).await.ok()?;
        let endpoint = format!("127.0.0.1:{}", port);

        // Give etcd a moment to fully start
        tokio::time::sleep(tokio::time::Duration::from_secs(2)).await;

        Some((container, endpoint))
    }

    #[tokio::test]
    async fn test_etcd_watcher_creation() {
        use hexcfg::adapters::EtcdWatcher;

        let Some((_container, endpoint)) = setup_etcd_watcher_test().await else {
            return;
        };

        let watcher = EtcdWatcher::new(vec![&endpoint], Some("test/")).await;
        assert!(watcher.is_ok());
    }

    #[tokio::test]
    async fn test_etcd_watcher_invalid_endpoint() {
        use hexcfg::adapters::EtcdWatcher;

        // Use localhost with closed port - this should fail connection immediately
        let watcher = EtcdWatcher::new(vec!["127.0.0.1:19999"], Some("test/")).await;

        // Note: etcd client may not fail immediately on invalid endpoints in some cases,
        // so we just verify the watcher can be created (it will fail on watch() if connection is bad)
        // For a real failure test, we'd need to call watch() and see the reconnection logic
        let _ = watcher;
    }

    #[tokio::test]
    async fn test_etcd_watcher_start_stop() {
        use hexcfg::adapters::EtcdWatcher;
        use hexcfg::ports::ConfigWatcher;
        use std::sync::Arc;

        let Some((_container, endpoint)) = setup_etcd_watcher_test().await else {
            return;
        };

        let mut watcher = EtcdWatcher::new(vec![&endpoint], Some("test/"))
            .await
            .unwrap();

        let callback = Arc::new(|_key: ConfigKey| {
            // Callback for testing
        });

        // Start watching
        assert!(watcher.watch(callback).is_ok());

        // Give watcher time to start
        tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

        // Stop watching
        assert!(watcher.stop().is_ok());
    }

    #[tokio::test]
    async fn test_etcd_watcher_callback_triggered() {
        use hexcfg::adapters::EtcdWatcher;
        use hexcfg::ports::ConfigWatcher;
        use etcd_client::Client;
        use std::sync::atomic::{AtomicBool, Ordering};
        use std::sync::Arc;

        let Some((_container, endpoint)) = setup_etcd_watcher_test().await else {
            return;
        };

        let mut watcher = EtcdWatcher::new(vec![&endpoint], Some("test/watcher/"))
            .await
            .unwrap();

        let triggered = Arc::new(AtomicBool::new(false));
        let triggered_clone = Arc::clone(&triggered);

        let callback = Arc::new(move |key: ConfigKey| {
            eprintln!("etcd watcher callback triggered for key: {}", key.as_str());
            triggered_clone.store(true, Ordering::SeqCst);
        });

        watcher.watch(callback).unwrap();

        // Wait for watcher to initialize
        tokio::time::sleep(tokio::time::Duration::from_millis(500)).await;

        // Modify a key in etcd
        let mut client = Client::connect([&endpoint], None).await.unwrap();
        client
            .put("test/watcher/mykey", "test_value", None)
            .await
            .unwrap();

        // Wait for the event to be processed
        tokio::time::sleep(tokio::time::Duration::from_secs(2)).await;

        // Clean up
        client.delete("test/watcher/mykey", None).await.unwrap();
        watcher.stop().unwrap();

        let was_triggered = triggered.load(Ordering::SeqCst);
        assert!(
            was_triggered,
            "etcd watcher callback should have been triggered"
        );
    }

    #[tokio::test]
    async fn test_etcd_watcher_multiple_changes() {
        use hexcfg::adapters::EtcdWatcher;
        use hexcfg::ports::ConfigWatcher;
        use etcd_client::Client;
        use std::sync::atomic::{AtomicUsize, Ordering};
        use std::sync::Arc;

        let Some((_container, endpoint)) = setup_etcd_watcher_test().await else {
            return;
        };

        let mut watcher = EtcdWatcher::new(vec![&endpoint], Some("test/multi/"))
            .await
            .unwrap();

        let trigger_count = Arc::new(AtomicUsize::new(0));
        let trigger_count_clone = Arc::clone(&trigger_count);

        let callback = Arc::new(move |key: ConfigKey| {
            eprintln!("etcd watcher detected change: {}", key.as_str());
            trigger_count_clone.fetch_add(1, Ordering::SeqCst);
        });

        watcher.watch(callback).unwrap();

        // Wait for watcher to initialize
        tokio::time::sleep(tokio::time::Duration::from_millis(500)).await;

        // Make multiple changes
        let mut client = Client::connect([&endpoint], None).await.unwrap();

        for i in 0..3 {
            client
                .put(format!("test/multi/key{}", i), format!("value{}", i), None)
                .await
                .unwrap();
            tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;
        }

        // Wait for events to be processed
        tokio::time::sleep(tokio::time::Duration::from_secs(2)).await;

        // Clean up
        for i in 0..3 {
            client
                .delete(format!("test/multi/key{}", i), None)
                .await
                .unwrap();
        }
        watcher.stop().unwrap();

        let count = trigger_count.load(Ordering::SeqCst);
        assert!(count >= 3, "Expected at least 3 triggers, got {}", count);
    }

    #[tokio::test]
    async fn test_etcd_watcher_prefix_filtering() {
        use hexcfg::adapters::EtcdWatcher;
        use hexcfg::ports::ConfigWatcher;
        use etcd_client::Client;
        use std::sync::atomic::{AtomicUsize, Ordering};
        use std::sync::Arc;

        let Some((_container, endpoint)) = setup_etcd_watcher_test().await else {
            return;
        };

        let mut watcher = EtcdWatcher::new(vec![&endpoint], Some("test/prefix/"))
            .await
            .unwrap();

        let trigger_count = Arc::new(AtomicUsize::new(0));
        let trigger_count_clone = Arc::clone(&trigger_count);

        let callback = Arc::new(move |key: ConfigKey| {
            eprintln!("etcd watcher detected change: {}", key.as_str());
            trigger_count_clone.fetch_add(1, Ordering::SeqCst);
        });

        watcher.watch(callback).unwrap();

        // Wait for watcher to initialize
        tokio::time::sleep(tokio::time::Duration::from_millis(500)).await;

        let mut client = Client::connect([&endpoint], None).await.unwrap();

        // This should trigger (has correct prefix)
        client
            .put("test/prefix/key1", "value1", None)
            .await
            .unwrap();

        // This should NOT trigger (different prefix)
        client
            .put("other/prefix/key2", "value2", None)
            .await
            .unwrap();

        // Wait for events to be processed
        tokio::time::sleep(tokio::time::Duration::from_secs(2)).await;

        // Clean up
        client.delete("test/prefix/key1", None).await.unwrap();
        client.delete("other/prefix/key2", None).await.unwrap();
        watcher.stop().unwrap();

        let count = trigger_count.load(Ordering::SeqCst);
        // etcd watch may generate multiple events for the same key change,
        // so we verify at least 1 event was received (confirming filtering works).
        // The important part is that only key1 triggered, not key2.
        assert!(
            count >= 1,
            "Expected at least 1 trigger for key with correct prefix, got {}",
            count
        );
        // Verify we didn't get an excessive number of triggers
        assert!(
            count <= 3,
            "Expected at most 3 triggers, got {} (something may be wrong)",
            count
        );
    }
}