junction-core 0.3.2

The core implementation for Junction - an xDS dynamically-configurable API load-balancer library.
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
//! Test macros for XDS Resources.
//!
//! Use these macros as a shorthand for writing out full XDS resource structs.

use std::str::FromStr;

use crate::xds::ResourceType;
use junction_api::backend::{Backend, BackendId, LbPolicy};
use xds_api::pb::{
    envoy::{
        config::{
            cluster::v3 as xds_cluster,
            core::v3 as xds_core,
            endpoint::v3 as xds_endpoint,
            listener::v3 as xds_listener,
            route::v3::{self as xds_route, route_action::hash_policy::Header},
        },
        service::discovery::v3::{DeltaDiscoveryRequest, DeltaDiscoveryResponse},
    },
    google::{protobuf, rpc},
};

use xds_api::pb::envoy::extensions::filters::{
    http::router::v3::Router, network::http_connection_manager::v3 as xds_http,
};

macro_rules! listener {
    ($name:expr, $route_name:expr$(,)*) => {{
        crate::xds::test::api_listener_rds($name, $route_name)
    }};
    ($name:expr, $route_name:expr => [$($vhost:expr),*$(,)*]$(,)?) => {{
        crate::xds::test::api_listener_inline_routes($name, $route_name, vec![
            $(
                $vhost,
            )*
        ])
    }};
}

pub(crate) use listener;

macro_rules! vhost {
    ($name:expr, $domains:expr, [$($route:expr),*$(,)*]$(,)?) => {{
        crate::xds::test::virtual_host($name, $domains, vec![$($route,)*])
    }};
}

pub(crate) use vhost;

macro_rules! cluster {
    ($cluster_name:expr) => {{
        crate::xds::test::cluster_from_name($cluster_name, None)
    }};
    (ring_hash $cluster_name:expr) => {{
        crate::xds::test::cluster_from_name($cluster_name, Some(xds_cluster::cluster::LbPolicy::RingHash))
    }};
    (inline $cluster_name:expr => { $($region:expr => [$($addr:expr),*]),* }) => {{
        let cla = crate::xds::test::cluster_load_assignment($cluster_name, vec![$(
            crate::xds::test::locality_lb_endpoints(Some($region), None, vec![
                $(
                    crate::xds::test::lb_endpoint($addr, None, None),
                )+
            ]),
        )*]);

        crate::xds::test::cluster_inline($cluster_name, cla)
    }};
}

pub(crate) use cluster;

macro_rules! cla {
    ($cluster_name:expr => { $($region:expr => [$($addr:expr),*]),* }) => {{
        crate::xds::test::cluster_load_assignment($cluster_name, vec![$(
            crate::xds::test::locality_lb_endpoints(Some($region), None, vec![
                $(
                    crate::xds::test::lb_endpoint($addr, None, None),
                )+
            ]),
        )*])
    }};
}
pub(crate) use cla;

macro_rules! route_config {
    ($name:expr, $vhosts:expr) => {{
        xds_api::pb::envoy::config::route::v3::RouteConfiguration {
            name: $name.to_string(),
            virtual_hosts: $vhosts.into_iter().collect(),
            ..Default::default()
        }
    }};
}

pub(crate) use route_config;

macro_rules! route {
    (default $cluster:expr) => {{
        crate::xds::test::route!(_INTERNAL path Some("/"), ring_hash None, header None => $cluster)
    }};
    (default ring_hash = $header:expr, $cluster:expr) => {{
        crate::xds::test::route!(_INTERNAL path Some("/"), ring_hash Some($header), header None => $cluster)
    }};
    (header $header_name:expr => $cluster:expr) => {{
        crate::xds::test::route!(_INTERNAL path None, ring_hash None, header Some($header_name) => $cluster)
    }};
    (path $path:expr => $cluster:expr) => {{
        crate::xds::test::route!(_INTERNAL path Some($path), header None => $cluster)
    }};
    (_INTERNAL path $path:expr, ring_hash $hash_header:expr, header $header_name:expr => $cluster:expr) => {
        crate::xds::test::route_to_cluster($path, $hash_header, $header_name, $cluster)
    };
}

pub(crate) use route;

