672 lines
20 KiB
Python
672 lines
20 KiB
Python
# #!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
# <HTTPretty - HTTP client mock for Python>
|
|
# Copyright (C) <2011> Gabriel Falcão <gabriel@nacaolivre.org>
|
|
#
|
|
# 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.
|
|
version = '0.5.1'
|
|
|
|
import re
|
|
import socket
|
|
import functools
|
|
import warnings
|
|
import logging
|
|
import traceback
|
|
|
|
from datetime import datetime
|
|
from datetime import timedelta
|
|
from StringIO import StringIO
|
|
from urlparse import urlsplit
|
|
|
|
from BaseHTTPServer import BaseHTTPRequestHandler
|
|
|
|
old_socket = socket.socket
|
|
old_create_connection = socket.create_connection
|
|
old_gethostbyname = socket.gethostbyname
|
|
old_gethostname = socket.gethostname
|
|
old_getaddrinfo = socket.getaddrinfo
|
|
old_socksocket = None
|
|
old_ssl_wrap_socket = None
|
|
old_sslwrap_simple = None
|
|
old_sslsocket = None
|
|
|
|
try:
|
|
import socks
|
|
old_socksocket = socks.socksocket
|
|
except ImportError:
|
|
socks = None
|
|
|
|
try:
|
|
import ssl
|
|
old_ssl_wrap_socket = ssl.wrap_socket
|
|
old_sslwrap_simple = ssl.sslwrap_simple
|
|
old_sslsocket = ssl.SSLSocket
|
|
except ImportError:
|
|
ssl = None
|
|
|
|
|
|
class HTTPrettyError(Exception):
|
|
pass
|
|
|
|
|
|
def utf8(s):
|
|
if isinstance(s, unicode):
|
|
s = s.encode('utf-8')
|
|
|
|
return str(s)
|
|
|
|
|
|
class HTTPrettyRequest(BaseHTTPRequestHandler, object):
|
|
def __init__(self, headers, body=''):
|
|
self.body = utf8(body)
|
|
self.raw_headers = utf8(headers)
|
|
|
|
self.rfile = StringIO(headers + body)
|
|
self.raw_requestline = self.rfile.readline()
|
|
self.error_code = self.error_message = None
|
|
self.parse_request()
|
|
self.method = self.command
|
|
|
|
def __repr__(self):
|
|
return 'HTTPrettyRequest(headers={0}, body="{1}")'.format(
|
|
self.headers,
|
|
self.body,
|
|
)
|
|
|
|
|
|
class EmptyRequestHeaders(dict):
|
|
pass
|
|
|
|
|
|
class HTTPrettyRequestEmpty(object):
|
|
body = ''
|
|
headers = EmptyRequestHeaders()
|
|
|
|
|
|
class FakeSockFile(StringIO):
|
|
def read(self, amount=None):
|
|
amount = amount or self.len
|
|
new_amount = amount
|
|
|
|
if amount > self.len:
|
|
new_amount = self.len - self.tell()
|
|
|
|
ret = StringIO.read(self, new_amount)
|
|
remaining = amount - new_amount - 1
|
|
if remaining > 0:
|
|
ret = ret + (" " * remaining)
|
|
|
|
return ret
|
|
|
|
|
|
class FakeSSLSocket(object):
|
|
def __init__(self, sock, *args, **kw):
|
|
self._httpretty_sock = sock
|
|
|
|
def __getattr__(self, attr):
|
|
if attr == '_httpretty_sock':
|
|
return super(FakeSSLSocket, self).__getattribute__(attr)
|
|
|
|
return getattr(self._httpretty_sock, attr)
|
|
|
|
|
|
class fakesock(object):
|
|
class socket(object):
|
|
_entry = None
|
|
debuglevel = 0
|
|
_sent_data = []
|
|
|
|
def __init__(self, family, type, protocol=6):
|
|
self.setsockopt(family, type, protocol)
|
|
self.truesock = old_socket(family, type, protocol)
|
|
self._closed = True
|
|
self.fd = FakeSockFile()
|
|
self.timeout = socket._GLOBAL_DEFAULT_TIMEOUT
|
|
self._sock = self
|
|
|
|
def getpeercert(self, *a, **kw):
|
|
now = datetime.now()
|
|
shift = now + timedelta(days=30 * 12)
|
|
return {
|
|
'notAfter': shift.strftime('%b %d %H:%M:%S GMT'),
|
|
'subjectAltName': (
|
|
('DNS', '*%s' % self._host),
|
|
('DNS', self._host),
|
|
('DNS', '*'),
|
|
),
|
|
'subject': (
|
|
(
|
|
('organizationName', u'*.%s' % self._host),
|
|
),
|
|
(
|
|
('organizationalUnitName',
|
|
u'Domain Control Validated'),
|
|
),
|
|
(
|
|
('commonName', u'*.%s' % self._host),
|
|
),
|
|
),
|
|
}
|
|
|
|
def ssl(self, sock, *args, **kw):
|
|
return sock
|
|
|
|
def setsockopt(self, family, type, protocol):
|
|
self.family = family
|
|
self.protocol = protocol
|
|
self.type = type
|
|
|
|
def connect(self, address):
|
|
self._address = (self._host, self._port) = address
|
|
self._closed = False
|
|
|
|
def close(self):
|
|
if not self._closed:
|
|
self.truesock.close()
|
|
self._closed = True
|
|
|
|
def makefile(self, mode, bufsize):
|
|
self._mode = mode
|
|
self._bufsize = bufsize
|
|
|
|
if self._entry:
|
|
self._entry.fill_filekind(self.fd)
|
|
|
|
return self.fd
|
|
|
|
def _true_sendall(self, data, *args, **kw):
|
|
self.truesock.connect(self._address)
|
|
self.truesock.sendall(data, *args, **kw)
|
|
_d = self.truesock.recv(255)
|
|
self.fd.seek(0)
|
|
self.fd.write(_d)
|
|
while _d:
|
|
_d = self.truesock.recv(255)
|
|
self.fd.write(_d)
|
|
|
|
self.fd.seek(0)
|
|
self.truesock.close()
|
|
|
|
def sendall(self, data, *args, **kw):
|
|
|
|
self._sent_data.append(data)
|
|
hostnames = [i.hostname for i in HTTPretty._entries.keys()]
|
|
self.fd.seek(0)
|
|
try:
|
|
verb, headers_string = data.split('\n', 1)
|
|
is_parsing_headers = True
|
|
except ValueError:
|
|
is_parsing_headers = False
|
|
|
|
if self._host not in hostnames:
|
|
return self._true_sendall(data)
|
|
|
|
if not is_parsing_headers:
|
|
if len(self._sent_data) > 1:
|
|
headers, body = map(utf8, self._sent_data[-2:])
|
|
try:
|
|
return HTTPretty.historify_request(headers, body)
|
|
|
|
except Exception, e:
|
|
logging.error(traceback.format_exc(e))
|
|
return self._true_sendall(data, *args, **kw)
|
|
|
|
method, path, version = re.split('\s+', verb.strip(), 3)
|
|
|
|
headers, body = map(utf8, data.split('\r\n\r\n'))
|
|
|
|
request = HTTPretty.historify_request(headers, body)
|
|
|
|
info = URIInfo(hostname=self._host, port=self._port, path=path,
|
|
last_request=request)
|
|
|
|
entries = []
|
|
for key, value in HTTPretty._entries.items():
|
|
if key == info:
|
|
entries = value
|
|
info = key
|
|
break
|
|
|
|
if not entries:
|
|
self._true_sendall(data)
|
|
return
|
|
|
|
entry = info.get_next_entry()
|
|
if entry.method == method:
|
|
self._entry = entry
|
|
|
|
def debug(*a, **kw):
|
|
import debug
|
|
|
|
def settimeout(self, new_timeout):
|
|
self.timeout = new_timeout
|
|
|
|
sendto = send = recvfrom_into = recv_into = recvfrom = recv = debug
|
|
|
|
|
|
def fake_wrap_socket(s, *args, **kw):
|
|
return s
|
|
|
|
|
|
def create_fake_connection(address, timeout=socket._GLOBAL_DEFAULT_TIMEOUT, source_address=None):
|
|
s = fakesock.socket(socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_TCP)
|
|
if timeout is not socket._GLOBAL_DEFAULT_TIMEOUT:
|
|
s.settimeout(timeout)
|
|
if source_address:
|
|
s.bind(source_address)
|
|
s.connect(address)
|
|
return s
|
|
|
|
|
|
def fake_gethostbyname(host):
|
|
return host
|
|
|
|
|
|
def fake_gethostname():
|
|
return 'localhost'
|
|
|
|
|
|
def fake_getaddrinfo(
|
|
host, port, family=None, socktype=None, proto=None, flags=None):
|
|
return [(2, 1, 6, '', (host, port))]
|
|
|
|
|
|
STATUSES = {
|
|
100: "Continue",
|
|
101: "Switching Protocols",
|
|
200: "OK",
|
|
201: "Created",
|
|
202: "Accepted",
|
|
203: "Non-Authoritative Information",
|
|
204: "No Content",
|
|
205: "Reset Content",
|
|
206: "Partial Content",
|
|
300: "Multiple Choices",
|
|
301: "Moved Permanently",
|
|
302: "Found",
|
|
303: "See Other",
|
|
304: "Not Modified",
|
|
305: "Use Proxy",
|
|
307: "Temporary Redirect",
|
|
400: "Bad Request",
|
|
401: "Unauthorized",
|
|
402: "Payment Required",
|
|
403: "Forbidden",
|
|
404: "Not Found",
|
|
405: "Method Not Allowed",
|
|
406: "Not Acceptable",
|
|
407: "Proxy Authentication Required",
|
|
408: "Request Time-out",
|
|
409: "Conflict",
|
|
410: "Gone",
|
|
411: "Length Required",
|
|
412: "Precondition Failed",
|
|
413: "Request Entity Too Large",
|
|
414: "Request-URI Too Large",
|
|
415: "Unsupported Media Type",
|
|
416: "Requested range not satisfiable",
|
|
417: "Expectation Failed",
|
|
500: "Internal Server Error",
|
|
501: "Not Implemented",
|
|
502: "Bad Gateway",
|
|
503: "Service Unavailable",
|
|
504: "Gateway Time-out",
|
|
505: "HTTP Version not supported",
|
|
}
|
|
|
|
|
|
class Entry(object):
|
|
def __init__(self, method, uri, body,
|
|
adding_headers=None,
|
|
forcing_headers=None,
|
|
status=200,
|
|
**headers):
|
|
|
|
self.method = method
|
|
self.uri = uri
|
|
self.body = body
|
|
self.body_length = len(body or '')
|
|
self.adding_headers = adding_headers or {}
|
|
self.forcing_headers = forcing_headers or {}
|
|
self.status = int(status)
|
|
|
|
for k, v in headers.items():
|
|
name = "-".join(k.split("_")).capitalize()
|
|
self.adding_headers[name] = v
|
|
|
|
self.validate()
|
|
|
|
def validate(self):
|
|
content_length_keys = 'Content-Length', 'content-cength'
|
|
for key in content_length_keys:
|
|
got = self.adding_headers.get(
|
|
key, self.forcing_headers.get(key, None))
|
|
|
|
if got is None:
|
|
continue
|
|
|
|
try:
|
|
igot = int(got)
|
|
except ValueError:
|
|
warnings.warn(
|
|
'HTTPretty got to register the Content-Length header ' \
|
|
'with "%r" which is not a number' % got,
|
|
)
|
|
|
|
if igot > self.body_length:
|
|
raise HTTPrettyError(
|
|
'HTTPretty got inconsistent parameters. The header ' \
|
|
'Content-Length you registered expects size "%d" but ' \
|
|
'the body you registered for that has actually length ' \
|
|
'"%d".\nFix that, or if you really want that, call ' \
|
|
'register_uri with "fill_with" callback.' % (
|
|
igot, self.body_length,
|
|
)
|
|
)
|
|
|
|
def __repr__(self):
|
|
return r'<Entry %s %s getting %d>' % (
|
|
self.method, self.uri, self.status)
|
|
|
|
def normalize_headers(self, headers):
|
|
new = {}
|
|
for k in headers:
|
|
new_k = '-'.join([s.title() for s in k.split('-')])
|
|
new[new_k] = headers[k]
|
|
|
|
return new
|
|
|
|
def fill_filekind(self, fk):
|
|
now = datetime.utcnow()
|
|
|
|
headers = {
|
|
'Status': self.status,
|
|
'Date': now.strftime('%a, %d %b %Y %H:%M:%S GMT'),
|
|
'Server': 'Python/HTTPretty',
|
|
'Connection': 'close',
|
|
}
|
|
|
|
if self.forcing_headers:
|
|
headers = self.forcing_headers
|
|
|
|
if self.adding_headers:
|
|
headers.update(self.adding_headers)
|
|
|
|
headers = self.normalize_headers(headers)
|
|
|
|
status = headers.get('Status', self.status)
|
|
string_list = [
|
|
'HTTP/1.1 %d %s' % (status, STATUSES[status]),
|
|
]
|
|
|
|
if 'Date' in headers:
|
|
string_list.append('Date: %s' % headers.pop('Date'))
|
|
|
|
if not self.forcing_headers:
|
|
content_type = headers.pop('Content-Type',
|
|
'text/plain; charset=utf-8')
|
|
|
|
content_length = headers.pop('Content-Length', self.body_length)
|
|
|
|
string_list.append(
|
|
'Content-Type: %s' % content_type)
|
|
string_list.append(
|
|
'Content-Length: %s' % content_length)
|
|
|
|
string_list.append('Server: %s' % headers.pop('Server')),
|
|
|
|
for k, v in headers.items():
|
|
string_list.append(
|
|
'%s: %s' % (k, utf8(v)),
|
|
)
|
|
|
|
fk.write("\n".join(string_list))
|
|
fk.write('\n\r\n')
|
|
|
|
fk.write(self.body)
|
|
fk.seek(0)
|
|
|
|
|
|
class URIInfo(object):
|
|
def __init__(self,
|
|
username='',
|
|
password='',
|
|
hostname='',
|
|
port=80,
|
|
path='/',
|
|
query='',
|
|
fragment='',
|
|
scheme='',
|
|
entries=None,
|
|
last_request=None):
|
|
|
|
self.username = username or ''
|
|
self.password = password or ''
|
|
self.hostname = hostname or ''
|
|
|
|
if port:
|
|
port = int(port)
|
|
|
|
elif scheme == 'https':
|
|
port = 443
|
|
|
|
self.port = port or 80
|
|
self.path = path or ''
|
|
self.query = query or ''
|
|
self.scheme = scheme
|
|
self.fragment = fragment or ''
|
|
self.entries = entries
|
|
self.current_entry = 0
|
|
self.last_request = last_request
|
|
|
|
def get_next_entry(self):
|
|
if self.current_entry >= len(self.entries):
|
|
self.current_entry = -1
|
|
|
|
if not self.entries:
|
|
raise ValueError('I have no entries: %s' % self)
|
|
|
|
entry = self.entries[self.current_entry]
|
|
if self.current_entry != -1:
|
|
self.current_entry += 1
|
|
return entry
|
|
|
|
def __unicode__(self):
|
|
attrs = (
|
|
'username',
|
|
'password',
|
|
'hostname',
|
|
'port',
|
|
'path',
|
|
'query',
|
|
'fragment',
|
|
)
|
|
fmt = ", ".join(['%s="%s"' % (k, getattr(self, k, '')) for k in attrs])
|
|
return ur'<httpretty.URIInfo(%s)>' % fmt
|
|
|
|
def __repr__(self):
|
|
return unicode(self)
|
|
|
|
def __hash__(self):
|
|
return hash(unicode(self))
|
|
|
|
def __eq__(self, other):
|
|
return unicode(self) == unicode(other)
|
|
|
|
@classmethod
|
|
def from_uri(cls, uri, entry):
|
|
result = urlsplit(uri)
|
|
return cls(result.username,
|
|
result.password,
|
|
result.hostname,
|
|
result.port,
|
|
result.path,
|
|
result.query,
|
|
result.fragment,
|
|
result.scheme,
|
|
entry)
|
|
|
|
|
|
class HTTPretty(object):
|
|
u"""The URI registration class"""
|
|
_entries = {}
|
|
latest_requests = []
|
|
GET = 'GET'
|
|
PUT = 'PUT'
|
|
POST = 'POST'
|
|
DELETE = 'DELETE'
|
|
HEAD = 'HEAD'
|
|
PATCH = 'PATCH'
|
|
last_request = HTTPrettyRequestEmpty()
|
|
|
|
@classmethod
|
|
def historify_request(cls, headers, body=''):
|
|
request = HTTPrettyRequest(headers, body)
|
|
cls.last_request = request
|
|
cls.latest_requests.append(request)
|
|
return request
|
|
|
|
@classmethod
|
|
def register_uri(cls, method, uri, body='HTTPretty :)',
|
|
adding_headers=None,
|
|
forcing_headers=None,
|
|
status=200,
|
|
responses=None, **headers):
|
|
|
|
if isinstance(responses, list) and len(responses) > 0:
|
|
entries_for_this_uri = responses
|
|
else:
|
|
headers['body'] = body
|
|
headers['adding_headers'] = adding_headers
|
|
headers['forcing_headers'] = forcing_headers
|
|
headers['status'] = status
|
|
|
|
entries_for_this_uri = [
|
|
cls.Response(**headers),
|
|
]
|
|
|
|
map(lambda e: setattr(e, 'uri', uri) or setattr(e, 'method', method),
|
|
entries_for_this_uri)
|
|
|
|
info = URIInfo.from_uri(uri, entries_for_this_uri)
|
|
if info in cls._entries:
|
|
del cls._entries[info]
|
|
|
|
cls._entries[info] = entries_for_this_uri
|
|
|
|
def __repr__(self):
|
|
return u'<HTTPretty with %d URI entries>' % len(self._entries)
|
|
|
|
@classmethod
|
|
def Response(cls, body, adding_headers=None, forcing_headers=None,
|
|
status=200, **headers):
|
|
|
|
headers['body'] = utf8(body)
|
|
headers['adding_headers'] = adding_headers
|
|
headers['forcing_headers'] = forcing_headers
|
|
headers['status'] = int(status)
|
|
return Entry(method=None, uri=None, **headers)
|
|
|
|
@classmethod
|
|
def disable(cls):
|
|
socket.socket = old_socket
|
|
socket.SocketType = old_socket
|
|
socket._socketobject = old_socket
|
|
|
|
socket.create_connection = old_create_connection
|
|
socket.gethostname = old_gethostname
|
|
socket.gethostbyname = old_gethostbyname
|
|
socket.getaddrinfo = old_getaddrinfo
|
|
socket.inet_aton = old_gethostbyname
|
|
|
|
socket.__dict__['socket'] = old_socket
|
|
socket.__dict__['_socketobject'] = old_socket
|
|
socket.__dict__['SocketType'] = old_socket
|
|
|
|
socket.__dict__['create_connection'] = old_create_connection
|
|
socket.__dict__['gethostname'] = old_gethostname
|
|
socket.__dict__['gethostbyname'] = old_gethostbyname
|
|
socket.__dict__['getaddrinfo'] = old_getaddrinfo
|
|
socket.__dict__['inet_aton'] = old_gethostbyname
|
|
|
|
if socks:
|
|
socks.socksocket = old_socksocket
|
|
socks.__dict__['socksocket'] = old_socksocket
|
|
|
|
if ssl:
|
|
ssl.wrap_socket = old_ssl_wrap_socket
|
|
ssl.sslwrap_simple = old_sslwrap_simple
|
|
ssl.SSLSocket = old_sslsocket
|
|
ssl.__dict__['wrap_socket'] = old_ssl_wrap_socket
|
|
ssl.__dict__['sslwrap_simple'] = old_sslwrap_simple
|
|
ssl.__dict__['SSLSocket'] = old_sslsocket
|
|
|
|
@classmethod
|
|
def enable(cls):
|
|
socket.socket = fakesock.socket
|
|
socket._socketobject = fakesock.socket
|
|
socket.SocketType = fakesock.socket
|
|
|
|
socket.create_connection = create_fake_connection
|
|
socket.gethostname = fake_gethostname
|
|
socket.gethostbyname = fake_gethostbyname
|
|
socket.getaddrinfo = fake_getaddrinfo
|
|
socket.inet_aton = fake_gethostbyname
|
|
|
|
socket.__dict__['socket'] = fakesock.socket
|
|
socket.__dict__['_socketobject'] = fakesock.socket
|
|
socket.__dict__['SocketType'] = fakesock.socket
|
|
|
|
socket.__dict__['create_connection'] = create_fake_connection
|
|
socket.__dict__['gethostname'] = fake_gethostname
|
|
socket.__dict__['gethostbyname'] = fake_gethostbyname
|
|
socket.__dict__['inet_aton'] = fake_gethostbyname
|
|
socket.__dict__['getaddrinfo'] = fake_getaddrinfo
|
|
|
|
if socks:
|
|
socks.socksocket = fakesock.socket
|
|
socks.__dict__['socksocket'] = fakesock.socket
|
|
|
|
if ssl:
|
|
ssl.wrap_socket = fake_wrap_socket
|
|
ssl.sslwrap_simple = fake_wrap_socket
|
|
ssl.SSLSocket = FakeSSLSocket
|
|
|
|
ssl.__dict__['wrap_socket'] = fake_wrap_socket
|
|
ssl.__dict__['sslwrap_simple'] = fake_wrap_socket
|
|
ssl.__dict__['SSLSocket'] = FakeSSLSocket
|
|
|
|
|
|
def httprettified(test):
|
|
"A decorator tests that use HTTPretty"
|
|
@functools.wraps(test)
|
|
def wrapper(*args, **kw):
|
|
HTTPretty.enable()
|
|
HTTPretty._entries.clear()
|
|
|
|
try:
|
|
return test(*args, **kw)
|
|
finally:
|
|
HTTPretty.disable()
|
|
|
|
return wrapper
|