Merge pull request #29 from splitio/3.5.6-fix_http_err_msg_and_traffic_type_microclient

kleinjoshuaa · web-flow · commit e2c1b0511934 · 2025-10-31T17:01:55.000-04:00
3.5.6 fix http err msg and traffic type microclient
diff --git a/CHANGES.txt b/CHANGES.txt
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,3 @@
+include README.md
+include CHANGES.txt
+include LICENSE
diff --git a/check_package_contents.sh b/check_package_contents.sh
@@ -0,0 +1 @@
+
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1 @@
+
diff --git a/examples/error_handling_example.py b/examples/error_handling_example.py
@@ -0,0 +1 @@
+
diff --git a/examples/list_traffic_types_and_attributes.py b/examples/list_traffic_types_and_attributes.py
@@ -0,0 +1 @@
+
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "splitapiclient"
-version = "3.5.5"
-description = "This Python Library provide full support for Split REST Admin API, allow creating, deleting and editing Environments, Splits, Split Definitions, Segments, Segment Keys, Users, Groups, API Keys, Change Requests, Attributes and Identities"
+version = "3.5.6"
+description = "This Python Library provides full support for Split REST Admin API, allow creating, deleting and editing Environments, Splits, Split Definitions, Segments, Segment Keys, Users, Groups, API Keys, Change Requests, Attributes and Identities"
 classifiers = [
     "Programming Language :: Python :: 3",
     "Operating System :: OS Independent",
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 5 - Production/Stable",
     "Environment :: Console",
     "Intended Audience :: Developers",
     "Programming Language :: Python :: 3",
@@ -25,9 +25,23 @@ maintainers = [
   {name = "Josh Klein", email = "joshua.klein@harness.io"}
 ]
 dependencies = [
-'argparse >= 1.1',
-'requests >= 2.14.2',
-'six >= 1.10.0',
+"argparse >= 1.1",
+"requests >= 2.14.2",
+"six >= 1.10.0",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest >= 6.2.4",
+    "pytest-mock >= 1.6.0",
+    "mock >= 2.0.0",
+]
+dev = [
+    "pytest >= 6.2.4",
+    "pytest-mock >= 1.6.0",
+    "mock >= 2.0.0",
+    "build >= 0.7.0",
+    "twine >= 3.4.0",
 ]
 
 [project.license]
@@ -51,22 +65,7 @@ addopts = "--verbose"
 [tool.setuptools]
 include-package-data = false
 
-[aliases]
-test = "pytest"
-
-[tool.pytest]
-addopts = "--verbose"
-
-[options]
-packages = "find:"
-setup_requires = "pytest-runner"
-
-[options.install_requires]
-"argparse>" = "1.1"
-"requests>" = "2.14.2"
-"six>" = "1.10.0"
-
-[options.tests_require]
-mock = "=2.0.0"
-pytest-mock = "=1.6.0"
-pytest = "=6.2.4"
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["splitapiclient*"]
+exclude = ["splitapiclient.tests*"]
diff --git a/splitapiclient/http_clients/harness_client.py b/splitapiclient/http_clients/harness_client.py
@@ -125,11 +125,13 @@ def _handle_invalid_response(self, response):
             400: HTTPIncorrectParametersError,
         }
 
+        # Format error message with status code
+        error_message = f"HTTP {response.status_code}: {response.text}"
         exc = status_codes_exceptions.get(response.status_code)
         if exc:
-            raise exc(response.text)
+            raise exc(error_message, response)
         else:
-            raise HTTPResponseError(response.text)
+            raise HTTPResponseError(error_message, response)
 
     def _handle_connection_error(self, e):
         '''
diff --git a/splitapiclient/http_clients/sync_client.py b/splitapiclient/http_clients/sync_client.py
@@ -50,12 +50,13 @@ def _handle_invalid_response(self, response):
             401: HTTPUnauthorizedError,
             400: HTTPIncorrectParametersError,
         }
-
+        # Format error message with status code
+        error_message = f"HTTP {response.status_code}: {response.text}"
         exc = status_codes_exceptions.get(response.status_code)
         if exc:
-            raise exc(response.text)
+            raise exc(error_message, response)
         else:
-            raise HTTPResponseError(response.text)
+            raise HTTPResponseError(error_message, response)
 
     def _handle_connection_error(self, e):
         '''
