1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
|
import json
import logging
import os
import uuid
from unittest import mock
import pytest
import globus_sdk
from globus_sdk import GlobusApp, GlobusAppConfig, GlobusSDKUsageError, UserApp
from globus_sdk.authorizers import NullAuthorizer
from globus_sdk.scopes import Scope, TransferScopes
from globus_sdk.testing import RegisteredResponse, get_last_request
from globus_sdk.token_storage import TokenValidationError
from globus_sdk.transport import RequestsTransport
@pytest.fixture
def auth_client():
return globus_sdk.NativeAppAuthClient(client_id=uuid.uuid1())
@pytest.fixture
def base_client_class():
class CustomClient(globus_sdk.BaseClient):
service_name = "transfer"
scopes = TransferScopes
default_scope_requirements = [TransferScopes.all]
def __init__(self, **kwargs) -> None:
super().__init__(**kwargs)
self.retry_config.max_retries = 0
return CustomClient
@pytest.fixture
def base_client(base_client_class):
return base_client_class()
# not particularly special, just a handy array of codes which should raise
# errors when encountered
ERROR_STATUS_CODES = (400, 404, 405, 409, 500, 503)
def test_cannot_instantiate_plain_base_client():
# attempting to instantiate a BaseClient errors
with pytest.raises(GlobusSDKUsageError):
globus_sdk.BaseClient()
def test_can_instantiate_base_client_with_explicit_url():
client = globus_sdk.BaseClient(base_url="https://example.org")
assert client.base_url == "https://example.org"
def test_can_instantiate_with_base_url_class_attribute():
class MyCoolClient(globus_sdk.BaseClient):
base_url = "https://example.org/"
client = MyCoolClient()
assert client.base_url == "https://example.org/"
def test_base_url_resolution_precedence():
"""
Base URL can come from one of 3 different places; this test asserts that we maintain
a consistent precedence between the three
(init-base_url > class-base_url > class-service_name)
"""
class BothAttributesClient(globus_sdk.BaseClient):
base_url = "class-base"
service_name = "service-name"
class OnlyServiceClient(globus_sdk.BaseClient):
service_name = "service-name"
# All 3 are set
assert BothAttributesClient(base_url="init-base").base_url == "init-base"
assert BothAttributesClient().base_url == "class-base"
assert OnlyServiceClient().base_url == "https://service-name.api.globus.org/"
def test_set_http_timeout(base_client):
class FooClient(globus_sdk.BaseClient):
service_name = "foo"
with mock.patch.dict(os.environ):
# ensure not set
os.environ.pop("GLOBUS_SDK_HTTP_TIMEOUT", None)
client = FooClient()
assert client.transport.http_timeout == 60.0
client = FooClient(transport=RequestsTransport(http_timeout=None))
assert client.transport.http_timeout == 60.0
client = FooClient(transport=RequestsTransport(http_timeout=-1))
assert client.transport.http_timeout is None
os.environ["GLOBUS_SDK_HTTP_TIMEOUT"] = "120"
client = FooClient()
assert client.transport.http_timeout == 120.0
os.environ["GLOBUS_SDK_HTTP_TIMEOUT"] = "-1"
client = FooClient()
assert client.transport.http_timeout is None
@pytest.mark.parametrize("mode", ("init", "post_init"))
def test_set_app_name(base_client, base_client_class, mode):
"""
Sets app name, confirms results
"""
# set app name
if mode == "post_init":
c = base_client
base_client.app_name = "SDK Test"
elif mode == "init":
c = base_client_class(app_name="SDK Test")
else:
raise NotImplementedError
# confirm results
assert c.app_name == "SDK Test"
assert c.transport.user_agent == f"{c.transport.BASE_USER_AGENT}/SDK Test"
@pytest.mark.parametrize(
"method, allows_body",
[("get", False), ("delete", False), ("post", True), ("put", True), ("patch", True)],
)
def test_http_methods(method, allows_body, base_client):
"""
BaseClient.{get, delete, post, put, patch} on a path does "the right thing"
Sends a text body or JSON body as requested
Raises a GlobusAPIError if the response is not a 200
NOTE: tests sending request bodies even on GET (which
*shouldn't* have bodies but *may* have them in reality).
"""
methodname = method.upper()
resolved_method = getattr(base_client, method)
path = "/v0.10/madeuppath/objectname"
RegisteredResponse(
service="transfer", path=path, method=methodname, json={"x": "y"}
).add()
# request with no body
res = resolved_method(path)
req = get_last_request()
assert req.method == methodname
assert req.body is None
assert "x" in res
assert res["x"] == "y"
if allows_body:
jsonbody = {"foo": "bar"}
res = resolved_method(path, data=jsonbody)
req = get_last_request()
assert req.method == methodname
assert req.body == json.dumps(jsonbody).encode("utf-8")
assert "x" in res
assert res["x"] == "y"
res = resolved_method(path, data="abc")
req = get_last_request()
assert req.method == methodname
assert req.body == "abc"
assert "x" in res
assert res["x"] == "y"
# send "bad" request
for status in ERROR_STATUS_CODES:
RegisteredResponse(
service="transfer",
path=path,
method=methodname,
json={"x": "y", "code": "ErrorCode", "message": "foo"},
status=status,
).replace()
with pytest.raises(globus_sdk.GlobusAPIError) as excinfo:
resolved_method(path)
assert excinfo.value.http_status == status
assert excinfo.value.raw_json["x"] == "y"
assert excinfo.value.code == "ErrorCode"
assert excinfo.value.message == "foo"
def test_handle_url_unsafe_chars(base_client):
# make sure this path (escaped) and the request path (unescaped) match
RegisteredResponse(
service="transfer", path="/v0.10/foo/foo%20bar", json={"x": "y"}
).add()
res = base_client.get("/v0.10/foo/foo bar")
assert "x" in res
assert res["x"] == "y"
def test_access_resource_server_property_via_instance(base_client):
# get works (and returns accurate info)
assert base_client.resource_server == TransferScopes.resource_server
def test_access_resource_server_property_via_class(base_client_class):
# get works (and returns accurate info)
assert base_client_class.resource_server == TransferScopes.resource_server
def test_app_integration(base_client_class):
def _reraise_token_error(_: GlobusApp, error: TokenValidationError):
raise error
config = GlobusAppConfig(token_validation_error_handler=_reraise_token_error)
app = UserApp("SDK Test", client_id="client_id", config=config)
c = base_client_class(app=app)
# confirm app_name set
assert c.app_name == "SDK Test"
# confirm default_required_scopes were automatically added
assert [str(s) for s in app.scope_requirements[c.resource_server]] == [
str(TransferScopes.all)
]
# confirm attempt at getting an authorizer from app
RegisteredResponse(
service="transfer", path="foo", method="get", json={"x": "y"}
).add()
with pytest.raises(TokenValidationError) as ex:
c.get("foo")
assert str(ex.value) == "No token data for transfer.api.globus.org"
def test_app_scopes(base_client_class):
app = UserApp("SDK Test", client_id="client_id")
c = base_client_class(app=app, app_scopes=[Scope("foo")])
# confirm app_scopes were added and default_required_scopes were not
assert [str(s) for s in app.scope_requirements[c.resource_server]] == ["foo"]
def test_add_app_scope(base_client_class):
app = UserApp("SDK Test", client_id="client_id")
c = base_client_class(app=app)
c.add_app_scope("foo")
str_list = [str(s) for s in app.scope_requirements[c.resource_server]]
assert len(str_list) == 2
assert str(TransferScopes.all) in str_list
assert "foo" in str_list
def test_add_app_scope_chaining(base_client_class):
app = UserApp("SDK Test", client_id="client_id")
c = base_client_class(app=app).add_app_scope("foo").add_app_scope("bar")
str_list = [str(s) for s in app.scope_requirements[c.resource_server]]
assert len(str_list) == 3
assert str(TransferScopes.all) in str_list
assert "foo" in str_list
assert "bar" in str_list
def test_app_mutually_exclusive(base_client_class):
app = UserApp("SDK Test", client_id="client_id")
expected = "A CustomClient cannot use both an 'app' and an 'authorizer'."
authorizer = NullAuthorizer()
with pytest.raises(globus_sdk.exc.GlobusSDKUsageError) as ex:
base_client_class(app=app, authorizer=authorizer)
assert str(ex.value) == expected
def test_app_name_override(base_client_class):
app = UserApp("SDK Test", client_id="client_id")
c = base_client_class(app=app, app_name="foo")
assert c.app_name == "foo"
def test_app_scopes_requires_app(base_client_class):
with pytest.raises(
globus_sdk.exc.GlobusSDKUsageError,
match=r"A CustomClient must have an 'app' to use 'app_scopes'\.",
):
base_client_class(app_scopes=[Scope("foo")])
def test_cannot_double_attach_app(base_client_class):
app = UserApp("SDK Test", client_id="client_id")
c = base_client_class(app=app)
with pytest.raises(
globus_sdk.exc.GlobusSDKUsageError,
match=r"Cannot attach GlobusApp to CustomClient when one is already attached\.",
):
c.attach_globus_app(app)
def test_cannot_attach_app_after_manually_setting_app_scopes(base_client_class):
c = base_client_class()
c.app_scopes = [Scope("foo")]
app = UserApp("SDK Test", client_id="client_id")
with pytest.raises(
globus_sdk.exc.GlobusSDKUsageError,
match=(
r"Cannot attach GlobusApp to CustomClient when `app_scopes` is already "
r"set\."
),
):
c.attach_globus_app(app)
def test_cannot_attach_app_when_authorizer_was_provided(base_client_class):
c = base_client_class(authorizer=NullAuthorizer())
app = UserApp("SDK Test", client_id="client_id")
with pytest.raises(
globus_sdk.exc.GlobusSDKUsageError,
match=(
r"Cannot attach GlobusApp to CustomClient when it has an authorizer "
r"assigned\."
),
):
c.attach_globus_app(app)
def test_cannot_attach_app_when_resource_server_is_not_resolvable():
class CustomClient(globus_sdk.BaseClient):
service_name = "transfer"
default_scope_requirements = [TransferScopes.all]
c = CustomClient()
app = UserApp("SDK Test", client_id="client_id")
with pytest.raises(
globus_sdk.exc.GlobusSDKUsageError,
match=(
r"Unable to use an 'app' with a client with no 'resource_server' defined\."
),
):
c.attach_globus_app(app)
def test_cannot_attach_app_with_mismatched_environment(base_client_class):
c = base_client_class(environment="preview")
app = UserApp("SDK Test", client_id="client_id")
with pytest.raises(
globus_sdk.exc.GlobusSDKUsageError,
match=(
r"\[Environment Mismatch\] CustomClient's environment \(preview\) does not "
r"match the GlobusApp's configured environment \(production\)\."
),
):
c.attach_globus_app(app)
def test_client_close_implicitly_closes_internal_transport(base_client_class):
# test the private _close() method directly
client = base_client_class()
with mock.patch.object(client.transport, "close") as transport_close:
client.close()
transport_close.assert_called_once()
def test_client_close_debug_logs_internal_transport_close(base_client_class, caplog):
caplog.set_level(logging.DEBUG)
client = base_client_class()
client.close()
assert "closing resource of type RequestsTransport for CustomClient" in caplog.text
def test_client_close_does_not_close_explicitly_passed_transport(base_client_class):
# test the private _close() method directly
client = base_client_class(transport=RequestsTransport())
with mock.patch.object(client.transport, "close") as transport_close:
client.close()
transport_close.assert_not_called()
def test_client_context_manager_exit_calls_close(base_client_class):
with mock.patch.object(globus_sdk.BaseClient, "close") as client_close_method:
with base_client_class():
client_close_method.assert_not_called()
client_close_method.assert_called_once()
|