refactor: move config tabs method in GlobalConfig class (#1595)

**Issue number:**
ADDON-78036

### PR Type

**What kind of change does this PR introduce?**
* [ ] Feature
* [ ] Bug Fix
* [x] Refactoring (no functional or API changes)
* [ ] Documentation Update
* [ ] Maintenance (dependency updates, CI, etc.)

## Summary
Made `config_tabs` (which is a method in `global_config_validator.py`)
as a part of `GlobalConfig` class.

### Changes
Made the `config_tabs` method part of the `GlobalConfig` class and
renamed the previous `tabs` method in GlobalConfig to `configuration`.

### User experience

## Checklist

If an item doesn't apply to your changes, leave it unchecked.

* [x] I have performed a self-review of this change according to the
[development
guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines)
* [ ] Tests have been added/modified to cover the changes [(testing
doc)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test)
* [ ] Changes are documented
* [x] PR title and description follows the [contributing
principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests)

Author: hetangmodi-crest

splunk_add_on_ucc_framework/global_config.py

@@ -122,16 +122,22 @@ def inputs(self) -> List[Any]:
             return self._content["pages"]["inputs"]["services"]
         return []
 
+    @property
+    def configuration(self) -> List[Any]:
+        if self.has_pages() and "configuration" in self._content["pages"]:
+            return self._content["pages"]["configuration"]["tabs"]
+        return []
+
     @property
     def pages(self) -> List[Any]:
         if "pages" in self._content:
             return self._content["pages"]
         return []
 
     @property
-    def tabs(self) -> List[Any]:
-        if self.has_pages() and "configuration" in self._content["pages"]:
-            return self._content["pages"]["configuration"]["tabs"]
+    def resolved_configuration(self) -> List[Any]:
+        if self.has_pages() and "configuration" in self.pages:
+            return [resolve_tab(tab) for tab in self.configuration]
         return []
 
     @property
@@ -141,22 +147,22 @@ def dashboard(self) -> Dict[str, Any]:
     @property
     def settings(self) -> List[Any]:
         settings = []
-        for tab in self.tabs:
+        for tab in self.configuration:
             if "table" not in tab:
                 settings.append(tab)
         return settings
 
     @property
     def logging_tab(self) -> Dict[str, Any]:
-        for tab in self.tabs:
+        for tab in self.configuration:
             if LoggingTab.from_definition(tab) is not None:
                 return tab
         return {}
 
     @property
     def configs(self) -> List[Any]:
         configs = []
-        for tab in self.tabs:
+        for tab in self.configuration:
             if "table" in tab:
                 configs.append(tab)
         return configs
@@ -226,7 +232,7 @@ def has_inputs(self) -> bool:
         return bool(self.inputs)
 
     def has_configuration(self) -> bool:
-        return bool(self.tabs)
+        return bool(self.configuration)
 
     def has_alerts(self) -> bool:
         return bool(self.alerts)
@@ -235,7 +241,7 @@ def has_dashboard(self) -> bool:
         return self.dashboard is not None
 
     def has_oauth(self) -> bool:
-        for tab in self.tabs:
+        for tab in self.configuration:
             if tab["name"] == "account":
                 for entity in tab["entity"]:
                     if entity["type"] == "oauth":

splunk_add_on_ucc_framework/global_config_update.py

@@ -56,7 +56,7 @@ def _handle_biased_terms(conf_entities: List[Dict[str, Any]]) -> List[Dict[str,
 
 
 def _handle_biased_terms_update(global_config: global_config_lib.GlobalConfig) -> None:
-    for tab in global_config.tabs:
+    for tab in global_config.configuration:
         conf_entities = tab.get("entity")
 
         if conf_entities is None:
@@ -151,7 +151,7 @@ def handle_global_config_update(global_config: global_config_lib.GlobalConfig) -
         logger.info("Updated globalConfig schema to version 0.0.1")
 
     if _version_tuple(version) < _version_tuple("0.0.2"):
-        for tab in global_config.tabs:
+        for tab in global_config.configuration:
             if tab.get("type") in ["loggingTab", "proxyTab"]:
                 continue
             if tab["name"] == "account":
@@ -325,7 +325,7 @@ def _stop_build_on_placeholder_usage(
         "`placeholder` option found for %s '%s'. It has been removed from UCC. "
         "We recommend to use `help` instead (https://splunk.github.io/addonfactory-ucc-generator/entity/)."
     )
-    for tab in global_config.tabs:
+    for tab in global_config.configuration:
         for entity in tab.get("entity", []):
             if "placeholder" in entity.get("options", {}):
                 logger.error(

splunk_add_on_ucc_framework/global_config_validator.py

@@ -25,7 +25,7 @@
 
 from splunk_add_on_ucc_framework import dashboard as dashboard_lib
 from splunk_add_on_ucc_framework import global_config as global_config_lib
-from splunk_add_on_ucc_framework.tabs import resolve_tab, Tab
+from splunk_add_on_ucc_framework.tabs import Tab
 from splunk_add_on_ucc_framework.exceptions import GlobalConfigValidatorException
 
 logger = logging.getLogger("ucc_gen")
@@ -51,15 +51,7 @@ def __init__(self, source_dir: str, global_config: global_config_lib.GlobalConfi
         self._source_dir = source_dir
         self._global_config = global_config
         self._config = global_config.content
-
-    @property
-    def config_tabs(self) -> List[Any]:
-        if self._global_config.has_configuration():
-            return [
-                resolve_tab(tab)
-                for tab in self._config["pages"]["configuration"]["tabs"]
-            ]
-        return []
+        self.resolved_configuration = global_config.resolved_configuration
 
     def _validate_config_against_schema(self) -> None:
         """
@@ -80,7 +72,7 @@ def _validate_configuration_tab_table_has_name_field(self) -> None:
         Validates that if a configuration tab should be rendered as a table,
         then it needs to have an entity which has field "name".
         """
-        for tab in self.config_tabs:
+        for tab in self.resolved_configuration:
             if "table" in tab:
                 entities = tab["entity"]
                 has_name_field = False
@@ -141,7 +133,7 @@ def _validate_file_type_entity(self) -> None:
         Also if file is encrypted but not required, this is not supported,
         and we need to throw a validation error.
         """
-        for tab in self.config_tabs:
+        for tab in self.resolved_configuration:
             entities = tab["entity"]
             for entity in entities:
                 if entity["type"] == "file":
@@ -251,7 +243,7 @@ def _validate_validators(self) -> None:
         number and regex are supported.
         """
         pages = self._config["pages"]
-        for tab in self.config_tabs:
+        for tab in self.resolved_configuration:
             entities = tab["entity"]
             for entity in entities:
                 self._validate_entity_validators(entity)
@@ -432,7 +424,7 @@ def _validate_duplicates(self) -> None:
         not required in schema, so this checks if globalConfig has inputs
         """
         pages = self._config["pages"]
-        self._validate_tabs_duplicates(self.config_tabs)
+        self._validate_tabs_duplicates(self.resolved_configuration)
 
         inputs = pages.get("inputs")
         if inputs:

tests/unit/test_global_config.py

@@ -104,14 +104,14 @@ def test_global_config_expand(tmp_path):
 
     global_config = global_config_lib.GlobalConfig(global_config_path)
 
-    assert {"type": "loggingTab"} in global_config.tabs
+    assert {"type": "loggingTab"} in global_config.configuration
     assert count_tabs(global_config, name="logging") == 0
     assert count_entities(global_config, type="interval") == 3
     assert count_entities(global_config, type="text", field="interval") == 0
 
     global_config.expand()
 
-    assert {"type": "loggingTab"} not in global_config.tabs
+    assert {"type": "loggingTab"} not in global_config.configuration
     assert count_tabs(global_config, name="logging") == 1
     assert count_entities(global_config, type="interval") == 0
     assert count_entities(global_config, type="text", field="interval") == 3
@@ -153,7 +153,7 @@ def test_global_config_add_ucc_version(global_config_only_logging, tmp_path):
 
 
 def all_entities(gc: global_config_lib.GlobalConfig) -> Iterator[Any]:
-    objects = itertools.chain(gc.tabs, gc.alerts, gc.inputs)
+    objects = itertools.chain(gc.configuration, gc.alerts, gc.inputs)
     return itertools.chain(*(obj["entity"] for obj in objects if "entity" in obj))
 
 
@@ -167,5 +167,7 @@ def count_entities(gc: global_config_lib.GlobalConfig, **kwargs: str) -> int:
 
 def count_tabs(gc: global_config_lib.GlobalConfig, **kwargs: str) -> int:
     return sum(
-        1 for tab in gc.tabs if all(tab.get(k, "") == v for k, v in kwargs.items())
+        1
+        for tab in gc.configuration
+        if all(tab.get(k, "") == v for k, v in kwargs.items())
     )

tests/unit/test_global_config_update.py

@@ -50,12 +50,12 @@ def test_handle_biased_terms_update(filename):
     input_entity_2_options_keys = global_config.inputs[0]["entity"][1]["options"].keys()
     assert "allowList" in input_entity_2_options_keys
     assert "whileList" not in input_entity_2_options_keys
-    configuration_entity_1_options_keys = global_config.tabs[0]["entity"][0][
+    configuration_entity_1_options_keys = global_config.configuration[0]["entity"][0][
         "options"
     ].keys()
     assert "denyList" in configuration_entity_1_options_keys
     assert "blackList" not in configuration_entity_1_options_keys
-    configuration_entity_2_options_keys = global_config.tabs[0]["entity"][1][
+    configuration_entity_2_options_keys = global_config.configuration[0]["entity"][1][
         "options"
     ].keys()
     assert "allowList" in configuration_entity_2_options_keys