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
|
# The MIT License (MIT)
# Copyright (c) 2014 Microsoft Corporation
# 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.
"""RequestTransport allowing injection of faults between SDK and Cosmos Gateway
"""
import json
import logging
import sys
from time import sleep
from typing import Callable, Optional, Any, Dict, List, MutableMapping
from azure.core.pipeline.transport import HttpRequest, HttpResponse
from azure.core.pipeline.transport._requests_basic import RequestsTransport, RequestsTransportResponse
from requests import Session
from azure.cosmos import documents
import test_config
from azure.cosmos.exceptions import CosmosHttpResponseError
from azure.core.exceptions import ServiceRequestError, ServiceResponseError
from azure.cosmos.http_constants import ResourceType, HttpHeaders
ERROR_WITH_COUNTER = "error_with_counter"
class FaultInjectionTransport(RequestsTransport):
logger = logging.getLogger('azure.cosmos.fault_injection_transport')
logger.setLevel(logging.DEBUG)
def __init__(self, *, session: Optional[Session] = None, loop=None, session_owner: bool = True, **config):
self.faults: List[Dict[str, Any]] = []
self.requestTransformations: List[Dict[str, Any]] = []
self.responseTransformations: List[Dict[str, Any]] = []
self.counters: Dict[str, int] = {
ERROR_WITH_COUNTER: 0
}
super().__init__(session=session, loop=loop, session_owner=session_owner, **config)
def reset_counters(self):
for name in self.counters:
self.counters[name] = 0
def error_with_counter(self, error: Exception) -> Exception:
self.counters[ERROR_WITH_COUNTER] += 1
return error
def add_fault(self, predicate: Callable[[HttpRequest], bool], fault_factory: Callable[[HttpRequest], Exception]):
self.faults.append({"predicate": predicate, "apply": fault_factory})
def add_response_transformation(self, predicate: Callable[[HttpRequest], bool], response_transformation: Callable[[HttpRequest, Callable[[HttpRequest], RequestsTransportResponse]], RequestsTransportResponse]):
self.responseTransformations.append({
"predicate": predicate,
"apply": response_transformation})
@staticmethod
def __first_item(iterable, condition=lambda x: True):
"""
Returns the first item in the `iterable` that satisfies the `condition`.
If no item satisfies the condition, it returns None.
"""
return next((x for x in iterable if condition(x)), None)
def send(self, request: HttpRequest, *, proxies: Optional[MutableMapping[str, str]] = None, **kwargs) -> HttpResponse:
FaultInjectionTransport.logger.info("--> FaultInjectionTransport.Send {} {}".format(request.method, request.url))
# find the first fault Factory with matching predicate if any
first_fault_factory = FaultInjectionTransport.__first_item(iter(self.faults), lambda f: f["predicate"](request))
if first_fault_factory:
FaultInjectionTransport.logger.info("--> FaultInjectionTransport.ApplyFaultInjection")
injected_error = first_fault_factory["apply"](request)
FaultInjectionTransport.logger.info("Found to-be-injected error {}".format(injected_error))
raise injected_error
# apply the chain of request transformations with matching predicates if any
matching_request_transformations = filter(lambda f: f["predicate"](f["predicate"]), iter(self.requestTransformations))
for currentTransformation in matching_request_transformations:
FaultInjectionTransport.logger.info("--> FaultInjectionTransport.ApplyRequestTransformation")
request = currentTransformation["apply"](request)
first_response_transformation = FaultInjectionTransport.__first_item(iter(self.responseTransformations), lambda f: f["predicate"](request))
FaultInjectionTransport.logger.info("--> FaultInjectionTransport.BeforeGetResponseTask")
get_response_task = super().send(request, proxies=proxies, **kwargs)
FaultInjectionTransport.logger.info("<-- FaultInjectionTransport.AfterGetResponseTask")
if first_response_transformation:
FaultInjectionTransport.logger.info(f"Invoking response transformation")
response = first_response_transformation["apply"](request, lambda: get_response_task)
response.headers["_request"] = request
FaultInjectionTransport.logger.info(f"Received response transformation result with status code {response.status_code}")
return response
else:
FaultInjectionTransport.logger.info(f"Sending request to {request.url}")
response = get_response_task
response.headers["_request"] = request
FaultInjectionTransport.logger.info(f"Received response with status code {response.status_code}")
return response
@staticmethod
def predicate_url_contains_id(r: HttpRequest, id_value: str) -> bool:
return id_value in r.url
@staticmethod
def predicate_targets_region(r: HttpRequest, region_endpoint: str) -> bool:
return r.url.startswith(region_endpoint)
@staticmethod
def print_call_stack():
print("Call stack:")
frame = sys._getframe()
while frame:
print(f"File: {frame.f_code.co_filename}, Line: {frame.f_lineno}, Function: {frame.f_code.co_name}")
frame = frame.f_back
@staticmethod
def predicate_req_payload_contains_id(r: HttpRequest, id_value: str):
if r.body is None:
return False
return '"id":"{}"'.format(id_value) in r.body
@staticmethod
def predicate_req_for_document_with_id(r: HttpRequest, id_value: str) -> bool:
return (FaultInjectionTransport.predicate_url_contains_id(r, id_value)
or FaultInjectionTransport.predicate_req_payload_contains_id(r, id_value))
@staticmethod
def predicate_is_database_account_call(r: HttpRequest) -> bool:
is_db_account_read = (r.headers.get(HttpHeaders.ThinClientProxyResourceType) == ResourceType.DatabaseAccount
and r.headers.get(HttpHeaders.ThinClientProxyOperationType) == documents._OperationType.Read)
return is_db_account_read
@staticmethod
def predicate_is_document_operation(r: HttpRequest) -> bool:
is_document_operation = r.headers.get(HttpHeaders.ThinClientProxyResourceType) == ResourceType.Document
return is_document_operation
@staticmethod
def predicate_is_resource_type(r: HttpRequest, resource_type: str) -> bool:
is_resource_type = r.headers.get(HttpHeaders.ThinClientProxyResourceType) == resource_type
return is_resource_type
@staticmethod
def predicate_is_operation_type(r: HttpRequest, operation_type: str) -> bool:
is_operation_type = r.headers.get(HttpHeaders.ThinClientProxyOperationType) == operation_type
return is_operation_type
@staticmethod
def predicate_is_resource_type(r: HttpRequest, resource_type: str) -> bool:
is_resource_type = r.headers.get(HttpHeaders.ThinClientProxyResourceType) == resource_type
return is_resource_type
@staticmethod
def predicate_is_write_operation(r: HttpRequest, uri_prefix: str) -> bool:
is_write_document_operation = documents._OperationType.IsWriteOperation(
str(r.headers.get(HttpHeaders.ThinClientProxyOperationType)),)
return is_write_document_operation and uri_prefix in r.url
@staticmethod
def error_after_delay(delay_in_ms: int, error: Exception) -> Exception:
sleep(delay_in_ms / 1000.0)
return error
@staticmethod
def error_write_forbidden() -> Exception:
return CosmosHttpResponseError(
status_code=403,
message="Injected error disallowing writes in this region.",
response=None,
sub_status_code=3,
)
@staticmethod
def error_region_down() -> Exception:
return ServiceRequestError(
message="Injected region down.",
)
@staticmethod
def error_service_response() -> Exception:
return ServiceResponseError(
message="Injected Service Response Error.",
)
@staticmethod
def transform_topology_swr_mrr(
write_region_name: str,
read_region_name: str,
inner: Callable[[], RequestsTransportResponse]) -> RequestsTransportResponse:
response = inner()
if not FaultInjectionTransport.predicate_is_database_account_call(response.request):
return response
data = response.body()
if response.status_code == 200 and data:
data = data.decode("utf-8")
result = json.loads(data)
readable_locations = result["readableLocations"]
writable_locations = result["writableLocations"]
readable_locations[0]["name"] = write_region_name
writable_locations[0]["name"] = write_region_name
readable_locations.append({"name": read_region_name, "databaseAccountEndpoint" : test_config.TestConfig.local_host})
FaultInjectionTransport.logger.info("Transformed Account Topology: {}".format(result))
request: HttpRequest = response.request
return FaultInjectionTransport.MockHttpResponse(request, 200, result)
return response
@staticmethod
def transform_topology_mwr(
first_region_name: str,
second_region_name: str,
inner: Callable[[], RequestsTransportResponse],
first_region_url: str = test_config.TestConfig.local_host.replace("localhost", "127.0.0.1"),
second_region_url: str = test_config.TestConfig.local_host
) -> RequestsTransportResponse:
response = inner()
if not FaultInjectionTransport.predicate_is_database_account_call(response.request):
return response
data = response.body()
if response.status_code == 200 and data:
data = data.decode("utf-8")
result = json.loads(data)
readable_locations = result["readableLocations"]
writable_locations = result["writableLocations"]
if first_region_url is None:
first_region_url = readable_locations[0]["databaseAccountEndpoint"]
readable_locations[0] = \
{"name": first_region_name, "databaseAccountEndpoint": first_region_url}
writable_locations[0] = \
{"name": first_region_name, "databaseAccountEndpoint": first_region_url}
readable_locations.append(
{"name": second_region_name, "databaseAccountEndpoint": second_region_url})
writable_locations.append(
{"name": second_region_name, "databaseAccountEndpoint": second_region_url})
result["enableMultipleWriteLocations"] = True
FaultInjectionTransport.logger.info("Transformed Account Topology: {}".format(result))
request: HttpRequest = response.request
return FaultInjectionTransport.MockHttpResponse(request, 200, result)
return response
class MockHttpResponse(RequestsTransportResponse):
def __init__(self, request: HttpRequest, status_code: int, content:Optional[Dict[str, Any]]):
self.request: HttpRequest = request
# This is actually never None, and set by all implementations after the call to
# __init__ of this class. This class is also a legacy impl, so it's risky to change it
# for low benefits The new "rest" implementation does define correctly status_code
# as non-optional.
self.status_code: int = status_code
self.headers: MutableMapping[str, str] = {}
self.reason: Optional[str] = None
self.content_type: Optional[str] = None
self.block_size: int = 4096 # Default to same as R
self.content: Optional[Dict[str, Any]] = None
self.json_text: str = ""
self.bytes: bytes = b""
if content:
self.content = content
self.json_text = json.dumps(content)
self.bytes = self.json_text.encode("utf-8")
def body(self) -> bytes:
return self.bytes
def text(self, encoding: Optional[str] = None) -> str:
return self.json_text
def load_body(self) -> None:
return
|