Merge pull request #34 from dbt-labs/feature/improve-logging-and-display

[Feature] Improve logging and display of information

requirements.txt

@@ -15,4 +15,5 @@ requests==2.28.1
 tomli==2.0.1
 typing_extensions==4.4.0
 urllib3==1.26.12
-croniter==1.3.7
+croniter==1.3.7
+rich==12.6.0

src/changeset/change_set.py

@@ -1,10 +1,12 @@
 from typing import Optional
 from pydantic import BaseModel
 import string
+from rich.table import Table
 
 
 class Change(BaseModel):
     """Describes what a given change is and hot to apply it."""
+
     identifier: str
     type: str
     action: str
@@ -20,21 +22,38 @@ def apply(self):
 
 class ChangeSet(BaseModel):
     """Store the set of changes to be displayed or applied."""
+
     __root__: Optional[list[Change]] = []
 
     def __iter__(self):
         return iter(self.__root__)
-    
+
     def append(self, change: Change):
         self.__root__.append(change)
-    
+
     def __str__(self):
         list_str = [str(change) for change in self.__root__]
         return "\n".join(list_str)
-
+
+    def to_table(self) -> Table:
+        """Return a table representation of the changeset."""
+
+        table = Table(title="Changes detected")
+
+        table.add_column("Action", style="cyan", no_wrap=True)
+        table.add_column("Type", style="magenta")
+        table.add_column("ID", style="green")
+
+        for change in self.__root__:
+            table.add_row(
+                change.action.upper(), string.capwords(change.type), change.identifier
+            )
+
+        return table
+
     def __len__(self):
         return len(self.__root__)
 
     def apply(self):
         for change in self.__root__:
-            change.apply()
+            change.apply()

src/main.py

@@ -9,6 +9,7 @@
 from schemas import check_job_mapping_same
 from changeset.change_set import Change, ChangeSet
 from schemas import check_env_var_same
+from rich.console import Console
 
 
 def build_change_set(config):
@@ -68,7 +69,7 @@ def build_change_set(config):
         dbt_cloud_change_set.append(dbt_cloud_change)
 
     # Remove Deleted Jobs
-    logger.warning("Detected {count} deleted jobs.", count=len(deleted_jobs))
+    logger.info("Detected {count} deleted jobs.", count=len(deleted_jobs))
     for identifier in deleted_jobs:
         dbt_cloud_change = Change(
             identifier=identifier,
@@ -183,8 +184,9 @@ def sync(config):
     if len(change_set) == 0:
         logger.success("-- PLAN -- No changes detected.")
     else:
-        logger.warning("-- PLAN -- {count} changes detected.", count=len(change_set))
-        print(change_set)
+        logger.info("-- PLAN -- {count} changes detected.", count=len(change_set))
+        console = Console()
+        console.log(change_set.to_table())
     logger.info("-- SYNC --")
     change_set.apply()
 
@@ -200,8 +202,9 @@ def plan(config):
     if len(change_set) == 0:
         logger.success("-- PLAN -- No changes detected.")
     else:
-        logger.warning("-- PLAN -- {count} changes detected.", count=len(change_set))
-        print(change_set)
+        logger.info("-- PLAN -- {count} changes detected.", count=len(change_set))
+        console = Console()
+        console.log(change_set.to_table())
 
 
 @cli.command()

src/schemas/__init__.py

@@ -37,7 +37,7 @@ def check_job_mapping_same(source_job: JobDefinition, dest_job: JobDefinition) -
         logger.success("✅ Jobs identical")
         return True
     else:
-        logger.warning(f"❌ Jobs are different - Diff: {diffs}")
+        logger.info(f"❌ Jobs are different - Diff: {diffs}")
         return False
 
 
@@ -58,5 +58,5 @@ def check_env_var_same(source_env_var: CustomEnvironmentVariable, dest_env_vars:
         )
         return (True, env_var_id)
     else:
-        logger.warning(f"❌ The env var overwrite for {source_env_var.name} is different")
+        logger.info(f"❌ The env var overwrite for {source_env_var.name} is different")
         return (False, env_var_id)