From 751e6d772e7b8f819a8c398b7d1627df322f02b6 Mon Sep 17 00:00:00 2001 From: Solarboaters <354059055+Solarboaters@users.noreply.github.com> Date: Wed, 18 Nov 2026 19:40:20 +0000 Subject: [PATCH 1/3] Preserve configuration sources when normalizing legacy keys --- can/util.py | 2 +- test/test_load_config.py | 48 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 1 deletion(-) diff --git a/can/util.py b/can/util.py index f3b1040fd..ceba5a303 100644 --- a/can/util.py +++ b/can/util.py @@ -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"]: diff --git a/test/test_load_config.py b/test/test_load_config.py index 3c850a730..97398ce55 100644 --- a/test/test_load_config.py +++ b/test/test_load_config.py @@ -44,6 +44,54 @@ 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 test_config_sources_are_not_modified(self): + for interface in (None, "", "virtual"): + with self.subTest(interface=interface): + original = {"bustype": "virtual", "channel": "0"} + if interface is not None: + original["interface"] = interface + for source in ("argument", "rc", "environment", "file"): + with self.subTest(source=source): + supplied = original.copy() + with ( + unittest.mock.patch.object( + can, "rc", supplied if source == "rc" else {} + ), + unittest.mock.patch( + "can.util.load_environment_config", + return_value=( + supplied if source == "environment" else {} + ), + ), + unittest.mock.patch( + "can.util.load_file_config", + return_value=supplied if source == "file" else {}, + ), + ): + for _ in range(2): + result = can.util.load_config( + config=supplied if source == "argument" else {} + ) + self.assertEqual( + result, {"interface": "virtual", "channel": 0} + ) + self.assertEqual(supplied, original) + + def test_config_precedence_with_legacy_interface(self): + supplied = {"interface": "virtual", "bustype": "socketcan", "channel": "0"} + rc = {"bustype": "serial", "channel": "1", "bitrate": "125000"} + with ( + unittest.mock.patch.object(can, "rc", rc), + unittest.mock.patch("can.util.load_environment_config", return_value={}), + unittest.mock.patch("can.util.load_file_config", return_value={}), + ): + self.assertEqual( + can.util.load_config(config=supplied), + {"interface": "virtual", "channel": 0, "bitrate": 125000}, + ) + self.assertEqual(supplied["bustype"], "socketcan") + self.assertEqual(rc, {"bustype": "serial", "channel": "1", "bitrate": "125000"}) + def test_config_default(self): tmp_config = self._gen_configration_file(["default"]) config = can.util.load_config(path=tmp_config) From 007d842944e8f79442152c2a13ae59cd4bfb33e7 Mon Sep 17 00:00:00 2001 From: Solarboaters <354059055+Solarboaters@users.noreply.github.com> Date: Sat, 21 Nov 2026 16:25:42 +0000 Subject: [PATCH 2/3] Add release note for configuration source preservation --- doc/changelog.d/2142.fixed.rst | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 doc/changelog.d/2142.fixed.rst diff --git a/doc/changelog.d/2142.fixed.rst b/doc/changelog.d/2142.fixed.rst new file mode 100644 index 000000000..d09c6d660 --- /dev/null +++ b/doc/changelog.d/2142.fixed.rst @@ -0,0 +1,2 @@ +Prevent configuration loading from modifying caller-owned dictionaries, +including ``can.rc``, when normalizing the legacy ``bustype`` key. From 41b602446eed297e2f233e52a434b2d266e5ee39 Mon Sep 17 00:00:00 2001 From: Solarboaters <354059055+Solarboaters@users.noreply.github.com> Date: Sun, 22 Nov 2026 01:28:13 +0000 Subject: [PATCH 3/3] Simplify configuration mutation regression tests --- test/test_load_config.py | 67 +++++++++++++--------------------------- 1 file changed, 22 insertions(+), 45 deletions(-) diff --git a/test/test_load_config.py b/test/test_load_config.py index 97398ce55..3075f7b40 100644 --- a/test/test_load_config.py +++ b/test/test_load_config.py @@ -44,53 +44,30 @@ 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 test_config_sources_are_not_modified(self): - for interface in (None, "", "virtual"): - with self.subTest(interface=interface): - original = {"bustype": "virtual", "channel": "0"} - if interface is not None: - original["interface"] = interface - for source in ("argument", "rc", "environment", "file"): - with self.subTest(source=source): - supplied = original.copy() - with ( - unittest.mock.patch.object( - can, "rc", supplied if source == "rc" else {} - ), - unittest.mock.patch( - "can.util.load_environment_config", - return_value=( - supplied if source == "environment" else {} - ), - ), - unittest.mock.patch( - "can.util.load_file_config", - return_value=supplied if source == "file" else {}, - ), - ): - for _ in range(2): - result = can.util.load_config( - config=supplied if source == "argument" else {} - ) - self.assertEqual( - result, {"interface": "virtual", "channel": 0} - ) - self.assertEqual(supplied, original) - - def test_config_precedence_with_legacy_interface(self): - supplied = {"interface": "virtual", "bustype": "socketcan", "channel": "0"} - rc = {"bustype": "serial", "channel": "1", "bitrate": "125000"} + 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), - unittest.mock.patch("can.util.load_environment_config", return_value={}), - unittest.mock.patch("can.util.load_file_config", return_value={}), + unittest.mock.patch.object(can, "rc", rc if rc is not None else {}), + unittest.mock.patch.dict("os.environ", {}, clear=True), ): - self.assertEqual( - can.util.load_config(config=supplied), - {"interface": "virtual", "channel": 0, "bitrate": 125000}, - ) - self.assertEqual(supplied["bustype"], "socketcan") - self.assertEqual(rc, {"bustype": "serial", "channel": "1", "bitrate": "125000"}) + 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", "")): + 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"])