feat!: run-all bot command errors if anything within it errors (#3262)

Author: eakmanrq

sqlmesh/integrations/github/cicd/command.py

@@ -232,7 +232,7 @@ def _run_all(controller: GithubController) -> None:
                 conclusion=GithubCheckConclusion.SKIPPED,
                 skip_reason="Unit Test(s) Failed so skipping deploying to production",
             )
-        return
+        raise CICDBotError("Failed to run tests. See check status for more information.")
     pr_environment_updated = _update_pr_environment(controller)
     prod_plan_generated = False
     if pr_environment_updated:
@@ -241,8 +241,9 @@ def _run_all(controller: GithubController) -> None:
         controller.update_prod_plan_preview_check(
             status=GithubCheckStatus.COMPLETED, conclusion=GithubCheckConclusion.SKIPPED
         )
-    if tests_passed and has_required_approval and pr_environment_updated and prod_plan_generated:
-        _deploy_production(controller)
+    deployed_to_prod = False
+    if has_required_approval and prod_plan_generated:
+        deployed_to_prod = _deploy_production(controller)
     elif is_auto_deploying_prod:
         if not has_required_approval:
             skip_reason = (
@@ -263,6 +264,14 @@ def _run_all(controller: GithubController) -> None:
             conclusion=GithubCheckConclusion.SKIPPED,
             skip_reason=skip_reason,
         )
+    if (
+        not pr_environment_updated
+        or not prod_plan_generated
+        or (has_required_approval and not deployed_to_prod)
+    ):
+        raise CICDBotError(
+            "A step of the run-all check failed. See check status for more information."
+        )
 
 
 @github.command()

tests/integrations/github/cicd/test_github_commands.py

@@ -16,7 +16,7 @@
     GithubCheckConclusion,
     GithubCheckStatus,
 )
-from sqlmesh.utils.errors import ConflictingPlanError, PlanError, TestError
+from sqlmesh.utils.errors import ConflictingPlanError, PlanError, TestError, CICDBotError
 
 pytest_plugins = ["tests.integrations.github.cicd.fixtures"]
 pytestmark = [
@@ -461,7 +461,8 @@ def test_run_all_test_failed(
     github_output_file = tmp_path / "github_output.txt"
 
     with mock.patch.dict(os.environ, {"GITHUB_OUTPUT": str(github_output_file)}):
-        command._run_all(controller)
+        with pytest.raises(CICDBotError):
+            command._run_all(controller)
 
     assert "SQLMesh - Run Unit Tests" in controller._check_run_mapping
     test_checks_runs = controller._check_run_mapping["SQLMesh - Run Unit Tests"].all_kwargs
@@ -593,7 +594,8 @@ def test_run_all_test_exception(
     github_output_file = tmp_path / "github_output.txt"
 
     with mock.patch.dict(os.environ, {"GITHUB_OUTPUT": str(github_output_file)}):
-        command._run_all(controller)
+        with pytest.raises(CICDBotError):
+            command._run_all(controller)
 
     assert "SQLMesh - Run Unit Tests" in controller._check_run_mapping
     test_checks_runs = controller._check_run_mapping["SQLMesh - Run Unit Tests"].all_kwargs
@@ -727,7 +729,8 @@ def raise_on_pr_plan(plan: Plan):
     github_output_file = tmp_path / "github_output.txt"
 
     with mock.patch.dict(os.environ, {"GITHUB_OUTPUT": str(github_output_file)}):
-        command._run_all(controller)
+        with pytest.raises(CICDBotError):
+            command._run_all(controller)
 
     assert "SQLMesh - PR Environment Synced" in controller._check_run_mapping
     pr_checks_runs = controller._check_run_mapping["SQLMesh - PR Environment Synced"].all_kwargs
@@ -851,7 +854,8 @@ def raise_on_prod_plan(plan: Plan):
     github_output_file = tmp_path / "github_output.txt"
 
     with mock.patch.dict(os.environ, {"GITHUB_OUTPUT": str(github_output_file)}):
-        command._run_all(controller)
+        with pytest.raises(CICDBotError):
+            command._run_all(controller)
 
     assert "SQLMesh - Prod Plan Preview" in controller._check_run_mapping
     prod_plan_preview_checks_runs = controller._check_run_mapping[

tests/integrations/github/cicd/test_integration.py

@@ -23,6 +23,7 @@
     GithubCheckStatus,
     GithubController,
 )
+from sqlmesh.utils.errors import CICDBotError
 from tests.integrations.github.cicd.fixtures import MockIssueComment
 
 pytest_plugins = ["tests.integrations.github.cicd.fixtures"]
@@ -509,7 +510,8 @@ def test_merge_pr_has_non_breaking_change_no_categorization(
     github_output_file = tmp_path / "github_output.txt"
 
     with mock.patch.dict(os.environ, {"GITHUB_OUTPUT": str(github_output_file)}):
-        command._run_all(controller)
+        with pytest.raises(CICDBotError):
+            command._run_all(controller)
 
     assert "SQLMesh - Run Unit Tests" in controller._check_run_mapping
     test_checks_runs = controller._check_run_mapping["SQLMesh - Run Unit Tests"].all_kwargs
@@ -1347,7 +1349,8 @@ def test_error_msg_when_applying_plan_with_bug(
     github_output_file = tmp_path / "github_output.txt"
 
     with mock.patch.dict(os.environ, {"GITHUB_OUTPUT": str(github_output_file)}):
-        command._run_all(controller)
+        with pytest.raises(CICDBotError):
+            command._run_all(controller)
 
     assert "SQLMesh - Run Unit Tests" in controller._check_run_mapping
     test_checks_runs = controller._check_run_mapping["SQLMesh - Run Unit Tests"].all_kwargs