Enhance URL generation tests for Harness microclients to verify inclusion of optional parameters (orgIdentifier, projectIdentifier) in API requests. Add comprehensive test cases for list and get methods across various microclients, ensuring correct URL formation based on provided identifiers.

Author: kleinjoshuaa

splitapiclient/tests/microclients/harness/conftest.py

@@ -0,0 +1,57 @@
+"""
+Shared pytest fixtures and helpers for Harness microclient tests.
+"""
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+import pytest
+
+
+class FakeResponse:
+    """
+    Simple class to mock Response objects from the requests module.
+    Used for testing URL generation without making actual HTTP calls.
+    """
+    def __init__(self, status, text):
+        self.status_code = status
+        self.text = text
+
+
+@pytest.fixture
+def fake_response():
+    """Factory fixture for creating FakeResponse objects."""
+    def _create_response(status=200, text='{}'):
+        return FakeResponse(status, text)
+    return _create_response
+
+
+@pytest.fixture
+def mock_requests_get(mocker):
+    """Mock requests.get and return the mock for assertions."""
+    mock = mocker.patch('splitapiclient.http_clients.sync_client.requests.get')
+    mock.return_value = FakeResponse(200, '{"data": []}')
+    return mock
+
+
+@pytest.fixture
+def mock_requests_post(mocker):
+    """Mock requests.post and return the mock for assertions."""
+    mock = mocker.patch('splitapiclient.http_clients.sync_client.requests.post')
+    mock.return_value = FakeResponse(200, '{"data": {}}')
+    return mock
+
+
+@pytest.fixture
+def mock_requests_put(mocker):
+    """Mock requests.put and return the mock for assertions."""
+    mock = mocker.patch('splitapiclient.http_clients.sync_client.requests.put')
+    mock.return_value = FakeResponse(200, '{"data": {}}')
+    return mock
+
+
+@pytest.fixture
+def mock_requests_delete(mocker):
+    """Mock requests.delete and return the mock for assertions."""
+    mock = mocker.patch('splitapiclient.http_clients.sync_client.requests.delete')
+    mock.return_value = FakeResponse(200, '{}')
+    return mock
+

splitapiclient/tests/microclients/harness/harness_apikey_microclient_test.py

@@ -1,9 +1,12 @@
 from __future__ import absolute_import, division, print_function, \
     unicode_literals
 
+import json
 from splitapiclient.microclients.harness import HarnessApiKeyMicroClient
 from splitapiclient.http_clients.sync_client import SyncHttpClient
+from splitapiclient.http_clients.harness_client import HarnessHttpClient
 from splitapiclient.resources.harness import HarnessApiKey
+from splitapiclient.tests.microclients.harness.conftest import FakeResponse
 
 
 class TestHarnessApiKeyMicroClient:
@@ -304,3 +307,149 @@ def test_delete(self, mocker):
 
         # Verify the result
         assert result is True
