xds-server 0.1.0

gRPC server implementation for xDS control plane
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
//! Protocol compliance tests for xDS.
//!
//! These tests verify that our xDS implementation follows the
//! Envoy xDS protocol specification correctly.

#![allow(dead_code)]

use std::sync::Arc;

use xds_cache::{Cache, ShardedCache, Snapshot};
use xds_core::{BoxResource, NodeHash, Resource, ResourceRegistry, TypeUrl};

use crate::delta::{ClientResourceState, DeltaHandler};
use crate::services::{AdsConfig, AdsService};
use crate::sotw::SotwHandler;
use crate::stream::StreamContext;

/// Test resource for protocol testing.
#[derive(Debug, Clone)]
struct TestCluster {
    name: String,
    version: String,
}

impl TestCluster {
    fn new(name: &str) -> Self {
        Self {
            name: name.to_string(),
            version: "1".to_string(),
        }
    }
}

impl Resource for TestCluster {
    fn type_url(&self) -> &str {
        TypeUrl::CLUSTER
    }

    fn name(&self) -> &str {
        &self.name
    }

    fn encode(&self) -> Result<prost_types::Any, Box<dyn std::error::Error + Send + Sync>> {
        Ok(prost_types::Any {
            type_url: self.type_url().to_string(),
            value: self.name.as_bytes().to_vec(),
        })
    }

    fn as_any(&self) -> &dyn std::any::Any {
        self
    }
}

/// Test resource for listeners.
#[derive(Debug, Clone)]
struct TestListener {
    name: String,
}

impl TestListener {
    fn new(name: &str) -> Self {
        Self {
            name: name.to_string(),
        }
    }
}

impl Resource for TestListener {
    fn type_url(&self) -> &str {
        TypeUrl::LISTENER
    }

    fn name(&self) -> &str {
        &self.name
    }

    fn encode(&self) -> Result<prost_types::Any, Box<dyn std::error::Error + Send + Sync>> {
        Ok(prost_types::Any {
            type_url: self.type_url().to_string(),
            value: self.name.as_bytes().to_vec(),
        })
    }

    fn as_any(&self) -> &dyn std::any::Any {
        self
    }
}

fn setup_cache_with_clusters(node_id: &str, clusters: Vec<&str>) -> (Arc<ShardedCache>, NodeHash) {
    let cache = Arc::new(ShardedCache::new());
    let node_hash = NodeHash::from_id(node_id);

    let resources: Vec<BoxResource> = clusters
        .into_iter()
        .map(|name| Arc::new(TestCluster::new(name)) as BoxResource)
        .collect();

    let snapshot = Snapshot::builder()
        .version("v1")
        .resources(TypeUrl::CLUSTER.into(), resources)
        .build();

    cache.set_snapshot(node_hash, snapshot);
    (cache, node_hash)
}

// ============================================================================
// SotW Protocol Tests
// ============================================================================

mod sotw_protocol {
    use super::*;

    /// Per xDS spec: Initial request with empty version_info should trigger response.
    #[test]
    fn initial_request_empty_version() {
        let (cache, node_hash) =
            setup_cache_with_clusters("node-1", vec!["cluster-a", "cluster-b"]);
        let registry = Arc::new(ResourceRegistry::new());
        let handler = SotwHandler::new(cache, registry);
        let ctx = StreamContext::new();

        // Initial request has empty version_info
        let result = handler
            .process_request(&ctx, TypeUrl::CLUSTER.into(), "", &[], node_hash)
            .unwrap();

        assert!(result.is_some(), "Initial request should receive response");
        let response = result.unwrap();
        assert_eq!(response.version_info, "v1");
        assert_eq!(response.resources.len(), 2);
    }

    /// Per xDS spec: Request with current version should not trigger response.
    #[test]
    fn request_with_current_version_no_response() {
        let (cache, node_hash) = setup_cache_with_clusters("node-1", vec!["cluster-a"]);
        let registry = Arc::new(ResourceRegistry::new());
        let handler = SotwHandler::new(cache, registry);
        let ctx = StreamContext::new();

        // Request with same version as cache
        let result = handler
            .process_request(&ctx, TypeUrl::CLUSTER.into(), "v1", &[], node_hash)
            .unwrap();

        assert!(result.is_none(), "Same version should not trigger response");
    }

    /// Per xDS spec: Request with old version should trigger response.
    #[test]
    fn request_with_old_version_gets_response() {
        let (cache, node_hash) = setup_cache_with_clusters("node-1", vec!["cluster-a"]);
        let registry = Arc::new(ResourceRegistry::new());
        let handler = SotwHandler::new(cache, registry);
        let ctx = StreamContext::new();

        // Request with old version
        let result = handler
            .process_request(&ctx, TypeUrl::CLUSTER.into(), "v0", &[], node_hash)
            .unwrap();

        assert!(result.is_some(), "Old version should trigger response");
        assert_eq!(result.unwrap().version_info, "v1");
    }