macro_rules! req {
    (t = $ty:expr $(,)*) => {
        crate::xds::test::req!(
            t = $ty,
            n = "",
            add = vec![],
            remove = vec![],
            init = vec![],
            err = None
        )
    };
    (t = $ty:expr, n = $n:expr $(,)*) => {
        crate::xds::test::req!(
            t = $ty,
            n = $n,
            add = vec![],
            remove = vec![],
            init = vec![],
            err = None
        )
    };
    (t = $ty:expr, add = $add:expr $(,)*) => {
        crate::xds::test::req!(
            t = $ty,
            n = "",
            add = $add,
            remove = vec![],
            init = vec![],
            err = None
        )
    };
    (t = $ty:expr, remove = $remove:expr $(,)*) => {
        crate::xds::test::req!(
            t = $ty,
            n = "",
            add = vec![],
            remove = $remove,
            init = vec![],
            err = None
        )
    };
    (t = $ty:expr, n = $n:expr, add = $add:expr $(,)*) => {
        crate::xds::test::req!(
            t = $ty,
            n = $n,
            add = $add,
            remove = vec![],
            init = vec![],
            err = None
        )
    };
    (t = $ty:expr, add = $add:expr, init = $init:expr $(,)*) => {
        crate::xds::test::req!(
            t = $ty,
            n = "",
            add = $add,
            remove = vec![],
            init = $init,
            err = None
        )
    };
    (t = $rty:expr, n = $n:expr, add = $add:expr, remove = $remove:expr, init = $init:expr, err = $err:expr $(,)*) => {{
        crate::xds::test::delta_discovery_request($rty, $n, $add, $remove, $init, $err)
    }};
}

pub(crate) use req;

use super::ResourceVec;

pub fn delta_discovery_request(
    rtype: ResourceType,
    response_nonce: &'static str,
    subscribe: Vec<&'static str>,
    unsubscribe: Vec<&'static str>,
    versions: Vec<(&'static str, &'static str)>,
    error: Option<&'static str>,
) -> DeltaDiscoveryRequest {
    let resource_names_subscribe = subscribe.into_iter().map(|n| n.to_string()).collect();
    let resource_names_unsubscribe = unsubscribe.into_iter().map(|n| n.to_string()).collect();
    let initial_resource_versions = versions
        .into_iter()
        .map(|(v, r)| (v.to_string(), r.to_string()))
        .collect();

    let error_detail = error.map(|msg| rpc::Status {
        code: tonic::Code::InvalidArgument.into(),
        message: msg.to_string(),
        ..Default::default()
    });

    DeltaDiscoveryRequest {
        type_url: rtype.type_url().to_string(),
        response_nonce: response_nonce.to_string(),
        resource_names_subscribe,
        resource_names_unsubscribe,
        initial_resource_versions,
        error_detail,
        ..Default::default()
    }
}

macro_rules! resp {
    (n = $nonce:expr, add = $add:expr, remove = $remove:expr $(,)*) => {
        crate::xds::test::delta_discovery_response($nonce, None, $add, $remove)
    };
}

pub(crate) use resp;

pub fn delta_discovery_response(
    nonce: &'static str,
    version: Option<&'static str>,
    resources: ResourceVec,
    removed_resources: Vec<&'static str>,
) -> DeltaDiscoveryResponse {
    let type_url = resources.resource_type().type_url().to_string();
    let system_version_info = version.map(|s| s.to_string()).unwrap_or_default();
    let resources = resources.to_resources().unwrap();
    let removed_resources = removed_resources
        .into_iter()
        .map(|s| s.to_string())
        .collect();

    DeltaDiscoveryResponse {
        type_url,
        system_version_info,
        nonce: nonce.to_string(),
        resources,
        removed_resources,
        ..Default::default()
    }
}

pub fn api_listener_rds(name: &'static str, route_name: &'static str) -> xds_listener::Listener {
    use xds_http::{http_connection_manager::RouteSpecifier, http_filter::ConfigType, Rds};

    let http_router_filter = Router::default();
    let route_specifier = RouteSpecifier::Rds(Rds {
        config_source: Some(ads_config_source()),
        route_config_name: route_name.to_string(),
    });

    let http_connection_manager = xds_http::HttpConnectionManager {
        route_specifier: Some(route_specifier),
        http_filters: vec![xds_http::HttpFilter {
            name: "jct_connection_manager".to_string(),
            config_type: Some(ConfigType::TypedConfig(
                protobuf::Any::from_msg(&http_router_filter).expect("generated invalid xds"),
            )),
            ..Default::default()
        }],
        ..Default::default()
    };

    xds_listener::Listener {
        name: name.to_string(),
        api_listener: Some(xds_listener::ApiListener {
            api_listener: Some(protobuf::Any::from_msg(&http_connection_manager).unwrap()),
        }),
        ..Default::default()
    }
}

pub fn api_listener_inline_routes(
    name: &'static str,
    route_name: &'static str,
    virtual_hosts: Vec<xds_route::VirtualHost>,
) -> xds_listener::Listener {
    use xds_http::{http_connection_manager::RouteSpecifier, http_filter::ConfigType};

    let http_router_filter = Router::default();
    let route_specifier = RouteSpecifier::RouteConfig(xds_route::RouteConfiguration {
        name: route_name.to_string(),
        virtual_hosts,
        ..Default::default()
    });

    let http_connection_manager = xds_http::HttpConnectionManager {
        route_specifier: Some(route_specifier),
        http_filters: vec![xds_http::HttpFilter {
            name: "jct_connection_manager".to_string(),
            config_type: Some(ConfigType::TypedConfig(
                protobuf::Any::from_msg(&http_router_filter).expect("generated invalid xds"),
            )),
            ..Default::default()
        }],
        ..Default::default()
    };

    xds_listener::Listener {
        name: name.to_string(),
        api_listener: Some(xds_listener::ApiListener {
            api_listener: Some(protobuf::Any::from_msg(&http_connection_manager).unwrap()),
        }),
        ..Default::default()
    }
}