+
+
+class TestHarnessApiKeyURLGeneration:
+    """
+    Tests that verify actual URL generation by mocking at the requests level.
+    These tests ensure that optional parameters (orgIdentifier, projectIdentifier)
+    are correctly included or excluded from the final URL.
+    """
+
+    # =========================================================================
+    # LIST method URL tests
+    # =========================================================================
+
+    def test_list_url_without_optional_identifiers(self, mocker):
+        """Verify list URL doesn't contain orgIdentifier/projectIdentifier when not set"""
+        mock_get = mocker.patch('splitapiclient.http_clients.harness_client.requests.get')
+        mock_get.return_value = FakeResponse(200, json.dumps({'data': []}))
+
+        hc = HarnessHttpClient('https://app.harness.io', 'test_token')
+        client = HarnessApiKeyMicroClient(hc, 'test_account')
+        client.list('parent1')
+
+        called_url = mock_get.call_args[0][0]
+        assert 'accountIdentifier=test_account' in called_url
+        assert 'parentIdentifier=parent1' in called_url
+        assert 'orgIdentifier' not in called_url
+        assert 'projectIdentifier' not in called_url
+
+    def test_list_url_with_org_identifier_only(self, mocker):
+        """Verify list URL contains orgIdentifier when set, but not projectIdentifier"""
+        mock_get = mocker.patch('splitapiclient.http_clients.harness_client.requests.get')
+        mock_get.return_value = FakeResponse(200, json.dumps({'data': []}))
+
+        hc = HarnessHttpClient('https://app.harness.io', 'test_token')
+        client = HarnessApiKeyMicroClient(hc, 'test_account', org_identifier='org1')
+        client.list('parent1')
+
+        called_url = mock_get.call_args[0][0]
+        assert 'accountIdentifier=test_account' in called_url
+        assert 'parentIdentifier=parent1' in called_url
+        assert 'orgIdentifier=org1' in called_url
+        assert 'projectIdentifier' not in called_url
+
+    def test_list_url_with_project_identifier_only(self, mocker):
+        """Verify list URL contains projectIdentifier when set, but not orgIdentifier"""
+        mock_get = mocker.patch('splitapiclient.http_clients.harness_client.requests.get')
+        mock_get.return_value = FakeResponse(200, json.dumps({'data': []}))
+
+        hc = HarnessHttpClient('https://app.harness.io', 'test_token')
+        client = HarnessApiKeyMicroClient(hc, 'test_account', project_identifier='proj1')
+        client.list('parent1')
+
+        called_url = mock_get.call_args[0][0]
+        assert 'accountIdentifier=test_account' in called_url
+        assert 'parentIdentifier=parent1' in called_url
+        assert 'orgIdentifier' not in called_url
+        assert 'projectIdentifier=proj1' in called_url
+
+    def test_list_url_with_both_identifiers(self, mocker):
+        """Verify list URL contains both orgIdentifier and projectIdentifier when set"""
+        mock_get = mocker.patch('splitapiclient.http_clients.harness_client.requests.get')
+        mock_get.return_value = FakeResponse(200, json.dumps({'data': []}))
+
+        hc = HarnessHttpClient('https://app.harness.io', 'test_token')
+        client = HarnessApiKeyMicroClient(hc, 'test_account', org_identifier='org1', project_identifier='proj1')
+        client.list('parent1')
+
+        called_url = mock_get.call_args[0][0]
+        assert 'accountIdentifier=test_account' in called_url
+        assert 'parentIdentifier=parent1' in called_url
+        assert 'orgIdentifier=org1' in called_url
+        assert 'projectIdentifier=proj1' in called_url
+
+    def test_list_url_with_method_override_identifiers(self, mocker):
+        """Verify list URL uses method parameters to override instance defaults"""
+        mock_get = mocker.patch('splitapiclient.http_clients.harness_client.requests.get')
+        mock_get.return_value = FakeResponse(200, json.dumps({'data': []}))
+
+        hc = HarnessHttpClient('https://app.harness.io', 'test_token')
+        client = HarnessApiKeyMicroClient(hc, 'test_account', org_identifier='default_org', project_identifier='default_proj')
+        client.list('parent1', org_identifier='override_org', project_identifier='override_proj')
+
+        called_url = mock_get.call_args[0][0]
+        assert 'accountIdentifier=test_account' in called_url
+        assert 'orgIdentifier=override_org' in called_url
+        assert 'projectIdentifier=override_proj' in called_url
+        assert 'default_org' not in called_url
+        assert 'default_proj' not in called_url
+
+    # =========================================================================
+    # GET method URL tests
+    # =========================================================================
+
+    def test_get_url_without_optional_identifiers(self, mocker):
+        """Verify get URL doesn't contain orgIdentifier/projectIdentifier when not set"""
+        mock_get = mocker.patch('splitapiclient.http_clients.harness_client.requests.get')
+        mock_get.return_value = FakeResponse(200, json.dumps({
+            'data': {'apiKey': {'identifier': 'ak1', 'name': 'AK1', 'description': '', 'parentIdentifier': 'parent1', 'apiKeyType': 'SERVICE_ACCOUNT'}}
+        }))
+
+        hc = HarnessHttpClient('https://app.harness.io', 'test_token')
+        client = HarnessApiKeyMicroClient(hc, 'test_account')
+        client.get('ak1', 'parent1')
+
+        called_url = mock_get.call_args[0][0]
+        assert '/apikey/aggregate/ak1' in called_url
+        assert 'accountIdentifier=test_account' in called_url
+        assert 'parentIdentifier=parent1' in called_url
+        assert 'orgIdentifier' not in called_url
+        assert 'projectIdentifier' not in called_url
+
+    def test_get_url_with_org_identifier_only(self, mocker):
+        """Verify get URL contains orgIdentifier when set, but not projectIdentifier"""
+        mock_get = mocker.patch('splitapiclient.http_clients.harness_client.requests.get')
+        mock_get.return_value = FakeResponse(200, json.dumps({
+            'data': {'apiKey': {'identifier': 'ak1', 'name': 'AK1', 'description': '', 'parentIdentifier': 'parent1', 'apiKeyType': 'SERVICE_ACCOUNT'}}
+        }))
+
+        hc = HarnessHttpClient('https://app.harness.io', 'test_token')
+        client = HarnessApiKeyMicroClient(hc, 'test_account', org_identifier='org1')
+        client.get('ak1', 'parent1')
+
+        called_url = mock_get.call_args[0][0]
+        assert '/apikey/aggregate/ak1' in called_url
+        assert 'accountIdentifier=test_account' in called_url
+        assert 'parentIdentifier=parent1' in called_url
+        assert 'orgIdentifier=org1' in called_url
+        assert 'projectIdentifier' not in called_url
+
+    def test_get_url_with_both_identifiers(self, mocker):
+        """Verify get URL contains both orgIdentifier and projectIdentifier when set"""
+        mock_get = mocker.patch('splitapiclient.http_clients.harness_client.requests.get')
+        mock_get.return_value = FakeResponse(200, json.dumps({
+            'data': {'apiKey': {'identifier': 'ak1', 'name': 'AK1', 'description': '', 'parentIdentifier': 'parent1', 'apiKeyType': 'SERVICE_ACCOUNT'}}
+        }))
+
+        hc = HarnessHttpClient('https://app.harness.io', 'test_token')
+        client = HarnessApiKeyMicroClient(hc, 'test_account', org_identifier='org1', project_identifier='proj1')
+        client.get('ak1', 'parent1')
+
+        called_url = mock_get.call_args[0][0]
+        assert '/apikey/aggregate/ak1' in called_url
+        assert 'accountIdentifier=test_account' in called_url
+        assert 'parentIdentifier=parent1' in called_url
+        assert 'orgIdentifier=org1' in called_url
+        assert 'projectIdentifier=proj1' in called_url