    /// Per xDS spec: Wildcard subscription (empty resource_names) gets all resources.
    #[test]
    fn wildcard_subscription_returns_all() {
        let (cache, node_hash) =
            setup_cache_with_clusters("node-1", vec!["cluster-a", "cluster-b", "cluster-c"]);
        let registry = Arc::new(ResourceRegistry::new());
        let handler = SotwHandler::new(cache, registry);
        let ctx = StreamContext::new();

        let result = handler
            .process_request(&ctx, TypeUrl::CLUSTER.into(), "", &[], node_hash)
            .unwrap();

        let response = result.unwrap();
        assert_eq!(response.resources.len(), 3);
    }

    /// Per xDS spec: Explicit subscription only returns requested resources.
    #[test]
    fn explicit_subscription_returns_requested() {
        let (cache, node_hash) =
            setup_cache_with_clusters("node-1", vec!["cluster-a", "cluster-b", "cluster-c"]);
        let registry = Arc::new(ResourceRegistry::new());
        let handler = SotwHandler::new(cache, registry);
        let ctx = StreamContext::new();

        // Request only cluster-a and cluster-c
        let result = handler
            .process_request(
                &ctx,
                TypeUrl::CLUSTER.into(),
                "",
                &["cluster-a".to_string(), "cluster-c".to_string()],
                node_hash,
            )
            .unwrap();

        let response = result.unwrap();
        assert_eq!(response.resources.len(), 2);
    }

    /// Per xDS spec: Response nonce must be unique.
    #[test]
    fn response_nonce_is_unique() {
        let (cache, node_hash) = setup_cache_with_clusters("node-1", vec!["cluster-a"]);
        let registry = Arc::new(ResourceRegistry::new());
        let handler = SotwHandler::new(cache, registry);
        let ctx = StreamContext::new();

        let r1 = handler
            .process_request(&ctx, TypeUrl::CLUSTER.into(), "", &[], node_hash)
            .unwrap()
            .unwrap();

        // Change version to force new response
        let snapshot = Snapshot::builder()
            .version("v2")
            .resources(
                TypeUrl::CLUSTER.into(),
                vec![Arc::new(TestCluster::new("cluster-a")) as BoxResource],
            )
            .build();
        handler.cache().set_snapshot(node_hash, snapshot);

        let r2 = handler
            .process_request(&ctx, TypeUrl::CLUSTER.into(), "v1", &[], node_hash)
            .unwrap()
            .unwrap();

        assert_ne!(r1.nonce, r2.nonce, "Each response should have unique nonce");
    }

    /// Per xDS spec: Unknown node should not receive resources.
    #[test]
    fn unknown_node_no_response() {
        let cache = Arc::new(ShardedCache::new());
        let registry = Arc::new(ResourceRegistry::new());
        let handler = SotwHandler::new(cache, registry);
        let ctx = StreamContext::new();

        let unknown_node = NodeHash::from_id("unknown-node");
        let result = handler
            .process_request(&ctx, TypeUrl::CLUSTER.into(), "", &[], unknown_node)
            .unwrap();

        assert!(result.is_none(), "Unknown node should not receive response");
    }

    /// Per xDS spec: Response type_url must match request.
    #[test]
    fn response_type_url_matches_request() {
        let (cache, node_hash) = setup_cache_with_clusters("node-1", vec!["cluster-a"]);
        let registry = Arc::new(ResourceRegistry::new());
        let handler = SotwHandler::new(cache, registry);
        let ctx = StreamContext::new();

        let result = handler
            .process_request(&ctx, TypeUrl::CLUSTER.into(), "", &[], node_hash)
            .unwrap()
            .unwrap();

        assert_eq!(result.type_url.as_str(), TypeUrl::CLUSTER);
    }
}

// ============================================================================
// Delta Protocol Tests
// ============================================================================

mod delta_protocol {
    use super::*;

    /// Initial delta request (empty subscribe/unsubscribe + empty initial versions)
    /// is a wildcard subscription that should return all resources as updates.
    #[test]
    fn initial_wildcard_returns_all_resources() {
        let (cache, node_hash) =
            setup_cache_with_clusters("delta-node", vec!["cluster-a", "cluster-b"]);
        let registry = Arc::new(ResourceRegistry::new());
        let handler = DeltaHandler::new(cache, registry);

        let ctx = StreamContext::new();
        let mut state = ClientResourceState::new();

        let response = handler
            .process_request(
                &ctx,
                TypeUrl::CLUSTER.into(),
                &mut state,
                vec![],
                vec![],
                node_hash,
            )
            .expect("delta process_request should not error")
            .expect("first wildcard request should produce a response");

        assert_eq!(response.resources.len(), 2);
        assert!(response.removed_resources.is_empty());
        assert!(!response.nonce.is_empty());
    }

