test(compare): pin which config: values are kept, dropped or skipped (#5472)

Review follow-up. One EMPTY_COMPARE_CONFIG tuple now decides both the
skip and the drop, rather than a tuple in one place and truthiness in
the other. T27 checks the reason each config entry was skipped, and
adds a mapping config, which must survive as the tariff's overrides -
nothing tested that, so a check skipping or dropping every config would
have passed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Author: chalfontchubby

apps/predbat/compare.py

@@ -27,6 +27,10 @@
 # 3. Consider Octopus API key to access current tariff info and switch links
 
 
+# An empty 'config:' line means no overrides; any other non-mapping value can't be applied
+EMPTY_COMPARE_CONFIG = (None, "", [], {})
+
+
 def check_compare_list(compare_list):
     """Split compare_list into the entries that can be compared and a message per skipped entry (#5472).
 
@@ -58,7 +62,7 @@ def check_compare_list(compare_list):
                 problem = "has a duplicate id '{}'".format(entry_id)
             elif not entry_name:
                 problem = "('{}') requires a non-empty 'name'".format(entry_id)
-            elif entry.get("config") not in (None, "", []) and not isinstance(entry["config"], dict):
+            elif entry.get("config") not in EMPTY_COMPARE_CONFIG and not isinstance(entry["config"], dict):
                 # run_all() and fetch_config() look overrides up by key; a list of them raised TypeError
                 # there and ended the whole comparison, and any other value was never a usable override
                 problem = "('{}') has a 'config' that isn't a set of 'setting: value' overrides".format(entry_id)
@@ -67,8 +71,7 @@ def check_compare_list(compare_list):
             continue
         seen_ids.add(entry_id)
         checked = dict(entry, id=entry_id, name=entry_name)
-        if not checked.get("config"):
-            # An empty 'config:' line (None, "", [] or {}) means no overrides, as it always has
+        if checked.get("config") in EMPTY_COMPARE_CONFIG:
             checked.pop("config", None)
         valid.append(checked)
     return valid, problems

apps/predbat/tests/test_compare.py

@@ -723,10 +723,11 @@ def _mock_plan_iboost_smart():
     # ------------------------------------------------------------------
     # T27: valid_compare_list() keeps only the entries run_all() can compare -
     #      skipping, with a warning naming the entry's position, one that isn't a
-    #      dict, has no id, repeats an earlier id or has no name - and turns a
-    #      numeric id into a string (#5472 - run_all() used to index tariff["id"]
-    #      directly, raising KeyError every cycle, and a numeric id still crashed
-    #      publish_data() building the sensor name)
+    #      dict, has no id, repeats an earlier id, has no name or has a config:
+    #      that is neither a mapping nor empty (None, "", [] and {} mean no
+    #      overrides) - and turns a numeric id into a string (#5472 - run_all()
+    #      used to index tariff["id"] directly, raising KeyError every cycle, and a
+    #      numeric id still crashed publish_data() building the sensor name)
     # ------------------------------------------------------------------
     logged = []
     entries = [
@@ -747,17 +748,24 @@ def _mock_plan_iboost_smart():
         {"id": "empty_dict_config", "name": "Empty Dict Config", "config": {}},
         {"id": "false_config", "name": "False Config", "config": False},
         {"id": "string_config", "name": "String Config", "config": "best_soc_min: 2.0"},
+        {"id": "mapping_config", "name": "Mapping Config", "config": {"best_soc_min": 2.0}},
     ]
     kept = valid_compare_list(entries, log=logged.append)
     kept_ids = [entry["id"] for entry in kept]
     skipped_positions = sorted(int(msg.split("compare_list entry ")[1].split(" ")[0]) for msg in logged)
 
-    if kept_ids != ["agile", "2024", "numeric_name", "empty_config", "empty_list_config", "empty_string_config", "empty_dict_config"]:
-        print("ERROR T27: valid_compare_list() should keep only 'agile', '2024', 'numeric_name' and the four empty-config entries (ids as strings), got {}".format(kept_ids))
+    if kept_ids != ["agile", "2024", "numeric_name", "empty_config", "empty_list_config", "empty_string_config", "empty_dict_config", "mapping_config"]:
+        print("ERROR T27: valid_compare_list() should keep only 'agile', '2024', 'numeric_name', the four empty-config entries and 'mapping_config' (ids as strings), got {}".format(kept_ids))
         failed += 1
     elif skipped_positions != [1, 2, 3, 5, 6, 8, 10, 11, 16, 17]:
         print("ERROR T27: valid_compare_list() should warn for entries 1, 2, 3, 5, 6, 8 (padded duplicate id), 10 (blank name), 11, 16 and 17 (unusable config), got {}".format(logged))
         failed += 1
+    elif not all("'config'" in msg for msg in logged if msg.split("compare_list entry ")[1].split(" ")[0] in ("11", "16", "17")):
+        print("ERROR T27: entries 11, 16 and 17 should be skipped for their config, got {}".format(logged))
+        failed += 1
+    elif kept[7].get("config") != {"best_soc_min": 2.0}:
+        print("ERROR T27: a mapping config: should be kept as the tariff's overrides, got {}".format(kept[7]))
+        failed += 1
     elif any("config" in entry for entry in kept[3:7]):
         print("ERROR T27: an empty 'config:' (None, [], \"\" or {{}}) should be dropped as no overrides, got {}".format(kept[3:7]))
         failed += 1