fuchsia_url/
repository_url.rs

1// Copyright 2022 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::errors::ParseError;
6use crate::{Host, Scheme, UrlParts};
7
8pub const SCHEME: &str = "fuchsia-pkg";
9
10/// A URL locating a Fuchsia package repository.
11/// Has the form "fuchsia-pkg://<repository>", where "repository" is a valid hostname.
12/// https://fuchsia.dev/fuchsia-src/concepts/packages/package_url?hl=en#repository
13#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
14pub struct RepositoryUrl {
15    host: Host,
16}
17
18impl RepositoryUrl {
19    /// Returns an error if the provided hostname does not comply to the package URL spec:
20    /// https://fuchsia.dev/fuchsia-src/concepts/packages/package_url#repository
21    /// Contains only lowercase ascii letters, digits, a hyphen or the dot delimiter.
22    pub fn parse_host(host: String) -> Result<Self, ParseError> {
23        Ok(Self { host: Host::parse(host)? })
24    }
25
26    /// Parse a "fuchsia-pkg://" URL that locates a package repository.
27    pub fn parse(url: &str) -> Result<Self, ParseError> {
28        let UrlParts { scheme, host, path, hash, resource } = UrlParts::parse(url)?;
29        let scheme = scheme.ok_or(ParseError::MissingScheme)?;
30        let host = host.ok_or(ParseError::MissingHost)?;
31        if path != "/" {
32            return Err(ParseError::ExtraPathSegments);
33        }
34        if hash.is_some() {
35            return Err(ParseError::CannotContainHash);
36        }
37        if resource.is_some() {
38            return Err(ParseError::CannotContainResource);
39        }
40        Self::new(scheme, host)
41    }
42
43    pub(crate) fn new(scheme: Scheme, host: Host) -> Result<Self, ParseError> {
44        if scheme != Scheme::FuchsiaPkg {
45            return Err(ParseError::InvalidScheme);
46        }
47
48        Ok(Self { host })
49    }
50
51    /// The hostname of the URL.
52    pub fn host(&self) -> &str {
53        self.host.as_ref()
54    }
55
56    /// Consumes the URL and returns the hostname.
57    pub fn into_host(self) -> String {
58        self.host.into()
59    }
60}
61
62impl std::str::FromStr for RepositoryUrl {
63    type Err = ParseError;
64
65    fn from_str(url: &str) -> Result<Self, Self::Err> {
66        Self::parse(url)
67    }
68}
69
70impl std::convert::TryFrom<&str> for RepositoryUrl {
71    type Error = ParseError;
72
73    fn try_from(value: &str) -> Result<Self, Self::Error> {
74        Self::parse(value)
75    }
76}
77
78impl std::fmt::Display for RepositoryUrl {
79    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
80        write!(f, "{}://{}", SCHEME, self.host.as_ref())
81    }
82}
83
84impl serde::Serialize for RepositoryUrl {
85    fn serialize<S: serde::Serializer>(&self, ser: S) -> Result<S::Ok, S::Error> {
86        self.to_string().serialize(ser)
87    }
88}
89
90impl<'de> serde::Deserialize<'de> for RepositoryUrl {
91    fn deserialize<D>(de: D) -> Result<Self, D::Error>
92    where
93        D: serde::Deserializer<'de>,
94    {
95        let url = String::deserialize(de)?;
96        Ok(Self::parse(&url).map_err(|err| serde::de::Error::custom(err))?)
97    }
98}
99
100#[cfg(test)]
101mod tests {
102    use super::*;
103    use crate::errors::PackagePathSegmentError;
104    use assert_matches::assert_matches;
105    use std::convert::TryFrom as _;
106
107    #[test]
108    fn parse_err() {
109        for (url, err) in [
110            ("example.org", ParseError::MissingScheme),
111            ("fuchsia-boot://example.org", ParseError::InvalidScheme),
112            ("fuchsia-pkg://", ParseError::MissingHost),
113            ("fuchsia-pkg://exaMple.org", ParseError::InvalidHost),
114            ("fuchsia-pkg://example.org/path", ParseError::ExtraPathSegments),
115            ("fuchsia-pkg://example.org//", ParseError::InvalidPathSegment(PackagePathSegmentError::Empty)),
116            ("fuchsia-pkg://example.org?hash=0000000000000000000000000000000000000000000000000000000000000000", ParseError::CannotContainHash),
117            ("fuchsia-pkg://example.org#resource", ParseError::CannotContainResource),
118            ("fuchsia-pkg://example.org/#resource", ParseError::CannotContainResource),
119        ] {
120            assert_matches!(
121                RepositoryUrl::parse(url),
122                Err(e) if e == err,
123                "the url {:?}", url
124            );
125            assert_matches!(
126                url.parse::<RepositoryUrl>(),
127                Err(e) if e == err,
128                "the url {:?}", url
129            );
130            assert_matches!(
131                RepositoryUrl::try_from(url),
132                Err(e) if e == err,
133                "the url {:?}", url
134            );
135            assert_matches!(
136                serde_json::from_str::<RepositoryUrl>(url),
137                Err(_),
138                "the url {:?}", url
139            );
140        }
141    }
142
143    #[test]
144    fn parse_ok() {
145        for (url, host, display) in [
146            ("fuchsia-pkg://example.org", "example.org", "fuchsia-pkg://example.org"),
147            ("fuchsia-pkg://example.org/", "example.org", "fuchsia-pkg://example.org"),
148            ("fuchsia-pkg://example", "example", "fuchsia-pkg://example"),
149        ] {
150            // Creation
151            assert_eq!(RepositoryUrl::parse(url).unwrap().host(), host, "the url {:?}", url);
152            assert_eq!(url.parse::<RepositoryUrl>().unwrap().host(), host, "the url {:?}", url);
153            assert_eq!(RepositoryUrl::try_from(url).unwrap().host(), host, "the url {:?}", url);
154            assert_eq!(
155                serde_json::from_str::<RepositoryUrl>(&format!("\"{url}\"")).unwrap().host(),
156                host,
157                "the url {:?}",
158                url
159            );
160
161            // Stringification
162            assert_eq!(
163                RepositoryUrl::parse(url).unwrap().to_string(),
164                display,
165                "the url {:?}",
166                url
167            );
168            assert_eq!(
169                serde_json::to_string(&RepositoryUrl::parse(url).unwrap()).unwrap(),
170                format!("\"{display}\""),
171                "the url {:?}",
172                url
173            );
174        }
175    }
176}
fuchsia_url/repository_url.rs

fuchsia_url/
repository_url.rs
