Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 13 additions & 1 deletion nettacker/core/utils/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,19 @@ def replace_dependent_response(log, response_dependent):
return log


def merge_logs_to_list(result, log_list=[]):
def merge_logs_to_list(result, log_list=None):
"""Recursively extract all 'log' values from a nested dict into a flat deduplicated list.

Args:
result: A dict (possibly nested) containing 'log' keys to extract.
log_list: Accumulator list for recursive calls. Defaults to a new empty list
on each top-level call to avoid mutable default argument pitfalls.

Returns:
A deduplicated list of extracted log values.
"""
if log_list is None:
log_list = []
Comment on lines +34 to +46
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a unit test for merge_logs_to_list covering the original bug: calling it multiple times without providing log_list should return independent results (no cross-call contamination). This helps prevent regressions of the mutable-default-argument issue.

Copilot uses AI. Check for mistakes.
if isinstance(result, dict):
if "json_event" in list(result.keys()):
if not isinstance(result["json_event"], dict):
Expand Down
37 changes: 37 additions & 0 deletions tests/core/utils/test_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,40 @@ def test_select_maximum_cpu_core(cpu_count_mock):
for level in ("low", "normal", "high", "maximum"):
assert common_utils.select_maximum_cpu_core(level) == levels[level]
assert common_utils.select_maximum_cpu_core("invalid") == 1


def test_merge_logs_to_list_simple():
result = {"log": "error occurred"}
assert common_utils.merge_logs_to_list(result) == ["error occurred"]


def test_merge_logs_to_list_nested():
result = {
"log": "outer",
"nested": {"log": "inner"},
}
logs = common_utils.merge_logs_to_list(result)
assert sorted(logs) == ["inner", "outer"]


def test_merge_logs_to_list_no_log_key():
result = {"status": "ok", "data": {"value": 42}}
assert common_utils.merge_logs_to_list(result) == []


def test_merge_logs_to_list_deduplicates():
result = {
"log": "same",
"nested": {"log": "same"},
}
assert common_utils.merge_logs_to_list(result) == ["same"]


def test_merge_logs_to_list_no_shared_state_between_calls():
"""Verify that consecutive calls without explicit log_list don't leak state."""
result_a = {"log": "first"}
result_b = {"log": "second"}
logs_a = common_utils.merge_logs_to_list(result_a)
logs_b = common_utils.merge_logs_to_list(result_b)
assert logs_a == ["first"]
assert logs_b == ["second"]
Loading