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
|
# Copyright 2014 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import http.client
import json
from unittest import mock
import pytest
import requests
try:
import grpc
from grpc_status import rpc_status
except ImportError: # pragma: NO COVER
grpc = rpc_status = None
from google.api_core import exceptions
from google.protobuf import any_pb2, json_format
from google.rpc import error_details_pb2, status_pb2
def test_create_google_cloud_error():
exception = exceptions.GoogleAPICallError("Testing")
exception.code = 600
assert str(exception) == "600 Testing"
assert exception.message == "Testing"
assert exception.errors == []
assert exception.response is None
def test_create_google_cloud_error_with_args():
error = {
"code": 600,
"message": "Testing",
}
response = mock.sentinel.response
exception = exceptions.GoogleAPICallError("Testing", [error], response=response)
exception.code = 600
assert str(exception) == "600 Testing"
assert exception.message == "Testing"
assert exception.errors == [error]
assert exception.response == response
def test_from_http_status():
message = "message"
exception = exceptions.from_http_status(http.client.NOT_FOUND, message)
assert exception.code == http.client.NOT_FOUND
assert exception.message == message
assert exception.errors == []
def test_from_http_status_with_errors_and_response():
message = "message"
errors = ["1", "2"]
response = mock.sentinel.response
exception = exceptions.from_http_status(
http.client.NOT_FOUND, message, errors=errors, response=response
)
assert isinstance(exception, exceptions.NotFound)
assert exception.code == http.client.NOT_FOUND
assert exception.message == message
assert exception.errors == errors
assert exception.response == response
def test_from_http_status_unknown_code():
message = "message"
status_code = 156
exception = exceptions.from_http_status(status_code, message)
assert exception.code == status_code
assert exception.message == message
def make_response(content):
response = requests.Response()
response._content = content
response.status_code = http.client.NOT_FOUND
response.request = requests.Request(
method="POST", url="https://example.com"
).prepare()
return response
def test_from_http_response_no_content():
response = make_response(None)
exception = exceptions.from_http_response(response)
assert isinstance(exception, exceptions.NotFound)
assert exception.code == http.client.NOT_FOUND
assert exception.message == "POST https://example.com/: unknown error"
assert exception.response == response
def test_from_http_response_text_content():
response = make_response(b"message")
response.encoding = "UTF8" # suppress charset_normalizer warning
exception = exceptions.from_http_response(response)
assert isinstance(exception, exceptions.NotFound)
assert exception.code == http.client.NOT_FOUND
assert exception.message == "POST https://example.com/: message"
def test_from_http_response_json_content():
response = make_response(
json.dumps({"error": {"message": "json message", "errors": ["1", "2"]}}).encode(
"utf-8"
)
)
exception = exceptions.from_http_response(response)
assert isinstance(exception, exceptions.NotFound)
assert exception.code == http.client.NOT_FOUND
assert exception.message == "POST https://example.com/: json message"
assert exception.errors == ["1", "2"]
def test_from_http_response_bad_json_content():
response = make_response(json.dumps({"meep": "moop"}).encode("utf-8"))
exception = exceptions.from_http_response(response)
assert isinstance(exception, exceptions.NotFound)
assert exception.code == http.client.NOT_FOUND
assert exception.message == "POST https://example.com/: unknown error"
def test_from_http_response_json_unicode_content():
response = make_response(
json.dumps(
{"error": {"message": "\u2019 message", "errors": ["1", "2"]}}
).encode("utf-8")
)
exception = exceptions.from_http_response(response)
assert isinstance(exception, exceptions.NotFound)
assert exception.code == http.client.NOT_FOUND
assert exception.message == "POST https://example.com/: \u2019 message"
assert exception.errors == ["1", "2"]
@pytest.mark.skipif(grpc is None, reason="No grpc")
def test_from_grpc_status():
message = "message"
exception = exceptions.from_grpc_status(grpc.StatusCode.OUT_OF_RANGE, message)
assert isinstance(exception, exceptions.BadRequest)
assert isinstance(exception, exceptions.OutOfRange)
assert exception.code == http.client.BAD_REQUEST
assert exception.grpc_status_code == grpc.StatusCode.OUT_OF_RANGE
assert exception.message == message
assert exception.errors == []
@pytest.mark.skipif(grpc is None, reason="No grpc")
def test_from_grpc_status_as_int():
message = "message"
exception = exceptions.from_grpc_status(11, message)
assert isinstance(exception, exceptions.BadRequest)
assert isinstance(exception, exceptions.OutOfRange)
assert exception.code == http.client.BAD_REQUEST
assert exception.grpc_status_code == grpc.StatusCode.OUT_OF_RANGE
assert exception.message == message
assert exception.errors == []
@pytest.mark.skipif(grpc is None, reason="No grpc")
def test_from_grpc_status_with_errors_and_response():
message = "message"
response = mock.sentinel.response
errors = ["1", "2"]
exception = exceptions.from_grpc_status(
grpc.StatusCode.OUT_OF_RANGE, message, errors=errors, response=response
)
assert isinstance(exception, exceptions.OutOfRange)
assert exception.message == message
assert exception.errors == errors
assert exception.response == response
@pytest.mark.skipif(grpc is None, reason="No grpc")
def test_from_grpc_status_unknown_code():
message = "message"
exception = exceptions.from_grpc_status(grpc.StatusCode.OK, message)
assert exception.grpc_status_code == grpc.StatusCode.OK
assert exception.message == message
@pytest.mark.skipif(grpc is None, reason="No grpc")
def test_from_grpc_error():
message = "message"
error = mock.create_autospec(grpc.Call, instance=True)
error.code.return_value = grpc.StatusCode.INVALID_ARGUMENT
error.details.return_value = message
exception = exceptions.from_grpc_error(error)
assert isinstance(exception, exceptions.BadRequest)
assert isinstance(exception, exceptions.InvalidArgument)
assert exception.code == http.client.BAD_REQUEST
assert exception.grpc_status_code == grpc.StatusCode.INVALID_ARGUMENT
assert exception.message == message
assert exception.errors == [error]
assert exception.response == error
@pytest.mark.skipif(grpc is None, reason="No grpc")
def test_from_grpc_error_non_call():
message = "message"
error = mock.create_autospec(grpc.RpcError, instance=True)
error.__str__.return_value = message
exception = exceptions.from_grpc_error(error)
assert isinstance(exception, exceptions.GoogleAPICallError)
assert exception.code is None
assert exception.grpc_status_code is None
assert exception.message == message
assert exception.errors == [error]
assert exception.response == error
@pytest.mark.skipif(grpc is None, reason="No grpc")
def test_from_grpc_error_bare_call():
message = "Testing"
class TestingError(grpc.Call, grpc.RpcError):
def __init__(self, exception):
self.exception = exception
def code(self):
return self.exception.grpc_status_code
def details(self):
return message
nested_message = "message"
error = TestingError(exceptions.GoogleAPICallError(nested_message))
exception = exceptions.from_grpc_error(error)
assert isinstance(exception, exceptions.GoogleAPICallError)
assert exception.code is None
assert exception.grpc_status_code is None
assert exception.message == message
assert exception.errors == [error]
assert exception.response == error
assert exception.details == []
def create_bad_request_details():
bad_request_details = error_details_pb2.BadRequest()
field_violation = bad_request_details.field_violations.add()
field_violation.field = "document.content"
field_violation.description = "Must have some text content to annotate."
status_detail = any_pb2.Any()
status_detail.Pack(bad_request_details)
return status_detail
def create_error_info_details():
info = error_details_pb2.ErrorInfo(
reason="SERVICE_DISABLED",
domain="googleapis.com",
metadata={
"consumer": "projects/455411330361",
"service": "translate.googleapis.com",
},
)
status_detail = any_pb2.Any()
status_detail.Pack(info)
return status_detail
def test_error_details_from_rest_response():
bad_request_detail = create_bad_request_details()
error_info_detail = create_error_info_details()
status = status_pb2.Status()
status.code = 3
status.message = (
"3 INVALID_ARGUMENT: One of content, or gcs_content_uri must be set."
)
status.details.append(bad_request_detail)
status.details.append(error_info_detail)
# See JSON schema in https://cloud.google.com/apis/design/errors#http_mapping
http_response = make_response(
json.dumps(
{"error": json.loads(json_format.MessageToJson(status, sort_keys=True))}
).encode("utf-8")
)
exception = exceptions.from_http_response(http_response)
want_error_details = [
json.loads(json_format.MessageToJson(bad_request_detail)),
json.loads(json_format.MessageToJson(error_info_detail)),
]
assert want_error_details == exception.details
# 404 POST comes from make_response.
assert str(exception) == (
"404 POST https://example.com/: 3 INVALID_ARGUMENT:"
" One of content, or gcs_content_uri must be set."
" [{'@type': 'type.googleapis.com/google.rpc.BadRequest',"
" 'fieldViolations': [{'description': 'Must have some text content to annotate.',"
" 'field': 'document.content'}]},"
" {'@type': 'type.googleapis.com/google.rpc.ErrorInfo',"
" 'domain': 'googleapis.com',"
" 'metadata': {'consumer': 'projects/455411330361',"
" 'service': 'translate.googleapis.com'},"
" 'reason': 'SERVICE_DISABLED'}]"
)
def test_error_details_from_v1_rest_response():
response = make_response(
json.dumps(
{"error": {"message": "\u2019 message", "errors": ["1", "2"]}}
).encode("utf-8")
)
exception = exceptions.from_http_response(response)
assert exception.details == []
assert (
exception.reason is None
and exception.domain is None
and exception.metadata is None
)
@pytest.mark.skipif(grpc is None, reason="gRPC not importable")
def test_error_details_from_grpc_response():
status = rpc_status.status_pb2.Status()
status.code = 3
status.message = (
"3 INVALID_ARGUMENT: One of content, or gcs_content_uri must be set."
)
status_br_detail = create_bad_request_details()
status_ei_detail = create_error_info_details()
status.details.append(status_br_detail)
status.details.append(status_ei_detail)
# The actual error doesn't matter as long as its grpc.Call,
# because from_call is mocked.
error = mock.create_autospec(grpc.Call, instance=True)
with mock.patch("grpc_status.rpc_status.from_call") as m:
m.return_value = status
exception = exceptions.from_grpc_error(error)
bad_request_detail = error_details_pb2.BadRequest()
error_info_detail = error_details_pb2.ErrorInfo()
status_br_detail.Unpack(bad_request_detail)
status_ei_detail.Unpack(error_info_detail)
assert exception.details == [bad_request_detail, error_info_detail]
assert exception.reason == error_info_detail.reason
assert exception.domain == error_info_detail.domain
assert exception.metadata == error_info_detail.metadata
@pytest.mark.skipif(grpc is None, reason="gRPC not importable")
def test_error_details_from_grpc_response_unknown_error():
status_detail = any_pb2.Any()
status = rpc_status.status_pb2.Status()
status.code = 3
status.message = (
"3 INVALID_ARGUMENT: One of content, or gcs_content_uri must be set."
)
status.details.append(status_detail)
error = mock.create_autospec(grpc.Call, instance=True)
with mock.patch("grpc_status.rpc_status.from_call") as m:
m.return_value = status
exception = exceptions.from_grpc_error(error)
assert exception.details == [status_detail]
assert (
exception.reason is None
and exception.domain is None
and exception.metadata is None
)
|