    /// After receiving a snapshot, a follow-up request with no version change
    /// should produce no further response (nothing to send).
    #[test]
    fn same_version_returns_no_response() {
        let (cache, node_hash) = setup_cache_with_clusters("delta-node", vec!["cluster-a"]);
        let registry = Arc::new(ResourceRegistry::new());
        let handler = DeltaHandler::new(cache, registry);

        let ctx = StreamContext::new();
        let mut state = ClientResourceState::new();

        // Initial request consumes the snapshot.
        let _first = handler
            .process_request(
                &ctx,
                TypeUrl::CLUSTER.into(),
                &mut state,
                vec![],
                vec![],
                node_hash,
            )
            .unwrap()
            .unwrap();

        // Re-issue with no subscription change — client already has the version.
        let second = handler
            .process_request(
                &ctx,
                TypeUrl::CLUSTER.into(),
                &mut state,
                vec![],
                vec![],
                node_hash,
            )
            .unwrap();

        assert!(second.is_none());
    }

    /// When a new snapshot drops a previously-sent resource, the delta response
    /// must include it in `removed_resources`.
    #[test]
    fn dropped_resource_is_reported_as_removed() {
        let (cache, node_hash) =
            setup_cache_with_clusters("delta-node", vec!["cluster-a", "cluster-b"]);
        let registry = Arc::new(ResourceRegistry::new());
        let handler = DeltaHandler::new(Arc::clone(&cache), registry);

        let ctx = StreamContext::new();
        let mut state = ClientResourceState::new();

        // Client receives both resources.
        let _first = handler
            .process_request(
                &ctx,
                TypeUrl::CLUSTER.into(),
                &mut state,
                vec![],
                vec![],
                node_hash,
            )
            .unwrap()
            .unwrap();

        // New snapshot with a different version that only contains cluster-a.
        let resources: Vec<BoxResource> = vec![Arc::new(TestCluster::new("cluster-a"))];
        let snapshot = Snapshot::builder()
            .version("v2")
            .resources(TypeUrl::CLUSTER.into(), resources)
            .build();
        cache.set_snapshot(node_hash, snapshot);

        let response = handler
            .process_request(
                &ctx,
                TypeUrl::CLUSTER.into(),
                &mut state,
                vec![],
                vec![],
                node_hash,
            )
            .unwrap()
            .expect("snapshot change should produce a delta response");

        assert!(response.removed_resources.contains(&"cluster-b".to_string()));
    }
}

// ============================================================================
// ADS Protocol Tests
// ============================================================================

mod ads_protocol {
    use super::*;

    /// ADS should handle multiple resource types.
    #[test]
    fn ads_handles_multiple_types() {
        let cache = Arc::new(ShardedCache::new());
        let registry = Arc::new(ResourceRegistry::new());
        let service = AdsService::new(cache.clone(), registry);

        let node_hash = NodeHash::from_id("node-1");

        // Add clusters
        let cluster: BoxResource = Arc::new(TestCluster::new("cluster-1"));
        let listener: BoxResource = Arc::new(TestListener::new("listener-1"));

        let snapshot = Snapshot::builder()
            .version("v1")
            .resources(TypeUrl::CLUSTER.into(), vec![cluster])
            .resources(TypeUrl::LISTENER.into(), vec![listener])
            .build();

        cache.set_snapshot(node_hash, snapshot);

        let ctx = StreamContext::new();

        // Request clusters
        let cluster_response = service
            .process_sotw_request(&ctx, TypeUrl::CLUSTER, "", &[], node_hash, "", None)
            .unwrap();
        assert!(cluster_response.is_some());

        // Request listeners
        let listener_response = service
            .process_sotw_request(&ctx, TypeUrl::LISTENER, "", &[], node_hash, "", None)
            .unwrap();
        assert!(listener_response.is_some());
    }

    /// ADS config customization.
    #[test]
    fn ads_config_customization() {
        let cache = Arc::new(ShardedCache::new());
        let registry = Arc::new(ResourceRegistry::new());
        let config = AdsConfig {
            max_concurrent_streams: 50,
            response_buffer_size: 8,
            enable_delta: false,
        };

        let service = AdsService::with_config(cache, registry, config);
        assert!(!service.config().enable_delta);
        assert_eq!(service.config().max_concurrent_streams, 50);
    }
}

// ============================================================================
// Resource Type Tests
// ============================================================================

mod resource_types {
    use super::*;

