fix(ui): show OAuth 2.0 entities on tabs other than "account" (#1895)

**Issue number:** ADDON-82672

### PR Type

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

## Summary

### Changes

UI had a hardcoded check that showed oauth2 entities only if tab's name
was "account". They were hidden if the name was different.

### User experience

The flow will work as before for "account" tabs. Users will now be able
to add oauth entities on other tabs as well.

## Checklist

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

### Review

* [x] self-review - I have performed a self-review of this change
according to the [development
guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines)
* [ ] Changes are documented. The documentation is understandable,
examples work [(more
info)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#documentation-guidelines)
* [x] PR title and description follows the [contributing
principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests)
* [ ] meeting - I have scheduled a meeting or recorded a demo to explain
these changes (if there is a video, put a link below and in the ticket)

### Tests

See [the testing
doc](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test).

* [x] Unit - tests have been added/modified to cover the changes
* [x] Smoke - tests have been added/modified to cover the changes
* [x] UI - tests have been added/modified to cover the changes
* [x] coverage - I have checked the code coverage of my changes [(see
more)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#checking-the-code-coverage)

**Demo/meeting:**

*Reviewers are encouraged to request meetings or demos if any part of
the change is unclear*

Author: kkedziak-splunk

tests/smoke/test_ucc_build.py

@@ -182,6 +182,7 @@ def test_ucc_generate_with_everything(caplog):
             ("bin", "splunk_ta_uccexample_rh_account.py"),
             ("bin", "splunk_ta_uccexample_rh_example_input_one.py"),
             ("bin", "splunk_ta_uccexample_rh_example_input_two.py"),
+            ("bin", "splunk_ta_uccexample_rh_organization.py"),
             ("bin", "splunk_ta_uccexample_rh_three_custom.py"),
             ("bin", "splunk_ta_uccexample_rh_example_input_four.py"),
             ("bin", "splunk_ta_uccexample_custom_rh.py"),

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/bin/splunk_ta_uccexample_rh_organization.py

@@ -0,0 +1,167 @@
+
+import import_declare_test
+
+from splunktaucclib.rest_handler.endpoint import (
+    field,
+    validator,
+    RestModel,
+    SingleModel,
+)
+from splunktaucclib.rest_handler import admin_external, util
+from splunktaucclib.rest_handler.admin_external import AdminExternalHandler
+import logging
+import json
+from solnlib import splunk_rest_client as rest_client
+from splunk.admin import InternalException
+
+
+util.remove_http_proxy_env_vars()
+
+
+special_fields = [
+    field.RestField(
+        'name',
+        required=True,
+        encrypted=False,
+        default=None,
+        validator=None
+    )
+]
+
+fields = [
+    field.RestField(
+        'client_id',
+        required=False,
+        encrypted=False,
+        default=None,
+        validator=None
+    ), 
+    field.RestField(
+        'client_secret',
+        required=False,
+        encrypted=True,
+        default=None,
+        validator=None
+    ), 
+    field.RestField(
+        'redirect_url',
+        required=False,
+        encrypted=False,
+        default=None,
+        validator=None
+    ), 
+    field.RestField(
+        'access_token',
+        required=False,
+        encrypted=True,
+        default=None,
+        validator=None
+    ), 
+    field.RestField(
+        'refresh_token',
+        required=False,
+        encrypted=True,
+        default=None,
+        validator=None
+    ), 
+    field.RestField(
+        'instance_url',
+        required=False,
+        encrypted=False,
+        default=None,
+        validator=None
+    )
+]
+model = RestModel(fields, name=None, special_fields=special_fields)
+
+
+endpoint = SingleModel(
+    'splunk_ta_uccexample_organization',
+    model,
+    config_name='organization',
+    need_reload=False,
+)
+
+APP_NAME = 'Splunk_TA_UCCExample'
+OAUTH_ENDPOINT = 'splunk_ta_uccexample_oauth'
+TOKEN_ENDPOINT = '/services/oauth2/token'
+
+
+class HandlerWithOauth(AdminExternalHandler):
+    def __init__(self, *args, **kw):
+        super().__init__(*args, **kw)
+        self._oauth_url = f"/servicesNS/nobody/{APP_NAME}/{OAUTH_ENDPOINT}/oauth"
+        self._rest_client = rest_client.SplunkRestClient(
+            self.getSessionKey(),
+            app=APP_NAME,
+        )
+
+    def oauth_call_url(self):
+        host = (
+            self.callerArgs.data.get("endpoint_token_oauth_credentials", [None])[0]
+            or self.callerArgs.data.get("endpoint_token", [None])[0]
+            or self.callerArgs.data.get("endpoint", [None])[0]
+        )
+
+        return f"https://{host}/{TOKEN_ENDPOINT.lstrip('/')}"
+
+    def oauth_client_credentials_call(self):
+        auth_type = self.callerArgs.data.get("auth_type", [""])[0]
+        if auth_type != "oauth_client_credentials":
+            return
+
+        client_id = (
+            self.callerArgs.data.get("client_id_oauth_credentials", [None])[0]
+            or self.callerArgs.data.get("client_id", [None])[0]
+        )
+
+        client_secret = (
+            self.callerArgs.data.get("client_secret_oauth_credentials", [None])[0]
+            or self.callerArgs.data.get("client_secret", [None])[0]
+        )
+
+        params = {
+            "grant_type": "client_credentials",
+            "client_id": client_id,
+            "client_secret": client_secret,
+            "url": self.oauth_call_url(),
+            "method": "POST",
+        }
+
+        if "scope" in self.callerArgs.data:
+            params["scope"] = self.callerArgs.data.get("scope", [None])[0]
+
+        data = json.loads(
+            self._rest_client.post(
+                self._oauth_url,
+                body=params,
+                headers=[("Content-Type", "application/json")],
+                output_mode="json",
+            ).body.read().decode("utf-8")
+        )["entry"][0]["content"]
+
+        if "access_token" not in data:
+            data = data.get("error", data)
+            raise InternalException("Error while trying to obtain OAuth token: %s" % data)
+
+        self.payload["access_token"] = data["access_token"]
+
+        for key in ["refresh_token", "instance_url"]:
+            if key in data:
+                self.payload[key] = data[key]
+
+    def handleCreate(self, confInfo):
+        self.oauth_client_credentials_call()
+        return super().handleCreate(confInfo)
+
+    def handleEdit(self, confInfo):
+        self.oauth_client_credentials_call()
+        return super().handleEdit(confInfo)
+
+
+if __name__ == '__main__':
+    logging.getLogger().addHandler(logging.NullHandler())
+    admin_external.handle(
+        endpoint,
+        handler=HandlerWithOauth,
+    )

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/default/app.conf

@@ -29,3 +29,4 @@ reload.splunk_ta_uccexample_custom_row_tab = simple
 reload.splunk_ta_uccexample_tab_hidden_for_cloud = simple
 reload.splunk_ta_uccexample_tab_hidden_for_enterprise = simple
 reload.splunk_ta_uccexample_oauth = simple
+reload.splunk_ta_uccexample_organization = simple

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/default/restmap.conf

@@ -1,6 +1,6 @@
 [admin:splunk_ta_uccexample_configuration]
 match = /
-members = splunk_ta_uccexample_account, splunk_ta_uccexample_custom_amd_row_tab, splunk_ta_uccexample_custom_row_tab, splunk_ta_uccexample_oauth, splunk_ta_uccexample_settings, splunk_ta_uccexample_tab_hidden_for_cloud, splunk_ta_uccexample_tab_hidden_for_enterprise
+members = splunk_ta_uccexample_account, splunk_ta_uccexample_custom_amd_row_tab, splunk_ta_uccexample_custom_row_tab, splunk_ta_uccexample_oauth, splunk_ta_uccexample_organization, splunk_ta_uccexample_settings, splunk_ta_uccexample_tab_hidden_for_cloud, splunk_ta_uccexample_tab_hidden_for_enterprise
 capability.put = admin_all_objects
 capability.post = list_storage_passwords
 
@@ -32,6 +32,13 @@ handlerfile = splunk_ta_uccexample_rh_account.py
 handleractions = edit, list, remove, create
 handlerpersistentmode = true
 
+[admin_external:splunk_ta_uccexample_organization]
+handlertype = python
+python.version = python3
+handlerfile = splunk_ta_uccexample_rh_organization.py
+handleractions = edit, list, remove, create
+handlerpersistentmode = true
+
 [admin_external:splunk_ta_uccexample_custom_row_tab]
 handlertype = python
 python.version = python3

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/default/server.conf

@@ -1,6 +1,7 @@
 [shclustering]
 conf_replication_include.splunk_ta_uccexample_settings = true
 conf_replication_include.splunk_ta_uccexample_account = true
+conf_replication_include.splunk_ta_uccexample_organization = true
 conf_replication_include.splunk_ta_uccexample_custom_row_tab = true
 conf_replication_include.splunk_ta_uccexample_custom_amd_row_tab = true
 conf_replication_include.splunk_ta_uccexample_tab_hidden_for_cloud = true

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/default/web.conf

@@ -14,6 +14,14 @@ methods = POST, GET
 pattern = splunk_ta_uccexample_account/*
 methods = POST, GET, DELETE
 
+[expose:splunk_ta_uccexample_organization]
+pattern = splunk_ta_uccexample_organization
+methods = POST, GET
+
+[expose:splunk_ta_uccexample_organization_specified]
+pattern = splunk_ta_uccexample_organization/*
+methods = POST, GET, DELETE
+
 [expose:splunk_ta_uccexample_custom_row_tab]
 pattern = splunk_ta_uccexample_custom_row_tab
 methods = POST, GET

tests/testdata/test_addons/package_global_config_everything/globalConfig.json

@@ -693,6 +693,71 @@
                     "restHandlerModule": "splunk_ta_uccexample_validate_account_rh",
                     "restHandlerClass": "CustomAccountValidator"
                 },
+                {
+                    "name": "organization",
+                    "title": "Organization",
+                    "table": {
+                        "actions": [
+                            "edit",
+                            "delete",
+                            "clone"
+                        ],
+                        "header": [
+                            {
+                                "label": "Name",
+                                "field": "name"
+                            },
+                            {
+                                "label": "Auth Type",
+                                "field": "auth_type"
+                            }
+                        ]
+                    },
+                    "entity": [
+                        {
+                            "type": "text",
+                            "label": "Name",
+                            "field": "name",
+                            "help": "Enter a unique name for this account.",
+                            "required": true
+                        },
+                        {
+                            "type": "oauth",
+                            "field": "oauth",
+                            "label": "Not used",
+                            "options": {
+                                "auth_type": [
+                                    "oauth"
+                                ],
+                                "oauth": [
+                                    {
+                                        "oauth_field": "client_id",
+                                        "label": "Client Id",
+                                        "field": "client_id",
+                                        "help": "Enter the Client Id for this account."
+                                    },
+                                    {
+                                        "oauth_field": "client_secret",
+                                        "label": "Client Secret",
+                                        "field": "client_secret",
+                                        "encrypted": true,
+                                        "help": "Enter the Client Secret key for this account."
+                                    },
+                                    {
+                                        "oauth_field": "redirect_url",
+                                        "label": "Redirect url",
+                                        "field": "redirect_url",
+                                        "help": "Copy and paste this URL into your app."
+                                    }
+                                ],
+                                "auth_code_endpoint": "/services/oauth2/authorize",
+                                "access_token_endpoint": "/services/oauth2/token",
+                                "oauth_timeout": 30,
+                                "oauth_state_enabled": false
+                            }
+                        }
+                    ]
+                },
                 {
                     "name": "custom_tab",
                     "title": "Custom_tab without entity",
@@ -2407,7 +2472,7 @@
     "meta": {
         "name": "Splunk_TA_UCCExample",
         "restRoot": "splunk_ta_uccexample",
-        "version": "5.69.0+d6b58f8c0",
+        "version": "5.69.1+d31a2b981",
         "displayName": "Splunk UCC test Add-on",
         "schemaVersion": "0.0.9",
         "supportedThemes": [

tests/ui/pages/account_page.py

@@ -131,12 +131,14 @@ def __init__(
         ucc_smartx_selenium_helper=None,
         ucc_smartx_rest_helper=None,
         open_page=True,
+        name="account",
     ):
         """
         :param ucc_smartx_selenium_helper: smartx configuration fixture
         """
+        self.name = name
         super().__init__(ucc_smartx_selenium_helper, ucc_smartx_rest_helper, open_page)
-        account_container = Selector(select='div[id="accountTab"]')
+        account_container = Selector(select=f'div[id="{name}Tab"]')
 
         if ucc_smartx_selenium_helper:
             self.table = ConfigurationTable(
@@ -170,10 +172,10 @@ def open(self):
             f"{self.splunk_web_url}/en-US/app/{C.ADDON_NAME}/configuration"
         )
         tab = Tab(self.browser)
-        tab.open_tab("account")
+        tab.open_tab(self.name)
 
     def _get_account_endpoint(self):
         """
         Get rest endpoint for the configuration
         """
-        return f"{self.splunk_mgmt_url}/servicesNS/nobody/{C.ADDON_NAME}/splunk_ta_uccexample_account"
+        return f"{self.splunk_mgmt_url}/servicesNS/nobody/{C.ADDON_NAME}/splunk_ta_uccexample_{self.name}"

tests/ui/test_configuration_page_account_tab.py

@@ -442,6 +442,21 @@ def test_account_oauth_fields_label_entity(
         self.assert_util(account.entity.client_secret.get_input_label, "Client Secret")
         self.assert_util(account.entity.redirect_url.get_input_label, "Redirect url")
 
+    @pytest.mark.execute_enterprise_cloud_true
+    @pytest.mark.forwarder
+    @pytest.mark.account
+    def test_account_oauth_fields_different_tab(
+        self, ucc_smartx_selenium_helper, ucc_smartx_rest_helper
+    ):
+        """Verifies oauth account field label"""
+        account = AccountPage(
+            ucc_smartx_selenium_helper, ucc_smartx_rest_helper, name="organization"
+        )
+        account.entity.open()
+        self.assert_util(account.entity.client_id.get_input_label, "Client Id")
+        self.assert_util(account.entity.client_secret.get_input_label, "Client Secret")
+        self.assert_util(account.entity.redirect_url.get_input_label, "Redirect url")
+
     @pytest.mark.execute_enterprise_cloud_true
     @pytest.mark.account
     def test_account_help_text_entity(

ui/src/components/BaseFormView/BaseFormView.tsx

@@ -251,7 +251,7 @@ class BaseFormView extends PureComponent<BaseFormProps, BaseFormState> {
         this.entities?.forEach((e) => {
             if (e.type === 'oauth') {
                 this.isOAuth = true;
-                if (props.page === PAGE_CONF && props.serviceName === 'account') {
+                if (props.page === PAGE_CONF) {
                     const authType: Array<AvaillableOAuthTypes> = e?.options?.auth_type;
                     this.isoauthState =
                         typeof e?.options?.oauth_state_enabled !== 'undefined'