Add --json parameter and test for it

Author: b-per

src/dbt_jobs_as_code/main.py

@@ -1,3 +1,4 @@
+import json
 import os
 import sys
 from importlib.metadata import version
@@ -10,7 +11,7 @@
 from ruamel.yaml import YAML
 
 from dbt_jobs_as_code.client import DBTCloud
-from dbt_jobs_as_code.cloud_yaml_mapping.change_set import build_change_set
+from dbt_jobs_as_code.cloud_yaml_mapping.change_set import build_change_set, json_serializer_type
 from dbt_jobs_as_code.cloud_yaml_mapping.validate_link import can_be_linked
 from dbt_jobs_as_code.exporter.export import export_jobs_yml
 from dbt_jobs_as_code.importer import check_job_fields, fetch_jobs, get_account_id
@@ -58,6 +59,13 @@
     help="The path to your vars_yml YML file (or pattern for those files) when using a templated job YML file.",
 )
 
+option_json_output = click.option(
+    "--json",
+    "output_json",
+    is_flag=True,
+    help="Output results in JSON format instead of human-readable text.",
+)
+
 
 @click.group(
     help=f"dbt-jobs-as-code {VERSION}\n\nA CLI to allow defining dbt Cloud jobs as code",
@@ -75,13 +83,15 @@ def cli() -> None:
 @option_project_ids
 @option_environment_ids
 @option_limit_projects_envs_to_yml
+@option_json_output
 def sync(
     config: str,
     vars_yml,
     project_id,
     environment_id,
     limit_projects_envs_to_yml,
     disable_ssl_verification,
+    output_json: bool,
 ):
     """Synchronize a dbt Cloud job config file against dbt Cloud.
     This command will update dbt Cloud with the changes in the local YML file. It is recommended to run a `plan` first to see what will be changed.
@@ -111,13 +121,20 @@ def sync(
         cloud_project_ids,
         cloud_environment_ids,
         limit_projects_envs_to_yml,
+        output_json=output_json,
     )
     if len(change_set) == 0:
-        logger.success("-- SYNC -- No changes detected.")
+        if output_json:
+            print(json.dumps({"job_changes": [], "env_var_overwrite_changes": []}))
+        else:
+            logger.success("-- SYNC -- No changes detected.")
     else:
-        logger.info("-- SYNC -- {count} changes detected.", count=len(change_set))
-        console = Console()
-        console.log(change_set.to_table())
+        if output_json:
+            print(json.dumps(change_set.to_json()))
+        else:
+            logger.info("-- SYNC -- {count} changes detected.", count=len(change_set))
+            console = Console()
+            console.log(change_set.to_table())
     change_set.apply()
 
     if not change_set.apply_success:
@@ -132,13 +149,15 @@ def sync(
 @option_project_ids
 @option_environment_ids
 @option_limit_projects_envs_to_yml
+@option_json_output
 def plan(
     config: str,
     vars_yml: str,
     project_id: List[int],
     environment_id: List[int],
     limit_projects_envs_to_yml: bool,
     disable_ssl_verification: bool,
+    output_json: bool,
 ):
     """Check the difference between a local file and dbt Cloud without updating dbt Cloud.
     This command will not update dbt Cloud.
@@ -167,13 +186,20 @@ def plan(
         cloud_project_ids,
         cloud_environment_ids,
         limit_projects_envs_to_yml,
+        output_json=output_json,
     )
     if len(change_set) == 0:
-        logger.success("-- PLAN -- No changes detected.")
+        if output_json:
+            print(json.dumps({"job_changes": [], "env_var_overwrite_changes": []}))
+        else:
+            logger.success("-- PLAN -- No changes detected.")
     else:
-        logger.info("-- PLAN -- {count} changes detected.", count=len(change_set))
-        console = Console()
-        console.log(change_set.to_table())
+        if output_json:
+            print(json.dumps(change_set.to_json(), default=json_serializer_type))
+        else:
+            logger.info("-- PLAN -- {count} changes detected.", count=len(change_set))
+            console = Console()
+            console.log(change_set.to_table())
 
 
 @cli.command()

tests/schemas/test_check_job_mapping_same.py

@@ -31,4 +31,8 @@ def test_check_job_mapping_same():
         triggers={},
     )
 