    /// Verify all standard xDS type URLs.
    #[test]
    fn standard_type_urls() {
        assert_eq!(
            TypeUrl::CLUSTER,
            "type.googleapis.com/envoy.config.cluster.v3.Cluster"
        );
        assert_eq!(
            TypeUrl::LISTENER,
            "type.googleapis.com/envoy.config.listener.v3.Listener"
        );
        assert_eq!(
            TypeUrl::ROUTE,
            "type.googleapis.com/envoy.config.route.v3.RouteConfiguration"
        );
        assert_eq!(
            TypeUrl::ENDPOINT,
            "type.googleapis.com/envoy.config.endpoint.v3.ClusterLoadAssignment"
        );
        assert_eq!(
            TypeUrl::SECRET,
            "type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.Secret"
        );
    }

    /// TypeUrl parsing and creation.
    #[test]
    fn type_url_parsing() {
        let cluster_url = TypeUrl::new(TypeUrl::CLUSTER);
        assert_eq!(cluster_url.as_str(), TypeUrl::CLUSTER);

        let custom_url = TypeUrl::new("custom.type/Resource");
        assert_eq!(custom_url.as_str(), "custom.type/Resource");
    }
}

// ============================================================================
// Node Identification Tests
// ============================================================================

mod node_identification {
    use super::*;

    /// Different nodes should have different hashes.
    #[test]
    fn different_nodes_different_hashes() {
        let hash1 = NodeHash::from_id("node-1");
        let hash2 = NodeHash::from_id("node-2");
        assert_ne!(hash1, hash2);
    }

    /// Same node ID should produce same hash.
    #[test]
    fn same_node_same_hash() {
        let hash1 = NodeHash::from_id("node-1");
        let hash2 = NodeHash::from_id("node-1");
        assert_eq!(hash1, hash2);
    }

    /// Each node should have isolated snapshot.
    #[test]
    fn node_isolation() {
        let cache = Arc::new(ShardedCache::new());
        let registry = Arc::new(ResourceRegistry::new());
        let handler = SotwHandler::new(cache.clone(), registry);

        let node1 = NodeHash::from_id("node-1");
        let node2 = NodeHash::from_id("node-2");

        // Set different snapshots for different nodes
        let snapshot1 = Snapshot::builder()
            .version("v1-node1")
            .resources(
                TypeUrl::CLUSTER.into(),
                vec![Arc::new(TestCluster::new("cluster-for-node1")) as BoxResource],
            )
            .build();

        let snapshot2 = Snapshot::builder()
            .version("v1-node2")
            .resources(
                TypeUrl::CLUSTER.into(),
                vec![Arc::new(TestCluster::new("cluster-for-node2")) as BoxResource],
            )
            .build();

        cache.set_snapshot(node1, snapshot1);
        cache.set_snapshot(node2, snapshot2);

        let ctx = StreamContext::new();

        let r1 = handler
            .process_request(&ctx, TypeUrl::CLUSTER.into(), "", &[], node1)
            .unwrap()
            .unwrap();
        let r2 = handler
            .process_request(&ctx, TypeUrl::CLUSTER.into(), "", &[], node2)
            .unwrap()
            .unwrap();

        assert_eq!(r1.version_info, "v1-node1");
        assert_eq!(r2.version_info, "v1-node2");
    }
}

// ============================================================================
// Versioning Tests
// ============================================================================

mod versioning {
    use super::*;

    /// Version comparison should be string-based.
    #[test]
    fn version_string_comparison() {
        let (cache, node_hash) = setup_cache_with_clusters("node-1", vec!["cluster-a"]);
        let registry = Arc::new(ResourceRegistry::new());
        let handler = SotwHandler::new(cache.clone(), registry);
        let ctx = StreamContext::new();

        // Get initial response
        let r1 = handler
            .process_request(&ctx, TypeUrl::CLUSTER.into(), "", &[], node_hash)
            .unwrap()
            .unwrap();

        // Request with exact same version string
        let r2 = handler
            .process_request(
                &ctx,
                TypeUrl::CLUSTER.into(),
                &r1.version_info,
                &[],
                node_hash,
            )
            .unwrap();

        assert!(
            r2.is_none(),
            "Exact version match should not trigger response"
        );
    }

    /// Semantic version strings work correctly.
    #[test]
    fn semantic_versions() {
        let cache = Arc::new(ShardedCache::new());
        let registry = Arc::new(ResourceRegistry::new());
        let handler = SotwHandler::new(cache.clone(), registry);
        let ctx = StreamContext::new();
        let node_hash = NodeHash::from_id("node-1");

        // Set snapshot with semantic version
        let snapshot = Snapshot::builder()
            .version("1.2.3")
            .resources(
                TypeUrl::CLUSTER.into(),
                vec![Arc::new(TestCluster::new("cluster-a")) as BoxResource],
            )
            .build();
        cache.set_snapshot(node_hash, snapshot);

        let response = handler
            .process_request(&ctx, TypeUrl::CLUSTER.into(), "1.2.2", &[], node_hash)
            .unwrap()
            .unwrap();

        assert_eq!(response.version_info, "1.2.3");
    }
}