Create test urls from raw parts directly

The previous behavior introduced some subtle issues in test code,
because fields of `gix_url::Url` instances created in with the `url`
methods sometimes contained different values than originally specified.

Author: niklaswimmer

gix-url/src/lib.rs

@@ -253,3 +253,43 @@ impl Url {
 }
 
 mod impls;
+
+/// This module contains extensions to the [crate::Url] struct which are only intended to be used
+/// for testing code. Do not use this module in production! For all intends and purposes the APIs of
+/// all functions and types exposed by this module are considered unstable and are allowed to break
+/// even in patch releases!
+#[doc(hidden)]
+pub mod testing {
+    use bstr::BString;
+
+    use crate::{Scheme, Url};
+
+    /// Additional functions for [crate::Url] which are only intended to be used for tests.
+    pub trait TestUrlExtension {
+        /// Create a new instance from the given parts without validating them.
+        ///
+        /// This function is primarily intended for testing purposes. For production code please
+        /// consider using [Url::from_parts] instead!
+        fn from_parts_unchecked(
+            scheme: Scheme,
+            user: Option<String>,
+            password: Option<String>,
+            host: Option<String>,
+            port: Option<u16>,
+            path: BString,
+            serialize_alternative_form: bool,
+        ) -> crate::Url {
+            Url {
+                scheme,
+                user,
+                password,
+                host,
+                port,
+                path,
+                serialize_alternative_form,
+            }
+        }
+    }
+
+    impl TestUrlExtension for crate::Url {}
+}

gix-url/tests/parse/file.rs

@@ -103,17 +103,19 @@ fn shortest_possible_relative_path() -> crate::Result {
     assert_eq!(parsed, ".");
     let parsed = assert_url("..", url_alternate(Scheme::File, None, None, None, b".."))?.to_bstring();
     assert_eq!(parsed, "..");
-    let parsed = assert_url("file://../", url(Scheme::File, None, None, None, b"../"))?.to_bstring();
-    assert_eq!(parsed, "file://../");
-    let parsed = assert_url("file://./", url(Scheme::File, None, None, None, b"./"))?.to_bstring();
-    assert_eq!(parsed, "file://./");
     #[cfg(windows)]
     {
         let parsed = assert_url("file://.\\", url(Scheme::File, None, None, None, b".\\"))?.to_bstring();
         assert_eq!(parsed, "file://.\\");
     }
-    let parsed = assert_url("file://a/", url(Scheme::File, None, None, None, b"a/"))?.to_bstring();
-    assert_eq!(parsed, "file://a/");
+    Ok(())
+}
+
+#[test]
+fn no_relative_paths_if_protocol() -> crate::Result {
+    assert_url_roundtrip("file://../", url(Scheme::File, None, "..", None, b"/"))?;
+    assert_url_roundtrip("file://./", url(Scheme::File, None, ".", None, b"/"))?;
+    assert_url_roundtrip("file://a/", url(Scheme::File, None, "a", None, b"/"))?;
     Ok(())
 }
 

gix-url/tests/parse/http.rs

@@ -13,7 +13,7 @@ fn username_expansion_is_unsupported() -> crate::Result {
 #[test]
 fn empty_user_cannot_roundtrip() -> crate::Result {
     let actual = gix_url::parse("http://@example.com/~byron/hello".into())?;
-    let expected = url(Scheme::Http, "", "example.com", None, b"/~byron/hello");
+    let expected = url(Scheme::Http, None, "example.com", None, b"/~byron/hello");
     assert_eq!(actual, expected);
     assert_eq!(
         actual.to_bstring(),
@@ -50,7 +50,7 @@ fn only_password() -> crate::Result {
 #[test]
 fn username_and_empty_password() -> crate::Result {
     let actual = gix_url::parse("http://user:@example.com/~byron/hello".into())?;
-    let expected = url_with_pass(Scheme::Http, "user", "", "example.com", None, b"/~byron/hello");
+    let expected = url(Scheme::Http, "user", "example.com", None, b"/~byron/hello");
     assert_eq!(actual, expected);
     assert_eq!(
         actual.to_bstring(),

gix-url/tests/parse/mod.rs

@@ -1,5 +1,5 @@
 use bstr::{BStr, ByteSlice};
-use gix_url::Scheme;
+use gix_url::{testing::TestUrlExtension, Scheme};
 
 fn assert_url(url: &str, expected: gix_url::Url) -> Result<gix_url::Url, crate::Error> {
     let actual = gix_url::parse(url.into())?;
@@ -33,7 +33,7 @@ fn url<'a, 'b>(
     port: impl Into<Option<u16>>,
     path: &[u8],
 ) -> gix_url::Url {
-    gix_url::Url::from_parts(
+    gix_url::Url::from_parts_unchecked(
         protocol,
         user.into().map(Into::into),
         None,
@@ -42,7 +42,6 @@ fn url<'a, 'b>(
         path.into(),
         false,
     )
-    .unwrap_or_else(|err| panic!("'{}' failed: {err:?}", path.as_bstr()))
 }
 
 fn url_with_pass<'a, 'b>(
@@ -53,7 +52,7 @@ fn url_with_pass<'a, 'b>(
     port: impl Into<Option<u16>>,
     path: &[u8],
 ) -> gix_url::Url {
-    gix_url::Url::from_parts(
+    gix_url::Url::from_parts_unchecked(
         protocol,
         user.into().map(Into::into),
         Some(password.into()),
@@ -62,7 +61,6 @@ fn url_with_pass<'a, 'b>(
         path.into(),
         false,
     )
-    .unwrap_or_else(|err| panic!("'{}' failed: {err:?}", path.as_bstr()))
 }
 
 fn url_alternate<'a, 'b>(
@@ -72,7 +70,7 @@ fn url_alternate<'a, 'b>(
     port: impl Into<Option<u16>>,
     path: &[u8],
 ) -> gix_url::Url {
-    let url = gix_url::Url::from_parts(
+    gix_url::Url::from_parts_unchecked(
         protocol.clone(),
         user.into().map(Into::into),
         None,
@@ -81,9 +79,6 @@ fn url_alternate<'a, 'b>(
         path.into(),
         true,
     )
-    .expect("valid");
-    assert_eq!(url.scheme, protocol);
-    url
 }
 
 mod file;

gix-url/tests/parse/ssh.rs

@@ -160,11 +160,11 @@ fn scp_like_with_user_and_relative_path_keep_relative_path() -> crate::Result {
 #[test]
 fn strange_windows_paths_yield_meaningful_results() -> crate::Result {
     let url = assert_url(
-        "[email protected]:42:C:/strange/absolute/path",
-        url_alternate(Scheme::Ssh, "user", "host.xz", Some(42), b"C:/strange/absolute/path"),
+        "[email protected]:C:/strange/absolute/path",
+        url_alternate(Scheme::Ssh, "user", "host.xz", None, b"C:/strange/absolute/path"),
     )?
     .to_bstring();
-    assert_eq!(url, "[email protected]:42:C:/strange/absolute/path");
+    assert_eq!(url, "[email protected]:C:/strange/absolute/path");
     Ok(())
 }