-    assert not check_job_mapping_same(mock_job1, mock_job2)
+    # Test that the jobs are different
+    same, diff = check_job_mapping_same(mock_job1, mock_job2)
+    assert not same
+    assert diff is not None
+    assert diff["status"] == "different"

tests/test_main.py

@@ -1,12 +1,16 @@
-from unittest.mock import patch
+import json
+from unittest.mock import Mock, patch
 
 import pytest
 from click.testing import CliRunner
 
-from dbt_jobs_as_code.main import import_jobs
+from dbt_jobs_as_code.cloud_yaml_mapping.change_set import Change, ChangeSet
+from dbt_jobs_as_code.main import cli, import_jobs
 from dbt_jobs_as_code.schemas.common_types import Settings, Triggers
 from dbt_jobs_as_code.schemas.job import JobDefinition
 
+# ============= Fixtures =============
+
 
 @pytest.fixture
 def mock_dbt_cloud():
@@ -55,6 +59,55 @@ def mock_dbt_cloud():
         yield instance
 
 
+@pytest.fixture
+def mock_change_set():
+    """Create a mock change set with both job and env var changes"""
+    change_set = ChangeSet()
+
+    # Add a job change
+    change_set.append(
+        Change(
+            identifier="job1",
+            type="job",
+            action="update",
+            proj_id=123,
+            env_id=456,
+            sync_function=Mock(),
+            parameters={},
+            differences={
+                "values_changed": {
+                    "root['name']": {"new_value": "new_name", "old_value": "old_name"}
+                }
+            },
+        )
+    )
+
+    # Add an env var change
+    change_set.append(
+        Change(
+            identifier="job1:DBT_VAR1",
+            type="env var overwrite",
+            action="update",
+            proj_id=123,
+            env_id=456,
+            sync_function=Mock(),
+            parameters={},
+            differences={"old_value": "old_val", "new_value": "new_val"},
+        )
+    )
+
+    return change_set
+
+
+@pytest.fixture
+def mock_empty_change_set():
+    """Create an empty change set"""
+    return ChangeSet()
+
+
+# ============= Import Command Tests =============
+
+
 def test_import_jobs_managed_only(mock_dbt_cloud):
     """Test that --managed-only flag only imports jobs with identifiers"""
     runner = CliRunner()
@@ -98,3 +151,143 @@ def test_import_jobs_without_managed_only(mock_dbt_cloud):
     assert "managed-job-1" in result.stdout
     assert "managed-job-2" in result.stdout
     assert "Unmanaged Job" in result.stdout
