Skip to content

tests/util: Move add/remove_owner() fns into RequestHelper trait #9950

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 15, 2024
Merged

tests/util: Move add/remove_owner() fns into RequestHelper trait #9950

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
24ecfa8
tests/util: Move `add/remove_owner()` fns into `RequestHelper` trait
Turbo87 Nov 15, 2024
f2318db
tests/util: Adjust `add/remove_owner()` fns return type
Turbo87 Nov 15, 2024
5c394bd
tests/routes/crates/owners/add: Use `add_named_owner()` helper fn
Turbo87 Nov 15, 2024
d97bb62
tests/routes/crates/owners/remove: Use `remove_named_owner()` helper fn
Turbo87 Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/tests/issues/issue1205.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use crate::tests::builders::CrateBuilder;
use crate::tests::util::TestApp;
use crate::tests::util::{RequestHelper, TestApp};
use crates_io_github::{GitHubOrganization, GitHubTeam, GitHubTeamMembership, MockGitHubClient};
use http::StatusCode;
use insta::assert_snapshot;
Expand Down
7 changes: 7 additions & 0 deletions src/tests/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@ pub struct OkBool {
ok: bool,
}

#[derive(Deserialize, Debug)]
pub struct OwnerResp {
// server must include `ok: true` to support old cargo clients
ok: bool,
msg: String,
}

