rama-net 0.3.0

rama network types and utilities
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

//! `Display` impl on [`Uri`] — round-trip from parse + format.

use super::super::super::UriInner;
use super::super::super::owned::OwnedUriRef;
use super::parse_graceful;
use crate::Protocol;
use crate::address::{Authority, Domain, Host, HostWithOptPort, UserInfo};
use crate::uri::{Fragment, Query, Uri};

use rama_core::bytes::BytesMut;

// ----------------------------------------------------------------------
// Lazy round-trip — parse then Display produces byte-identical output.
// ----------------------------------------------------------------------

#[test]
fn lazy_round_trip() {
    for input in [
        // origin-form
        "/",
        "/foo",
        "/foo/bar",
        "/foo?bar=1",
        "/foo?bar=1#section",
        "/path#frag",
        "/?",
        "/#",
        // absolute-form
        "https://example.com/",
        "https://example.com/path?q=1#f",
        "http://user:pass@example.com:8080/p",
        "https://[::1]:443/",
        // opaque
        "urn:isbn:0451450523",
        "mailto:user@example.com",
        "data:text/plain",
        // empty-path absolute
        "http://example.com",
    ] {
        let uri: Uri = parse_graceful(input).unwrap();
        assert_eq!(uri.to_string(), input, "round-trip mismatch");
    }
}

#[test]
fn asterisk_displays_as_star() {
    let uri: Uri = parse_graceful("*").unwrap();
    assert_eq!(uri.to_string(), "*");
}

// ----------------------------------------------------------------------
// Owned reassembly — construct OwnedUriRef directly and verify the
// component pieces are stitched together correctly.
// ----------------------------------------------------------------------

fn owned(o: OwnedUriRef) -> Uri {
    Uri {
        inner: UriInner::Owned(crate::std::sync::Arc::new(o)),
    }
}

fn http_authority(host: &str, port: Option<u16>, userinfo: Option<&str>) -> Authority {
    Authority {
        user_info: userinfo.map(|s| UserInfo::try_from(s).unwrap()),
        address: HostWithOptPort {
            host: Host::Name(Domain::try_from(host).unwrap()),
            port: port.into(),
        },
    }
}

#[test]
fn owned_origin_form_path_only() {
    let uri = owned(OwnedUriRef {
        path: BytesMut::from(&b"/foo"[..]),
        ..Default::default()
    });
    assert_eq!(uri.to_string(), "/foo");
}

#[test]
fn owned_origin_form_with_query_and_fragment() {
    let uri = owned(OwnedUriRef {
        path: BytesMut::from(&b"/p"[..]),
        query: Some(Query {
            bytes: BytesMut::from(&b"a=1"[..]),
        }),
        fragment: Some(Fragment {
            bytes: BytesMut::from(&b"sec"[..]),
        }),
        ..Default::default()
    });
    assert_eq!(uri.to_string(), "/p?a=1#sec");
}

#[test]
fn owned_absolute_form_full() {
    let uri = owned(OwnedUriRef {
        scheme: Some(Protocol::HTTPS),
        authority: Some(http_authority("example.com", Some(8443), Some("u:p"))),
        path: BytesMut::from(&b"/x"[..]),
        query: Some(Query {
            bytes: BytesMut::from(&b"q=1"[..]),
        }),
        fragment: None,
    });
    assert_eq!(uri.to_string(), "https://u:p@example.com:8443/x?q=1");
}

#[test]
fn owned_opaque_form_scheme_only() {
    // urn:isbn:0 — scheme + path, no authority.
    let uri = owned(OwnedUriRef {
        scheme: Some(Protocol::from_static("urn")),
        authority: None,
        path: BytesMut::from(&b"isbn:0"[..]),
        query: None,
        fragment: None,
    });
    assert_eq!(uri.to_string(), "urn:isbn:0");
}

#[test]
fn owned_empty_query_distinguished_from_no_query() {
    // ?-with-empty-content (`Some(empty)`) vs no `?` at all (`None`)
    // must produce different output — these are distinct URIs (§3.4).
    let with_q = owned(OwnedUriRef {
        path: BytesMut::from(&b"/p"[..]),
        query: Some(Query {
            bytes: BytesMut::new(),
        }),
        ..Default::default()
    });
    let no_q = owned(OwnedUriRef {
        path: BytesMut::from(&b"/p"[..]),
        query: None,
        ..Default::default()
    });
    assert_eq!(with_q.to_string(), "/p?");
    assert_eq!(no_q.to_string(), "/p");
}