diff --git a/splitapiclient/microclients/traffic_type_microclient.py b/splitapiclient/microclients/traffic_type_microclient.py
@@ -49,7 +49,7 @@ def list(self, workspace_id):
             self._endpoint['all_items'],
             workspaceId = workspace_id
         )
-        return [TrafficType(item, self._http_client) for item in response]
+        return [TrafficType(item, workspace_id, self._http_client) for item in response]
 
     def find(self, traffic_type_name, workspace_id):
         '''
diff --git a/splitapiclient/tests/http_clients/test_harness_http_client.py b/splitapiclient/tests/http_clients/test_harness_http_client.py
@@ -0,0 +1,145 @@
+from __future__ import absolute_import, division, print_function, \
+    unicode_literals
+
+import pytest
+from splitapiclient.http_clients.harness_client import HarnessHttpClient
+from splitapiclient.util.exceptions import HTTPUnauthorizedError, \
+    HTTPNotFoundError, HTTPIncorrectParametersError, HTTPResponseError
+
+
+class FakeResponse:
+    '''
+    Simple class to mock returned Response objects from the requests module.
+    '''
+    def __init__(self, status, text):
+        self.status_code = status
+        self.text = text
+
+
+class TestHarnessHttpClient:
+    '''
+    Tests for the HarnessHttpClient class error handling
+    '''
+
+    def test_handle_invalid_response(self):
+        '''
+        Test that error messages include status codes and response object is passed
+        '''
+        c1 = HarnessHttpClient('https://app.harness.io/', 'fake_harness_token')
+        
+        # Test 401 Unauthorized
+        with pytest.raises(HTTPUnauthorizedError) as exc_info:
+            c1._handle_invalid_response(FakeResponse(401, 'Unauthorized'))
+        assert 'HTTP 401' in str(exc_info.value)
+        assert 'Unauthorized' in str(exc_info.value)
+        assert exc_info.value._error is not None
+        assert exc_info.value._error.status_code == 401
+        
+        # Test 400 Bad Request
+        with pytest.raises(HTTPIncorrectParametersError) as exc_info:
+            c1._handle_invalid_response(FakeResponse(400, 'Bad request'))
+        assert 'HTTP 400' in str(exc_info.value)
+        assert 'Bad request' in str(exc_info.value)
+        assert exc_info.value._error.status_code == 400
+        
+        # Test 404 Not Found
+        with pytest.raises(HTTPNotFoundError) as exc_info:
+            c1._handle_invalid_response(FakeResponse(404, 'Not found'))
+        assert 'HTTP 404' in str(exc_info.value)
+        assert 'Not found' in str(exc_info.value)
+        assert exc_info.value._error.status_code == 404
+        
+        # Test generic error (500 Internal Server Error)
+        with pytest.raises(HTTPResponseError) as exc_info:
+            c1._handle_invalid_response(FakeResponse(500, 'Internal server error'))
+        assert 'HTTP 500' in str(exc_info.value)
+        assert 'Internal server error' in str(exc_info.value)
+        assert exc_info.value._error.status_code == 500
+        
+        # Test another generic error (403 Forbidden)
+        with pytest.raises(HTTPResponseError) as exc_info:
+            c1._handle_invalid_response(FakeResponse(403, '{"error": "Forbidden"}'))
+        assert 'HTTP 403' in str(exc_info.value)
+        assert 'Forbidden' in str(exc_info.value)
+        assert exc_info.value._error.status_code == 403
+        
+        # Test JSON error response
+        with pytest.raises(HTTPResponseError) as exc_info:
+            c1._handle_invalid_response(FakeResponse(503, '{"message": "Service temporarily unavailable", "code": "SERVICE_UNAVAILABLE"}'))
+        assert 'HTTP 503' in str(exc_info.value)
+        assert 'Service temporarily unavailable' in str(exc_info.value)
+        assert exc_info.value._error.status_code == 503
+
+    def test_is_harness_endpoint(self):
+        '''
+        Test that Harness endpoints are correctly identified
+        '''
+        harness_client = HarnessHttpClient('https://app.harness.io/', 'token')
+        split_client = HarnessHttpClient('https://api.split.io/internal/api/v2', 'token')
+        
+        # Harness endpoint should return True
+        assert harness_client._is_harness_endpoint({}) == True
+        
+        # Split endpoint should return False
+        assert split_client._is_harness_endpoint({}) == False
+
+    def test_deprecated_endpoint_detection(self):
+        '''
+        Test that deprecated endpoints are correctly identified
+        '''
+        client = HarnessHttpClient('https://app.harness.io/', 'token')
+        
+        # Test workspace POST (deprecated)
+        workspace_endpoint = {
+            'url_template': 'workspaces/create',
+            'method': 'POST'
+        }
+        assert client._is_deprecated_endpoint(workspace_endpoint) == True
+        
+        # Test workspace GET (not deprecated)
+        workspace_get_endpoint = {
+            'url_template': 'workspaces/list',
+            'method': 'GET'
+        }
+        assert client._is_deprecated_endpoint(workspace_get_endpoint) == False
+        
+        # Test users endpoint (all methods deprecated)
+        users_endpoint = {
+            'url_template': 'users/123',
+            'method': 'GET'
+        }
+        assert client._is_deprecated_endpoint(users_endpoint) == True
+        
+        # Test groups endpoint (all methods deprecated)
+        groups_endpoint = {
+            'url_template': 'groups/456',
+            'method': 'POST'
+        }
+        assert client._is_deprecated_endpoint(groups_endpoint) == True
+        
+        # Test restrictions endpoint (all methods deprecated)
+        restrictions_endpoint = {
+            'url_template': 'restrictions/789',
+            'method': 'DELETE'
+        }
+        assert client._is_deprecated_endpoint(restrictions_endpoint) == True
+        
+        # Test apiKeys with admin type (deprecated)
+        apikeys_endpoint = {
+            'url_template': 'apiKeys/create',
+            'method': 'POST'
+        }
+        body_admin = {'apiKeyType': 'admin'}
+        assert client._is_deprecated_endpoint(apikeys_endpoint, body_admin) == True
+        
+        # Test apiKeys with non-admin type (not deprecated)
+        body_non_admin = {'apiKeyType': 'user'}
+        assert client._is_deprecated_endpoint(apikeys_endpoint, body_non_admin) == False
+        
+        # Test non-deprecated endpoint
+        splits_endpoint = {
+            'url_template': 'splits/ws/123',
+            'method': 'GET'
+        }
+        assert client._is_deprecated_endpoint(splits_endpoint) == False
+
diff --git a/splitapiclient/tests/microclients/traffic_type_integration_test.py b/splitapiclient/tests/microclients/traffic_type_integration_test.py
diff --git a/splitapiclient/version.py b/splitapiclient/version.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+include README.md`
	`2`	`+include CHANGES.txt`
	`3`	`+include LICENSE`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ def list(self, workspace_id):`
`49`	`49`	`self._endpoint['all_items'],`
`50`	`50`	`workspaceId = workspace_id`
`51`	`51`	`)`
`52`		`- return [TrafficType(item, self._http_client) for item in response]`
	`52`	`+ return [TrafficType(item, workspace_id, self._http_client) for item in response]`
`53`	`53`
`54`	`54`	`def find(self, traffic_type_name, workspace_id):`
`55`	`55`	`'''`