fn new_user(login: &str) -> NewUser<'_> {
NewUser {
gh_id: next_gh_id(),
Expand Down
66 changes: 14 additions & 52 deletions src/tests/routes/crates/owners/add.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,8 @@ async fn test_cargo_invite_owners() {
let new_user = app.db_new_user("cilantro");
CrateBuilder::new("guacamole", owner.as_model().id).expect_build(&mut conn);

#[derive(Serialize)]
struct OwnerReq {
owners: Option<Vec<String>>,
}
#[derive(Deserialize, Debug)]
struct OwnerResp {
// server must include `ok: true` to support old cargo clients
ok: bool,
msg: String,
}

let body = serde_json::to_string(&OwnerReq {
owners: Some(vec![new_user.as_model().gh_login.clone()]),
});
let json: OwnerResp = owner
.put("/api/v1/crates/guacamole/owners", body.unwrap())
let json = owner
.add_named_owner("guacamole", &new_user.as_model().gh_login)
.await
.good();

Expand All @@ -57,10 +43,7 @@ async fn owner_change_via_cookie() {

let krate = CrateBuilder::new("foo_crate", cookie.as_model().id).expect_build(&mut conn);

let url = format!("/api/v1/crates/{}/owners", krate.name);
let body = json!({ "owners": [user2.gh_login] });
let body = serde_json::to_vec(&body).unwrap();
let response = cookie.put::<()>(&url, body).await;
let response = cookie.add_named_owner(&krate.name, &user2.gh_login).await;
assert_eq!(response.status(), StatusCode::OK);
assert_snapshot!(response.text(), @r#"{"msg":"user user-2 has been invited to be an owner of crate foo_crate","ok":true}"#);
}
Expand All @@ -75,10 +58,7 @@ async fn owner_change_via_token() {

let krate = CrateBuilder::new("foo_crate", token.as_model().user_id).expect_build(&mut conn);

let url = format!("/api/v1/crates/{}/owners", krate.name);
let body = json!({ "owners": [user2.gh_login] });
let body = serde_json::to_vec(&body).unwrap();
let response = token.put::<()>(&url, body).await;
let response = token.add_named_owner(&krate.name, &user2.gh_login).await;
assert_eq!(response.status(), StatusCode::OK);
assert_snapshot!(response.text(), @r#"{"msg":"user user-2 has been invited to be an owner of crate foo_crate","ok":true}"#);
}
Expand All @@ -95,10 +75,7 @@ async fn owner_change_via_change_owner_token() {

let krate = CrateBuilder::new("foo_crate", token.as_model().user_id).expect_build(&mut conn);

let url = format!("/api/v1/crates/{}/owners", krate.name);
let body = json!({ "owners": [user2.gh_login] });
let body = serde_json::to_vec(&body).unwrap();
let response = token.put::<()>(&url, body).await;
let response = token.add_named_owner(&krate.name, &user2.gh_login).await;
assert_eq!(response.status(), StatusCode::OK);
assert_snapshot!(response.text(), @r#"{"msg":"user user-2 has been invited to be an owner of crate foo_crate","ok":true}"#);
}
Expand All @@ -115,10 +92,7 @@ async fn owner_change_via_change_owner_token_with_matching_crate_scope() {

let krate = CrateBuilder::new("foo_crate", token.as_model().user_id).expect_build(&mut conn);

let url = format!("/api/v1/crates/{}/owners", krate.name);
let body = json!({ "owners": [user2.gh_login] });
let body = serde_json::to_vec(&body).unwrap();
let response = token.put::<()>(&url, body).await;
let response = token.add_named_owner(&krate.name, &user2.gh_login).await;
assert_eq!(response.status(), StatusCode::OK);
assert_snapshot!(response.text(), @r#"{"msg":"user user-2 has been invited to be an owner of crate foo_crate","ok":true}"#);
}
Expand All @@ -135,10 +109,7 @@ async fn owner_change_via_change_owner_token_with_wrong_crate_scope() {

let krate = CrateBuilder::new("foo_crate", token.as_model().user_id).expect_build(&mut conn);

let url = format!("/api/v1/crates/{}/owners", krate.name);
let body = json!({ "owners": [user2.gh_login] });
let body = serde_json::to_vec(&body).unwrap();
let response = token.put::<()>(&url, body).await;
let response = token.add_named_owner(&krate.name, &user2.gh_login).await;
assert_eq!(response.status(), StatusCode::FORBIDDEN);
assert_snapshot!(response.text(), @r#"{"errors":[{"detail":"this token does not have the required permissions to perform this action"}]}"#);
}
Expand All @@ -155,10 +126,7 @@ async fn owner_change_via_publish_token() {

let krate = CrateBuilder::new("foo_crate", token.as_model().user_id).expect_build(&mut conn);

let url = format!("/api/v1/crates/{}/owners", krate.name);
let body = json!({ "owners": [user2.gh_login] });
let body = serde_json::to_vec(&body).unwrap();
let response = token.put::<()>(&url, body).await;
let response = token.add_named_owner(&krate.name, &user2.gh_login).await;
assert_eq!(response.status(), StatusCode::FORBIDDEN);
assert_snapshot!(response.text(), @r#"{"errors":[{"detail":"this token does not have the required permissions to perform this action"}]}"#);
}
Expand All @@ -173,10 +141,7 @@ async fn owner_change_without_auth() {

let krate = CrateBuilder::new("foo_crate", cookie.as_model().id).expect_build(&mut conn);

let url = format!("/api/v1/crates/{}/owners", krate.name);
let body = json!({ "owners": [user2.gh_login] });
let body = serde_json::to_vec(&body).unwrap();
let response = anon.put::<()>(&url, body).await;
let response = anon.add_named_owner(&krate.name, &user2.gh_login).await;
assert_eq!(response.status(), StatusCode::FORBIDDEN);
assert_snapshot!(response.text(), @r#"{"errors":[{"detail":"this action requires authentication"}]}"#);
}
Expand Down Expand Up @@ -294,10 +259,7 @@ async fn test_unknown_crate() {
let (app, _, user) = TestApp::full().with_user();
app.db_new_user("bar");

let body = json!({ "owners": ["bar"] });
let body = serde_json::to_vec(&body).unwrap();

let response = user.put::<()>("/api/v1/crates/unknown/owners", body).await;
let response = user.add_named_owner("unknown", "bar").await;
assert_eq!(response.status(), StatusCode::NOT_FOUND);
assert_snapshot!(response.text(), @r#"{"errors":[{"detail":"crate `unknown` does not exist"}]}"#);
}
Expand All @@ -309,8 +271,7 @@ async fn test_unknown_user() {

CrateBuilder::new("foo", cookie.as_model().id).expect_build(&mut conn);

let body = serde_json::to_vec(&json!({ "owners": ["unknown"] })).unwrap();
let response = cookie.put::<()>("/api/v1/crates/foo/owners", body).await;
let response = cookie.add_named_owner("foo", "unknown").await;
assert_eq!(response.status(), StatusCode::BAD_REQUEST);
assert_snapshot!(response.text(), @r#"{"errors":[{"detail":"could not find user with login `unknown`"}]}"#);
}
Expand All @@ -322,8 +283,9 @@ async fn test_unknown_team() {

CrateBuilder::new("foo", cookie.as_model().id).expect_build(&mut conn);

let body = serde_json::to_vec(&json!({ "owners": ["github:unknown:unknown"] })).unwrap();
let response = cookie.put::<()>("/api/v1/crates/foo/owners", body).await;
let response = cookie
.add_named_owner("foo", "github:unknown:unknown")
.await;
assert_eq!(response.status(), StatusCode::BAD_REQUEST);
assert_snapshot!(response.text(), @r#"{"errors":[{"detail":"could not find the github team unknown/unknown. Make sure that you have the right permissions in GitHub. See https://doc.rust-lang.org/cargo/reference/publishing.html#github-permissions"}]}"#);
}
Expand Down
15 changes: 3 additions & 12 deletions src/tests/routes/crates/owners/remove.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,7 @@ async fn test_unknown_crate() {
let (app, _, user) = TestApp::full().with_user();
app.db_new_user("bar");

let body = json!({ "owners": ["bar"] });
let body = serde_json::to_vec(&body).unwrap();

let response = user
.delete_with_body::<()>("/api/v1/crates/unknown/owners", body)
.await;
let response = user.remove_named_owner("unknown", "bar").await;
assert_eq!(response.status(), StatusCode::NOT_FOUND);
assert_snapshot!(response.text(), @r#"{"errors":[{"detail":"crate `unknown` does not exist"}]}"#);
}
Expand All @@ -58,10 +53,7 @@ async fn test_unknown_user() {

CrateBuilder::new("foo", cookie.as_model().id).expect_build(&mut conn);

let body = serde_json::to_vec(&json!({ "owners": ["unknown"] })).unwrap();
let response = cookie
.delete_with_body::<()>("/api/v1/crates/foo/owners", body)
.await;
let response = cookie.remove_named_owner("foo", "unknown").await;
assert_eq!(response.status(), StatusCode::BAD_REQUEST);
assert_snapshot!(response.text(), @r#"{"errors":[{"detail":"could not find user with login `unknown`"}]}"#);
}
Expand All @@ -73,9 +65,8 @@ async fn test_unknown_team() {

CrateBuilder::new("foo", cookie.as_model().id).expect_build(&mut conn);

let body = serde_json::to_vec(&json!({ "owners": ["github:unknown:unknown"] })).unwrap();
let response = cookie
.delete_with_body::<()>("/api/v1/crates/foo/owners", body)
.remove_named_owner("foo", "github:unknown:unknown")
.await;
assert_eq!(response.status(), StatusCode::BAD_REQUEST);
assert_snapshot!(response.text(), @r#"{"errors":[{"detail":"could not find team with login `github:unknown:unknown`"}]}"#);
Expand Down
56 changes: 28 additions & 28 deletions src/tests/util.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
use crate::middleware::session;
use crate::models::{ApiToken, CreatedApiToken, User};
use crate::tests::{
CategoryListResponse, CategoryResponse, CrateList, CrateResponse, GoodCrate, OkBool,
CategoryListResponse, CategoryResponse, CrateList, CrateResponse, GoodCrate, OwnerResp,
OwnersResponse, VersionResponse,
};

Expand Down Expand Up @@ -221,6 +221,33 @@ pub trait RequestHelper {
let url = "/api/v1/categories";
self.get(url).await.good()
}

/// Add to the specified crate the specified owners.
async fn add_named_owners<T>(&self, krate_name: &str, owners: &[T]) -> Response<OwnerResp>
where
T: serde::Serialize,
{
let url = format!("/api/v1/crates/{krate_name}/owners");
let body = json!({ "owners": owners }).to_string();
self.put(&url, body).await
}

/// Add a single owner to the specified crate.
async fn add_named_owner(&self, krate_name: &str, owner: &str) -> Response<OwnerResp> {
self.add_named_owners(krate_name, &[owner]).await
}

/// Remove from the specified crate the specified owners.
async fn remove_named_owners(&self, krate_name: &str, owners: &[&str]) -> Response<OwnerResp> {
let url = format!("/api/v1/crates/{krate_name}/owners");
let body = json!({ "owners": owners }).to_string();
self.delete_with_body(&url, body).await
}

/// Remove a single owner to the specified crate.
async fn remove_named_owner(&self, krate_name: &str, owner: &str) -> Response<OwnerResp> {
self.remove_named_owners(krate_name, &[owner]).await
}
}

fn req(method: Method, path: &str) -> MockRequest {
Expand Down Expand Up @@ -345,31 +372,4 @@ impl MockTokenUser {
pub fn plaintext(&self) -> &PlainToken {
&self.token.plaintext
}

/// Add to the specified crate the specified owners.
pub async fn add_named_owners<T>(&self, krate_name: &str, owners: &[T]) -> Response<OkBool>
where
T: serde::Serialize,
{
let url = format!("/api/v1/crates/{krate_name}/owners");
let body = json!({ "owners": owners }).to_string();
self.put(&url, body).await
}

/// Add a single owner to the specified crate.
pub async fn add_named_owner(&self, krate_name: &str, owner: &str) -> Response<OkBool> {
self.add_named_owners(krate_name, &[owner]).await
}

/// Remove from the specified crate the specified owners.
pub async fn remove_named_owners(&self, krate_name: &str, owners: &[&str]) -> Response<OkBool> {
let url = format!("/api/v1/crates/{krate_name}/owners");
let body = json!({ "owners": owners }).to_string();
self.delete_with_body(&url, body).await
}

/// Remove a single owner to the specified crate.
pub async fn remove_named_owner(&self, krate_name: &str, owner: &str) -> Response<OkBool> {
self.remove_named_owners(krate_name, &[owner]).await
}
}