Decouple environment and model difference summary

Author: themisvaltinos

sqlmesh/core/console.py

@@ -282,13 +282,20 @@ def stop_env_migration_progress(self, success: bool = True) -> None:
         """Stop the environment migration progress."""
 
     @abc.abstractmethod
-    def show_difference_summary(
+    def show_environment_difference_summary(
+        self,
+        context_diff: ContextDiff,
+        no_diff: bool = True,
+    ) -> None:
+        """Displays a summary of differences for the environment."""
+
+    @abc.abstractmethod
+    def show_model_difference_summary(
         self,
         context_diff: ContextDiff,
         environment_naming_info: EnvironmentNamingInfo,
         default_catalog: t.Optional[str],
         no_diff: bool = True,
-        show_environment_statements: bool = True,
     ) -> None:
         """Displays a summary of differences for the given models."""
 
@@ -552,14 +559,19 @@ def update_state_import_progress(
     def stop_state_import(self, success: bool, input_file: Path) -> None:
         pass
 
-    def show_difference_summary(
+    def show_environment_difference_summary(
+        self,
+        context_diff: ContextDiff,
+        no_diff: bool = True,
+    ) -> None:
+        pass
+
+    def show_model_difference_summary(
         self,
         context_diff: ContextDiff,
         environment_naming_info: EnvironmentNamingInfo,
         default_catalog: t.Optional[str],
         no_diff: bool = True,
-        show_environment_statements: bool = True,
-        ignored_snapshot_ids: t.Optional[t.Set[SnapshotId]] = None,
     ) -> None:
         pass
 
@@ -1312,21 +1324,16 @@ def stop_state_import(self, success: bool, input_file: Path) -> None:
             else:
                 self.log_error("State import failed!")
 
-    def show_difference_summary(
+    def show_environment_difference_summary(
         self,
         context_diff: ContextDiff,
-        environment_naming_info: EnvironmentNamingInfo,
-        default_catalog: t.Optional[str],
         no_diff: bool = True,
-        show_environment_statements: bool = True,
     ) -> None:
-        """Shows a summary of the differences.
+        """Shows a summary of the environment differences.
 
         Args:
             context_diff: The context diff to use to print the summary
-            environment_naming_info: The environment naming info to reference when printing model names
-            default_catalog: The default catalog to reference when deciding to remove catalog from display names
-            no_diff: Hide the actual SQL differences.
+            no_diff: Hide the actual environment statement differences.
         """
         if context_diff.is_new_environment:
             msg = (
@@ -1361,13 +1368,28 @@ def show_difference_summary(
         if context_diff.has_requirement_changes:
             self._print(f"[bold]Requirements:\n{context_diff.requirements_diff()}")
 
-        if context_diff.has_environment_statements_changes and show_environment_statements:
+        if context_diff.has_environment_statements_changes and not no_diff:
             self._print("[bold]Environment statements:\n")
             for type, diff in context_diff.environment_statements_diff(
                 include_python_env=not context_diff.is_new_environment
             ):
                 self._print(Syntax(diff, type, line_numbers=False))
 
+    def show_model_difference_summary(
+        self,
+        context_diff: ContextDiff,
+        environment_naming_info: EnvironmentNamingInfo,
+        default_catalog: t.Optional[str],
+        no_diff: bool = True,
+    ) -> None:
+        """Shows a summary of the model differences.
+
+        Args:
+            context_diff: The context diff to use to print the summary
+            environment_naming_info: The environment naming info to reference when printing model names
+            default_catalog: The default catalog to reference when deciding to remove catalog from display names
+            no_diff: Hide the actual SQL differences.
+        """
         self._show_summary_tree_for(
             context_diff,
             "Models",
@@ -1543,13 +1565,18 @@ def _prompt_categorize(
         """Get the user's change category for the directly modified models."""
         plan = plan_builder.build()
 
-        self.show_difference_summary(
+        self.show_environment_difference_summary(
             plan.context_diff,
-            plan.environment_naming_info,
-            default_catalog=default_catalog,
-            show_environment_statements=not no_diff,
+            no_diff=no_diff,
         )
 
+        if plan.context_diff.has_changes:
+            self.show_model_difference_summary(
+                plan.context_diff,
+                plan.environment_naming_info,
+                default_catalog=default_catalog,
+            )
+
         if not no_diff:
             self._show_categorized_snapshots(plan, default_catalog)
 
@@ -2489,21 +2516,16 @@ class MarkdownConsole(CaptureTerminalConsole):
     def __init__(self, **kwargs: t.Any) -> None:
         super().__init__(**{**kwargs, "console": RichConsole(no_color=True)})
 
-    def show_difference_summary(
+    def show_environment_difference_summary(
         self,
         context_diff: ContextDiff,
-        environment_naming_info: EnvironmentNamingInfo,
-        default_catalog: t.Optional[str],
         no_diff: bool = True,
-        show_environment_statements: bool = True,
     ) -> None:
-        """Shows a summary of the differences.
+        """Shows a summary of the environment differences.
 
         Args:
             context_diff: The context diff to use to print the summary.
-            environment_naming_info: The environment naming info to reference when printing model names
-            default_catalog: The default catalog to reference when deciding to remove catalog from display names
-            no_diff: Hide the actual SQL differences.
+            no_diff: Hide the actual environment statements differences.
         """
         if context_diff.is_new_environment:
             self._print(
@@ -2521,13 +2543,28 @@ def show_difference_summary(
         if context_diff.has_requirement_changes:
             self._print(f"Requirements:\n{context_diff.requirements_diff()}")
 
-        if context_diff.has_environment_statements_changes and show_environment_statements:
+        if context_diff.has_environment_statements_changes and not no_diff:
             self._print("[bold]Environment statements:\n")
             for _, diff in context_diff.environment_statements_diff(
                 include_python_env=not context_diff.is_new_environment
             ):
                 self._print(diff)
 
+    def show_model_difference_summary(
+        self,
+        context_diff: ContextDiff,
+        environment_naming_info: EnvironmentNamingInfo,
+        default_catalog: t.Optional[str],
+        no_diff: bool = True,
+    ) -> None:
+        """Shows a summary of the model differences.
+
+        Args:
+            context_diff: The context diff to use to print the summary.
+            environment_naming_info: The environment naming info to reference when printing model names
+            default_catalog: The default catalog to reference when deciding to remove catalog from display names
+            no_diff: Hide the actual SQL differences.
+        """
         added_snapshots = {context_diff.snapshots[s_id] for s_id in context_diff.added}
         added_snapshot_models = {s for s in added_snapshots if s.is_model}
         if added_snapshot_models:
@@ -3030,26 +3067,32 @@ def update_env_migration_progress(self, num_tasks: int) -> None:
     def stop_env_migration_progress(self, success: bool = True) -> None:
         self._write(f"Stopping environment migration with success={success}")
 
-    def show_difference_summary(
+    def show_environment_difference_summary(
         self,
         context_diff: ContextDiff,
-        environment_naming_info: EnvironmentNamingInfo,
-        default_catalog: t.Optional[str],
         no_diff: bool = True,
-        show_environment_statements: bool = True,
     ) -> None:
-        self._write("Model Difference Summary:")
+        self._write("Environment Difference Summary:")
 
         if context_diff.has_requirement_changes:
             self._write(f"Requirements:\n{context_diff.requirements_diff()}")
 
-        if context_diff.has_environment_statements_changes and show_environment_statements:
+        if context_diff.has_environment_statements_changes and not no_diff:
             self._write("Environment statements:\n")
             for _, diff in context_diff.environment_statements_diff(
                 include_python_env=not context_diff.is_new_environment
             ):
                 self._write(diff)
 
+    def show_model_difference_summary(
+        self,
+        context_diff: ContextDiff,
+        environment_naming_info: EnvironmentNamingInfo,
+        default_catalog: t.Optional[str],
+        no_diff: bool = True,
+    ) -> None:
+        self._write("Model Difference Summary:")
+
         for added in context_diff.new_snapshots:
             self._write(f"  Added: {added}")
         for removed in context_diff.removed_snapshots:

sqlmesh/core/context.py

@@ -1533,18 +1533,22 @@ def diff(self, environment: t.Optional[str] = None, detailed: bool = False) -> b
         environment = environment or self.config.default_target_environment
         environment = Environment.sanitize_name(environment)
         context_diff = self._context_diff(environment)
-        self.console.show_difference_summary(
+        self.console.show_environment_difference_summary(
             context_diff,
-            EnvironmentNamingInfo.from_environment_catalog_mapping(
-                self.config.environment_catalog_mapping,
-                name=environment,
-                suffix_target=self.config.environment_suffix_target,
-                normalize_name=context_diff.normalize_environment_name,
-            ),
-            self.default_catalog,
             no_diff=not detailed,
-            show_environment_statements=detailed,
         )
+        if context_diff.has_changes:
+            self.console.show_model_difference_summary(
+                context_diff,
+                EnvironmentNamingInfo.from_environment_catalog_mapping(
+                    self.config.environment_catalog_mapping,
+                    name=environment,
+                    suffix_target=self.config.environment_suffix_target,
+                    normalize_name=context_diff.normalize_environment_name,
+                ),
+                self.default_catalog,
+                no_diff=not detailed,
+            )
         return context_diff.has_changes
 
     @python_api_analytics

sqlmesh/integrations/github/cicd/controller.py

@@ -457,12 +457,15 @@ def get_plan_summary(self, plan: Plan) -> str:
         try:
             # Clear out any output that might exist from prior steps
             self._console.clear_captured_outputs()
-            self._console.show_difference_summary(
+            self._console.show_environment_difference_summary(
+                context_diff=plan.context_diff,
+                no_diff=False,
+            )
+            self._console.show_model_difference_summary(
                 context_diff=plan.context_diff,
                 environment_naming_info=plan.environment_naming_info,
                 default_catalog=self._context.default_catalog,
                 no_diff=False,
-                show_environment_statements=True,
             )
             difference_summary = self._console.consume_captured_output()
             self._console._show_missing_dates(plan, self._context.default_catalog)

tests/core/test_context.py

@@ -287,7 +287,8 @@ def test_diff(sushi_context: Context, mocker: MockerFixture):
 
     sushi_context.upsert_model("sushi.customers", query=parse_one("select 1 as customer_id"))
     sushi_context.diff("test")
-    assert mock_console.show_difference_summary.called
+    assert mock_console.show_environment_difference_summary.called
+    assert mock_console.show_model_difference_summary.called
     assert success