vdk-core: add is_default() function to config

Why?

There are cases where we want to know we're using
the default value for a config option. One such
case is configuration presets

#3055

What?

Add is_default() to the config object.

How was this tested?

Unit tests

What kind of change is this?

Feature/non-breaking

Signed-off-by: Dilyan Marinov <[email protected]>

examples/confluence-reader/confluence_document.py

@@ -1,6 +1,7 @@
 # Copyright 2021-2024 VMware, Inc.
 # SPDX-License-Identifier: Apache-2.0
 
+
 class ConfluenceDocument:
     def __init__(self, metadata, data, deleted=False):
         """

projects/vdk-core/src/vdk/internal/core/config.py

@@ -64,6 +64,9 @@ class Configuration:
     __config_key_to_default_value: dict[ConfigKey, ConfigValue] = field(
         default_factory=dict
     )
+    __config_key_to_is_default: dict[ConfigKey, ConfigValue] = field(
+        default_factory=dict
+    )
     __config_key_to_sensitive: dict[ConfigKey, bool] = field(default_factory=dict)
 
     def __getitem__(self, key: ConfigKey):
@@ -124,6 +127,16 @@ def is_sensitive(self, key: ConfigKey) -> bool | None:
         """
         return self.__config_key_to_sensitive.get(key)
 
+    def is_default(self, key: ConfigKey) -> bool:
+        """
+        Return True if the configuration value associated with a given key
+        is the same as the default value
+
+        :param key: the configuration key (e.g db_host, service_uri, etc.)
+        :return: the value corresponding to the configuration key
+        """
+        return self.__config_key_to_is_default.get(key, True)
+
     def list_config_keys(self) -> list[ConfigKey]:
         """
         List all added (defined) config keys
@@ -145,13 +158,15 @@ class ConfigurationBuilder:
     __config_key_to_description: dict[ConfigKey, str]
     __config_key_to_value: dict[ConfigKey, ConfigValue]
     __config_key_to_default_value: dict[ConfigKey, ConfigValue]
+    __config_key_to_is_default: dict[ConfigKey, bool]
     __config_key_to_sensitive: dict[ConfigKey, bool]
 
     def __init__(self):
         self.__config_key_to_description = dict()
         self.__config_key_to_default_value = dict()
         self.__config_key_to_value = dict()
         self.__config_key_to_sensitive = dict()
+        self.__config_key_to_is_default = dict()
 
     def add(
         self,
@@ -199,6 +214,7 @@ def set_value(self, key: ConfigKey, value: ConfigValue) -> ConfigurationBuilder:
         self.__config_key_to_value[key] = convert_value_to_type_of_default_type(
             key, value, default_value
         )
+        self.__config_key_to_is_default[key] = False
         return self
 
     def list_config_keys(self) -> list[ConfigKey]:

projects/vdk-core/tests/vdk/internal/core/test_config.py

@@ -22,6 +22,7 @@ def test_add(key, default_value, show_default_value, description):
     assert description is None or description in cfg.get_description(key)
     assert default_value == cfg.get_value(key)
     assert default_value == cfg[key]
+    assert cfg.is_default(key)
 
 
 def test_unknown_key():
@@ -81,6 +82,16 @@ def test_set_value_overrides_default():
     builder.add("key", "default_value", False, "key description")
     cfg = builder.build()
     assert cfg.get_value("key") == "value"
+    assert not cfg.is_default("key")
+
+
+def test_set_value_eq_default_is_not_default():
+    builder = ConfigurationBuilder()
+    builder.add("key", "value", False, "key description")
+    builder.set_value("key", "value")
+    cfg = builder.build()
+    assert cfg.get_value("key") == "value"
+    assert not cfg.is_default("key")
 
 
 def test_set_value_overrides_default_preserve_types():