Skip to content

test(core): stop output-format global leaking across tests #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GregHolmes wants to merge 3 commits into
base: main
Choose a base branch
from
Open

test(core): stop output-format global leaking across tests #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7359524
test(core): stop output-format global leaking across tests
GregHolmes Aug 14, 2026
e1c8190
style(core): fix fixture import order
GregHolmes Aug 14, 2026
f1469c1
refactor(core): mirror full _output_config key set in output-format t…
GregHolmes Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions packages/deepctl-core/tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
"""Shared fixtures for deepctl-core tests."""

from __future__ import annotations

import pytest
from deepctl_core import output as _output

# Snapshot the pristine output config at import time, before any test (or a
# test that invokes the CLI) mutates it.
_OUTPUT_DEFAULTS = dict(_output._output_config)


@pytest.fixture(autouse=True)
def _reset_output_config():
"""Isolate the process-global output config per test.

``deepctl_core.output._output_config`` is mutable module state that
``setup_output`` (called by the CLI entrypoint and some tests) overwrites,
with nothing resetting it afterwards. That let a format set by one test leak
into the next — e.g. the ``output_result`` JSON tests only passed because an
earlier CLI-invoking test left the global on ``"json"`` (they fail in
isolation). Restore the pristine defaults around every test so
``output_result`` — which reads this global via ``get_output_format`` — sees
a deterministic format regardless of ordering.
"""
_output._output_config.clear()
_output._output_config.update(_OUTPUT_DEFAULTS)
yield
_output._output_config.clear()
_output._output_config.update(_OUTPUT_DEFAULTS)
105 changes: 70 additions & 35 deletions packages/deepctl-core/tests/unit/test_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@
from click.testing import CliRunner
from deepctl_core import AuthManager, BaseCommand, Config, DeepgramClient

# Mirrors the full key set of deepctl_core.output._output_config so a patched
# stand-in can't drift from the real global. Spread with a format override,
# e.g. {**_OUTPUT_CONFIG_DEFAULTS, "format": "json"}, at each patch site.
_OUTPUT_CONFIG_DEFAULTS = {
"format": "default",
"quiet": False,
"verbose": False,
"color": True,
"agentic": False,
}


class TestBaseCommand:
"""Test suite for BaseCommand class."""
Expand Down Expand Up @@ -468,11 +479,14 @@ def test_output_result_none(self, mock_command_class):

@pytest.mark.unit
@patch("deepctl_core.base_command.console")
@patch(
"deepctl_core.output._output_config",
{**_OUTPUT_CONFIG_DEFAULTS, "format": "json"},
)
def test_output_result_json_dict(self, mock_console, mock_command_class):
"""Test output_result with JSON format and dict result."""
command = mock_command_class()
config = Mock(spec=Config)
config.get.return_value = "json" # output.format returns json

result = {"key": "value", "number": 42}
command.output_result(result, config)
Expand All @@ -484,11 +498,14 @@ def test_output_result_json_dict(self, mock_console, mock_command_class):

@pytest.mark.unit
@patch("deepctl_core.base_command.console")
@patch(
"deepctl_core.output._output_config",
{**_OUTPUT_CONFIG_DEFAULTS, "format": "json"},
)
def test_output_result_json_list(self, mock_console, mock_command_class):
"""Test output_result with JSON format and list result."""
command = mock_command_class()
config = Mock(spec=Config)
config.get.return_value = "json"

result = [{"id": 1}, {"id": 2}]
command.output_result(result, config)
Expand All @@ -499,11 +516,14 @@ def test_output_result_json_list(self, mock_console, mock_command_class):

@pytest.mark.unit
@patch("deepctl_core.base_command.console")
@patch(
"deepctl_core.output._output_config",
{**_OUTPUT_CONFIG_DEFAULTS, "format": "json"},
)
def test_output_result_json_string(self, mock_console, mock_command_class):
"""Test output_result with JSON format and string result."""
command = mock_command_class()
config = Mock(spec=Config)
config.get.return_value = "json"

result = "simple string"
command.output_result(result, config)
Expand All @@ -517,6 +537,10 @@ def test_output_result_json_string(self, mock_console, mock_command_class):
assert json.loads(actual_output) == expected_data