+
+
+# ============= Plan Command Tests =============
+
+
+@patch("dbt_jobs_as_code.main.build_change_set")
+def test_plan_command_json_output(mock_build_change_set, mock_change_set):
+    """Test that plan command produces valid JSON output when --json flag is used"""
+    mock_build_change_set.return_value = mock_change_set
+
+    runner = CliRunner()
+    result = runner.invoke(cli, ["plan", "--json", "config.yml"])
+
+    assert result.exit_code == 0
+
+    # Verify the output is valid JSON
+    json_output = json.loads(result.output)
+
+    # Verify structure
+    assert "job_changes" in json_output
+    assert "env_var_overwrite_changes" in json_output
+
+    # Verify job changes
+    assert len(json_output["job_changes"]) == 1
+    job_change = json_output["job_changes"][0]
+    assert job_change["identifier"] == "job1"
+    assert job_change["action"] == "UPDATE"
+    assert "differences" in job_change
+
+    # Verify env var changes
+    assert len(json_output["env_var_overwrite_changes"]) == 1
+    env_var_change = json_output["env_var_overwrite_changes"][0]
+    assert env_var_change["identifier"] == "job1:DBT_VAR1"
+    assert env_var_change["action"] == "UPDATE"
+    assert "differences" in env_var_change
+
+
+@patch("dbt_jobs_as_code.main.build_change_set")
+def test_plan_command_json_output_no_changes(mock_build_change_set, mock_empty_change_set):
+    """Test that plan command produces valid JSON output with no changes"""
+    mock_build_change_set.return_value = mock_empty_change_set
+
+    runner = CliRunner()
+    result = runner.invoke(cli, ["plan", "--json", "config.yml"])
+
+    assert result.exit_code == 0
+
+    # Verify the output is valid JSON
+    json_output = json.loads(result.output)
+
+    # Verify structure
+    assert json_output == {
+        "job_changes": [],
+        "env_var_overwrite_changes": [],
+    }
+
+
+@patch("dbt_jobs_as_code.main.build_change_set")
+def test_plan_command_regular_output(mock_build_change_set, mock_change_set):
+    """Test that plan command produces regular output when --json flag is not used"""
+    mock_build_change_set.return_value = mock_change_set
+
+    runner = CliRunner()
+    result = runner.invoke(cli, ["plan", "config.yml"])
+
+    assert result.exit_code == 0
+
+    # Verify this is not JSON
+    with pytest.raises(json.JSONDecodeError):
+        json.loads(result.output)
+
+
+# ============= Sync Command Tests =============
+
+
+@patch("dbt_jobs_as_code.main.build_change_set")
+def test_sync_command_json_output(mock_build_change_set, mock_change_set):
+    """Test that sync command produces valid JSON output when --json flag is used"""
+    mock_build_change_set.return_value = mock_change_set
+
+    runner = CliRunner()
+    result = runner.invoke(cli, ["sync", "--json", "config.yml"])
+
+    assert result.exit_code == 0
+
+    # Verify the output is valid JSON
+    json_output = json.loads(result.output)
+
+    # Verify structure
+    assert "job_changes" in json_output
+    assert "env_var_overwrite_changes" in json_output
+
+    # Verify job changes
+    assert len(json_output["job_changes"]) == 1
+    job_change = json_output["job_changes"][0]
+    assert job_change["identifier"] == "job1"
+    assert job_change["action"] == "UPDATE"
+    assert "differences" in job_change
+
+    # Verify env var changes
+    assert len(json_output["env_var_overwrite_changes"]) == 1
+    env_var_change = json_output["env_var_overwrite_changes"][0]
+    assert env_var_change["identifier"] == "job1:DBT_VAR1"
+    assert env_var_change["action"] == "UPDATE"
+    assert "differences" in env_var_change
+
+
+@patch("dbt_jobs_as_code.main.build_change_set")
+def test_sync_command_json_output_no_changes(mock_build_change_set, mock_empty_change_set):
+    """Test that sync command produces valid JSON output with no changes"""
+    mock_build_change_set.return_value = mock_empty_change_set
+
+    runner = CliRunner()
+    result = runner.invoke(cli, ["sync", "--json", "config.yml"])
+
+    assert result.exit_code == 0
+
+    # Verify the output is valid JSON
+    json_output = json.loads(result.output)
+
+    # Verify structure
+    assert json_output == {
+        "job_changes": [],
+        "env_var_overwrite_changes": [],
+    }
+
+
+@patch("dbt_jobs_as_code.main.build_change_set")
+def test_sync_command_regular_output(mock_build_change_set, mock_change_set):
+    """Test that sync command produces regular output when --json flag is not used"""
+    mock_build_change_set.return_value = mock_change_set
+
+    runner = CliRunner()
+    result = runner.invoke(cli, ["sync", "config.yml"])
+
+    assert result.exit_code == 0
+
+    # Verify this is not JSON
+    with pytest.raises(json.JSONDecodeError):
+        json.loads(result.output)