tests: add tests for wait_on_ci_approval option

Author: Sakib25800

src/bors/handlers/review.rs

@@ -37,6 +37,7 @@ pub(super) async fn command_approve(
     };
 
     if repo_state.config.load().wait_on_ci_approval {
+        tracing::debug!("Checking CI status for PR {}", pr.number);
         // Get all the check suites for the PR.
         let checks = repo_state
             .client
@@ -276,15 +277,15 @@ mod tests {
     use crate::{
         github::PullRequestNumber,
         tests::mocks::{
-            default_pr_number, default_repo_name, run_test, BorsBuilder, BorsTester, Permissions,
-            PullRequestChangeEvent, User, World,
+            default_pr_number, default_repo_name, run_test, BorsBuilder, BorsTester, Branch,
+            Permissions, PullRequestChangeEvent, User, World,
         },
     };
 
     #[sqlx::test]
     async fn default_approve(pool: sqlx::PgPool) {
         BorsBuilder::new(pool)
-            .world(create_world_with_approve_config())
+            .world(create_world_with_immediate_approve_config())
             .run_test(|mut tester| async {
                 tester.post_comment("@bors r+").await?;
                 assert_eq!(
@@ -310,7 +311,7 @@ mod tests {
     #[sqlx::test]
     async fn approve_on_behalf(pool: sqlx::PgPool) {
         BorsBuilder::new(pool)
-            .world(create_world_with_approve_config())
+            .world(create_world_with_immediate_approve_config())
             .run_test(|mut tester| async {
                 let approve_user = "user1";
                 tester
@@ -351,7 +352,7 @@ mod tests {
     #[sqlx::test]
     async fn unapprove(pool: sqlx::PgPool) {
         BorsBuilder::new(pool)
-            .world(create_world_with_approve_config())
+            .world(create_world_with_immediate_approve_config())
             .run_test(|mut tester| async {
                 tester.post_comment("@bors r+").await?;
                 assert_eq!(
@@ -382,7 +383,7 @@ mod tests {
     #[sqlx::test]
     async fn unapprove_on_base_edited(pool: sqlx::PgPool) {
         BorsBuilder::new(pool)
-            .world(create_world_with_approve_config())
+            .world(create_world_with_immediate_approve_config())
             .run_test(|mut tester| async {
                 tester.post_comment("@bors r+").await?;
                 assert_eq!(
@@ -416,7 +417,7 @@ PR will need to be re-approved."#,
     #[sqlx::test]
     async fn edit_pr_do_nothing_when_base_not_edited(pool: sqlx::PgPool) {
         BorsBuilder::new(pool)
-            .world(create_world_with_approve_config())
+            .world(create_world_with_immediate_approve_config())
             .run_test(|mut tester| async {
                 tester.post_comment("@bors r+").await?;
                 assert_eq!(
@@ -468,7 +469,7 @@ PR will need to be re-approved."#,
     #[sqlx::test]
     async fn unapprove_on_push(pool: sqlx::PgPool) {
         BorsBuilder::new(pool)
-            .world(create_world_with_approve_config())
+            .world(create_world_with_immediate_approve_config())
             .run_test(|mut tester| async {
                 tester.post_comment("@bors r+").await?;
                 assert_eq!(
@@ -506,14 +507,96 @@ PR will need to be re-approved."#,
         .await;
     }
 
-    fn create_world_with_approve_config() -> World {
+    #[sqlx::test]
+    async fn wait_for_ci_approval(pool: sqlx::PgPool) {
+        BorsBuilder::new(pool)
+            .world(create_world_with_ci_approved_config())
+            .run_test(|mut tester| async {
+                tester.post_comment("@bors r+").await?;
+                assert_eq!(
+                    tester.get_comment().await?,
+                    ":hourglass_flowing_sand: Waiting for CI checks to complete before approving..."
+                );
+                Ok(tester)
+            })
+            .await;
+    }
+
+    #[sqlx::test]
+    async fn reject_approval_on_failed_ci(pool: sqlx::PgPool) {
+        BorsBuilder::new(pool)
+            .world(create_world_with_ci_approved_config())
+            .run_test(|mut tester| async {
+                let branch_name = format!("pr-{}", default_pr_number());
+                tester.create_branch(&branch_name).expect_suites(1);
+                tester
+                    .workflow_failure(tester.get_branch(&branch_name))
+                    .await?;
+                tester.post_comment("@bors r+").await?;
+                assert_eq!(
+                    tester.get_comment().await?,
+                    ":x: Approval rejected, CI checks have failed."
+                );
+                Ok(tester)
+            })
+            .await;
+    }
+
+    #[sqlx::test]
+    async fn approve_on_ci_success(pool: sqlx::PgPool) {
+        BorsBuilder::new(pool)
+            .world(create_world_with_ci_approved_config())
+            .run_test(|mut tester| async {
+                let branch_name = format!("pr-{}", default_pr_number());
+                tester.create_branch(&branch_name).expect_suites(1);
+                tester
+                    .workflow_success(tester.get_branch(&branch_name))
+                    .await?;
+                tester.post_comment("@bors r+").await?;
+                assert_eq!(
+                    tester.get_comment().await?,
+                    format!(
+                        "Commit pr-{}-sha has been approved by `{}`",
+                        default_pr_number(),
+                        User::default_user().name
+                    ),
+                );
+                check_pr_approved_by(
+                    &tester,
+                    default_pr_number().into(),
+                    &User::default_user().name,
+                )
+                .await;
+                Ok(tester)
+            })
+            .await;
+    }
+
+    fn create_world_with_immediate_approve_config() -> World {
+        let world = World::default();
+        world.default_repo().lock().set_config(
+            r#"
+wait_on_ci_approval = false
+[labels]
+approve = ["+approved"]
+"#,
+        );
+        world
+    }
+
+    fn create_world_with_ci_approved_config() -> World {
         let world = World::default();
         world.default_repo().lock().set_config(
             r#"
+wait_on_ci_approval = true
 [labels]
 approve = ["+approved"]
 "#,
         );
+        world.default_repo().lock().branches.push(Branch::new(
+            &format!("pr-{}", default_pr_number()),
+            &format!("pr-{}-sha", default_pr_number()),
+        ));
         world
     }