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 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
|
#!/usr/bin/env python3
'''
mock_server.py - this file is part of S3QL.
Copyright © 2008 Nikolaus Rath <Nikolaus@rath.org>
This work can be distributed under the terms of the GNU GPLv3.
'''
import hashlib
import json
import logging
import re
import socketserver
import urllib.parse
from http.server import BaseHTTPRequestHandler
from xml.sax.saxutils import escape as xml_escape
log = logging.getLogger(__name__)
ERROR_RESPONSE_TEMPLATE = '''\
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Code>%(code)s</Code>
<Message>%(message)s</Message>
<Resource>%(resource)s</Resource>
<RequestId>%(request_id)s</RequestId>
</Error>
'''
COPY_RESPONSE_TEMPLATE = '''\
<?xml version="1.0" encoding="UTF-8"?>
<CopyObjectResult xmlns="%(ns)s">
<LastModified>2008-02-20T22:13:01</LastModified>
<ETag>"%(etag)s"</ETag>
</CopyObjectResult>
'''
class StorageServer(socketserver.TCPServer):
def __init__(self, request_handler, server_address):
super().__init__(server_address, request_handler)
self.data = dict()
self.metadata = dict()
self.hostname = self.server_address[0]
self.port = self.server_address[1]
class ParsedURL:
__slots__ = ['bucket', 'key', 'params', 'fragment']
class S3CRequestHandler(BaseHTTPRequestHandler):
'''A request handler implementing a subset of the AWS S3 Interface
Bucket names are ignored, all keys share the same global
namespace.
'''
server_version = "MockHTTP"
protocol_version = 'HTTP/1.1'
meta_header_re = re.compile(r'X-AMZ-Meta-([a-z0-9_.-]+)$', re.IGNORECASE)
hdr_prefix = 'X-AMZ-'
xml_ns = 'http://s3.amazonaws.com/doc/2006-03-01/'
def parse_url(self, path):
p = ParsedURL()
q = urllib.parse.urlsplit(path)
path = urllib.parse.unquote(q.path)
assert path[0] == '/'
(p.bucket, p.key) = path[1:].split('/', maxsplit=1)
p.params = urllib.parse.parse_qs(q.query)
p.fragment = q.fragment
return p
def log_message(self, format, *args):
log.debug(format, *args)
def handle(self):
# Ignore exceptions resulting from the client closing
# the connection.
try:
return super().handle()
except ValueError as exc:
if exc.args == ('I/O operation on closed file.',):
pass
else:
raise
except (BrokenPipeError, ConnectionResetError):
pass
def do_DELETE(self):
q = self.parse_url(self.path)
try:
del self.server.data[q.key]
del self.server.metadata[q.key]
except KeyError:
self.send_error(404, code='NoSuchKey', resource=q.key)
return
else:
self.send_response(204)
self.end_headers()
def _check_encoding(self):
encoding = self.headers['Content-Encoding']
if 'Content-Length' not in self.headers:
self.send_error(400, message='Missing Content-Length', code='MissingContentLength')
return
elif encoding and encoding != 'identity':
self.send_error(501, message='Unsupported encoding', code='NotImplemented')
return
return int(self.headers['Content-Length'])
def _get_meta(self):
meta = dict()
for name, value in self.headers.items():
hit = self.meta_header_re.search(name)
if hit:
meta[hit.group(1)] = value
return meta
def do_PUT(self):
len_ = self._check_encoding()
q = self.parse_url(self.path)
meta = self._get_meta()
src = self.headers.get(self.hdr_prefix + 'copy-source')
if src and len_:
self.send_error(
400, message='Upload and copy are mutually exclusive', code='UnexpectedContent'
)
return
elif src:
src = urllib.parse.unquote(src)
hit = re.match('^/([a-z0-9._-]+)/(.+)$', src)
if not hit:
self.send_error(400, message='Cannot parse copy-source', code='InvalidArgument')
return
metadata_directive = self.headers.get(self.hdr_prefix + 'metadata-directive', 'COPY')
if metadata_directive not in ('COPY', 'REPLACE'):
self.send_error(400, message='Invalid metadata directive', code='InvalidArgument')
return
src = hit.group(2)
try:
data = self.server.data[src]
self.server.data[q.key] = data
if metadata_directive == 'COPY':
self.server.metadata[q.key] = self.server.metadata[src]
else:
self.server.metadata[q.key] = meta
except KeyError:
self.send_error(404, code='NoSuchKey', resource=src)
return
else:
data = self.rfile.read(len_)
self.server.metadata[q.key] = meta
self.server.data[q.key] = data
md5 = hashlib.md5()
md5.update(data)
if src:
content = (
COPY_RESPONSE_TEMPLATE % {'etag': md5.hexdigest(), 'ns': self.xml_ns}
).encode('utf-8')
self.send_response(200)
self.send_header('ETag', '"%s"' % md5.hexdigest())
self.send_header('Content-Length', str(len(content)))
self.send_header("Content-Type", 'text/xml')
self.end_headers()
self.wfile.write(content)
else:
self.send_response(201)
self.send_header('ETag', '"%s"' % md5.hexdigest())
self.send_header('Content-Length', '0')
self.end_headers()
def handle_expect_100(self):
if self.command == 'PUT':
self._check_encoding()
self.send_response_only(100)
self.end_headers()
return True
def do_GET(self):
q = self.parse_url(self.path)
if not q.key:
return self.do_list(q)
try:
data = self.server.data[q.key]
meta = self.server.metadata[q.key]
except KeyError:
self.send_error(404, code='NoSuchKey', resource=q.key)
return
self.send_response(200)
self.send_header("Content-Type", 'application/octet-stream')
self.send_header("Content-Length", str(len(data)))
for name, value in meta.items():
self.send_header(self.hdr_prefix + 'Meta-%s' % name, value)
md5 = hashlib.md5()
md5.update(data)
self.send_header('ETag', '"%s"' % md5.hexdigest())
self.end_headers()
self.send_data(data)
def send_data(self, data):
self.wfile.write(data)
def do_list(self, q):
marker = q.params['marker'][0] if 'marker' in q.params else None
max_keys = int(q.params['max_keys'][0]) if 'max_keys' in q.params else 1000
prefix = q.params['prefix'][0] if 'prefix' in q.params else ''
resp = [
'<?xml version="1.0" encoding="UTF-8"?>',
'<ListBucketResult xmlns="%s">' % self.xml_ns,
'<MaxKeys>%d</MaxKeys>' % max_keys,
'<IsTruncated>false</IsTruncated>',
]
count = 0
for key in sorted(self.server.data):
if not key.startswith(prefix):
continue
if marker and key <= marker:
continue
resp.append('<Contents><Key>%s</Key></Contents>' % xml_escape(key))
count += 1
if count == max_keys:
resp[3] = '<IsTruncated>true</IsTruncated>'
break
resp.append('</ListBucketResult>')
body = '\n'.join(resp).encode()
self.send_response(200)
self.send_header("Content-Type", 'text/xml')
self.send_header("Content-Length", str(len(body)))
self.end_headers()
self.wfile.write(body)
def do_HEAD(self):
q = self.parse_url(self.path)
try:
meta = self.server.metadata[q.key]
data = self.server.data[q.key]
except KeyError:
self.send_error(404, code='NoSuchKey', resource=q.key)
return
self.send_response(200)
self.send_header("Content-Type", 'application/octet-stream')
self.send_header("Content-Length", str(len(data)))
for name, value in meta.items():
self.send_header(self.hdr_prefix + 'Meta-%s' % name, value)
self.end_headers()
def send_error(self, status, message=None, code='', resource='', extra_headers=None):
if not message:
try:
(_, message) = self.responses[status]
except KeyError:
message = 'Unknown'
self.log_error("code %d, message %s", status, message)
content = (
ERROR_RESPONSE_TEMPLATE
% {
'code': code,
'message': xml_escape(message),
'request_id': 42,
'resource': xml_escape(resource),
}
).encode('utf-8', 'replace')
self.send_response(status, message)
self.send_header("Content-Type", 'text/xml; charset="utf-8"')
self.send_header("Content-Length", str(len(content)))
if extra_headers:
for name, value in extra_headers.items():
self.send_header(name, value)
self.end_headers()
if self.command != 'HEAD' and status >= 200 and status not in (204, 304):
self.wfile.write(content)
class S3C4RequestHandler(S3CRequestHandler):
'''Request Handler for s3c4 backend
Currently identical to S3CRequestHandler since mock request handlers
do not check request signatures.
'''
pass
class BasicSwiftRequestHandler(S3CRequestHandler):
'''A request handler implementing a subset of the OpenStack Swift Interface
Container and AUTH_* prefix are ignored, all keys share the same global
namespace.
To keep it simple, this handler is both storage server and authentication
server in one.
'''
meta_header_re = re.compile(r'X-Object-Meta-([a-z0-9_.-]+)$', re.IGNORECASE)
hdr_prefix = 'X-Object-'
SWIFT_INFO = {
"swift": {
"max_meta_count": 90,
"max_meta_value_length": 256,
"container_listing_limit": 10000,
"extra_header_count": 0,
"max_meta_overall_size": 4096,
"version": "2.0.0", # < 2.8
"max_meta_name_length": 128,
"max_header_size": 16384,
}
}
def parse_url(self, path):
p = ParsedURL()
q = urllib.parse.urlsplit(path)
path = urllib.parse.unquote(q.path)
assert path[0:4] == '/v1/'
(_, p.bucket, p.key) = path[4:].split('/', maxsplit=2)
p.params = urllib.parse.parse_qs(q.query, True)
p.fragment = q.fragment
return p
def do_PUT(self):
len_ = self._check_encoding()
q = self.parse_url(self.path)
meta = self._get_meta()
src = self.headers.get('x-copy-from')
if src and len_:
self.send_error(
400, message='Upload and copy are mutually exclusive', code='UnexpectedContent'
)
return
elif src:
src = urllib.parse.unquote(src)
hit = re.match('^/([a-z0-9._-]+)/(.+)$', src)
if not hit:
self.send_error(400, message='Cannot parse x-copy-from', code='InvalidArgument')
return
src = hit.group(2)
try:
data = self.server.data[src]
self.server.data[q.key] = data
if 'x-fresh-metadata' in self.headers:
self.server.metadata[q.key] = meta
else:
self.server.metadata[q.key] = self.server.metadata[src].copy()
self.server.metadata[q.key].update(meta)
except KeyError:
self.send_error(404, code='NoSuchKey', resource=src)
return
else:
data = self.rfile.read(len_)
self.server.metadata[q.key] = meta
self.server.data[q.key] = data
md5 = hashlib.md5()
md5.update(data)
if src:
self.send_response(202)
self.send_header('X-Copied-From', self.headers['x-copy-from'])
self.send_header('Content-Length', '0')
self.end_headers()
else:
self.send_response(201)
self.send_header('ETag', '"%s"' % md5.hexdigest())
self.send_header('Content-Length', '0')
self.end_headers()
def do_POST(self):
q = self.parse_url(self.path)
meta = self._get_meta()
if q.key not in self.server.metadata:
self.send_error(404, code='NoSuchKey', resource=q.key)
return
self.server.metadata[q.key] = meta
self.send_response(204)
self.send_header('Content-Length', '0')
self.end_headers()
def do_GET(self):
if self.path in ('/v1.0', '/auth/v1.0'):
self.send_response(200)
self.send_header(
'X-Storage-Url',
'http://%s:%d/v1/AUTH_xyz' % (self.server.hostname, self.server.port),
)
self.send_header('X-Auth-Token', 'static')
self.send_header('Content-Length', '0')
self.end_headers()
elif self.path == '/info':
content = json.dumps(self.SWIFT_INFO).encode('utf-8')
self.send_response(200)
self.send_header('Content-Length', str(len(content)))
self.send_header("Content-Type", 'application/json; charset="utf-8"')
self.end_headers()
self.wfile.write(content)
else:
return super().do_GET()
def do_list(self, q):
marker = q.params['marker'][0] if 'marker' in q.params else None
max_keys = int(q.params['limit'][0]) if 'limit' in q.params else 10000
prefix = q.params['prefix'][0] if 'prefix' in q.params else ''
resp = []
count = 0
for key in sorted(self.server.data):
if not key.startswith(prefix):
continue
if marker and key <= marker:
continue
resp.append({'name': key})
count += 1
if count == max_keys:
break
body = json.dumps(resp).encode('utf-8')
self.send_response(200)
self.send_header("Content-Type", 'application/json; charset="utf-8"')
self.send_header("Content-Length", str(len(body)))
self.end_headers()
self.wfile.write(body)
class CopySwiftRequestHandler(BasicSwiftRequestHandler):
'''OpenStack Swift handler that emulates Copy middleware.'''
SWIFT_INFO = {
"swift": {
"max_meta_count": 90,
"max_meta_value_length": 256,
"container_listing_limit": 10000,
"extra_header_count": 0,
"max_meta_overall_size": 4096,
"version": "2.9.0", # >= 2.8
"max_meta_name_length": 128,
"max_header_size": 16384,
}
}
def do_COPY(self):
src = self.parse_url(self.path)
meta = self._get_meta()
try:
dst = self.headers['destination']
assert dst[0] == '/'
(_, dst) = dst[1:].split('/', maxsplit=1)
except KeyError:
self.send_error(400, message='No Destination provided', code='InvalidArgument')
return
if src.key not in self.server.metadata:
self.send_error(404, code='NoSuchKey', resource=src)
return
if 'x-fresh-metadata' in self.headers:
self.server.metadata[dst] = meta
else:
self.server.metadata[dst] = self.server.metadata[src.key].copy()
self.server.metadata[dst].update(meta)
self.server.data[dst] = self.server.data[src.key]
self.send_response(202)
self.send_header('X-Copied-From', '%s/%s' % (src.bucket, src.key))
self.send_header('Content-Length', '0')
self.end_headers()
class BulkDeleteSwiftRequestHandler(BasicSwiftRequestHandler):
'''OpenStack Swift handler that emulates bulk middleware (the delete part).'''
MAX_DELETES = 8 # test deletes 16 objects, so needs two requests
SWIFT_INFO = {
"bulk_delete": {"max_failed_deletes": MAX_DELETES, "max_deletes_per_request": MAX_DELETES},
"swift": {
"max_meta_count": 90,
"max_meta_value_length": 256,
"container_listing_limit": 10000,
"extra_header_count": 0,
"max_meta_overall_size": 4096,
"version": "2.0.0", # < 2.8
"max_meta_name_length": 128,
"max_header_size": 16384,
},
}
def do_POST(self):
q = self.parse_url(self.path)
if not 'bulk-delete' in q.params:
return super().do_POST()
response = {
'Response Status': '200 OK',
'Response Body': '',
'Number Deleted': 0,
'Number Not Found': 0,
'Errors': [],
}
def send_response(status_int):
content = json.dumps(response).encode('utf-8')
self.send_response(status_int)
self.send_header('Content-Length', str(len(content)))
self.send_header("Content-Type", 'application/json; charset="utf-8"')
self.end_headers()
self.wfile.write(content)
def error(reason):
response['Response Status'] = '502 Internal Server Error'
response['Response Body'] = reason
send_response(502)
def inline_error(http_status, body):
'''bail out when processing begun. Always HTTP 200 Ok.'''
response['Response Status'] = http_status
response['Response Body'] = body
send_response(200)
len_ = self._check_encoding()
lines = self.rfile.read(len_).decode('utf-8').split("\n")
for index, to_delete in enumerate(lines):
if index >= self.MAX_DELETES:
return inline_error(
'413 Request entity too large',
'Maximum Bulk Deletes: %d per request' % self.MAX_DELETES,
)
to_delete = urllib.parse.unquote(to_delete.strip())
assert to_delete[0] == '/'
to_delete = to_delete[1:].split('/', maxsplit=1)
if len(to_delete) < 2:
return error("deleting containers is not supported")
to_delete = to_delete[1]
try:
del self.server.data[to_delete]
del self.server.metadata[to_delete]
except KeyError:
response['Number Not Found'] += 1
else:
response['Number Deleted'] += 1
if not (response['Number Deleted'] or response['Number Not Found']):
return inline_error('400 Bad Request', 'Invalid bulk delete.')
send_response(200)
#: A list of the available mock request handlers with
#: corresponding storage urls
handler_list = [
(S3CRequestHandler, 's3c://%(host)s:%(port)d/s3ql_test'),
(S3C4RequestHandler, 's3c4://%(host)s:%(port)d/s3ql_test'),
# Special syntax only for testing against mock server
(BasicSwiftRequestHandler, 'swift://%(host)s:%(port)d/s3ql_test'),
(CopySwiftRequestHandler, 'swift://%(host)s:%(port)d/s3ql_test'),
(BulkDeleteSwiftRequestHandler, 'swift://%(host)s:%(port)d/s3ql_test'),
]
|