fix(ui): use the correct OAuth2 url (#1899)

**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

The UI by default uses a different URL for OAuth2 endpoint that UCC
generates. Meaning that we get 404 with a TA generated by UCC, without
any manual modifications.

This PR also adds tests for the previously untested functionality.

### User experience

No 404's for `*_oauth` endpoint.

## 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

.github/workflows/build-test-release.yml

@@ -285,6 +285,16 @@ jobs:
         with:
           name: test-results-ui-${{ matrix.splunk.version }}-${{ matrix.test-group }}
           path: test-results/*
+      - name: Copy splunkd.log
+        if: failure()
+        run: |
+          docker cp splunk:/opt/splunk/var/log/splunk/splunkd.log ./splunkd.log
+      - name: Upload splunkd.log to GitHub Check
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: test-ui-splunkd-splunkd-${{ matrix.splunk.version }}-${{ matrix.test-group }}.log
+          path: ./splunkd.log
       - uses: dorny/test-reporter@v2
         if: success() || failure()
         with:

scripts/run_splunk.sh

@@ -28,6 +28,7 @@ docker run \
   -p 8088:8088 \
   -p 8089:8089 \
   -p 9997:9997 \
+  --add-host host.docker.internal:host-gateway \
   -e "SPLUNK_START_ARGS=--accept-license" \
   -e "SPLUNK_PASSWORD=Chang3d!" \
   -e "SPLUNK_HEC_TOKEN=4a8a737d-5452-426c-a6f7-106dca4e813f" \

splunk_add_on_ucc_framework/templates/oauth.template

@@ -3,18 +3,16 @@ This module will be used to get oauth token from auth code
 """
 import import_declare_test
 
-import urllib
-try:
-    from urllib import urlencode
-except:
-    from urllib.parse import urlencode
+import json
 from httplib2 import Http, ProxyInfo, socks
-import splunk.admin as admin
+from urllib.parse import urlencode, urlsplit
+
 from solnlib import log
 from solnlib import conf_manager
 from solnlib.conf_manager import InvalidHostnameError, InvalidPortError
 from solnlib.utils import is_true
-import json
+import splunk.admin as admin
+from splunk.rest import getcontext
 
 
 log.Logs.set_context()
@@ -85,7 +83,8 @@ class {{app_name | lower}}_rh_oauth2_token(admin.MConfigHandler):
             logger.debug("oAUth url %s", url)
             proxy_info = self.getProxyDetails()
 
-            http = Http(proxy_info=proxy_info)
+            context = getcontext(urlsplit(url))
+            http = Http(proxy_info=proxy_info, context=context)
             method = self.callerArgs.data['method'][0]
 
             # Create payload from the arguments received

tests/testdata/expected_addons/expected_output_global_config_configuration/Splunk_TA_UCCExample/bin/splunk_ta_uccexample_rh_oauth.py

@@ -3,18 +3,16 @@
 """
 import import_declare_test
 
-import urllib
-try:
-    from urllib import urlencode
-except:
-    from urllib.parse import urlencode
+import json
 from httplib2 import Http, ProxyInfo, socks
-import splunk.admin as admin
+from urllib.parse import urlencode, urlsplit
+
 from solnlib import log
 from solnlib import conf_manager
 from solnlib.conf_manager import InvalidHostnameError, InvalidPortError
 from solnlib.utils import is_true
-import json
+import splunk.admin as admin
+from splunk.rest import getcontext
 
 
 log.Logs.set_context()
@@ -85,7 +83,8 @@ def handleEdit(self, confInfo):
             logger.debug("oAUth url %s", url)
             proxy_info = self.getProxyDetails()
 
-            http = Http(proxy_info=proxy_info)
+            context = getcontext(urlsplit(url))
+            http = Http(proxy_info=proxy_info, context=context)
             method = self.callerArgs.data['method'][0]
 
             # Create payload from the arguments received

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

@@ -3,18 +3,16 @@
 """
 import import_declare_test
 
-import urllib
-try:
-    from urllib import urlencode
-except:
-    from urllib.parse import urlencode
+import json
 from httplib2 import Http, ProxyInfo, socks
-import splunk.admin as admin
+from urllib.parse import urlencode, urlsplit
+
 from solnlib import log
 from solnlib import conf_manager
 from solnlib.conf_manager import InvalidHostnameError, InvalidPortError
 from solnlib.utils import is_true
-import json
+import splunk.admin as admin
+from splunk.rest import getcontext
 
 
 log.Logs.set_context()
@@ -85,7 +83,8 @@ def handleEdit(self, confInfo):
             logger.debug("oAUth url %s", url)
             proxy_info = self.getProxyDetails()
 
-            http = Http(proxy_info=proxy_info)
+            context = getcontext(urlsplit(url))
+            http = Http(proxy_info=proxy_info, context=context)
             method = self.callerArgs.data['method'][0]
 
             # Create payload from the arguments received

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

@@ -49,7 +49,14 @@
         encrypted=False,
         default=None,
         validator=None
-    ), 
+    ),
+    field.RestField(
+        'endpoint',
+        required=False,
+        encrypted=False,
+        default=None,
+        validator=None
+    ),
     field.RestField(
         'access_token',
         required=False,

tests/testdata/test_addons/package_global_config_everything/globalConfig.json

@@ -748,10 +748,16 @@
                                         "label": "Redirect url",
                                         "field": "redirect_url",
                                         "help": "Copy and paste this URL into your app."
+                                    },
+                                    {
+                                        "oauth_field": "endpoint",
+                                        "label": "Endpoint",
+                                        "field": "endpoint",
+                                        "help": "Put here endpoint, ie. login.salesforce.com"
                                     }
                                 ],
-                                "auth_code_endpoint": "/services/oauth2/authorize",
-                                "access_token_endpoint": "/services/oauth2/token",
+                                "auth_code_endpoint": "/oauth/authorize",
+                                "access_token_endpoint": "/oauth/token",
                                 "oauth_timeout": 30,
                                 "oauth_state_enabled": false
                             }

tests/ui/conftest.py

@@ -2,6 +2,7 @@
 
 import pytest
 
+from tests.ui.oauth2_server.oauth_server import OAuth2TestServer
 from tests.ui.pages.account_page import AccountPage
 from tests.ui.test_configuration_page_account_tab import _ACCOUNT_CONFIG
 from pytest_splunk_addon_ui_smartx import utils as s_utils
@@ -53,3 +54,19 @@ def pytest_runtest_call(item: pytest.Item) -> Iterator[Any]:
         log_msg = [f"{log.level}: {log.source} - {log.message}" for log in severe_logs]
         msg = "Severe logs found in browser console logs: \n" + "\n".join(log_msg)
         pytest.fail(msg, pytrace=True)
+
+
+@pytest.fixture(scope="session")
+def _oauth_server() -> Iterator[OAuth2TestServer]:
+    """Pytest fixture for OAuth2 test server."""
+    server = OAuth2TestServer(host="0.0.0.0")  # Use random port
+    server.start()
+    yield server
+    server.stop()
+
+
+@pytest.fixture
+def oauth_server_port(_oauth_server: OAuth2TestServer) -> int:
+    """Pytest fixture for OAuth2 test server."""
+    _oauth_server.clear_data()
+    return _oauth_server.port

tests/ui/oauth2_server/__init__.py

@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>OAuth2 Test Server - Login</title>
+    <style>
+        body { font-family: Arial, sans-serif; margin: 50px; }
+        .form-container { max-width: 400px; margin: 0 auto; }
+        .form-group { margin: 15px 0; }
+        label { display: block; margin-bottom: 5px; }
+        input { width: 100%; padding: 8px; box-sizing: border-box; }
+        button { background-color: #007cba; color: white; padding: 10px 20px; border: none; cursor: pointer; }
+        button:hover { background-color: #005a87; }
+        .info { background-color: #f0f0f0; padding: 15px; margin-bottom: 20px; border-radius: 5px; }
+    </style>
+</head>
+<body>
+    <div class="form-container">
+        <h2>OAuth2 Test Server</h2>
+        <div class="info">
+            <strong>Test Credentials:</strong><br>
+            Email: Any email address<br>
+            Password: <code>good</code>
+        </div>
+        <form method="post" action="/oauth/authorize">
+            <input type="hidden" name="client_id" value="${client_id}">
+            <input type="hidden" name="redirect_uri" value="${redirect_uri}">
+            <input type="hidden" name="state" value="${state}">
+            <input type="hidden" name="response_type" value="${response_type}">
+            
+            <div class="form-group">
+                <label for="email">Email:</label>
+                <input type="email" id="email" name="email" required>
+            </div>
+            
+            <div class="form-group">
+                <label for="password">Password:</label>
+                <input type="password" id="password" name="password" required>
+            </div>
+            
+            <div class="form-group">
+                <button type="submit">Login</button>
+            </div>
+        </form>
+    </div>
+</body>
+</html>