|
| 1 | +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"). You |
| 4 | +# may not use this file except in compliance with the License. A copy of |
| 5 | +# the License is located at |
| 6 | +# |
| 7 | +# http://aws.amazon.com/apache2.0/ |
| 8 | +# |
| 9 | +# or in the "license" file accompanying this file. This file is |
| 10 | +# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF |
| 11 | +# ANY KIND, either express or implied. See the License for the specific |
| 12 | +# language governing permissions and limitations under the License. |
| 13 | +"""Tests for SageMakerClient caching and session handling. |
| 14 | +
|
| 15 | +Regression coverage for aws/sagemaker-python-sdk#5986 and #6069: a client built |
| 16 | +for one boto3 session must never be handed to a caller that passed a different |
| 17 | +session, and the ``config`` argument must actually reach the boto3 clients. |
| 18 | +""" |
| 19 | + |
| 20 | +from __future__ import absolute_import |
| 21 | + |
| 22 | +import boto3 |
| 23 | +import pytest |
| 24 | +from botocore.config import Config |
| 25 | + |
| 26 | +from sagemaker.core.utils.utils import SageMakerClient |
| 27 | + |
| 28 | +REGION_A = "us-west-2" |
| 29 | +REGION_B = "us-east-1" |
| 30 | + |
| 31 | + |
| 32 | +def _session(access_key, region): |
| 33 | + """Offline boto3 session carrying distinguishable static credentials.""" |
| 34 | + return boto3.Session( |
| 35 | + aws_access_key_id=access_key, |
| 36 | + aws_secret_access_key="secret-" + access_key, |
| 37 | + region_name=region, |
| 38 | + ) |
| 39 | + |
| 40 | + |
| 41 | +def _access_key(boto_client): |
| 42 | + return boto_client._request_signer._credentials.access_key |
| 43 | + |
| 44 | + |
| 45 | +@pytest.fixture(autouse=True) |
| 46 | +def _isolated_cache(): |
| 47 | + SageMakerClient.reset() |
| 48 | + yield |
| 49 | + SageMakerClient.reset() |
| 50 | + |
| 51 | + |
| 52 | +def test_explicit_session_is_honored_after_another_client_exists(): |
| 53 | + """The second session must not receive the first session's client (#5986, #6069).""" |
| 54 | + session_a = _session("AKIAFIRSTSESSION0000", REGION_A) |
| 55 | + session_b = _session("AKIASECONDSESSION000", REGION_B) |
| 56 | + |
| 57 | + client_a = SageMakerClient(session=session_a) |
| 58 | + client_b = SageMakerClient(session=session_b) |
| 59 | + |
| 60 | + assert client_a is not client_b |
| 61 | + assert client_b.session is session_b |
| 62 | + assert client_b.region_name == REGION_B |
| 63 | + for service in ( |
| 64 | + "sagemaker", |
| 65 | + "sagemaker-runtime", |
| 66 | + "sagemaker-featurestore-runtime", |
| 67 | + "sagemaker-metrics", |
| 68 | + ): |
| 69 | + assert _access_key(client_b.get_client(service)) == "AKIASECONDSESSION000" |
| 70 | + assert _access_key(client_a.get_client(service)) == "AKIAFIRSTSESSION0000" |
| 71 | + |
| 72 | + |
| 73 | +def test_same_session_returns_cached_instance(): |
| 74 | + session_a = _session("AKIAFIRSTSESSION0000", REGION_A) |
| 75 | + |
| 76 | + assert SageMakerClient(session=session_a) is SageMakerClient(session=session_a) |
| 77 | + assert SageMakerClient(session=session_a, region_name=REGION_A) is SageMakerClient( |
| 78 | + session=session_a, region_name=REGION_A |
| 79 | + ) |
| 80 | + |
| 81 | + |
| 82 | +def test_same_session_different_region_gets_distinct_client(): |
| 83 | + session_a = _session("AKIAFIRSTSESSION0000", REGION_A) |
| 84 | + |
| 85 | + client_a = SageMakerClient(session=session_a, region_name=REGION_A) |
| 86 | + client_b = SageMakerClient(session=session_a, region_name=REGION_B) |
| 87 | + |
| 88 | + assert client_a is not client_b |
| 89 | + assert client_b.sagemaker_client.meta.region_name == REGION_B |
| 90 | + |
| 91 | + |
| 92 | +def test_bare_call_returns_first_created_instance_as_default(): |
| 93 | + """Configure-once pattern: SageMakerClient(session=...) then bare SageMakerClient().""" |
| 94 | + session_a = _session("AKIAFIRSTSESSION0000", REGION_A) |
| 95 | + |
| 96 | + configured = SageMakerClient(session=session_a) |
| 97 | + |
| 98 | + assert SageMakerClient() is configured |
| 99 | + assert SageMakerClient() is configured |
| 100 | + |
| 101 | + |
| 102 | +def test_bare_call_default_is_not_replaced_by_later_explicit_session(): |
| 103 | + session_a = _session("AKIAFIRSTSESSION0000", REGION_A) |
| 104 | + session_b = _session("AKIASECONDSESSION000", REGION_B) |
| 105 | + |
| 106 | + default = SageMakerClient(session=session_a) |
| 107 | + SageMakerClient(session=session_b) |
| 108 | + |
| 109 | + assert SageMakerClient() is default |
| 110 | + |
| 111 | + |
| 112 | +def test_bare_call_creates_default_from_default_chain(monkeypatch): |
| 113 | + monkeypatch.setenv("AWS_ACCESS_KEY_ID", "AKIAENVIRONMENT00000") |
| 114 | + monkeypatch.setenv("AWS_SECRET_ACCESS_KEY", "secret") |
| 115 | + monkeypatch.setenv("AWS_DEFAULT_REGION", REGION_A) |
| 116 | + |
| 117 | + default = SageMakerClient() |
| 118 | + |
| 119 | + assert SageMakerClient() is default |
| 120 | + assert default.region_name == REGION_A |
| 121 | + assert _access_key(default.sagemaker_client) == "AKIAENVIRONMENT00000" |
| 122 | + |
| 123 | + |
| 124 | +def test_config_argument_is_applied_and_user_agent_suffix_appended(): |
| 125 | + session_a = _session("AKIAFIRSTSESSION0000", REGION_A) |
| 126 | + config = Config(connect_timeout=3, read_timeout=7, user_agent_extra="mytool/1.0") |
| 127 | + |
| 128 | + client = SageMakerClient(session=session_a, config=config) |
| 129 | + |
| 130 | + meta_config = client.sagemaker_client.meta.config |
| 131 | + assert meta_config.connect_timeout == 3 |
| 132 | + assert meta_config.read_timeout == 7 |
| 133 | + assert meta_config.user_agent_extra.startswith("mytool/1.0 ") |
| 134 | + assert "sagemaker" in meta_config.user_agent_extra.lower() |
| 135 | + |
| 136 | + |
| 137 | +def test_default_config_keeps_retry_settings(): |
| 138 | + session_a = _session("AKIAFIRSTSESSION0000", REGION_A) |
| 139 | + |
| 140 | + client = SageMakerClient(session=session_a) |
| 141 | + |
| 142 | + # botocore normalizes {"max_attempts": N} to {"total_max_attempts": N + 1}. |
| 143 | + retries = client.sagemaker_client.meta.config.retries |
| 144 | + assert retries["total_max_attempts"] == 11 |
| 145 | + assert retries["mode"] == "standard" |
| 146 | + |
| 147 | + |
| 148 | +def test_distinct_config_objects_get_distinct_clients(): |
| 149 | + session_a = _session("AKIAFIRSTSESSION0000", REGION_A) |
| 150 | + config_1 = Config(connect_timeout=1) |
| 151 | + config_2 = Config(connect_timeout=2) |
| 152 | + |
| 153 | + client_1 = SageMakerClient(session=session_a, config=config_1) |
| 154 | + client_2 = SageMakerClient(session=session_a, config=config_2) |
| 155 | + |
| 156 | + assert client_1 is not client_2 |
| 157 | + assert client_1.sagemaker_client.meta.config.connect_timeout == 1 |
| 158 | + assert client_2.sagemaker_client.meta.config.connect_timeout == 2 |
| 159 | + |
| 160 | + |
| 161 | +def test_reset_clears_default_and_keyed_entries(): |
| 162 | + session_a = _session("AKIAFIRSTSESSION0000", REGION_A) |
| 163 | + client_a = SageMakerClient(session=session_a) |
| 164 | + default = SageMakerClient() |
| 165 | + |
| 166 | + SageMakerClient.reset() |
| 167 | + |
| 168 | + assert SageMakerClient(session=session_a) is not client_a |
| 169 | + assert SageMakerClient() is not default |
| 170 | + |
| 171 | + |
| 172 | +def _cached_entries(): |
| 173 | + from sagemaker.core.utils.utils import _ClientCacheMeta |
| 174 | + |
| 175 | + return _ClientCacheMeta._instances.get(SageMakerClient, {}) |
| 176 | + |
| 177 | + |
| 178 | +def test_keyed_cache_is_bounded_and_default_survives_eviction(): |
| 179 | + from sagemaker.core.utils.utils import _ClientCacheMeta |
| 180 | + |
| 181 | + cap = _ClientCacheMeta._MAX_KEYED_ENTRIES |
| 182 | + sessions = [_session(f"AKIA{i:016d}", REGION_A) for i in range(cap + 5)] |
| 183 | + |
| 184 | + default = SageMakerClient(session=sessions[0]) |
| 185 | + clients = [SageMakerClient(session=s) for s in sessions] |
| 186 | + |
| 187 | + entries = _cached_entries() |
| 188 | + keyed = [k for k in entries if k != _ClientCacheMeta._DEFAULT_KEY] |
| 189 | + assert len(keyed) == cap |
| 190 | + # The oldest keyed entries were dropped, the newest kept. |
| 191 | + assert SageMakerClient(session=sessions[-1]) is clients[-1] |
| 192 | + assert SageMakerClient(session=sessions[0]) is not clients[0] |
| 193 | + # The process default is pinned regardless of eviction. |
| 194 | + assert SageMakerClient() is default |
| 195 | + |
| 196 | + |
| 197 | +def test_recently_used_entry_is_kept_over_stale_ones(): |
| 198 | + from sagemaker.core.utils.utils import _ClientCacheMeta |
| 199 | + |
| 200 | + cap = _ClientCacheMeta._MAX_KEYED_ENTRIES |
| 201 | + sessions = [_session(f"AKIA{i:016d}", REGION_A) for i in range(cap)] |
| 202 | + clients = [SageMakerClient(session=s) for s in sessions] |
| 203 | + |
| 204 | + # Touch the oldest entry so it becomes most recently used, then overflow by one. |
| 205 | + assert SageMakerClient(session=sessions[0]) is clients[0] |
| 206 | + SageMakerClient(session=_session("AKIAOVERFLOW00000000", REGION_A)) |
| 207 | + |
| 208 | + assert SageMakerClient(session=sessions[0]) is clients[0] |
| 209 | + assert SageMakerClient(session=sessions[1]) is not clients[1] |
| 210 | + |
| 211 | + |
| 212 | +def test_concurrent_first_calls_share_one_instance(): |
| 213 | + import threading |
| 214 | + |
| 215 | + session_a = _session("AKIAFIRSTSESSION0000", REGION_A) |
| 216 | + results = [] |
| 217 | + start = threading.Barrier(8) |
| 218 | + |
| 219 | + def build(): |
| 220 | + start.wait() |
| 221 | + results.append(SageMakerClient(session=session_a)) |
| 222 | + |
| 223 | + threads = [threading.Thread(target=build) for _ in range(8)] |
| 224 | + for t in threads: |
| 225 | + t.start() |
| 226 | + for t in threads: |
| 227 | + t.join() |
| 228 | + |
| 229 | + assert len(results) == 8 |
| 230 | + assert all(r is results[0] for r in results) |
0 commit comments