@pytest.mark.unit
@patch(
"deepctl_core.output._output_config",
{**_OUTPUT_CONFIG_DEFAULTS, "format": "json"},
)
def test_output_result_pydantic_model(self, mock_command_class):
"""Test output_result with Pydantic model."""
from pydantic import BaseModel
Expand All @@ -527,7 +551,6 @@ class TestModel(BaseModel):

command = mock_command_class()
config = Mock(spec=Config)
config.get.return_value = "json"

result = TestModel(name="test", value=123)

Expand All @@ -538,6 +561,10 @@ class TestModel(BaseModel):
mock_output_json.assert_called_once_with({"name": "test", "value": 123})

@pytest.mark.unit
@patch(
"deepctl_core.output._output_config",
{**_OUTPUT_CONFIG_DEFAULTS, "format": "json"},
)
def test_output_result_list_of_pydantic_models(self, mock_command_class):
"""Test output_result with list of Pydantic models."""
from pydantic import BaseModel
Expand All @@ -548,7 +575,6 @@ class TestModel(BaseModel):

command = mock_command_class()
config = Mock(spec=Config)
config.get.return_value = "json"

result = [
TestModel(name="test1", value=1),
Expand All @@ -567,7 +593,7 @@ class TestModel(BaseModel):
@patch("deepctl_core.base_command.console")
@patch(
"deepctl_core.output._output_config",
{"format": "yaml", "quiet": False, "verbose": False, "color": True},
{**_OUTPUT_CONFIG_DEFAULTS, "format": "yaml"},
)
def test_output_result_yaml(self, mock_console, mock_command_class):
"""Test output_result with YAML format."""
Expand All @@ -587,7 +613,7 @@ def test_output_result_yaml(self, mock_console, mock_command_class):
@patch("deepctl_core.base_command.console")
@patch(
"deepctl_core.output._output_config",
{"format": "table", "quiet": False, "verbose": False, "color": True},
{**_OUTPUT_CONFIG_DEFAULTS, "format": "table"},
)
def test_output_result_table_list_of_dicts(self, mock_console, mock_command_class):
"""Test output_result with table format and list of dicts."""
Expand All @@ -606,7 +632,7 @@ def test_output_result_table_list_of_dicts(self, mock_console, mock_command_clas
@patch("deepctl_core.base_command.console")
@patch(
"deepctl_core.output._output_config",
{"format": "table", "quiet": False, "verbose": False, "color": True},
{**_OUTPUT_CONFIG_DEFAULTS, "format": "table"},
)
def test_output_result_table_dict(self, mock_console, mock_command_class):
"""Test output_result with table format and dict."""
Expand All @@ -623,7 +649,7 @@ def test_output_result_table_dict(self, mock_console, mock_command_class):
@patch("deepctl_core.base_command.console")
@patch(
"deepctl_core.output._output_config",
{"format": "csv", "quiet": False, "verbose": False, "color": True},
{**_OUTPUT_CONFIG_DEFAULTS, "format": "csv"},
)
def test_output_result_csv_list_of_dicts(self, mock_console, mock_command_class):
"""Test output_result with CSV format and list of dicts."""
Expand All @@ -644,7 +670,7 @@ def test_output_result_csv_list_of_dicts(self, mock_console, mock_command_class)
@patch("deepctl_core.base_command.console")
@patch(
"deepctl_core.output._output_config",
{"format": "csv", "quiet": False, "verbose": False, "color": True},
{**_OUTPUT_CONFIG_DEFAULTS, "format": "csv"},
)
def test_output_result_csv_dict(self, mock_console, mock_command_class):
"""Test output_result with CSV format and dict."""
Expand All @@ -665,7 +691,7 @@ def test_output_result_csv_dict(self, mock_console, mock_command_class):
@patch("deepctl_core.base_command.console")
@patch(
"deepctl_core.output._output_config",
{"format": "unknown", "quiet": False, "verbose": False, "color": True},
{**_OUTPUT_CONFIG_DEFAULTS, "format": "unknown"},
)
def test_output_result_unknown_format(self, mock_console, mock_command_class):
"""Test output_result with unknown format falls back to JSON."""
Expand Down Expand Up @@ -1049,65 +1075,76 @@ def handle(self, *args, **kwargs):
@pytest.mark.unit
def test_confirm_calls_click_when_guided_and_not_agentic(self, command):
command._guided = True
with patch("deepctl_core.base_command._agentic", False), patch(
"deepctl_core.base_command.click.confirm", return_value=True
) as mock:
with (
patch("deepctl_core.base_command._agentic", False),
patch("deepctl_core.base_command.click.confirm", return_value=True) as mock,
):
assert command.confirm("OK?", default=False) is True
mock.assert_called_once()

@pytest.mark.unit
def test_confirm_returns_default_when_not_guided(self, command):
command._guided = False
with patch("deepctl_core.base_command._agentic", False), patch(
"deepctl_core.base_command.click.confirm"
) as mock:
with (
patch("deepctl_core.base_command._agentic", False),
patch("deepctl_core.base_command.click.confirm") as mock,
):
assert command.confirm("OK?", default=False) is False
mock.assert_not_called()

@pytest.mark.unit
def test_confirm_returns_default_when_agentic(self, command):
command._guided = True
with patch("deepctl_core.base_command._agentic", True), patch(
"deepctl_core.base_command.click.confirm"
) as mock:
with (
patch("deepctl_core.base_command._agentic", True),
patch("deepctl_core.base_command.click.confirm") as mock,
):
assert command.confirm("OK?", default=True) is True
mock.assert_not_called()

@pytest.mark.unit
def test_confirm_returns_default_when_not_ci_friendly(self, command):
command.ci_friendly = False
command._guided = True
with patch("deepctl_core.base_command._agentic", False), patch(
"deepctl_core.base_command.click.confirm"
) as mock:
with (
patch("deepctl_core.base_command._agentic", False),
patch("deepctl_core.base_command.click.confirm") as mock,
):
assert command.confirm("OK?", default=False) is False
mock.assert_not_called()

@pytest.mark.unit
def test_prompt_calls_click_when_guided(self, command):
command._guided = True
with patch("deepctl_core.base_command._agentic", False), patch(
"deepctl_core.base_command.click.prompt", return_value="user-input"
) as mock:
with (
patch("deepctl_core.base_command._agentic", False),
patch(
"deepctl_core.base_command.click.prompt", return_value="user-input"
) as mock,
):
assert command.prompt("Name?", default="alice") == "user-input"
mock.assert_called_once()

@pytest.mark.unit
def test_prompt_returns_default_when_not_guided(self, command):
command._guided = False
with patch("deepctl_core.base_command._agentic", False), patch(
"deepctl_core.base_command.click.prompt"
) as mock:
with (
patch("deepctl_core.base_command._agentic", False),
patch("deepctl_core.base_command.click.prompt") as mock,
):
assert command.prompt("Name?", default="alice") == "alice"
mock.assert_not_called()

@pytest.mark.unit
def test_prompt_with_no_default_still_prompts_when_not_guided(self, command):
# Pre-existing safety: prompt() only short-circuits when default is not None
command._guided = False
with patch("deepctl_core.base_command._agentic", False), patch(
"deepctl_core.base_command.click.prompt", return_value="typed"
) as mock:
with (
patch("deepctl_core.base_command._agentic", False),
patch(
"deepctl_core.base_command.click.prompt", return_value="typed"
) as mock,
):
assert command.prompt("Name?", default=None) == "typed"
mock.assert_called_once()

Expand Down Expand Up @@ -1161,9 +1198,7 @@ def test_any_commandline_arg_breaks_guided(self, command):

@pytest.mark.unit
def test_env_var_breaks_guided(self, command):
ctx = self._ctx_with_sources(
{"foo": "DEFAULT", "bar": "ENVIRONMENT"}
)
ctx = self._ctx_with_sources({"foo": "DEFAULT", "bar": "ENVIRONMENT"})
with patch("deepctl_core.base_command._agentic", False):
assert command.is_guided(ctx) is False

Expand Down
Loading