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 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
|
# A simple HTTP server implemented using h11 and Trio:
# http://trio.readthedocs.io/en/latest/index.html
#
# S3 Mock server logic starts from handle_mock_s3_request
from dataclasses import dataclass
import json
from itertools import count
from urllib.parse import parse_qs, urlparse
import os
from typing import Optional
from enum import Enum
import trio
import h11
MAX_RECV = 2**16
TIMEOUT = 120 # this must be higher than any response's "delay" setting
VERBOSE = False
# Flags to keep between requests
SHOULD_THROTTLE = True
RETRY_REQUEST_COUNT = 0
base_dir = os.path.dirname(os.path.realpath(__file__))
class S3Opts(Enum):
CreateMultipartUpload = 1
CompleteMultipartUpload = 2
UploadPart = 3
AbortMultipartUpload = 4
GetObject = 5
ListParts = 6
CreateSession = 7
@dataclass
class Response:
status_code: int
delay: int
headers: any
data: str
chunked: bool
head_request: bool
@dataclass
class ResponseConfig:
path: str
disconnect_after_headers = False
generate_body_size: Optional[int] = None
json_path: str = None
throttle: bool = False
force_retry: bool = False
def _resolve_file_path(self, wrapper, request_type):
global SHOULD_THROTTLE
if self.json_path is None:
response_file = os.path.join(
base_dir, request_type.name, f"{self.path[1:]}.json")
if os.path.exists(response_file) == False:
wrapper.info(
response_file, "not exist, using the default response")
response_file = os.path.join(
base_dir, request_type.name, f"default.json")
if "throttle" in response_file:
# We throttle the request half the time to make sure it succeeds after a retry
if SHOULD_THROTTLE is False:
wrapper.info("Skipping throttling")
response_file = os.path.join(
base_dir, request_type.name, f"default.json")
else:
wrapper.info("Throttling")
# Flip the flag
SHOULD_THROTTLE = not SHOULD_THROTTLE
self.json_path = response_file
def resolve_response(self, wrapper, request_type, chunked=False, head_request=False):
self._resolve_file_path(wrapper, request_type)
wrapper.info("resolving response from json file: ", self.json_path,
".\n generate_body_size: ", self.generate_body_size)
with open(self.json_path, 'r') as f:
data = json.load(f)
# if response has delay, then sleep before sending it
delay = data.get('delay', 0)
status_code = data['status']
if self.generate_body_size is not None:
# generate body with a specific size instead
body = "a" * self.generate_body_size
else:
body = "\n".join(data['body'])
headers = wrapper.basic_headers()
content_length_set = False
for header in data['headers'].items():
headers.append((header[0], str(header[1])))
if header[0].lower() == "content-length":
content_length_set = True
if chunked:
headers.append(('Transfer-Encoding', "chunked"))
else:
if self.force_retry:
# Use a long `content-length` header to trigger error when we try to send EOM.
# so that the server will close connection after we send the header.
headers.append(("Content-Length", str(123456)))
elif content_length_set is False:
headers.append(("Content-Length", str(len(body))))
response = Response(status_code=status_code, delay=delay, headers=headers,
data=body, chunked=chunked, head_request=head_request)
return response
class TrioHTTPWrapper:
_next_id = count()
def __init__(self, stream):
self.stream = stream
self.conn = h11.Connection(h11.SERVER)
# A unique id for this connection, to include in debugging output
# (useful for understanding what's going on if there are multiple
# simultaneous clients).
self._obj_id = next(TrioHTTPWrapper._next_id)
async def send(self, event):
assert type(event) is not h11.ConnectionClosed
data = self.conn.send(event)
try:
await self.stream.send_all(data)
except BaseException:
# If send_all raises an exception (especially trio.Cancelled),
# we have no choice but to give it up.
self.conn.send_failed()
raise
async def _read_from_peer(self):
if self.conn.they_are_waiting_for_100_continue:
self.info("Sending 100 Continue")
go_ahead = h11.InformationalResponseConfig(
status_code=100, headers=self.basic_headers()
)
await self.send(go_ahead)
try:
data = await self.stream.receive_some(MAX_RECV)
except ConnectionError:
# They've stopped listening. Not much we can do about it here.
data = b""
self.conn.receive_data(data)
async def next_event(self):
while True:
event = self.conn.next_event()
if event is h11.NEED_DATA:
await self._read_from_peer()
continue
return event
async def shutdown_and_clean_up(self):
try:
await self.stream.send_eof()
except trio.BrokenResourceError:
return
with trio.move_on_after(TIMEOUT):
try:
while True:
# Attempt to read until EOF
got = await self.stream.receive_some(MAX_RECV)
if not got:
break
except trio.BrokenResourceError:
pass
finally:
await self.stream.aclose()
def basic_headers(self):
# HTTP requires these headers in all responses (client would do
# something different here)
return [
("Server", "mock_s3_server"),
]
def info(self, *args):
# Little debugging method
if VERBOSE:
print("{}:".format(self._obj_id), *args)
################################################################
# Server main loop
################################################################
async def send_simple_response(wrapper, status_code, content_type, body):
wrapper.info("Sending", status_code, "response with", len(body), "bytes")
headers = wrapper.basic_headers()
headers.append(("Content-Type", content_type))
headers.append(("Content-Length", str(len(body))))
res = h11.Response(status_code=status_code, headers=headers)
await wrapper.send(res)
await wrapper.send(h11.Data(data=body))
await wrapper.send(h11.EndOfMessage())
async def maybe_send_error_response(wrapper, exc):
if wrapper.conn.our_state not in {h11.IDLE, h11.SEND_RESPONSE}:
wrapper.info("...but I can't, because our state is",
wrapper.conn.our_state)
return
try:
if isinstance(exc, h11.RemoteProtocolError):
status_code = exc.error_status_hint
elif isinstance(exc, trio.TooSlowError):
status_code = 408 # Request Timeout
else:
status_code = 500
body = str(exc).encode("utf-8")
await send_simple_response(
wrapper, status_code, "text/plain; charset=utf-8", body
)
except Exception as exc:
wrapper.info("error while sending error response:", exc)
async def http_serve(stream):
wrapper = TrioHTTPWrapper(stream)
wrapper.info("Got new connection")
while True:
assert wrapper.conn.states == {
h11.CLIENT: h11.IDLE, h11.SERVER: h11.IDLE}
try:
with trio.fail_after(TIMEOUT):
wrapper.info("Server main loop waiting for request")
event = await wrapper.next_event()
wrapper.info("Server main loop got event:", event)
if type(event) is h11.Request:
await handle_mock_s3_request(wrapper, event)
except Exception as exc:
wrapper.info("Error during response handler: {!r}".format(exc))
await maybe_send_error_response(wrapper, exc)
if wrapper.conn.our_state is h11.MUST_CLOSE:
wrapper.info("connection is not reusable, so shutting down")
await wrapper.shutdown_and_clean_up()
return
else:
try:
wrapper.info("trying to re-use connection")
wrapper.conn.start_next_cycle()
except h11.ProtocolError:
states = wrapper.conn.states
wrapper.info("unexpected state", states, "-- bailing out")
await maybe_send_error_response(
wrapper, RuntimeError("unexpected state {}".format(states))
)
await wrapper.shutdown_and_clean_up()
return
################################################################
# Actual response handlers
################################################################
# Helper function
async def send_response(wrapper, response):
if response.delay > 0:
assert response.delay < TIMEOUT
await trio.sleep(response.delay)
wrapper.info("Sending", response.status_code,
"response with", len(response.data), "bytes")
res = h11.Response(status_code=response.status_code,
headers=response.headers)
try:
await wrapper.send(res)
except Exception as e:
print(e)
if not response.head_request:
if response.chunked:
await wrapper.send(h11.Data(data=b"%X\r\n%s\r\n" % (len(response.data), response.data.encode())))
else:
await wrapper.send(h11.Data(data=response.data.encode()))
await wrapper.send(h11.EndOfMessage())
res = h11.Response(status_code=response.status_code,
headers=response.headers)
async def send_simple_response(wrapper, status_code, content_type, body):
wrapper.info("Sending", status_code, "response with", len(body), "bytes")
headers = wrapper.basic_headers()
headers.append(("Content-Type", content_type))
headers.append(("Content-Length", str(len(body))))
res = h11.Response(status_code=status_code, headers=headers)
await wrapper.send(res)
await wrapper.send(h11.Data(data=body))
await wrapper.send(h11.EndOfMessage())
async def send_response_from_json(wrapper, response_json_path, chunked=False, generate_body=False, generate_body_size=0, head_request=False):
wrapper.info("sending response from json file: ", response_json_path,
".\n generate_body: ", generate_body, "generate_body_size: ", generate_body_size)
with open(response_json_path, 'r') as f:
data = json.load(f)
# if response has delay, then sleep before sending it
delay = data.get('delay', 0)
if delay > 0:
assert delay < TIMEOUT
await trio.sleep(delay)
status_code = data['status']
if generate_body:
# generate body with a specific size instead
body = "a" * generate_body_size
else:
body = "\n".join(data['body'])
wrapper.info("Sending", status_code,
"response with", len(body), "bytes")
headers = wrapper.basic_headers()
for header in data['headers'].items():
headers.append((header[0], header[1]))
if chunked:
headers.append(('Transfer-Encoding', "chunked"))
res = h11.Response(status_code=status_code, headers=headers)
await wrapper.send(res)
await wrapper.send(h11.Data(data=b"%X\r\n%s\r\n" % (len(body), body.encode())))
else:
headers.append(("Content-Length", str(len(body))))
res = h11.Response(status_code=status_code, headers=headers)
await wrapper.send(res)
if head_request:
await wrapper.send(h11.EndOfMessage())
return
await wrapper.send(h11.Data(data=body.encode()))
await wrapper.send(h11.EndOfMessage())
async def send_mock_s3_response(wrapper, request_type, path, generate_body=False, generate_body_size=0, head_request=False):
response_file = os.path.join(
base_dir, request_type.name, f"{path[1:]}.json")
if os.path.exists(response_file) == False:
wrapper.info(response_file, "not exist, using the default response")
response_file = os.path.join(
base_dir, request_type.name, f"default.json")
if "throttle" in response_file:
# We throttle the request half the time to make sure it succeeds after a retry
if wrapper.should_throttle is False:
wrapper.info("Skipping throttling")
response_file = os.path.join(
base_dir, request_type.name, f"default.json")
else:
wrapper.info("Throttling")
# Flip the flag
wrapper.should_throttle = not wrapper.should_throttle
await send_response_from_json(wrapper, response_file, generate_body=generate_body, generate_body_size=generate_body_size, head_request=head_request)
async def maybe_send_error_response(wrapper, exc):
if wrapper.conn.our_state not in {h11.IDLE, h11.SEND_RESPONSE}:
wrapper.info("...but I can't, because our state is",
wrapper.conn.our_state)
return
try:
await wrapper.send(res)
except Exception as e:
print(e)
if not response.head_request:
if response.chunked:
await wrapper.send(h11.Data(data=b"%X\r\n%s\r\n" % (len(response.data), response.data.encode())))
else:
await wrapper.send(h11.Data(data=response.data.encode()))
await wrapper.send(h11.EndOfMessage())
def get_request_header_value(request, header_name):
for header in request.headers:
if header[0].decode("utf-8").lower() == header_name.lower():
return header[1].decode("utf-8")
return None
def handle_get_object_modified(start_range, end_range, request):
data_length = end_range - start_range
if start_range == 0:
return ResponseConfig("/get_object_modified_first_part", generate_body_size=data_length)
else:
# Check the request header to make sure "If-Match" is set
etag = get_request_header_value(request, "if-match")
print(etag)
# fetch Etag from the first_part response file
response_file = os.path.join(
base_dir, S3Opts.GetObject.name, f"get_object_modified_first_part.json")
with open(response_file, 'r') as f:
data = json.load(f)
if data['headers']['ETag'] == etag:
return ResponseConfig("/get_object_modified_success")
return ResponseConfig("/get_object_modified_failure")
def handle_get_object(wrapper, request, parsed_path, head_request=False):
global RETRY_REQUEST_COUNT
response_config = ResponseConfig(parsed_path.path)
if parsed_path.path == "/get_object_checksum_retry" and not head_request:
RETRY_REQUEST_COUNT = RETRY_REQUEST_COUNT + 1
if RETRY_REQUEST_COUNT == 1:
wrapper.info("Force retry on the request")
response_config.force_retry = True
else:
RETRY_REQUEST_COUNT = 0
if parsed_path.path == "/get_object_invalid_response_missing_content_range" or parsed_path.path == "/get_object_invalid_response_missing_etags":
# Don't generate the body for those requests
return response_config
body_range_value = get_request_header_value(request, "range")
if body_range_value:
body_range = body_range_value.split("=")[1]
start_range = int(body_range.split("-")[0])
end_range = int(body_range.split("-")[1])
else:
# default length is 65535
start_range = 0
end_range = 65535
data_length = end_range - start_range
if parsed_path.path == "/get_object_modified":
return handle_get_object_modified(start_range, end_range, request)
response_config.generate_body_size = data_length
return response_config
def handle_list_parts(parsed_path):
if parsed_path.path == "/multiple_list_parts":
if parsed_path.query.find("part-number-marker") != -1:
return ResponseConfig("/multiple_list_parts_2")
else:
return ResponseConfig("/multiple_list_parts_1")
return ResponseConfig(parsed_path.path)
async def handle_mock_s3_request(wrapper, request):
parsed_path = urlparse(request.target.decode("ascii"))
method = request.method.decode("utf-8")
response_config = None
if method == "POST":
if parsed_path.query == "uploads":
# POST /{Key+}?uploads HTTP/1.1 -- Create MPU
request_type = S3Opts.CreateMultipartUpload
else:
# POST /Key+?uploadId=UploadId HTTP/1.1 -- Complete MPU
request_type = S3Opts.CompleteMultipartUpload
elif method == "PUT":
request_type = S3Opts.UploadPart
elif method == "DELETE":
request_type = S3Opts.AbortMultipartUpload
elif method == "GET" or method == "HEAD":
if parsed_path.query.find("uploadId") != -1:
# GET /Key+?max-parts=MaxParts&part-number-marker=PartNumberMarker&uploadId=UploadId HTTP/1.1 -- List Parts
request_type = S3Opts.ListParts
response_config = handle_list_parts(parsed_path)
elif parsed_path.query.find("session") != -1:
request_type = S3Opts.CreateSession
else:
request_type = S3Opts.GetObject
response_config = handle_get_object(
wrapper, request, parsed_path, head_request=method == "HEAD")
else:
# TODO: support more type.
wrapper.info("unsupported request:", request)
request_type = S3Opts.CreateMultipartUpload
while True:
event = await wrapper.next_event()
if type(event) is h11.EndOfMessage:
break
assert type(event) is h11.Data
if response_config is None:
response_config = ResponseConfig(parsed_path.path)
response = response_config.resolve_response(
wrapper, request_type, head_request=method == "HEAD")
await send_response(wrapper, response)
################################################################
# Run the server
################################################################
async def serve(port):
print("listening on http://localhost:{}".format(port))
try:
await trio.serve_tcp(http_serve, port)
except KeyboardInterrupt:
print("KeyboardInterrupt - shutting down")
if __name__ == "__main__":
trio.run(serve, 8080)
|