ibm-cloud-sdk-core 3.20.1__tar.gz → 3.20.2__tar.gz

{ibm-cloud-sdk-core-3.20.1/ibm_cloud_sdk_core.egg-info → ibm-cloud-sdk-core-3.20.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ibm-cloud-sdk-core
-Version: 3.20.1
+Version: 3.20.2
 Summary: Core library used by SDKs for IBM Cloud Services
 Home-page: https://github.com/IBM/python-sdk-core
 Author: IBM
@@ -29,7 +29,7 @@ License-File: LICENSE
 [![CLA assistant](https://cla-assistant.io/readme/badge/ibm/python-sdk-core)](https://cla-assistant.io/ibm/python-sdk-core)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-# IBM Python SDK Core Version 3.20.1
+# IBM Python SDK Core Version 3.20.2
 This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
 (openapi-sdkgen).
 

{ibm-cloud-sdk-core-3.20.1 → ibm-cloud-sdk-core-3.20.2}/README.md

@@ -4,7 +4,7 @@
 [![CLA assistant](https://cla-assistant.io/readme/badge/ibm/python-sdk-core)](https://cla-assistant.io/ibm/python-sdk-core)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-# IBM Python SDK Core Version 3.20.1
+# IBM Python SDK Core Version 3.20.2
 This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
 (openapi-sdkgen).
 

{ibm-cloud-sdk-core-3.20.1 → ibm-cloud-sdk-core-3.20.2}/ibm_cloud_sdk_core/base_service.py

@@ -30,6 +30,7 @@ from requests.exceptions import JSONDecodeError
 from ibm_cloud_sdk_core.authenticators import Authenticator
 from .api_exception import ApiException
 from .detailed_response import DetailedResponse
+from .http_adapter import SSLHTTPAdapter
 from .token_managers.token_manager import TokenManager
 from .utils import (
     has_bad_first_or_last_char,
@@ -38,7 +39,6 @@ from .utils import (
     cleanup_values,
     read_external_sources,
     strip_extra_slashes,
-    SSLHTTPAdapter,
     GzipStream,
 )
 from .private_helpers import _build_user_agent

ibm-cloud-sdk-core-3.20.2/ibm_cloud_sdk_core/http_adapter.py

@@ -0,0 +1,27 @@
+import ssl
+
+from requests.adapters import HTTPAdapter, DEFAULT_POOLBLOCK
+from urllib3.util.ssl_ import create_urllib3_context
+
+
+# pylint: disable=fixme
+class SSLHTTPAdapter(HTTPAdapter):
+    """Wraps the original HTTP adapter and adds additional SSL context."""
+
+    def __init__(self, *args, **kwargs):
+        self._disable_ssl_verification = kwargs.pop('_disable_ssl_verification', None)
+
+        super().__init__(*args, **kwargs)
+
+    def init_poolmanager(self, connections, maxsize, block=DEFAULT_POOLBLOCK, **pool_kwargs):
+        """Create and use custom SSL configuration."""
+
+        ssl_context = create_urllib3_context()
+        ssl_context.load_default_certs()
+        ssl_context.minimum_version = ssl.TLSVersion.TLSv1_2
+
+        if self._disable_ssl_verification:
+            ssl_context.check_hostname = False
+            ssl_context.verify_mode = ssl.CERT_NONE
+
+        super().init_poolmanager(connections, maxsize, block, ssl_context=ssl_context, **pool_kwargs)

{ibm-cloud-sdk-core-3.20.1 → ibm-cloud-sdk-core-3.20.2}/ibm_cloud_sdk_core/utils.py

@@ -19,41 +19,14 @@ import gzip
 import io
 import json as json_import
 import re
-import ssl
 from os import getenv, environ, getcwd
 from os.path import isfile, join, expanduser
 from typing import List, Union
 from urllib.parse import urlparse, parse_qs
 
-from requests.adapters import HTTPAdapter, DEFAULT_POOLBLOCK
-from urllib3.util.ssl_ import create_urllib3_context
-
 import dateutil.parser as date_parser
 
 
-# pylint: disable=fixme
-# TODO: revert the change in the `requirement.txt` once this class become deprecated!
-class SSLHTTPAdapter(HTTPAdapter):
-    """Wraps the original HTTP adapter and adds additional SSL context."""
-
-    def __init__(self, *args, **kwargs):
-        self._disable_ssl_verification = kwargs.pop('_disable_ssl_verification', None)
-
-        super().__init__(*args, **kwargs)
-
-    def init_poolmanager(self, connections, maxsize, block=DEFAULT_POOLBLOCK, **pool_kwargs):
-        """Create and use custom SSL configuration."""
-
-        ssl_context = create_urllib3_context()
-        ssl_context.minimum_version = ssl.TLSVersion.TLSv1_2
-
-        if self._disable_ssl_verification:
-            ssl_context.check_hostname = False
-            ssl_context.verify_mode = ssl.CERT_NONE
-
-        super().init_poolmanager(connections, maxsize, block, ssl_context=ssl_context, **pool_kwargs)
-
-
 class GzipStream(io.RawIOBase):
     """Compress files on the fly.
 

ibm-cloud-sdk-core-3.20.2/ibm_cloud_sdk_core/version.py

@@ -0,0 +1 @@
+__version__ = '3.20.2'

{ibm-cloud-sdk-core-3.20.1 → ibm-cloud-sdk-core-3.20.2/ibm_cloud_sdk_core.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ibm-cloud-sdk-core
-Version: 3.20.1
+Version: 3.20.2
 Summary: Core library used by SDKs for IBM Cloud Services
 Home-page: https://github.com/IBM/python-sdk-core
 Author: IBM
@@ -29,7 +29,7 @@ License-File: LICENSE
 [![CLA assistant](https://cla-assistant.io/readme/badge/ibm/python-sdk-core)](https://cla-assistant.io/ibm/python-sdk-core)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-# IBM Python SDK Core Version 3.20.1
+# IBM Python SDK Core Version 3.20.2
 This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
 (openapi-sdkgen).
 

{ibm-cloud-sdk-core-3.20.1 → ibm-cloud-sdk-core-3.20.2}/ibm_cloud_sdk_core.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ ibm_cloud_sdk_core/api_exception.py
 ibm_cloud_sdk_core/base_service.py
 ibm_cloud_sdk_core/detailed_response.py
 ibm_cloud_sdk_core/get_authenticator.py
+ibm_cloud_sdk_core/http_adapter.py
 ibm_cloud_sdk_core/private_helpers.py
 ibm_cloud_sdk_core/utils.py
 ibm_cloud_sdk_core/version.py
@@ -50,6 +51,7 @@ test/test_container_token_manager.py
 test/test_cp4d_authenticator.py
 test/test_cp4d_token_manager.py
 test/test_detailed_response.py
+test/test_http_adapter.py
 test/test_iam_authenticator.py
 test/test_iam_token_manager.py
 test/test_jwt_token_manager.py
@@ -63,5 +65,4 @@ test/test_vpc_instance_token_manager.py
 test_integration/__init__.py
 test_integration/test_cp4d_authenticator_integration.py
 test_integration/test_iam_authenticator_integration.py
-test_integration/test_mcsp_authenticator_integration.py
-test_integration/test_ssl_verification.py
+test_integration/test_mcsp_authenticator_integration.py

{ibm-cloud-sdk-core-3.20.1 → ibm-cloud-sdk-core-3.20.2}/ibm_cloud_sdk_core.egg-info/requires.txt

@@ -1,4 +1,4 @@
-requests<2.32.3,>=2.31.0
+requests<3.0.0,>=2.31.0
 urllib3<3.0.0,>=2.1.0
 python_dateutil<3.0.0,>=2.8.2
 PyJWT<3.0.0,>=2.8.0

{ibm-cloud-sdk-core-3.20.1 → ibm-cloud-sdk-core-3.20.2}/requirements.txt

@@ -1,4 +1,4 @@
-requests>=2.31.0,<2.32.3
+requests>=2.31.0,<3.0.0
 urllib3>=2.1.0,<3.0.0
 python_dateutil>=2.8.2,<3.0.0
 PyJWT>=2.8.0,<3.0.0

{ibm-cloud-sdk-core-3.20.1 → ibm-cloud-sdk-core-3.20.2}/setup.py

@@ -19,7 +19,7 @@ import pkg_resources
 from setuptools import setup, find_packages
 from setuptools.command.test import test as TestCommand
 
-__version__ = '3.20.1'
+__version__ = '3.20.2'
 
 if sys.argv[-1] == 'publish':
     # test server

{ibm-cloud-sdk-core-3.20.1 → ibm-cloud-sdk-core-3.20.2}/test/test_api_exception.py

@@ -74,6 +74,9 @@ def test_api_exception():
     mock_response = requests.get('https://test-errormessage.com', timeout=None)
     exception = ApiException(500, http_response=mock_response)
     assert exception.message == 'IAM error message'
+    assert exception.http_response.text == '{"errorMessage": "IAM error message"}'
+    assert exception.http_response.content == b'{"errorMessage": "IAM error message"}'
+    assert exception.http_response.json() == {'errorMessage': 'IAM error message'}
 
     responses.add(
         responses.GET,
@@ -86,3 +89,5 @@ def test_api_exception():
     exception = ApiException(500, http_response=mock_response)
     assert exception.message == 'plain text error'
     assert str(exception) == 'Error: plain text error, Status code: 500 , X-global-transaction-id: xx'
+    assert exception.http_response.text == 'plain text error'
+    assert exception.http_response.content == b'plain text error'

ibm-cloud-sdk-core-3.20.2/test/test_http_adapter.py

@@ -0,0 +1,123 @@
+# pylint: disable=missing-docstring
+import os
+import threading
+import warnings
+from http.server import HTTPServer, SimpleHTTPRequestHandler
+from ssl import get_default_verify_paths, SSLContext, PROTOCOL_TLSv1_1, PROTOCOL_TLSv1_2
+from typing import Callable
+
+import pytest
+import urllib3
+from requests.exceptions import SSLError
+
+from ibm_cloud_sdk_core.base_service import BaseService
+from ibm_cloud_sdk_core.authenticators import NoAuthAuthenticator
+
+
+# The certificate files that are used in this tests are generated by this command:
+# pylint: disable=line-too-long,pointless-string-statement
+"""
+openssl req -x509 -out test_ssl.crt -keyout test_ssl.key \
+  -newkey rsa:2048 -nodes -sha256 -days 36500 \
+  -subj '/CN=localhost' -extensions EXT -config <( \
+   printf "[dn]\nCN=localhost\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:localhost\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")
+"""
+
+
+# Load the certificate and the key files.
+cert = os.path.join(os.path.dirname(__file__), '../resources/test_ssl.crt')
+key = os.path.join(os.path.dirname(__file__), '../resources/test_ssl.key')
+
+
+def _local_server(tls_version: int, port: int) -> Callable:
+    def decorator(test_function: Callable) -> Callable:
+        def inner():
+            # Disable warnings caused by the self-signed certificate.
+            urllib3.disable_warnings()
+
+            # Build the SSL context for the server.
+            ssl_context = SSLContext(tls_version)
+            ssl_context.load_cert_chain(certfile=cert, keyfile=key)
+
+            # Create and start the server on a separate thread.
+            server = HTTPServer(('localhost', port), SimpleHTTPRequestHandler)
+            server.socket = ssl_context.wrap_socket(server.socket, server_side=True)
+            t = threading.Thread(target=server.serve_forever)
+            t.start()
+
+            # We run everything in a big try-except-finally block to make sure we always
+            # shutdown the HTTP server gracefully.
+            try:
+                test_function()
+            except Exception:  # pylint: disable=try-except-raise
+                raise
+            finally:
+                server.shutdown()
+                t.join()
+                # Re-enable warnings.
+                warnings.resetwarnings()
+
+        return inner
+
+    return decorator
+
+
+@_local_server(PROTOCOL_TLSv1_1, 3333)
+def test_tls_v1_1():
+    service = BaseService(service_url='https://localhost:3333', authenticator=NoAuthAuthenticator())
+    prepped = service.prepare_request('GET', url='/')
+    # The following request should fail, because the server will try
+    # to use TLS v1.1 but that's not allowed in our client.
+    with pytest.raises(Exception) as exception:
+        service.send(prepped, verify=cert)
+    # Errors can be differ based on the Python version.
+    assert exception.type is SSLError or exception.type is ConnectionError
+
+
+@_local_server(PROTOCOL_TLSv1_2, 3334)
+def test_tls_v1_2():
+    service = BaseService(service_url='https://localhost:3334', authenticator=NoAuthAuthenticator())
+
+    # First call the server with the default configuration.
+    # It should fail due to the self-signed SSL cert.
+    assert service.disable_ssl_verification is False
+    prepped = service.prepare_request('GET', url='/')
+    with pytest.raises(SSLError, match='certificate verify failed: self-signed certificate'):
+        res = service.send(prepped)
+
+    # Next configure it to validate by using our local certificate. Should raise no exception.
+    res = service.send(prepped, verify=cert)
+    assert res is not None
+
+    # Now disable the SSL verification. The request shouldn't raise any issue.
+    service.set_disable_ssl_verification(True)
+    assert service.disable_ssl_verification is True
+    prepped = service.prepare_request('GET', url='/')
+    res = service.send(prepped)
+    assert res is not None
+
+    # Lastly, try with an external URL.
+    # This test case is mainly here to reproduce the regression
+    # in the `requests` package that was introduced in `2.32.3`.
+    # More details on the issue can be found here: https://github.com/psf/requests/issues/6730
+    service = BaseService(service_url='https://cloud.ibm.com', authenticator=NoAuthAuthenticator())
+    assert service.disable_ssl_verification is False
+
+    ssl_context = service.http_adapter.poolmanager.connection_pool_kw.get("ssl_context")
+    assert ssl_context is not None
+    # In some cases (especially in Ubuntu containers that we use for testing on Travis)
+    # the default CA certificates are stored in a different place, so let's try to
+    # load those before making the final decision for this test case.
+    if len(ssl_context.get_ca_certs()) == 0:
+        try:
+            default_ca_path = get_default_verify_paths().capath
+            ssl_context.load_verify_locations(os.path.join(default_ca_path, 'ca-certificates.crt'))
+        except:
+            # Errors are ignored, let's jump straight to the assertion.
+            pass
+
+    assert len(ssl_context.get_ca_certs()) > 0
+
+    prepped = service.prepare_request('GET', url='/status')
+    res = service.send(prepped)
+    assert res is not None

{ibm-cloud-sdk-core-3.20.1 → ibm-cloud-sdk-core-3.20.2}/test/test_jwt_token_manager.py

@@ -97,9 +97,8 @@ def test_is_token_expired():
 
 
 def test_abstract_class_instantiation():
-    with pytest.raises(TypeError) as err:
+    with pytest.raises(TypeError, match=r"^Can't instantiate abstract class JWTTokenManager.*$"):
         JWTTokenManager(None)
-    assert str(err.value).startswith("Can't instantiate abstract class JWTTokenManager with abstract")
 
 
 def test_disable_ssl_verification():

{ibm-cloud-sdk-core-3.20.1 → ibm-cloud-sdk-core-3.20.2}/test/test_token_manager.py

@@ -34,14 +34,8 @@ class MockTokenManager(TokenManager):
 
 
 def test_abstract_class_instantiation():
-    with pytest.raises(TypeError) as err:
+    with pytest.raises(TypeError, match=r"^Can't instantiate abstract class TokenManager.*$"):
         TokenManager(None)
-    assert (
-        str(err.value) == "Can't instantiate abstract class "
-        "TokenManager with abstract methods "
-        "_save_token_info, "
-        "request_token"
-    )
 
 
 def requests_request_spy(*args, **kwargs):

ibm-cloud-sdk-core-3.20.1/ibm_cloud_sdk_core/version.py

@@ -1 +0,0 @@
-__version__ = '3.20.1'

ibm-cloud-sdk-core-3.20.1/test_integration/test_ssl_verification.py

@@ -1,62 +0,0 @@
-# pylint: disable=missing-docstring
-import os
-import threading
-from http.server import HTTPServer, SimpleHTTPRequestHandler
-from ssl import PROTOCOL_TLS_SERVER, SSLContext
-
-import pytest
-from requests.exceptions import SSLError
-
-from ibm_cloud_sdk_core.base_service import BaseService
-from ibm_cloud_sdk_core.authenticators import NoAuthAuthenticator
-
-
-# The certificate files that are used in this tests are generated by this command:
-# openssl req \
-#    -new \
-#    -newkey rsa:4096 \
-#    -days 36500 \
-#    -nodes \
-#    -x509 \
-#    -subj "/C=US/CN=localhost" \
-#    -keyout test_ssl.key \
-#    -out test_ssl.cert
-
-
-def test_ssl_verification():
-    # Load the certificate and the key files.
-    cert = os.path.join(os.path.dirname(__file__), '../resources/test_ssl.cert')
-    key = os.path.join(os.path.dirname(__file__), '../resources/test_ssl.key')
-
-    # Build the SSL context for the server.
-    ssl_context = SSLContext(PROTOCOL_TLS_SERVER)
-    ssl_context.load_cert_chain(certfile=cert, keyfile=key)
-
-    # Create and start the server on a separate thread.
-    server = HTTPServer(('127.0.0.1', 3333), SimpleHTTPRequestHandler)
-    server.socket = ssl_context.wrap_socket(server.socket, server_side=True)
-    t = threading.Thread(target=server.serve_forever)
-    t.start()
-
-    # We run everything in a big try-except-finally block to make sure we always
-    # shutdown the HTTP server gracefully.
-    try:
-        service = BaseService(service_url='https://127.0.0.1:3333', authenticator=NoAuthAuthenticator())
-        #
-        # First call the server with the default configuration.
-        # It should fail due to the invalid SSL cert.
-        assert service.disable_ssl_verification is False
-        prepped = service.prepare_request('GET', url='/')
-        with pytest.raises(SSLError):
-            res = service.send(prepped)
-
-        # Now disable the SSL verification. The request shouldn't raise any issue.
-        service.set_disable_ssl_verification(True)
-        assert service.disable_ssl_verification is True
-        prepped = service.prepare_request('GET', url='/')
-        res = service.send(prepped)
-        assert res is not None
-    except Exception:  # pylint: disable=try-except-raise
-        raise
-    finally:
-        server.shutdown()