pub fn route_to_cluster(
    path: Option<&str>,
    hash_header: Option<&str>,
    match_header: Option<&str>,
    cluster_name: &str,
) -> xds_route::Route {
    let mut route_match = xds_route::RouteMatch {
        ..Default::default()
    };

    if let Some(path) = path {
        route_match.path_specifier = Some(xds_route::route_match::PathSpecifier::Path(
            path.to_string(),
        ));
    }

    if let Some(header_name) = match_header {
        let header_matcher = xds_route::HeaderMatcher {
            name: header_name.to_string(),
            header_match_specifier: Some(
                xds_route::header_matcher::HeaderMatchSpecifier::PresentMatch(true),
            ),
            ..Default::default()
        };
        route_match.headers = vec![header_matcher];
    }

    let hash_policy = hash_header
        .map(|header_name| {
            let hash_policy = xds_route::route_action::HashPolicy {
                policy_specifier: Some(
                    xds_route::route_action::hash_policy::PolicySpecifier::Header(Header {
                        header_name: header_name.to_string(),
                        regex_rewrite: None,
                    }),
                ),
                terminal: true,
            };
            vec![hash_policy]
        })
        .unwrap_or_default();

    let action = xds_route::route::Action::Route(xds_route::RouteAction {
        hash_policy,
        cluster_specifier: Some(xds_route::route_action::ClusterSpecifier::Cluster(
            cluster_name.to_string(),
        )),
        ..Default::default()
    });
    xds_route::Route {
        r#match: Some(route_match),
        action: Some(action),
        ..Default::default()
    }
}

pub fn virtual_host(
    name: &'static str,
    domains: impl IntoIterator<Item = &'static str>,
    routes: impl IntoIterator<Item = xds_route::Route>,
) -> xds_route::VirtualHost {
    xds_route::VirtualHost {
        name: name.to_string(),
        domains: domains.into_iter().map(|s| s.to_string()).collect(),
        routes: routes.into_iter().collect(),
        ..Default::default()
    }
}

pub fn cluster_from_name(
    name: &'static str,
    lb_policy: Option<xds_cluster::cluster::LbPolicy>,
) -> xds_cluster::Cluster {
    let backend = Backend {
        id: BackendId::from_str(name).unwrap(),
        lb: LbPolicy::Unspecified,
    };

    let mut cluster = backend.to_xds();
    if let Some(lb_policy) = lb_policy {
        cluster.lb_policy = lb_policy.into();
    }
    cluster
}

pub fn cluster_load_assignment(
    name: &'static str,
    endpoints: Vec<xds_endpoint::LocalityLbEndpoints>,
) -> xds_endpoint::ClusterLoadAssignment {
    xds_endpoint::ClusterLoadAssignment {
        cluster_name: name.to_string(),
        endpoints,
        ..Default::default()
    }
}

pub fn locality_lb_endpoints(
    region: Option<&'static str>,
    zone: Option<&'static str>,
    lb_endpoints: Vec<xds_endpoint::LbEndpoint>,
) -> xds_endpoint::LocalityLbEndpoints {
    let locality = xds_core::Locality {
        region: region.unwrap_or("").to_string(),
        zone: zone.unwrap_or("").to_string(),
        ..Default::default()
    };

    xds_endpoint::LocalityLbEndpoints {
        locality: Some(locality),
        lb_endpoints,
        ..Default::default()
    }
}

pub fn lb_endpoint(
    hostname: &'static str,
    port: Option<u32>,
    health: Option<xds_core::HealthStatus>,
) -> xds_endpoint::LbEndpoint {
    let port = port.unwrap_or(80);
    let endpoint = xds_endpoint::Endpoint {
        address: Some(xds_core::Address {
            address: Some(xds_core::address::Address::SocketAddress(
                xds_core::SocketAddress {
                    address: hostname.to_string(),
                    port_specifier: Some(xds_core::socket_address::PortSpecifier::PortValue(port)),
                    ..Default::default()
                },
            )),
        }),
        ..Default::default()
    };

    let health = health.unwrap_or(xds_core::HealthStatus::Healthy);
    xds_endpoint::LbEndpoint {
        health_status: health as i32,
        metadata: None,
        load_balancing_weight: None,
        host_identifier: Some(xds_endpoint::lb_endpoint::HostIdentifier::Endpoint(
            endpoint,
        )),
    }
}

pub fn ads_config_source() -> xds_core::ConfigSource {
    xds_core::ConfigSource {
        config_source_specifier: Some(xds_core::config_source::ConfigSourceSpecifier::Ads(
            xds_core::AggregatedConfigSource {},
        )),
        resource_api_version: xds_core::ApiVersion::V3 as i32,
        ..Default::default()
    }
}