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
|
# -*- coding: utf-8 -*-
# --------------------------------------------------------------------------
#
# Copyright (c) Microsoft Corporation. All rights reserved.
#
# The MIT License (MIT)
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the ""Software""), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# --------------------------------------------------------------------------
import logging
import pickle
try:
from unittest import mock
except ImportError:
import mock
import requests
import pytest
from azure.core.exceptions import DecodeError, AzureError
from azure.core.pipeline import Pipeline, PipelineResponse, PipelineRequest, PipelineContext
from azure.core.pipeline.policies import (
NetworkTraceLoggingPolicy,
ContentDecodePolicy,
RequestHistory,
RetryPolicy,
HTTPPolicy,
)
from utils import (
HTTP_REQUESTS,
create_http_request,
HTTP_RESPONSES,
REQUESTS_TRANSPORT_RESPONSES,
create_http_response,
create_transport_response,
request_and_responses_product,
)
from azure.core.pipeline._tools import is_rest
def test_pipeline_context():
kwargs = {"stream": True, "cont_token": "bla"}
context = PipelineContext("transport", **kwargs)
context["foo"] = "bar"
context["xyz"] = "123"
context["deserialized_data"] = "marvelous"
assert context["foo"] == "bar"
assert context.options == kwargs
with pytest.raises(TypeError):
context.clear()
with pytest.raises(TypeError):
context.update({})
assert context.pop("foo") == "bar"
assert "foo" not in context
serialized = pickle.dumps(context)
revived_context = pickle.loads(serialized) # nosec
assert revived_context.options == kwargs
assert revived_context.transport is None
assert "deserialized_data" in revived_context
assert len(revived_context) == 1
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_request_history(http_request):
class Non_deep_copyable(object):
def __deepcopy__(self, memodict={}):
raise ValueError()
body = Non_deep_copyable()
request = create_http_request(http_request, "GET", "http://localhost/", {"user-agent": "test_request_history"})
request.body = body
request_history = RequestHistory(request)
assert request_history.http_request.headers == request.headers
assert request_history.http_request.url == request.url
assert request_history.http_request.method == request.method
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_request_history_type_error(http_request):
class Non_deep_copyable(object):
def __deepcopy__(self, memodict={}):
raise TypeError()
body = Non_deep_copyable()
request = create_http_request(http_request, "GET", "http://localhost/", {"user-agent": "test_request_history"})
request.body = body
request_history = RequestHistory(request)
assert request_history.http_request.headers == request.headers
assert request_history.http_request.url == request.url
assert request_history.http_request.method == request.method
@mock.patch("azure.core.pipeline.policies._universal._LOGGER")
@pytest.mark.parametrize("http_request,http_response", request_and_responses_product(HTTP_RESPONSES))
def test_no_log(mock_http_logger, http_request, http_response):
universal_request = http_request("GET", "http://localhost/")
request = PipelineRequest(universal_request, PipelineContext(None))
http_logger = NetworkTraceLoggingPolicy()
response = PipelineResponse(request, create_http_response(http_response, universal_request, None), request.context)
# By default, no log handler for HTTP
http_logger.on_request(request)
mock_http_logger.debug.assert_not_called()
http_logger.on_response(request, response)
mock_http_logger.debug.assert_not_called()
mock_http_logger.reset_mock()
# I can enable it per request
request.context.options["logging_enable"] = True
http_logger.on_request(request)
assert mock_http_logger.debug.call_count >= 1
mock_http_logger.reset_mock()
request.context.options["logging_enable"] = True
http_logger.on_response(request, response)
assert mock_http_logger.debug.call_count >= 1
mock_http_logger.reset_mock()
# I can enable it per request (bool value should be honored)
request.context.options["logging_enable"] = False
http_logger.on_request(request)
mock_http_logger.debug.assert_not_called()
request.context.options["logging_enable"] = False
http_logger.on_response(request, response)
mock_http_logger.debug.assert_not_called()
mock_http_logger.reset_mock()
# I can enable it globally
request.context.options = {}
http_logger.enable_http_logger = True
http_logger.on_request(request)
assert mock_http_logger.debug.call_count >= 1
http_logger.on_response(request, response)
assert mock_http_logger.debug.call_count >= 1
mock_http_logger.reset_mock()
# I can enable it globally and override it locally
http_logger.enable_http_logger = True
request.context.options["logging_enable"] = False
http_logger.on_request(request)
mock_http_logger.debug.assert_not_called()
response.context["logging_enable"] = False
http_logger.on_response(request, response)
mock_http_logger.debug.assert_not_called()
mock_http_logger.reset_mock()
# Let's make this request a failure, retried twice
request.context.options["logging_enable"] = True
http_logger.on_request(request)
http_logger.on_response(request, response)
first_count = mock_http_logger.debug.call_count
assert first_count >= 1
http_logger.on_request(request)
http_logger.on_response(request, response)
second_count = mock_http_logger.debug.call_count
assert second_count == first_count * 2
@pytest.mark.parametrize("http_request", HTTP_REQUESTS)
def test_retry_without_http_response(http_request):
class NaughtyPolicy(HTTPPolicy):
def send(*args):
raise AzureError("boo")
policies = [RetryPolicy(), NaughtyPolicy()]
pipeline = Pipeline(policies=policies, transport=None)
with pytest.raises(AzureError):
pipeline.run(http_request("GET", url="https://foo.bar"))
@pytest.mark.parametrize(
"http_request,http_response,requests_transport_response",
request_and_responses_product(HTTP_RESPONSES, REQUESTS_TRANSPORT_RESPONSES),
)
def test_raw_deserializer(http_request, http_response, requests_transport_response):
raw_deserializer = ContentDecodePolicy()
context = PipelineContext(None, stream=False)
universal_request = http_request("GET", "http://localhost/")
request = PipelineRequest(universal_request, context)
def build_response(body, content_type=None):
if is_rest(http_response):
class MockResponse(http_response):
def __init__(self, body, content_type):
super(MockResponse, self).__init__(
request=None,
internal_response=None,
status_code=400,
reason="Bad Request",
content_type="application/json",
headers={},
stream_download_generator=None,
)
self._body = body
self.content_type = content_type
def body(self):
return self._body
def read(self):
self._content = self._body
return self.content
else:
class MockResponse(http_response):
def __init__(self, body, content_type):
super(MockResponse, self).__init__(None, None)
self._body = body
self.content_type = content_type
def body(self):
return self._body
return PipelineResponse(request, MockResponse(body, content_type), context)
response = build_response(b"<groot/>", content_type="application/xml")
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result.tag == "groot"
response = build_response(b"\xef\xbb\xbf<utf8groot/>", content_type="application/xml")
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result.tag == "utf8groot"
# The basic deserializer works with unicode XML
response = build_response('<groot language="français"/>'.encode("utf-8"), content_type="application/xml")
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result.attrib["language"] == "français"
# Catch some weird situation where content_type is XML, but content is JSON
response = build_response(b'{"ugly": true}', content_type="application/xml")
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result["ugly"] is True
# Be sure I catch the correct exception if it's neither XML nor JSON
response = build_response(b"gibberish", content_type="application/xml")
with pytest.raises(DecodeError) as err:
raw_deserializer.on_response(request, response)
assert err.value.response is response.http_response
response = build_response(b"{{gibberish}}", content_type="application/xml")
with pytest.raises(DecodeError) as err:
raw_deserializer.on_response(request, response)
assert err.value.response is response.http_response
# Simple JSON
response = build_response(b'{"success": true}', content_type="application/json")
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result["success"] is True
# Simple JSON with BOM
response = build_response(b'\xef\xbb\xbf{"success": true}', content_type="application/json")
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result["success"] is True
# Simple JSON with complex content_type
response = build_response(b'{"success": true}', content_type="application/vnd.microsoft.appconfig.kv.v1+json")
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result["success"] is True
# Simple JSON with complex content_type, v2
response = build_response(b'{"success": true}', content_type="text/vnd.microsoft.appconfig.kv.v1+json")
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result["success"] is True
# For compat, if no content-type, decode JSON
response = build_response(b'"data"')
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result == "data"
# Let text/plain let through
response = build_response(b"I am groot", content_type="text/plain")
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result == "I am groot"
# Let text/plain let through + BOM
response = build_response(b"\xef\xbb\xbfI am groot", content_type="text/plain")
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result == "I am groot"
# Try with a mock of requests
req_response = requests.Response()
req_response.headers["content-type"] = "application/json"
req_response._content = b'{"success": true}'
req_response._content_consumed = True
response = PipelineResponse(
None,
create_transport_response(requests_transport_response, None, req_response),
PipelineContext(None, stream=False),
)
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result["success"] is True
# I can enable it per request
request.context.options["response_encoding"] = "utf-8"
response = build_response(b"\xc3\xa9", content_type="text/plain")
raw_deserializer.on_request(request)
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result == "é"
assert response.context["response_encoding"] == "utf-8"
del request.context["response_encoding"]
# I can enable it globally
raw_deserializer = ContentDecodePolicy(response_encoding="utf-8")
response = build_response(b"\xc3\xa9", content_type="text/plain")
raw_deserializer.on_request(request)
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result == "é"
assert response.context["response_encoding"] == "utf-8"
del request.context["response_encoding"]
# Per request is more important
request.context.options["response_encoding"] = "utf-8-sig"
response = build_response(b"\xc3\xa9", content_type="text/plain")
raw_deserializer.on_request(request)
raw_deserializer.on_response(request, response)
result = response.context["deserialized_data"]
assert result == "é"
assert response.context["response_encoding"] == "utf-8-sig"
del request.context["response_encoding"]
def test_json_merge_patch():
assert ContentDecodePolicy.deserialize_from_text(
'{"hello": "world"}', mime_type="application/merge-patch+json"
) == {"hello": "world"}
def test_json_regex():
assert not ContentDecodePolicy.JSON_REGEXP.match("text/plain")
assert ContentDecodePolicy.JSON_REGEXP.match("application/json")
assert ContentDecodePolicy.JSON_REGEXP.match("text/json")
assert ContentDecodePolicy.JSON_REGEXP.match("application/merge-patch+json")
assert ContentDecodePolicy.JSON_REGEXP.match("application/ld+json")
assert ContentDecodePolicy.JSON_REGEXP.match("application/vnd.microsoft.appconfig.kv+json")
assert not ContentDecodePolicy.JSON_REGEXP.match("application/+json")
assert not ContentDecodePolicy.JSON_REGEXP.match("application/not-json")
assert not ContentDecodePolicy.JSON_REGEXP.match("application/iamjson")
assert not ContentDecodePolicy.JSON_REGEXP.match("fake/json")
|