#[test]
fn owned_empty_fragment_distinguished_from_no_fragment() {
    let with_f = owned(OwnedUriRef {
        path: BytesMut::from(&b"/p"[..]),
        fragment: Some(Fragment {
            bytes: BytesMut::new(),
        }),
        ..Default::default()
    });
    let no_f = owned(OwnedUriRef {
        path: BytesMut::from(&b"/p"[..]),
        fragment: None,
        ..Default::default()
    });
    assert_eq!(with_f.to_string(), "/p#");
    assert_eq!(no_f.to_string(), "/p");
}

// ----------------------------------------------------------------------
// Debug — userinfo password redaction
//
// `Display` is wire-faithful (intentionally) but `Debug` MUST NOT leak
// credentials through tracing spans, panic messages, or `dbg!`. The
// password portion of any userinfo is rendered as `***`.
// ----------------------------------------------------------------------

#[test]
fn debug_redacts_lazy_uri_password() {
    let u = parse_graceful("http://alice:secret@example.com/p").unwrap();
    let s = format!("{u:?}");
    assert!(!s.contains("secret"), "debug leaked password: {s}");
    assert!(s.contains("alice"));
    assert!(s.contains("***"));
    assert!(s.contains("example.com"));
}

#[test]
fn debug_preserves_userinfo_with_no_password() {
    // Username-only userinfo carries no credential; Debug emits it raw.
    let u = parse_graceful("http://alice@example.com/p").unwrap();
    let s = format!("{u:?}");
    assert!(s.contains("alice@"), "user-only userinfo dropped: {s}");
    assert!(!s.contains("***"), "no password → no redaction marker: {s}");
}

#[test]
fn debug_omits_userinfo_section_when_absent() {
    let u = parse_graceful("http://example.com/p").unwrap();
    let s = format!("{u:?}");
    assert!(!s.contains('@'));
    assert!(!s.contains("***"));
    assert!(s.contains("example.com"));
}

#[test]
fn debug_redacts_owned_uri_password() {
    // Trigger Owned form via mutation, then verify Debug still redacts.
    let mut u = parse_graceful("http://alice:secret@example.com/p").unwrap();
    // Any mutating call upgrades to Owned.
    u.set_path("/new");
    let s = format!("{u:?}");
    assert!(!s.contains("secret"), "debug leaked password (Owned): {s}");
    assert!(s.contains("alice"));
    assert!(s.contains("***"));
}

#[test]
fn display_remains_wire_faithful_with_userinfo() {
    // Display is the wire form — userinfo is preserved verbatim. The
    // protective surface is `Debug
    let u = parse_graceful("http://alice:secret@example.com/p").unwrap();
    assert_eq!(u.to_string(), "http://alice:secret@example.com/p");
}

#[test]
fn debug_wraps_in_uri_marker() {
    // The `Uri("…")` wrapper is the documented Debug shape; pin it so
    // downstream log scrapers and snapshot tests can rely on the format.
    let u = parse_graceful("http://example.com/").unwrap();
    assert_eq!(format!("{u:?}"), r#"Uri("http://example.com/")"#);
}

// ----------------------------------------------------------------------
// IPv6 authority brackets — RFC 3986 §3.2.2 mandates `IP-literal = "["
// IPv6address "]"` for URI authority context, regardless of port. Lazy
// preserves source bytes so it Just Works; Owned reassembly used to
// drop the brackets when port was None.
// ----------------------------------------------------------------------

#[test]
fn owned_ipv6_no_port_keeps_brackets() {
    let mut u = parse_graceful("http://[::1]/path").unwrap();
    u.set_path("/other"); // promotes Lazy → Owned
    assert_eq!(u.to_string(), "http://[::1]/other");
}

#[test]
fn owned_ipv6_with_port_keeps_brackets() {
    let mut u = parse_graceful("http://[2001:db8::1]:8080/p").unwrap();
    u.set_path("/q");
    assert_eq!(u.to_string(), "http://[2001:db8::1]:8080/q");
}

#[test]
fn owned_ipv6_canonicalize_keeps_brackets() {
    // canonicalize also produces an Owned form. Default-port drop
    // (https:443) should leave the IPv6 host bracketed.
    let u = parse_graceful("https://[::1]:443/p").unwrap();
    let canonical = u.canonicalize();
    assert_eq!(canonical.to_string(), "https://[::1]/p");
}

#[test]
fn owned_ipv6_userinfo_brackets_correctly() {
    // userinfo + IPv6 + no port — every section needs the right
    // delimiters after Owned reassembly.
    let mut u = parse_graceful("http://alice@[::1]/p").unwrap();
    u.set_path("/q");
    assert_eq!(u.to_string(), "http://alice@[::1]/q");
}