Make ignore_bot_comment test end-to-end

Author: Kobzol

src/bors/handlers/mod.rs

@@ -1,5 +1,6 @@
-use anyhow::Context;
 use std::sync::Arc;
+
+use anyhow::Context;
 use tracing::Instrument;
 
 use crate::bors::command::{BorsCommand, CommandParseError};
@@ -273,25 +274,17 @@ fn is_bors_observed_branch(branch: &str) -> bool {
 
 #[cfg(test)]
 mod tests {
-    use crate::tests::event::{comment, default_pr_number};
-    use crate::tests::state::{test_bot_user, ClientBuilder};
+    use crate::tests::mocks::{run_test, Comment, User};
 
     #[sqlx::test]
-    async fn test_ignore_bot_comment(pool: sqlx::PgPool) {
-        let state = ClientBuilder::default().pool(pool).create_state().await;
-        state
-            .comment(comment("@bors ping").author(test_bot_user()).create())
-            .await;
-        state.client().check_comments(default_pr_number(), &[]);
+    async fn ignore_bot_comment(pool: sqlx::PgPool) {
+        run_test(pool, |mut tester| async {
+            tester
+                .post_comment(Comment::from("@bors ping").with_author(User::bors_bot()))
+                .await;
+            // Returning here will make sure that no comments were received
+            Ok(tester)
+        })
+        .await;
     }
-
-    // #[sqlx::test]
-    // async fn test_do_not_comment_when_pr_fetch_fails(pool: sqlx::PgPool) {
-    //     let state = ClientBuilder::default().pool(pool).create_state().await;
-    //     state
-    //         .client()
-    //         .set_get_pr_fn(|_| Err(anyhow::anyhow!("Foo")));
-    //     state.comment(comment("foo").create()).await;
-    //     state.client().check_comments(default_pr_number(), &[]);
-    // }
 }

src/tests/event.rs

@@ -65,10 +65,6 @@ impl From<CommentBuilder> for PullRequestComment {
     }
 }
 
-pub fn comment(text: &str) -> CommentBuilder {
-    CommentBuilder::default().text(text.to_string())
-}
-
 pub fn suite_success() -> CheckSuite {
     CheckSuite {
         status: CheckSuiteStatus::Success,

src/tests/mocks/app.rs

@@ -1,3 +1,4 @@
+use crate::tests::mocks::User;
 use serde::Serialize;
 use url::Url;
 use wiremock::{
@@ -53,7 +54,7 @@ impl Default for App {
             owner: GitHubUser::default(),
             name: "bors".to_string(),
             // same as bors user html_url
-            html_url: "https://test-bors.bot.com".parse().unwrap(),
+            html_url: GitHubUser::from(User::bors_bot()).html_url,
             external_url: "https://test-bors.bot.com".parse().unwrap(),
             permissions: Permissions {},
             events: vec!["*".to_string()],

src/tests/mocks/bors.rs

@@ -116,13 +116,8 @@ impl BorsTester {
             .content
     }
 
-    pub async fn post_comment(&mut self, content: &str) {
-        self.webhook_comment(Comment::new(
-            Repo::default().name,
-            default_pr_number(),
-            content,
-        ))
-        .await;
+    pub async fn post_comment<C: Into<Comment>>(&mut self, comment: C) {
+        self.webhook_comment(comment.into()).await;
     }
 
     async fn webhook_comment(&mut self, comment: Comment) {

src/tests/mocks/comment.rs

@@ -6,8 +6,10 @@ use serde::Serialize;
 use url::Url;
 
 use crate::github::GithubRepoName;
+use crate::tests::event::default_pr_number;
 use crate::tests::mocks::repository::GitHubRepository;
 use crate::tests::mocks::user::{GitHubUser, User};
+use crate::tests::mocks::Repo;
 
 #[derive(Clone, Debug)]
 pub struct Comment {
@@ -32,6 +34,12 @@ impl Comment {
     }
 }
 
+impl<'a> From<&'a str> for Comment {
+    fn from(value: &'a str) -> Self {
+        Comment::new(Repo::default().name, default_pr_number(), value)
+    }
+}
+
 // Copied from octocrab, since its version if #[non_exhaustive]
 #[derive(Serialize)]
 pub struct GitHubIssueCommentEventPayload {

src/tests/mocks/mod.rs

@@ -9,6 +9,7 @@ use crate::tests::mocks::permissions::TeamApiMockServer;
 use crate::TeamApiClient;
 
 pub use bors::run_test;
+pub use comment::Comment;
 pub use repository::Repo;
 pub use user::User;
 

src/tests/mocks/pull_request.rs

@@ -10,6 +10,10 @@ use super::{
     Repo, User,
 };
 
+pub fn default_pr_number() -> u64 {
+    1
+}
+
 pub async fn mock_pull_requests(
     repo: &Repo,
     comments_tx: Sender<Comment>,
@@ -35,7 +39,7 @@ pub async fn mock_pull_requests(
                 let comment_payload: CommentCreatePayload = req.body_json().unwrap();
                 let comment: Comment =
                     Comment::new(repo_name.clone(), pr_number, &comment_payload.body)
-                        .with_author(User::new(1002, "bors"));
+                        .with_author(User::bors_bot());
 
                 // We cannot use `tx.blocking_send()`, because this function is actually called
                 // from within an async task, but it is not async, so we also cannot use
@@ -105,10 +109,6 @@ struct Base {
     sha: String,
 }
 
-fn default_pr_number() -> u64 {
-    1
-}
-
 #[derive(Deserialize)]
 struct CommentCreatePayload {
     body: String,

src/tests/mocks/repository.rs

@@ -64,7 +64,7 @@ timeout = 3600
     }
 }
 
-fn default_repo_name() -> GithubRepoName {
+pub fn default_repo_name() -> GithubRepoName {
     GithubRepoName::new("rust-lang", "borstest")
 }
 

src/tests/mocks/user.rs

@@ -8,6 +8,14 @@ pub struct User {
 }
 
 impl User {
+    pub fn default_user() -> Self {
+        Self::new(101, "default-user")
+    }
+
+    pub fn bors_bot() -> Self {
+        Self::new(102, "bors-bot")
+    }
+
     pub fn new(id: u64, name: &str) -> Self {
         Self {
             github_id: id,
@@ -18,7 +26,7 @@ impl User {
 
 impl Default for User {
     fn default() -> Self {
-        Self::new(101, "default-user")
+        Self::default_user()
     }
 }
 
@@ -30,7 +38,7 @@ pub struct GitHubUser {
     avatar_url: Url,
     gravatar_id: String,
     url: Url,
-    html_url: Url,
+    pub html_url: Url,
     followers_url: Url,
     following_url: Url,
     gists_url: Url,