Add unit tests for the patch API

Signed-off-by: Rustin170506 <[email protected]>

Author: 0xPoe

src/tests/krate/publish/snapshots/all__krate__publish__links__crate_with_links_field-2.snap

@@ -45,6 +45,7 @@ expression: response.json()
     "readme_path": "/api/v1/crates/foo/1.0.0/readme",
     "rust_version": null,
     "updated_at": "[datetime]",
+    "yank_message": null,
     "yanked": false
   }
 }

src/tests/krate/publish/snapshots/all__krate__publish__manifest__boolean_readme-2.snap

@@ -45,6 +45,7 @@ expression: response.json()
     "readme_path": "/api/v1/crates/foo/1.0.0/readme",
     "rust_version": "1.69",
     "updated_at": "[datetime]",
+    "yank_message": null,
     "yanked": false
   }
 }

src/tests/krate/publish/snapshots/all__krate__publish__manifest__lib_and_bin_crate-2.snap

@@ -48,6 +48,7 @@ expression: response.json()
     "readme_path": "/api/v1/crates/foo/1.0.0/readme",
     "rust_version": null,
     "updated_at": "[datetime]",
+    "yank_message": null,
     "yanked": false
   }
 }

src/tests/krate/yanking.rs

@@ -220,3 +220,66 @@ async fn publish_after_yank_max_version() {
     let json = anon.show_crate("fyk_max").await;
     assert_eq!(json.krate.max_version, "2.0.0");
 }
+
+#[tokio::test(flavor = "multi_thread")]
+async fn patch_version_yank_unyank() {
+    let (_, anon, _, token) = TestApp::full().with_token();
+
+    // Upload a new crate
+    let crate_to_publish = PublishBuilder::new("patchable", "1.0.0");
+    token.publish_crate(crate_to_publish).await.good();
+
+    // Check initial state
+    let json = anon.show_version("patchable", "1.0.0").await;
+    assert!(!json.version.yanked);
+    assert_eq!(json.version.yank_message, None);
+
+    // Yank with message
+    token
+        .update_yank_status("patchable", "1.0.0", Some(true), Some("Yanking reason"))
+        .await
+        .good();
+
+    let json = anon.show_version("patchable", "1.0.0").await;
+    assert!(json.version.yanked);
+    assert_eq!(
+        json.version.yank_message,
+        Some("Yanking reason".to_string())
+    );
+
+    // Update yank message
+    token
+        .update_yank_status("patchable", "1.0.0", None, Some("Updated reason"))
+        .await
+        .good();
+
+    let json = anon.show_version("patchable", "1.0.0").await;
+    assert!(json.version.yanked);
+    assert_eq!(
+        json.version.yank_message,
+        Some("Updated reason".to_string())
+    );
+
+    // Unyank
+    token
+        .update_yank_status("patchable", "1.0.0", Some(false), None)
+        .await
+        .good();
+
+    let json = anon.show_version("patchable", "1.0.0").await;
+    assert!(!json.version.yanked);
+    assert_eq!(json.version.yank_message, None);
+
+    // Attempt to set yank message on unyanked version (should fail)
+    token
+        .update_yank_status("patchable", "1.0.0", None, Some("Invalid message"))
+        .await
+        .status()
+        .is_client_error();
+    // Attempt to unyank with message (should fail)
+    token
+        .update_yank_status("patchable", "1.0.0", Some(false), Some("Invalid message"))
+        .await
+        .status()
+        .is_client_error();
+}

src/tests/routes/crates/snapshots/all__routes__crates__read__show.snap

@@ -71,6 +71,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/foo_show/1.0.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     },
     {
@@ -103,6 +104,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/foo_show/0.5.1/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     },
     {
@@ -135,6 +137,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/foo_show/0.5.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]

src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__prerelease_versions_not_included_in_reverse_dependencies.snap

@@ -51,6 +51,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c3/1.0.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]

src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies.snap

@@ -51,6 +51,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c2/1.1.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]

src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies_includes_published_by_user_when_present.snap

@@ -63,6 +63,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c3/3.0.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     },
     {
@@ -89,6 +90,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c2/2.0.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]

src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies_query_supports_u64_version_number_parts.snap

@@ -51,6 +51,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c2/1.0.18446744073709551615/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]

src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies_when_old_version_doesnt_depend_but_new_does.snap

@@ -51,6 +51,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c2/2.0.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]

src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__yanked_versions_not_included_in_reverse_dependencies.snap

@@ -51,6 +51,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c2/2.0.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]

src/tests/routes/crates/versions/snapshots/all__routes__crates__versions__list__versions.snap

