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 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
|
"""Tests of session module"""
import os
from unittest import mock
import pytest
from rasterio.session import (
DummySession,
AWSSession,
Session,
OSSSession,
GSSession,
SwiftSession,
AzureSession,
parse_bool,
)
def test_base_session_hascreds_notimpl():
"""Session.hascreds must be overridden"""
assert Session.hascreds({}) is NotImplemented
def test_base_session_get_credential_options_notimpl():
"""Session.get_credential_options must be overridden"""
assert Session().get_credential_options() is NotImplemented
def test_dummy_session():
"""DummySession works"""
sesh = DummySession()
assert sesh._session is None
assert sesh.get_credential_options() == {}
@pytest.mark.parametrize(("v", "vparsed"), [
(None, False),
(False, False),
(0, False),
(True, True),
("", True),
("yes", True),
("YES", True),
("no", False),
("No", False),
("NO", False),
("off", False),
("0", False),
("false", False),
("FaLsE", False),
])
def test_parse_bool(v, vparsed):
"""parse_bool works"""
assert isinstance(parse_bool(v), bool)
assert parse_bool(v) == vparsed
def test_aws_session_class():
"""AWSSession works"""
sesh = AWSSession(aws_access_key_id='foo', aws_secret_access_key='bar')
assert sesh._session
assert sesh.get_credential_options()['AWS_ACCESS_KEY_ID'] == 'foo'
assert sesh.get_credential_options()['AWS_SECRET_ACCESS_KEY'] == 'bar'
def test_aws_session_class_session():
"""AWSSession works"""
boto3 = pytest.importorskip("boto3")
sesh = AWSSession(session=boto3.session.Session(aws_access_key_id='foo', aws_secret_access_key='bar'))
assert sesh._session
assert sesh.get_credential_options()['AWS_ACCESS_KEY_ID'] == 'foo'
assert sesh.get_credential_options()['AWS_SECRET_ACCESS_KEY'] == 'bar'
def test_aws_session_class_unsigned(monkeypatch):
"""AWSSession works"""
sesh = AWSSession(aws_unsigned=True, region_name='us-mountain-1',
endpoint_url="http://localhost:9090")
assert sesh.get_credential_options()['AWS_NO_SIGN_REQUEST'] == 'YES'
assert sesh.get_credential_options()['AWS_REGION'] == 'us-mountain-1'
assert sesh.get_credential_options()['AWS_S3_ENDPOINT'] == 'http://localhost:9090'
# default to environment variable when not set
monkeypatch.setenv("AWS_NO_SIGN_REQUEST", "YES")
sesh = AWSSession()
assert sesh.unsigned is True
assert sesh.get_credential_options()['AWS_NO_SIGN_REQUEST'] == 'YES'
# Arguments override environment variable
sesh = AWSSession(aws_access_key_id="fake", aws_secret_access_key="fake", aws_unsigned=False)
assert sesh.unsigned is False
assert 'AWS_NO_SIGN_REQUEST' not in sesh.get_credential_options()
monkeypatch.undo()
def test_aws_session_class_unsigned_noboto3(monkeypatch):
"""AWSSession works without boto3"""
import rasterio.session
monkeypatch.setenv("AWS_NO_SIGN_REQUEST", "YES")
monkeypatch.setattr(rasterio.session, "boto3", None)
assert rasterio.session.boto3 is None
sesh = AWSSession()
assert sesh.unsigned is True
assert sesh.get_credential_options()['AWS_NO_SIGN_REQUEST'] == 'YES'
monkeypatch.undo()
def test_aws_session_class_profile(tmpdir, monkeypatch):
"""Confirm that profile_name kwarg works."""
pytest.importorskip("boto3")
credentials_file = tmpdir.join('credentials')
credentials_file.write("[testing]\n"
"aws_access_key_id = foo\n"
"aws_secret_access_key = bar\n"
"aws_session_token = baz")
monkeypatch.setenv('AWS_SHARED_CREDENTIALS_FILE', str(credentials_file))
monkeypatch.setenv('AWS_SESSION_TOKEN', 'ignore_me')
sesh = AWSSession(profile_name='testing')
assert sesh._session
assert sesh.get_credential_options()['AWS_ACCESS_KEY_ID'] == 'foo'
assert sesh.get_credential_options()['AWS_SECRET_ACCESS_KEY'] == 'bar'
assert sesh.get_credential_options()['AWS_SESSION_TOKEN'] == 'baz'
monkeypatch.undo()
def test_aws_session_class_endpoint():
"""Confirm that endpoint_url kwarg works."""
pytest.importorskip("boto3")
sesh = AWSSession(endpoint_url="example.com")
assert sesh.get_credential_options()['AWS_S3_ENDPOINT'] == 'example.com'
sesh = AWSSession(endpoint_url="example.com", aws_unsigned=True)
assert sesh.get_credential_options()['AWS_S3_ENDPOINT'] == 'example.com'
def test_session_factory_unparsed():
"""Get a DummySession for unparsed paths"""
sesh = Session.from_path("/vsicurl/lolwut")
assert isinstance(sesh, DummySession)
def test_session_factory_empty():
"""Get a DummySession for no path"""
sesh = Session.from_path("")
assert isinstance(sesh, DummySession)
def test_session_factory_local():
"""Get a DummySession for local paths"""
sesh = Session.from_path("file:///lolwut")
assert isinstance(sesh, DummySession)
def test_session_factory_unknown():
"""Get a DummySession for unknown paths"""
sesh = Session.from_path("https://fancy-cloud.com/lolwut")
assert isinstance(sesh, DummySession)
def test_session_factory_s3():
"""Get an AWSSession for s3:// paths"""
pytest.importorskip("boto3")
sesh = Session.from_path("s3://lol/wut")
assert isinstance(sesh, AWSSession)
def test_session_factory_s3_presigned_url():
"""Get a DummySession for presigned URLs"""
sesh = Session.from_path("https://fancy-cloud.com/lolwut?X-Amz-Signature=foo")
assert isinstance(sesh, DummySession)
def test_session_factory_s3_no_boto3(monkeypatch):
"""Get an AWSSession for s3:// paths"""
pytest.importorskip("boto3")
with monkeypatch.context() as mpctx:
mpctx.setattr("rasterio.session.boto3", None)
sesh = Session.from_path("s3://lol/wut")
assert isinstance(sesh, DummySession)
def test_session_factory_s3_kwargs():
"""Get an AWSSession for s3:// paths with keywords"""
pytest.importorskip("boto3")
sesh = Session.from_path("s3://lol/wut", aws_access_key_id='foo', aws_secret_access_key='bar')
assert isinstance(sesh, AWSSession)
assert sesh._session.get_credentials().access_key == 'foo'
assert sesh._session.get_credentials().secret_key == 'bar'
def test_foreign_session_factory_dummy():
sesh = Session.from_foreign_session(None)
assert isinstance(sesh, DummySession)
def test_foreign_session_factory_s3():
boto3 = pytest.importorskip("boto3")
aws_session = boto3.Session(aws_access_key_id='foo', aws_secret_access_key='bar')
sesh = Session.from_foreign_session(aws_session, cls=AWSSession)
assert isinstance(sesh, AWSSession)
assert sesh._session.get_credentials().access_key == 'foo'
assert sesh._session.get_credentials().secret_key == 'bar'
def test_requester_pays():
"""GDAL is configured with requester pays"""
sesh = AWSSession(aws_access_key_id='foo', aws_secret_access_key='bar', requester_pays=True)
assert sesh._session
assert sesh.get_credential_options()['AWS_REQUEST_PAYER'] == 'requester'
def test_oss_session_class():
"""OSSSession works"""
oss_session = OSSSession(
oss_access_key_id='foo',
oss_secret_access_key='bar',
oss_endpoint='null-island-1')
assert oss_session._creds
assert oss_session.get_credential_options()['OSS_ACCESS_KEY_ID'] == 'foo'
assert oss_session.get_credential_options()['OSS_SECRET_ACCESS_KEY'] == 'bar'
def test_session_factory_oss_kwargs():
"""Get an OSSSession for oss:// paths with keywords"""
sesh = Session.from_path("oss://lol/wut", oss_access_key_id='foo', oss_secret_access_key='bar')
assert isinstance(sesh, OSSSession)
assert sesh.get_credential_options()['OSS_ACCESS_KEY_ID'] == 'foo'
assert sesh.get_credential_options()['OSS_SECRET_ACCESS_KEY'] == 'bar'
def test_google_session_ctor_no_arg():
session = GSSession()
assert not session._creds
def test_gs_session_class():
"""GSSession works"""
gs_session = GSSession(
google_application_credentials='foo')
assert gs_session._creds
assert gs_session.get_credential_options()['GOOGLE_APPLICATION_CREDENTIALS'] == 'foo'
assert gs_session.hascreds({'GOOGLE_APPLICATION_CREDENTIALS': 'foo'})
def test_swift_session_class():
"""SwiftSession works"""
swift_session = SwiftSession(
swift_storage_url='foo',
swift_auth_token='bar',)
assert swift_session._creds
assert swift_session.get_credential_options()['SWIFT_STORAGE_URL'] == 'foo'
assert swift_session.get_credential_options()['SWIFT_AUTH_TOKEN'] == 'bar'
def test_swift_session_by_user_key():
def mock_init(self, session=None,
swift_storage_url=None, swift_auth_token=None,
swift_auth_v1_url=None, swift_user=None, swift_key=None):
self._creds = {'SWIFT_STORAGE_URL':'foo',
'SWIFT_AUTH_TOKEN':'bar'}
with mock.patch('rasterio.session.SwiftSession.__init__', new=mock_init):
swift_session = SwiftSession(
swift_auth_v1_url='foo',
swift_user='bar',
swift_key='key')
assert swift_session._creds
assert swift_session.get_credential_options()['SWIFT_STORAGE_URL'] == 'foo'
assert swift_session.get_credential_options()['SWIFT_AUTH_TOKEN'] == 'bar'
def test_session_factory_swift_kwargs():
"""Get an SwiftSession for /vsiswift/bucket/key with keywords"""
sesh = Session.from_path("/vsiswift/lol/wut", swift_storage_url='foo', swift_auth_token='bar')
assert isinstance(sesh, DummySession)
def test_session_aws_or_dummy_aws():
"""Get an AWSSession when boto3 is available"""
boto3 = pytest.importorskip("boto3")
assert isinstance(Session.aws_or_dummy(), AWSSession)
def test_session_aws_or_dummy_dummy(monkeypatch):
"""Get a DummySession when boto3 is not available"""
boto3 = pytest.importorskip("boto3")
with monkeypatch.context() as mpctx:
mpctx.setattr("rasterio.session.boto3", None)
assert isinstance(Session.aws_or_dummy(), DummySession)
def test_no_sign_request(monkeypatch):
"""If AWS_NO_SIGN_REQUEST is set do not default to aws_unsigned=False"""
monkeypatch.setenv("AWS_NO_SIGN_REQUEST", "YES")
assert AWSSession().unsigned
def test_no_credentialization_if_unsigned(monkeypatch):
"""Don't get credentials if we're not signing, see #1984"""
sesh = AWSSession(aws_unsigned=True)
assert sesh._creds is None
def test_azure_session_class():
"""AzureSession works"""
azure_session = AzureSession(azure_storage_account='foo', azure_storage_access_key='bar')
assert azure_session._creds
assert azure_session.get_credential_options()['AZURE_STORAGE_ACCOUNT'] == 'foo'
assert azure_session.get_credential_options()['AZURE_STORAGE_ACCESS_KEY'] == 'bar'
assert azure_session.hascreds(azure_session.get_credential_options())
def test_azure_session_class_connection_string():
"""AzureSession works"""
azure_session = AzureSession(azure_storage_connection_string='AccountName=myaccount;AccountKey=MY_ACCOUNT_KEY')
assert azure_session._creds
assert (
azure_session.get_credential_options()['AZURE_STORAGE_CONNECTION_STRING']
== 'AccountName=myaccount;AccountKey=MY_ACCOUNT_KEY'
)
assert azure_session.hascreds(azure_session.get_credential_options())
def test_session_factory_az_kwargs():
"""Get an AzureSession for az:// paths with keywords"""
sesh = Session.from_path("az://lol/wut", azure_storage_account='foo', azure_storage_access_key='bar')
assert isinstance(sesh, AzureSession)
assert sesh.get_credential_options()['AZURE_STORAGE_ACCOUNT'] == 'foo'
assert sesh.get_credential_options()['AZURE_STORAGE_ACCESS_KEY'] == 'bar'
assert sesh.hascreds(sesh.get_credential_options())
def test_session_factory_az_kwargs_connection_string():
"""Get an AzureSession for az:// paths with keywords"""
sesh = Session.from_path("az://lol/wut", azure_storage_connection_string='AccountName=myaccount;AccountKey=MY_ACCOUNT_KEY')
assert isinstance(sesh, AzureSession)
assert sesh.get_credential_options()['AZURE_STORAGE_CONNECTION_STRING'] == 'AccountName=myaccount;AccountKey=MY_ACCOUNT_KEY'
assert sesh.hascreds(sesh.get_credential_options())
def test_session_factory_az_kwargs_access_token():
"""Get an AzureSession for az:// paths with keywords"""
sesh = Session.from_path("az://lol/wut", azure_storage_account='foo', azure_storage_access_token='bar')
assert isinstance(sesh, AzureSession)
assert sesh.get_credential_options()['AZURE_STORAGE_ACCOUNT'] == 'foo'
assert sesh.get_credential_options()['AZURE_STORAGE_ACCESS_TOKEN'] == 'bar'
assert sesh.hascreds(sesh.get_credential_options())
def test_session_factory_az_kwargs_sas_token():
"""Get an AzureSession for az:// paths with keywords"""
sesh = Session.from_path("az://lol/wut", azure_storage_account='foo', azure_storage_sas_token='bar')
assert isinstance(sesh, AzureSession)
assert sesh.get_credential_options()['AZURE_STORAGE_ACCOUNT'] == 'foo'
assert sesh.get_credential_options()['AZURE_STORAGE_SAS_TOKEN'] == 'bar'
assert sesh.hascreds(sesh.get_credential_options())
def test_session_factory_az_kwargs_tenant_id():
"""Get an AzureSession for az:// paths with keywords"""
sesh = Session.from_path("az://lol/wut", azure_storage_account='foo', azure_tenant_id='tenant', azure_client_id='client', azure_federated_token_file='file', azure_authority_host='host')
assert isinstance(sesh, AzureSession)
assert sesh.get_credential_options()['AZURE_STORAGE_ACCOUNT'] == 'foo'
assert sesh.get_credential_options()['AZURE_TENANT_ID'] == 'tenant'
assert sesh.get_credential_options()['AZURE_CLIENT_ID'] == 'client'
assert sesh.get_credential_options()['AZURE_FEDERATED_TOKEN_FILE'] == 'file'
assert sesh.get_credential_options()['AZURE_AUTHORITY_HOST'] == 'host'
assert sesh.hascreds(sesh.get_credential_options())
def test_session_factory_az_env(monkeypatch):
"""Get an AzureSession for az:// paths with environment variables"""
monkeypatch.setattr(os, "environ", {})
monkeypatch.setenv('AZURE_STORAGE_ACCOUNT', 'foo')
monkeypatch.setenv('AZURE_STORAGE_ACCESS_KEY', 'bar')
sesh = Session.from_path("az://lol/wut")
assert isinstance(sesh, AzureSession)
assert sesh.get_credential_options()['AZURE_STORAGE_ACCOUNT'] == 'foo'
assert sesh.get_credential_options()['AZURE_STORAGE_ACCESS_KEY'] == 'bar'
assert sesh.hascreds(sesh.get_credential_options())
def test_session_factory_az_env_connection_string(monkeypatch):
"""Get an AzureSession for az:// paths with environment variables"""
monkeypatch.setattr(os, "environ", {})
monkeypatch.setenv('AZURE_STORAGE_CONNECTION_STRING', 'foo')
sesh = Session.from_path("az://lol/wut")
assert isinstance(sesh, AzureSession)
assert sesh.get_credential_options()['AZURE_STORAGE_CONNECTION_STRING'] == 'foo'
assert sesh.hascreds(sesh.get_credential_options())
def test_session_factory_az_env_sas_token(monkeypatch):
"""Get an AzureSession for az:// paths with environment variables"""
monkeypatch.setattr(os, "environ", {})
monkeypatch.setenv('AZURE_STORAGE_ACCOUNT', 'foo')
monkeypatch.setenv('AZURE_STORAGE_SAS_TOKEN', 'bar')
sesh = Session.from_path("az://lol/wut")
assert isinstance(sesh, AzureSession)
assert sesh.get_credential_options()['AZURE_STORAGE_ACCOUNT'] == 'foo'
assert sesh.get_credential_options()['AZURE_STORAGE_SAS_TOKEN'] == 'bar'
assert sesh.hascreds(sesh.get_credential_options())
def test_session_factory_az_env_tenant(monkeypatch):
"""Get an AzureSession for az:// paths with environment variables"""
monkeypatch.setattr(os, "environ", {})
monkeypatch.setenv('AZURE_STORAGE_ACCOUNT', 'foo')
monkeypatch.setenv('AZURE_TENANT_ID', 'tenant')
monkeypatch.setenv('AZURE_CLIENT_ID', 'client')
monkeypatch.setenv('AZURE_FEDERATED_TOKEN_FILE', 'file')
monkeypatch.setenv('AZURE_AUTHORITY_HOST', 'host')
sesh = Session.from_path("az://lol/wut")
assert isinstance(sesh, AzureSession)
assert sesh.get_credential_options()['AZURE_STORAGE_ACCOUNT'] == 'foo'
assert sesh.get_credential_options()['AZURE_TENANT_ID'] == 'tenant'
assert sesh.get_credential_options()['AZURE_CLIENT_ID'] == 'client'
assert sesh.get_credential_options()['AZURE_FEDERATED_TOKEN_FILE'] == 'file'
assert sesh.get_credential_options()['AZURE_AUTHORITY_HOST'] == 'host'
assert sesh.hascreds(sesh.get_credential_options())
def test_azure_no_sign_request(monkeypatch):
"""If AZURE_NO_SIGN_REQUEST is set do not default to azure_unsigned=False"""
monkeypatch.setattr(os, "environ", {})
monkeypatch.setenv('AZURE_STORAGE_ACCOUNT', 'foo')
monkeypatch.setenv('AZURE_NO_SIGN_REQUEST', 'YES')
sesh = AzureSession()
assert sesh.unsigned
assert sesh.hascreds(sesh.get_credential_options())
def test_azure_session_class_unsigned():
"""AzureSession works"""
sesh = AzureSession(azure_unsigned=True, azure_storage_account='naipblobs')
assert sesh.get_credential_options()['AZURE_NO_SIGN_REQUEST'] == 'YES'
assert sesh.get_credential_options()['AZURE_STORAGE_ACCOUNT'] == 'naipblobs'
assert sesh.hascreds(sesh.get_credential_options())
|