Skip to content
Merged
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
2 changes: 1 addition & 1 deletion can/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ def load_config(

# Slightly complex here to only search for the file config if required
for _cfg in config_sources:
cfg = _cfg(context) if callable(_cfg) else _cfg
cfg = dict(_cfg(context) if callable(_cfg) else _cfg)
# remove legacy operator (and copy to interface if not already present)
if "bustype" in cfg:
if "interface" not in cfg or not cfg["interface"]:
Expand Down
2 changes: 2 additions & 0 deletions doc/changelog.d/2142.fixed.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Prevent configuration loading from modifying caller-owned dictionaries,
including ``can.rc``, when normalizing the legacy ``bustype`` key.
25 changes: 25 additions & 0 deletions test/test_load_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,31 @@ def _gen_configration_file(self, sections):
def _dict_to_env(self, d):
return {f"CAN_{k.upper()}": str(v) for k, v in d.items()}

def _load_config_isolated(self, config=None, rc=None):
missing_file = f"{self.test_dir}/missing.conf"
with (
unittest.mock.patch.object(can, "rc", rc if rc is not None else {}),
unittest.mock.patch.dict("os.environ", {}, clear=True),
):
return can.util.load_config(path=missing_file, config=config)

def test_legacy_bustype_does_not_modify_config_argument(self):
for extra in ({}, {"interface": ""}, {"interface": "virtual"}):
with self.subTest(interface=extra.get("interface", "<missing>")):
original = {"bustype": "virtual", "channel": "0", **extra}
supplied = original.copy()
result = self._load_config_isolated(config=supplied)
self.assertEqual(result, {"interface": "virtual", "channel": 0})
self.assertEqual(supplied, original)

def test_legacy_bustype_does_not_modify_can_rc(self):
original = {"bustype": "virtual", "channel": "0"}
rc = original.copy()
for _ in range(2):
result = self._load_config_isolated(rc=rc)
self.assertEqual(result, {"interface": "virtual", "channel": 0})
self.assertEqual(rc, original)

def test_config_default(self):
tmp_config = self._gen_configration_file(["default"])
config = can.util.load_config(path=tmp_config)
Expand Down
Loading