@@ -28,6 +28,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/foo_versions/1.0.0/readme",
       "rust_version": "1.64",
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     },
     {
@@ -60,6 +61,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/foo_versions/0.5.1/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     },
     {
@@ -92,6 +94,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/foo_versions/0.5.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]

src/tests/routes/crates/versions/snapshots/all__routes__crates__versions__read__show_by_crate_name_and_semver_no_published_by.snap

@@ -27,6 +27,7 @@ expression: json
     "readme_path": "/api/v1/crates/foo_vers_show_no_pb/1.0.0/readme",
     "rust_version": null,
     "updated_at": "[datetime]",
+    "yank_message": null,
     "yanked": false
   }
 }

src/tests/routes/crates/versions/snapshots/all__routes__crates__versions__read__show_by_crate_name_and_version.snap

@@ -33,6 +33,7 @@ expression: json
     "readme_path": "/api/v1/crates/foo_vers_show/2.0.0/readme",
     "rust_version": "1.64",
     "updated_at": "[datetime]",
+    "yank_message": null,
     "yanked": false
   }
 }

src/tests/routes/crates/versions/yank_unyank.rs

@@ -1,14 +1,24 @@
 use crate::builders::{CrateBuilder, PublishBuilder};
 use crate::util::{RequestHelper, Response, TestApp};
-use crate::OkBool;
+use crate::{OkBool, VersionResponse};
 use http::StatusCode;
+use serde_json::json;
 
 pub trait YankRequestHelper {
     /// Yank the specified version of the specified crate and run all pending background jobs
     async fn yank(&self, krate_name: &str, version: &str) -> Response<OkBool>;
 
     /// Unyank the specified version of the specified crate and run all pending background jobs
     async fn unyank(&self, krate_name: &str, version: &str) -> Response<OkBool>;
+
+    /// Update the yank status of the specified version of the specified crate with a patch request and run all pending background jobs
+    async fn update_yank_status(
+        &self,
+        krate_name: &str,
+        version: &str,
+        yanked: Option<bool>,
+        yank_message: Option<&str>,
+    ) -> Response<VersionResponse>;
 }
 
 impl<T: RequestHelper> YankRequestHelper for T {
@@ -25,6 +35,26 @@ impl<T: RequestHelper> YankRequestHelper for T {
         self.app().run_pending_background_jobs().await;
         response
     }
+
+    async fn update_yank_status(
+        &self,
+        krate_name: &str,
+        version: &str,
+        yanked: Option<bool>,
+        yank_message: Option<&str>,
+    ) -> Response<VersionResponse> {
+        let url = format!("/api/v1/crates/{krate_name}/{version}");
+
+        let json_body = json!({
+            "yanked": yanked,
+            "yank_message": yank_message
+        });
+        let body = serde_json::to_string(&json_body).expect("Failed to serialize JSON body");
+
+        let response = self.patch(&url, body).await;
+        self.app().run_pending_background_jobs().await;
+        response
+    }
 }
 
 #[tokio::test(flavor = "multi_thread")]

src/tests/util.rs

@@ -146,6 +146,20 @@ pub trait RequestHelper {
         self.run(request).await
     }
 
+    /// Issue a PATCH request
+    async fn patch<T>(&self, path: &str, body: impl Into<Bytes>) -> Response<T> {
+        let body = body.into();
+        let is_json = body.starts_with(b"{") && body.ends_with(b"}");
+
+        let mut request = self.request_builder(Method::PATCH, path);
+        *request.body_mut() = body;
+        if is_json {
+            request.header(header::CONTENT_TYPE, "application/json");
+        }
+
+        self.run(request).await
+    }
+
     /// Issue a DELETE request
     async fn delete<T>(&self, path: &str) -> Response<T> {
         let request = self.request_builder(Method::DELETE, path);

src/views.rs

@@ -558,6 +558,7 @@ pub struct EncodableVersion {
     pub downloads: i32,
     pub features: serde_json::Value,
     pub yanked: bool,
+    pub yank_message: Option<String>,
     pub lib_links: Option<String>,
     // NOTE: Used by shields.io, altering `license` requires a PR with shields.io
     pub license: Option<String>,
@@ -586,6 +587,7 @@ impl EncodableVersion {
             downloads,
             features,
             yanked,
+            yank_message,
             links: lib_links,
             license,
             crate_size,
@@ -613,6 +615,7 @@ impl EncodableVersion {
             downloads,
             features,
             yanked,
+            yank_message,
             lib_links,
             license,
             links,
@@ -736,6 +739,7 @@ mod tests {
             downloads: 0,
             features: serde_json::from_str("{}").unwrap(),
             yanked: false,
+            yank_message: None,
             license: None,
             lib_links: None,
             links: EncodableVersionLinks {