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 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
//! The Junction configuration API. This crate allows you to build configuration
//! for a dynamic HTTP client and export it to a control plane or pass it
//! directly to an in-process client. Junction configuration is expressable as
//! plain Rust strucs, and can be serialized/deserialized with a [serde]
//! compatible library.
//!
//! All of the configuration here should be correct by construction - if you can
//! create a struct, it's valid Junction configuration. Different
//! representations of the same configuration are possible, and clients and
//! control planes may normalize your configuration differently, so when writing
//! tests for your configuration be aware that it may be normalized while
//! converting between different formats or data sources.
//!
//! # Core Concepts
//!
//! ## Targets
//!
//! The Junction API is built around the idea of a traffic [Target], a a unique
//! identifier for a place to send traffic. Targets are logical; a Kubernetes
//! Service target represents the entire service, running [anywhere in a
//! multi-cluster deployment][ns-position], not an individual Pod or Node or
//! Service object.
//!
//! [ns-position]: https://github.com/kubernetes/community/blob/master/sig-multicluster/namespace-sameness-position-statement.md
//!
//! ## Routes
//!
//! An HTTP [Route][crate::http::Route] is the client facing half of Junction,
//! and contains most of the things you'd traditionally find in a hand-rolled
//! HTTP client - timeouts, retries, URL rewriting and more. The [http]
//! module's documentation goes into detail on how and why to configure a Route.
//!
//! ## Backends
//!
//! A [Backend][crate::backend::Backend] is the Service oriented half of
//! Junction configuration. Backends configuration gives you control over the
//! things you'd normally configure in a reverse proxy or a traditional load
//! balancer, like load balancing. See the [backend] module's documentation for
//! more detail.
//!
//! # Crate Feature Flags
//!
//! The following feature flags are available:
//!
//! * The `kube` feature includes conversions from Junction configuration to and
//! from Kubernetes objects. This feature depends on the `kube` and
//! `k8s-openapi` crates. See the [kube] module docs for more detail.
//!
//! * The `xds` feature includes conversions from Junction configuration to and
//! from xDS types. This feature depends on the [xds-api][xds_api] crate.
mod error;
use std::{ops::Deref, str::FromStr};
pub use error::Error;
pub mod backend;
pub mod http;
mod shared;
pub use shared::{Duration, Fraction, Regex};
#[cfg(feature = "xds")]
mod xds;
#[cfg(any(feature = "kube_v1_29", feature = "kube_v1_30", feature = "kube_v1_31"))]
pub mod kube;
#[cfg(feature = "typeinfo")]
use junction_typeinfo::TypeInfo;
use serde::{de::Visitor, Deserialize, Serialize};
#[cfg(feature = "xds")]
macro_rules! value_or_default {
($value:expr, $default:expr) => {
$value.as_ref().map(|v| v.value).unwrap_or($default)
};
}
#[cfg(feature = "xds")]
pub(crate) use value_or_default;
// TODO: replace String with SmolStr
macro_rules! newtype_string {
($(#[$id_attr:meta])* pub $name:ident) => {
$(#[$id_attr])*
#[derive(Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct $name(String);
impl Deref for $name {
type Target = str;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl AsRef<str> for $name {
fn as_ref(&self) -> &str {
&self.0
}
}
impl std::fmt::Display for $name {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str(&self.0)
}
}
impl std::fmt::Debug for $name {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{:?}", self.0)
}
}
impl Serialize for $name {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
serializer.serialize_str(&self.0)
}
}
impl<'de> Deserialize<'de> for $name {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
// implements both visit_str and visit_string in case that moving the
// string into this $name instead of cloning is possible.
struct NameVisitor;
impl<'de> Visitor<'de> for NameVisitor {
type Value = $name;
fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
formatter.write_str("a valid DNS $name")
}
fn visit_string<E>(self, v: String) -> Result<Self::Value, E>
where
E: serde::de::Error,
{
let name: Result<$name, Error> = v.try_into();
name.map_err(|e: Error| E::custom(e.to_string()))
}
fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: serde::de::Error,
{
$name::from_str(v).map_err(|e| E::custom(e.to_string()))
}
}
deserializer.deserialize_string(NameVisitor)
}
}
#[cfg(feature = "typeinfo")]
impl junction_typeinfo::TypeInfo for $name {
fn kind() -> junction_typeinfo::Kind {
junction_typeinfo::Kind::String
}
}
impl FromStr for $name {
type Err = Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
Self::validate(s.as_bytes())?;
Ok($name(s.to_string()))
}
}
impl TryFrom<String> for $name {
type Error = Error;
fn try_from(value: String) -> Result<$name, Self::Error> {
$name::validate(value.as_bytes())?;
Ok($name(value))
}
}
impl<'a> TryFrom<&'a str> for $name {
type Error = Error;
fn try_from(value: &'a str) -> Result<$name, Self::Error> {
$name::validate(value.as_bytes())?;
Ok($name(value.to_string()))
}
}
}
}
// A lookup table of valid RFC 1123 name characters. RFC 1035 labels use
// this table as well but ignore the '.' character.
//
// Adapted from the table used in the http crate to valid URI and Authority
// strings.
//
// https://github.com/hyperium/http/blob/master/src/uri/mod.rs#L146-L153
#[rustfmt::skip]
const DNS_CHARS: [u8; 256] = [
// 0 1 2 3 4 5 6 7 8 9
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 1x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 2x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 3x
0, 0, 0, 0, 0, b'-', b'.', 0, b'0', b'1', // 4x
b'2', b'3', b'4', b'5', b'6', b'7', b'8', b'9', 0, 0, // 5x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 6x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 7x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 8x
0, 0, 0, 0, 0, 0, 0, b'a', b'b', b'c', // 9x
b'd', b'e', b'f', b'g', b'h', b'i', b'j', b'k', b'l', b'm', // 10x
b'n', b'o', b'p', b'q', b'r', b's', b't', b'u', b'v', b'w', // 11x
b'x', b'y', b'z', 0, 0, 0, 0, 0, 0, 0, // 12x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 13x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 14x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 15x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 16x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 17x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 18x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 19x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 20x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 21x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 22x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 23x
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 24x
0, 0, 0, 0, 0, 0, // 25x
];
newtype_string! {
/// AN RFC 1123 DNS domain name.
///
/// This name must be no more than 253 characters, and can only contain
/// lowercase ascii alphanumeric charaters, `.` and `-`.
pub Hostname
}
impl Hostname {
/// The RFC 1035 max length. We don't add any extra validation to it, since
/// there's a variety of places Name gets used and they won't all have the
/// same constraints.
const MAX_LEN: usize = 253;
/// Create a new hostname from a static string.
///
/// Assumes that a human being has manually validated that this is a valid
/// hostname and will panic if it is not.
pub fn from_static(src: &'static str) -> Self {
Self::validate(src.as_bytes()).expect("expected a static Name to be valid");
Self(src.to_string())
}
fn validate(bs: &[u8]) -> Result<(), Error> {
if bs.len() > Self::MAX_LEN {
return Err(Error::new_static(
"Hostname must not be longer than 253 characters",
));
}
for (i, &b) in bs.iter().enumerate() {
match (i, DNS_CHARS[b as usize]) {
(_, 0) => return Err(Error::new_static("Hostname contains an invalid character")),
(0, b'-' | b'.') => {
return Err(Error::new_static(
"Hostname must start with an alphanumeric character",
))
}
(i, b'-' | b'.') if i == bs.len() => {
return Err(Error::new_static(
"Hostname must end with an alphanumeric character",
))
}
_ => (),
}
}
Ok(())
}
}
newtype_string! {
/// An RFC 1035 compatible name. This name must be useable as a component of a
/// DNS subdomain - it must start with a lowercase ascii alphabetic character
/// and may only consist of ascii lowercase alphanumeric characters and the `-`
/// character.
pub Name
}
impl Name {
// RFC 1035 max length.
const MAX_LEN: usize = 63;
/// Create a new name from a static string.
///
/// Assumes that a human being has manually validated that this is a valid name
/// and will panic if it is not.
pub fn from_static(src: &'static str) -> Self {
Self::validate(src.as_bytes()).expect("expected a static Name to be valid");
Self(src.to_string())
}
/// Check that a `str` is a valid Name.
///
/// Being a valid name also implies that the slice is valid utf-8.
fn validate(bs: &[u8]) -> Result<(), Error> {
if bs.len() > Self::MAX_LEN {
return Err(Error::new_static(
"Name must not be longer than 63 characters",
));
}
for (i, &b) in bs.iter().enumerate() {
match (i, DNS_CHARS[b as usize]) {
(_, 0 | b'.') => {
return Err(Error::new_static("Name contains an invalid character"))
}
(0, b'-' | b'0'..=b'9') => {
return Err(Error::new_static("Name must start with [a-z]"))
}
(i, b'-') if i == bs.len() => {
return Err(Error::new_static(
"Name must end with an alphanumeric character",
))
}
_ => (),
}
}
Ok(())
}
}
/// A traffic target. Traffic targets are abstract, uniquely identifiable places
/// to route traffic, like a DNS name or a Kubernetes Service.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
#[serde(tag = "type")]
#[cfg_attr(feature = "typeinfo", derive(TypeInfo))]
pub enum Target {
/// A DNS hostname.
///
/// Traffic sent to a DNS hostname will uses the addresses returned from DNS
/// as its final destination. How addresses are fetched and load balanced is
/// configured on each [Backend][crate::backend::Backend].
#[serde(alias = "dns", alias = "DNS")]
Dns(Dns),
/// The addresses that make up a Kubernetes Service.
///
/// Any type of Service, except an `ExternalName` Service may be used as a
/// traffic target (to represent an `ExternalName` Service, use a [DNS target][Target::Dns])
/// and will route traffic directly to Pod IPs as if the service had
/// explicitly set `ClusterIP: None`.
#[serde(untagged)]
KubeService(KubeService),
}
impl std::fmt::Display for Target {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
self.write_name(f)
}
}
impl std::str::FromStr for Target {
type Err = Error;
fn from_str(name: &str) -> Result<Self, Self::Err> {
let hostname = Hostname::from_str(name)?;
let target = match name {
n if n.ends_with(KubeService::SUBDOMAIN) => {
let parts: Vec<_> = hostname.split('.').collect();
if parts.len() != 5 {
return Err(Error::new_static(
"invalid Service target: name and namespace must be valid DNS labels",
));
}
let name = parts[0].parse()?;
let namespace = parts[1].parse()?;
Target::KubeService(KubeService { name, namespace })
}
_ => Target::Dns(Dns { hostname }),
};
Ok(target)
}
}
impl Target {
const BACKEND_SUBDOMAIN: &'static str = ".lb.jct";
/// Create a new DNS target. The given name must be a valid RFC 1123 DNS
/// hostname.
pub fn dns(name: &str) -> Result<Self, Error> {
let hostname = Hostname::from_str(name)?;
Ok(Target::Dns(Dns { hostname }))
}
/// Create a new Kubernetes Service target.
///
/// `name` and `hostname` must be valid DNS subdomain labels.
pub fn kube_service(namespace: &str, name: &str) -> Result<Self, Error> {
let namespace = Name::from_str(namespace)?;
let name = Name::from_str(name)?;
Ok(Target::KubeService(KubeService { name, namespace }))
}
/// Convert this target into a [BackendId] with the specified port.
pub fn into_backend(self, port: u16) -> BackendId {
BackendId { target: self, port }
}
/// Convert this target into a [VirtualHost] with an optional port.
pub fn into_vhost(self, port: Option<u16>) -> VirtualHost {
VirtualHost { target: self, port }
}
/// The canonical name of this Target.
///
/// This is an alias for the [Display][std::fmt::Display] representation.
pub fn name(&self) -> String {
let mut buf = String::new();
self.write_name(&mut buf).unwrap();
buf
}
fn write_name(&self, w: &mut impl std::fmt::Write) -> std::fmt::Result {
match self {
Target::Dns(dns) => {
w.write_str(&dns.hostname)?;
}
Target::KubeService(svc) => {
write!(
w,
"{name}.{namespace}{subdomain}",
name = svc.name,
namespace = svc.namespace,
subdomain = KubeService::SUBDOMAIN,
)?;
}
}
Ok(())
}
#[doc(hidden)]
pub fn passthrough_route_name(&self) -> String {
let mut buf = String::new();
self.write_passthrough_route_name(&mut buf).unwrap();
buf
}
fn write_passthrough_route_name(&self, w: &mut impl std::fmt::Write) -> std::fmt::Result {
match self {
Target::Dns(dns) => {
write!(w, "{}{}", dns.hostname, Target::BACKEND_SUBDOMAIN)?;
}
Target::KubeService(svc) => {
write!(
w,
"{name}.{namespace}{svc}{backend}",
name = svc.name,
namespace = svc.namespace,
svc = KubeService::SUBDOMAIN,
backend = Target::BACKEND_SUBDOMAIN,
)?;
}
}
Ok(())
}
#[doc(hidden)]
pub fn from_passthrough_route_name(name: &str) -> Result<Self, Error> {
let hostname = Hostname::from_str(name)?;
let Some(hostname) = hostname.strip_suffix(Target::BACKEND_SUBDOMAIN) else {
return Err(Error::new_static("expected a Junction backend name"));
};
Self::from_str(hostname)
}
}
/// A Kubernetes Service to target with traffic.
///
/// See [Target::KubeService].
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, Hash, Default, PartialOrd, Ord)]
#[cfg_attr(feature = "typeinfo", derive(TypeInfo))]
pub struct KubeService {
/// The name of the Kubernetes Service to target.
pub name: Name,
/// The namespace of the Kubernetes service to target. This must be explicitly
/// specified, and won't be inferred from context.
pub namespace: Name,
}
impl KubeService {
const SUBDOMAIN: &'static str = ".svc.cluster.local";
}
/// A DNS name to target with traffic.
///
/// See [Target::Dns].
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, Hash, Default, PartialOrd, Ord)]
#[cfg_attr(feature = "typeinfo", derive(TypeInfo))]
pub struct Dns {
/// A valid RFC1123 DNS domain name.
pub hostname: Hostname,
}
/// A virtual hostname. `VirtualHosts` represent the primary layer of
/// indirection in Junction. Traffic sent to a `VirtualHost` is routed to an
/// appropriate backend based on the content of the request.
///
/// VirtualHosts uniquely map to the Authority section of a URL.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash, PartialOrd, Ord)]
#[cfg_attr(feature = "typeinfo", derive(TypeInfo))]
pub struct VirtualHost {
/// The logical target for this traffic.
#[serde(flatten)]
pub target: Target,
/// The port this virtual hostname should apply to. If no port is specified,
/// traffic is allowed on any port.
pub port: Option<u16>,
}
impl std::fmt::Display for VirtualHost {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
self.write_name(f)
}
}
impl std::str::FromStr for VirtualHost {
type Err = Error;
fn from_str(name: &str) -> Result<Self, Self::Err> {
let (name, port) = parse_port(name)?;
let target = Target::from_str(name)?;
Ok(Self { target, port })
}
}
impl VirtualHost {
/// Return a clone of this target with its port set to `port`.
pub fn with_port(&self, port: u16) -> Self {
Self {
target: self.target.clone(),
port: Some(port),
}
}
/// Return a clone of this virtual host with no port set.
pub fn without_port(&self) -> Self {
Self {
target: self.target.clone(),
port: None,
}
}
/// Return a clone of this VirtualHost with its port set to `default_port`
/// if it doesn't already have a port set.
pub fn with_default_port(&self, default_port: u16) -> Self {
Self {
target: self.target.clone(),
port: Some(self.port.unwrap_or(default_port)),
}
}
/// Clone this VirtualHost and convert it to a [BackendId].
///
/// Returns `None` if this VirtualHost has no port set.
pub fn into_backend(self) -> Option<BackendId> {
self.port.map(|port| BackendId {
target: self.target,
port,
})
}
/// The canonical name of this virtual host.
///
/// This is an alias for the [Display][std::fmt::Display] representation of
/// this VirtualHost.
pub fn name(&self) -> String {
let mut buf = String::new();
self.write_name(&mut buf).unwrap();
buf
}
fn write_name(&self, w: &mut impl std::fmt::Write) -> std::fmt::Result {
self.target.write_name(w)?;
if let Some(port) = self.port {
write!(w, ":{port}")?;
}
Ok(())
}
}
/// A target and port together uniquely represent a [Backend][crate::backend::Backend].
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash, PartialOrd, Ord)]
#[cfg_attr(feature = "typeinfo", derive(TypeInfo))]
pub struct BackendId {
/// The logical traffic target that this backend configures.
#[serde(flatten)]
pub target: Target,
/// The port backend traffic is sent on.
pub port: u16,
}
impl std::fmt::Display for BackendId {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
self.write_name(f)
}
}
impl std::str::FromStr for BackendId {
type Err = Error;
fn from_str(name: &str) -> Result<Self, Self::Err> {
let (name, port) = parse_port(name)?;
let port =
port.ok_or_else(|| Error::new_static("expected a fully qualified name with a port"))?;
let target = Target::from_str(name)?;
Ok(Self { target, port })
}
}
impl BackendId {
/// Convert this id into a [VirtualHost] with the same route target and port.
pub fn into_vhost(self) -> VirtualHost {
VirtualHost {
target: self.target,
port: Some(self.port),
}
}
/// The cannonical name of this ID. This is an alias for the
/// [Display][std::fmt::Display] representation of this ID.
pub fn name(&self) -> String {
let mut buf = String::new();
self.write_name(&mut buf).unwrap();
buf
}
fn write_name(&self, w: &mut impl std::fmt::Write) -> std::fmt::Result {
self.target.write_name(w)?;
write!(w, ":{port}", port = self.port)?;
Ok(())
}
#[doc(hidden)]
pub fn passthrough_route_name(&self) -> String {
let mut buf = String::new();
self.write_passthrough_route_name(&mut buf).unwrap();
buf
}
fn write_passthrough_route_name(&self, w: &mut impl std::fmt::Write) -> std::fmt::Result {
self.target.write_passthrough_route_name(w)?;
write!(w, ":{port}", port = self.port)?;
Ok(())
}
#[doc(hidden)]
pub fn from_passthrough_route_name(name: &str) -> Result<Self, Error> {
let (name, port) = parse_port(name)?;
let port =
port.ok_or_else(|| Error::new_static("expected a fully qualified name with a port"))?;
let target = Target::from_passthrough_route_name(name)?;
Ok(Self { target, port })
}
}
#[inline]
fn parse_port(s: &str) -> Result<(&str, Option<u16>), Error> {
let (name, port) = match s.split_once(':') {
Some((name, port)) => (name, Some(port)),
None => (s, None),
};
let port = match port {
Some(port) => {
Some(u16::from_str(port).map_err(|_| Error::new_static("invalid port number"))?)
}
None => None,
};
Ok((name, port))
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_parses_json() {
let target = serde_json::json!({
"type": "service",
"name": "foo",
"namespace": "potato",
});
assert_eq!(
serde_json::from_value::<Target>(target).unwrap(),
Target::kube_service("potato", "foo").unwrap(),
);
let target = serde_json::json!({
"type": "dns",
"hostname": "example.com"
});
assert_eq!(
serde_json::from_value::<Target>(target).unwrap(),
Target::dns("example.com").unwrap(),
);
}
#[test]
fn test_route_target_name() {
assert_route_name(
VirtualHost {
target: Target::KubeService(KubeService {
name: Name::from_static("potato"),
namespace: Name::from_static("production"),
}),
port: None,
},
"potato.production.svc.cluster.local",
);
assert_route_name(
VirtualHost {
target: Target::Dns(Dns {
hostname: Hostname::from_static("cool-stuff.example.com"),
}),
port: None,
},
"cool-stuff.example.com",
);
assert_route_name(
VirtualHost {
target: Target::KubeService(KubeService {
name: Name::from_static("potato"),
namespace: Name::from_static("production"),
}),
port: Some(123),
},
"potato.production.svc.cluster.local:123",
);
assert_route_name(
VirtualHost {
target: Target::Dns(Dns {
hostname: Hostname::from_static("cool-stuff.example.com"),
}),
port: Some(123),
},
"cool-stuff.example.com:123",
);
}
#[track_caller]
fn assert_route_name(target: VirtualHost, str: &'static str) {
assert_eq!(&target.name(), str);
let parsed = VirtualHost::from_str(str).unwrap();
assert_eq!(parsed, target);
}
#[test]
fn test_backend_target_name() {
assert_backend_name(
BackendId {
target: Target::KubeService(KubeService {
name: Name::from_static("potato"),
namespace: Name::from_static("production"),
}),
port: 123,
},
"potato.production.svc.cluster.local:123",
);
assert_backend_name(
BackendId {
target: Target::Dns(Dns {
hostname: Hostname::from_static("cool-stuff.example.com"),
}),
port: 123,
},
"cool-stuff.example.com:123",
);
assert!(BackendId::from_str("potato.production.svc.cluster.local").is_err());
assert!(BackendId::from_str("cool-stuff.example.com",).is_err());
}
#[track_caller]
fn assert_backend_name(target: BackendId, str: &'static str) {
assert_eq!(&target.name(), str);
let parsed = BackendId::from_str(str).unwrap();
assert_eq!(parsed, target);
}
#[test]
fn test_target_name() {
assert_name(
Target::kube_service("production", "potato").unwrap(),
"potato.production.svc.cluster.local",
);
assert_name(
Target::dns("cool-stuff.example.com").unwrap(),
"cool-stuff.example.com",
);
}
#[track_caller]
fn assert_name(target: Target, str: &'static str) {
assert_eq!(&target.name(), str);
let parsed = Target::from_str(str).unwrap();
assert_eq!(parsed, target);
}
#[test]
fn test_target_passthrough_name() {
assert_passthrough_name(
Target::kube_service("production", "potato").unwrap(),
"potato.production.svc.cluster.local.lb.jct",
);
assert_passthrough_name(
Target::dns("cool-stuff.example.com").unwrap(),
"cool-stuff.example.com.lb.jct",
);
}
#[track_caller]
fn assert_passthrough_name(target: Target, str: &'static str) {
assert_eq!(&target.passthrough_route_name(), str);
let parsed = Target::from_passthrough_route_name(str).unwrap();
assert_eq!(parsed, target);
}
#[test]
fn test_valid_name() {
let alphabetic: Vec<char> = (b'a'..=b'z').map(|b| b as char).collect();
let full_alphabet: Vec<char> = (b'a'..=b'z')
.chain(b'0'..=b'9')
.chain([b'-'])
.map(|b| b as char)
.collect();
arbtest::arbtest(|u| {
let input = arbitrary_string(u, &alphabetic, &full_alphabet, Name::MAX_LEN);
let res = Name::from_str(&input);
assert!(
res.is_ok(),
"string should be a valid name: {input:?} (len={}): {}",
input.len(),
res.unwrap_err(),
);
Ok(())
});
}
#[test]
fn test_valid_hostname() {
let alphanumeric: Vec<char> = (b'a'..=b'z')
.chain(b'0'..=b'9')
.map(|b| b as char)
.collect();
let full_alphabet: Vec<char> = (b'a'..=b'z')
.chain(b'0'..=b'9')
.chain([b'-', b'.'])
.map(|b| b as char)
.collect();
arbtest::arbtest(|u| {
let input = arbitrary_string(u, &alphanumeric, &full_alphabet, Hostname::MAX_LEN);
let res = Hostname::from_str(&input);
assert!(
res.is_ok(),
"string should be a valid hostname: {input:?} (len={}): {}",
input.len(),
res.unwrap_err(),
);
Ok(())
});
}
fn arbitrary_string(
u: &mut arbitrary::Unstructured,
first_and_last: &[char],
alphabet: &[char],
max_len: usize,
) -> String {
let len: usize = u.choose_index(max_len).unwrap();
let mut input = String::new();
if len > 0 {
input.push(*u.choose(first_and_last).unwrap());
}
if len > 1 {
for _ in 1..(len - 1) {
input.push(*u.choose(alphabet).unwrap());
}
}
if len > 2 {
input.push(*u.choose(first_and_last).unwrap());
}
input
}
}