Add tests for PR conflict comments

Author: Kobzol

src/bors/handlers/pr_events.rs

@@ -119,7 +119,7 @@ pub(super) async fn handle_pull_request_opened(
                 author: payload.pull_request.author.username.clone(),
                 assignees,
                 base_branch: payload.pull_request.base.name.clone(),
-                mergeable_state: MergeableState::Unknown,
+                mergeable_state: payload.pull_request.mergeable_state.clone().into(),
                 pr_status,
             },
         )
@@ -361,6 +361,7 @@ async fn notify_of_pushed_pr(
 
 #[cfg(test)]
 mod tests {
+    use insta::assert_snapshot;
     use octocrab::params::checks::{CheckRunConclusion, CheckRunStatus};
 
     use crate::bors::PullRequestStatus;
@@ -439,7 +440,7 @@ mod tests {
             tester.get_pr_copy(()).await.expect_unapproved();
             Ok(())
         })
-        .await;
+            .await;
     }
 
     #[sqlx::test]
@@ -653,13 +654,13 @@ mod tests {
         run_test(pool, async |tester: &mut BorsTester| {
             let pr = tester
                 .open_pr(default_repo_name(), |pr| {
-                    pr.mergeable_state = OctocrabMergeableState::Unknown
+                    pr.mergeable_state = OctocrabMergeableState::Unknown;
                 })
                 .await?;
-            tester.push_to_branch(default_branch_name()).await?;
+            tester.push_to_branch(default_branch_name(), "sha").await?;
             tester
                 .modify_pr_state(pr.id(), |pr| {
-                    pr.mergeable_state = OctocrabMergeableState::Dirty
+                    pr.mergeable_state = OctocrabMergeableState::Dirty;
                 })
                 .await;
             tester
@@ -672,6 +673,86 @@ mod tests {
         .await;
     }
 
+    #[sqlx::test]
+    async fn conflict_message_unknown_sha(pool: sqlx::PgPool) {
+        run_test(pool, async |tester: &mut BorsTester| {
+            let pr = tester
+                .open_pr(default_repo_name(), |pr| {
+                    pr.mergeable_state = OctocrabMergeableState::Clean;
+                })
+                .await?;
+            tester
+                .modify_pr_state(pr.id(), |pr| {
+                    pr.mergeable_state = OctocrabMergeableState::Dirty;
+                })
+                .await;
+            tester.push_to_branch(default_branch_name(), "sha").await?;
+            assert_snapshot!(tester.get_next_comment_text(pr).await?, @":umbrella: The latest upstream changes made this pull request unmergeable. Please [resolve the merge conflicts](https://rustc-dev-guide.rust-lang.org/git.html#rebasing-and-conflicts).");
+
+            Ok(())
+        })
+            .await;
+    }
+
+    #[sqlx::test]
+    async fn conflict_message_unknown_sha_approved(pool: sqlx::PgPool) {
+        run_test(pool, async |tester: &mut BorsTester| {
+            let pr = tester
+                .open_pr(default_repo_name(), |pr| {
+                    pr.mergeable_state = OctocrabMergeableState::Clean;
+                })
+                .await?;
+            tester.approve(pr.id()).await?;
+            tester
+                .modify_pr_state(pr.id(), |pr| {
+                    pr.mergeable_state = OctocrabMergeableState::Dirty;
+                })
+                .await;
+            tester.push_to_branch(default_branch_name(), "sha").await?;
+            assert_snapshot!(tester.get_next_comment_text(pr.id()).await?, @r"
+            :umbrella: The latest upstream changes made this pull request unmergeable. Please [resolve the merge conflicts](https://rustc-dev-guide.rust-lang.org/git.html#rebasing-and-conflicts).
+
+            This pull request was unapproved.
+            ");
+            tester.get_pr_copy(pr.id()).await.expect_unapproved();
+
+            Ok(())
+        })
+            .await;
+    }
+
+    #[sqlx::test]
+    async fn conflict_message_known_sha(pool: sqlx::PgPool) {
+        run_test(pool, async |tester: &mut BorsTester| {
+            let pr2 = tester
+                .open_pr(default_repo_name(), |pr| {
+                    pr.mergeable_state = OctocrabMergeableState::Clean;
+                })
+                .await?;
+
+            let pr1 = tester
+                .open_pr(default_repo_name(), |_| {})
+                .await?;
+            tester.approve(pr1.id()).await?;
+            tester.start_auto_build(pr1.id()).await?;
+            tester.workflow_full_success(tester.auto_branch().await).await?;
+            tester.process_merge_queue().await;
+            tester.expect_comments(pr1.id(), 1).await;
+            let sha = tester.auto_branch().await.get_sha().to_string();
+
+            tester
+                .modify_pr_state(pr2.id(), |pr| {
+                    pr.mergeable_state = OctocrabMergeableState::Dirty;
+                })
+                .await;
+            tester.push_to_branch(default_branch_name(), &sha).await?;
+            assert_snapshot!(tester.get_next_comment_text(pr2.id()).await?, @":umbrella: The latest upstream changes (presumably #3) made this pull request unmergeable. Please [resolve the merge conflicts](https://rustc-dev-guide.rust-lang.org/git.html#rebasing-and-conflicts).");
+
+            Ok(())
+        })
+            .await;
+    }
+
     #[sqlx::test]
     async fn enqueue_prs_on_pr_opened(pool: sqlx::PgPool) {
         run_test(pool, async |tester: &mut BorsTester| {
@@ -752,7 +833,7 @@ mod tests {
             ");
             Ok(())
         })
-        .await;
+            .await;
         gh.check_cancelled_workflows(default_repo_name(), &[123]);
     }
 
@@ -777,7 +858,7 @@ mod tests {
             ");
             Ok(())
         })
-        .await;
+            .await;
     }
 
     #[sqlx::test]

src/server/webhook.rs

@@ -487,22 +487,23 @@ mod tests {
         insta::assert_debug_snapshot!(
             check_webhook("webhook/push.json", "push").await,
             @r#"
-            Ok(
-                GitHubWebhook(
-                    Repository(
-                        PushToBranch(
-                            PushToBranch {
-                                repository: GithubRepoName {
-                                    owner: "kobzol",
-                                    name: "bors-kindergarten",
-                                },
-                                branch: "main",
+        Ok(
+            GitHubWebhook(
+                Repository(
+                    PushToBranch(
+                        PushToBranch {
+                            repository: GithubRepoName {
+                                owner: "kobzol",
+                                name: "bors-kindergarten",
                             },
-                        ),
+                            branch: "main",
+                            sha: "bc7370e473896a94d40a7dff71f197a3ff0208f5",
+                        },
                     ),
                 ),
-            )
-            "#
+            ),
+        )
+        "#
         );
     }
 

src/tests/mocks/pull_request.rs

@@ -89,6 +89,12 @@ impl From<()> for PrIdentifier {
     }
 }
 
+impl From<PullRequest> for PrIdentifier {
+    fn from(pr: PullRequest) -> Self {
+        pr.id()
+    }
+}
+
 pub enum CommentMsg {
     Comment(Comment),
     Close,
@@ -534,13 +540,15 @@ pub struct GitHubPushEventPayload {
     pub repository: GitHubRepository,
     #[serde(rename = "ref")]
     pub ref_field: String,
+    pub after: String,
 }
 
 impl GitHubPushEventPayload {
-    pub fn new(branch_name: &str) -> Self {
+    pub fn new(branch_name: &str, sha: &str) -> Self {
         GitHubPushEventPayload {
             repository: default_repo_name().into(),
             ref_field: format!("refs/heads/{branch_name}"),
+            after: sha.to_string(),
         }
     }
 }

src/tests/mod.rs

@@ -352,8 +352,8 @@ impl BorsTester {
             .get_commit_message(branch.get_sha())
     }
 
-    pub async fn push_to_branch(&mut self, branch: &str) -> anyhow::Result<()> {
-        self.send_webhook("push", GitHubPushEventPayload::new(branch))
+    pub async fn push_to_branch(&mut self, branch: &str, sha: &str) -> anyhow::Result<()> {
+        self.send_webhook("push", GitHubPushEventPayload::new(branch, sha))
             .await
     }