6671320cc5
Callbacks are now called when the response is about to be written. A callback now takes the actual request as first parameter. And can be any object that is callable. Furthermore the signature of the return value has changed to a tuple returning the status code along with the headers and the body. This allows for more logic in the callbacks. Callbacks and regex url matching now work together because the real request is used for passing the url the callback instead of the Regex
918 lines
27 KiB
Python
918 lines
27 KiB
Python
# #!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
# <HTTPretty - HTTP client mock for Python>
|
|
# Copyright (C) <2011-2013> 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.
|
|
from __future__ import unicode_literals
|
|
|
|
version = '0.5.12'
|
|
|
|
import re
|
|
import inspect
|
|
import socket
|
|
import functools
|
|
import itertools
|
|
import warnings
|
|
import logging
|
|
import sys
|
|
import traceback
|
|
import types
|
|
|
|
PY3 = sys.version_info[0] == 3
|
|
if PY3:
|
|
text_type = str
|
|
byte_type = bytes
|
|
import io
|
|
StringIO = io.BytesIO
|
|
|
|
class Py3kObject(object):
|
|
def __repr__(self):
|
|
return self.__str__()
|
|
else:
|
|
text_type = unicode
|
|
byte_type = str
|
|
import StringIO
|
|
StringIO = StringIO.StringIO
|
|
|
|
|
|
class Py3kObject(object):
|
|
def __repr__(self):
|
|
ret = self.__str__()
|
|
if PY3:
|
|
return ret
|
|
else:
|
|
ret.encode('utf-8')
|
|
|
|
from datetime import datetime
|
|
from datetime import timedelta
|
|
try:
|
|
from urllib.parse import urlsplit, parse_qs
|
|
except ImportError:
|
|
from urlparse import urlsplit, parse_qs
|
|
|
|
try:
|
|
from http.server import BaseHTTPRequestHandler
|
|
except ImportError:
|
|
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
|
|
if not PY3:
|
|
old_sslwrap_simple = ssl.sslwrap_simple
|
|
old_sslsocket = ssl.SSLSocket
|
|
except ImportError:
|
|
ssl = None
|
|
|
|
|
|
ClassTypes = (type,)
|
|
if not PY3:
|
|
ClassTypes = (type, types.ClassType)
|
|
|
|
|
|
POTENTIAL_HTTP_PORTS = [80, 443]
|
|
|
|
|
|
class HTTPrettyError(Exception):
|
|
pass
|
|
|
|
|
|
def utf8(s):
|
|
if isinstance(s, text_type):
|
|
s = s.encode('utf-8')
|
|
|
|
return byte_type(s)
|
|
|
|
|
|
def decode_utf8(s):
|
|
if isinstance(s, byte_type):
|
|
s = s.decode("utf-8")
|
|
|
|
return text_type(s)
|
|
|
|
|
|
def parse_requestline(s):
|
|
"""
|
|
http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5
|
|
|
|
>>> parse_requestline('GET / HTTP/1.0')
|
|
('GET', '/', '1.0')
|
|
>>> parse_requestline('post /testurl htTP/1.1')
|
|
('POST', '/testurl', '1.1')
|
|
>>> parse_requestline('Im not a RequestLine')
|
|
Traceback (most recent call last):
|
|
...
|
|
ValueError: Not a Request-Line
|
|
"""
|
|
methods = b'|'.join(HTTPretty.METHODS)
|
|
m = re.match(br'(' + methods + b')\s+(.*)\s+HTTP/(1.[0|1])', s, re.I)
|
|
if m:
|
|
return m.group(1).upper(), m.group(2), m.group(3)
|
|
else:
|
|
raise ValueError('Not a Request-Line')
|
|
|
|
|
|
class HTTPrettyRequest(BaseHTTPRequestHandler, Py3kObject):
|
|
def __init__(self, headers, body=''):
|
|
self.body = utf8(body)
|
|
self.raw_headers = utf8(headers)
|
|
self.client_address = ['10.0.0.1']
|
|
self.rfile = StringIO(b'\r\n\r\n'.join([headers.strip(), body]))
|
|
self.wfile = StringIO()
|
|
self.raw_requestline = self.rfile.readline()
|
|
self.error_code = self.error_message = None
|
|
self.parse_request()
|
|
self.method = self.command
|
|
self.querystring = parse_qs(self.path.split("?", 1)[-1])
|
|
|
|
def __str__(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):
|
|
pass
|
|
|
|
|
|
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
|
|
self.is_http = False
|
|
|
|
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
|
|
self.is_http = self._port in POTENTIAL_HTTP_PORTS
|
|
if not self.is_http:
|
|
self.truesock.connect(self._address)
|
|
|
|
def close(self):
|
|
if not self._closed:
|
|
self.truesock.close()
|
|
self._closed = True
|
|
|
|
def makefile(self, mode='r', bufsize=-1):
|
|
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):
|
|
if self.is_http:
|
|
self.truesock.connect(self._address)
|
|
|
|
self.truesock.sendall(data, *args, **kw)
|
|
|
|
_d = True
|
|
while _d:
|
|
try:
|
|
_d = self.truesock.recv(16)
|
|
self.truesock.settimeout(0.0)
|
|
self.fd.write(_d)
|
|
|
|
except socket.error:
|
|
break
|
|
|
|
self.fd.seek(0)
|
|
|
|
def sendall(self, data, *args, **kw):
|
|
|
|
self._sent_data.append(data)
|
|
hostnames = [getattr(i.info, 'hostname', None) for i in HTTPretty._entries.keys()]
|
|
self.fd.seek(0)
|
|
try:
|
|
requestline, _ = data.split(b'\r\n', 1)
|
|
method, path, version = parse_requestline(requestline)
|
|
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, False)
|
|
|
|
except Exception as e:
|
|
logging.error(traceback.format_exc(e))
|
|
return self._true_sendall(data, *args, **kw)
|
|
|
|
# path might come with
|
|
s = urlsplit(path)
|
|
POTENTIAL_HTTP_PORTS.append(int(s.port or 80))
|
|
headers, body = map(utf8, data.split(b'\r\n\r\n', 1))
|
|
|
|
request = HTTPretty.historify_request(headers, body)
|
|
|
|
info = URIInfo(hostname=self._host, port=self._port,
|
|
path=s.path,
|
|
query=s.query,
|
|
last_request=request)
|
|
|
|
entries = []
|
|
|
|
for matcher, value in HTTPretty._entries.items():
|
|
if matcher.matches(info):
|
|
entries = value
|
|
break
|
|
|
|
if not entries:
|
|
self._true_sendall(data)
|
|
return
|
|
|
|
self._entry = matcher.get_next_entry(method)
|
|
# Attach more info to the entry
|
|
# So the callback can be more clever about what to do
|
|
# This does also fix the case where the callback
|
|
# would be handed a compiled regex as uri instead of the
|
|
# real uri
|
|
self._entry.info = info
|
|
self._entry.request = request
|
|
|
|
def debug(*a, **kw):
|
|
frame = inspect.stack()[0][0]
|
|
lines = map(utf8, traceback.format_stack(frame))
|
|
|
|
message = [
|
|
"HTTPretty intercepted and unexpected socket method call.",
|
|
("Please open an issue at "
|
|
"'https://github.com/gabrielfalcao/HTTPretty/issues'"),
|
|
"And paste the following traceback:\n",
|
|
"".join(decode_utf8(lines)),
|
|
]
|
|
raise RuntimeError("\n".join(message))
|
|
|
|
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",
|
|
102: "Processing",
|
|
200: "OK",
|
|
201: "Created",
|
|
202: "Accepted",
|
|
203: "Non-Authoritative Information",
|
|
204: "No Content",
|
|
205: "Reset Content",
|
|
206: "Partial Content",
|
|
207: "Multi-Status",
|
|
208: "Already Reported",
|
|
226: "IM Used",
|
|
300: "Multiple Choices",
|
|
301: "Moved Permanently",
|
|
302: "Found",
|
|
303: "See Other",
|
|
304: "Not Modified",
|
|
305: "Use Proxy",
|
|
306: "Switch Proxy",
|
|
307: "Temporary Redirect",
|
|
308: "Permanent 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 a Timeout",
|
|
409: "Conflict",
|
|
410: "Gone",
|
|
411: "Length Required",
|
|
412: "Precondition Failed",
|
|
413: "Request Entity Too Large",
|
|
414: "Request-URI Too Long",
|
|
415: "Unsupported Media Type",
|
|
416: "Requested Range Not Satisfiable",
|
|
417: "Expectation Failed",
|
|
418: "I'm a teapot",
|
|
420: "Enhance Your Calm",
|
|
422: "Unprocessable Entity",
|
|
423: "Locked",
|
|
424: "Failed Dependency",
|
|
424: "Method Failure",
|
|
425: "Unordered Collection",
|
|
426: "Upgrade Required",
|
|
428: "Precondition Required",
|
|
429: "Too Many Requests",
|
|
431: "Request Header Fields Too Large",
|
|
444: "No Response",
|
|
449: "Retry With",
|
|
450: "Blocked by Windows Parental Controls",
|
|
451: "Unavailable For Legal Reasons",
|
|
451: "Redirect",
|
|
494: "Request Header Too Large",
|
|
495: "Cert Error",
|
|
496: "No Cert",
|
|
497: "HTTP to HTTPS",
|
|
499: "Client Closed Request",
|
|
500: "Internal Server Error",
|
|
501: "Not Implemented",
|
|
502: "Bad Gateway",
|
|
503: "Service Unavailable",
|
|
504: "Gateway Timeout",
|
|
505: "HTTP Version Not Supported",
|
|
506: "Variant Also Negotiates",
|
|
507: "Insufficient Storage",
|
|
508: "Loop Detected",
|
|
509: "Bandwidth Limit Exceeded",
|
|
510: "Not Extended",
|
|
511: "Network Authentication Required",
|
|
598: "Network read timeout error",
|
|
599: "Network connect timeout error",
|
|
}
|
|
|
|
|
|
class Entry(Py3kObject):
|
|
def __init__(self, method, uri, body,
|
|
adding_headers=None,
|
|
forcing_headers=None,
|
|
status=200,
|
|
streaming=False,
|
|
**headers):
|
|
|
|
self.method = method
|
|
self.uri = uri
|
|
self.info = None
|
|
self.request = None
|
|
|
|
self.body_is_callable = False
|
|
if hasattr(body,"__call__"):
|
|
self.body_is_callable = True
|
|
|
|
self.body = body
|
|
|
|
self.streaming = streaming
|
|
if not streaming and not self.body_is_callable:
|
|
self.body_length = len(self.body or '')
|
|
else:
|
|
self.body_length = 0
|
|
|
|
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-length'
|
|
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".' % (
|
|
igot, self.body_length,
|
|
)
|
|
)
|
|
|
|
def __str__(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.lower() 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.normalize_headers(self.adding_headers))
|
|
|
|
headers = self.normalize_headers(headers)
|
|
status = headers.get('status', self.status)
|
|
if self.body_is_callable:
|
|
status, headers, self.body = self.body(self.request,self.info.full_url(),headers)
|
|
headers.update({'content-length':len(self.body)})
|
|
|
|
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)
|
|
if not self.streaming:
|
|
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(
|
|
'{0}: {1}'.format(k, v),
|
|
)
|
|
|
|
for item in string_list:
|
|
fk.write(utf8(item) + b'\n')
|
|
|
|
fk.write(b'\r\n')
|
|
|
|
if self.streaming:
|
|
self.body, body = itertools.tee(self.body)
|
|
for chunk in body:
|
|
fk.write(utf8(chunk))
|
|
else:
|
|
fk.write(utf8(self.body))
|
|
|
|
fk.seek(0)
|
|
|
|
|
|
class URIInfo(Py3kObject):
|
|
def __init__(self,
|
|
username='',
|
|
password='',
|
|
hostname='',
|
|
port=80,
|
|
path='/',
|
|
query='',
|
|
fragment='',
|
|
scheme='',
|
|
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 or (self.port is 80 and "http" or "https")
|
|
self.fragment = fragment or ''
|
|
self.last_request = last_request
|
|
|
|
def __str__(self):
|
|
attrs = (
|
|
'username',
|
|
'password',
|
|
'hostname',
|
|
'port',
|
|
'path',
|
|
)
|
|
fmt = ", ".join(['%s="%s"' % (k, getattr(self, k, '')) for k in attrs])
|
|
return r'<httpretty.URIInfo(%s)>' % fmt
|
|
|
|
def __hash__(self):
|
|
return hash(text_type(self))
|
|
|
|
def __eq__(self, other):
|
|
self_tuple = (self.port, decode_utf8(self.hostname), decode_utf8(self.path))
|
|
other_tuple = (other.port, decode_utf8(other.hostname), decode_utf8(other.path))
|
|
return self_tuple == other_tuple
|
|
|
|
def full_url(self):
|
|
credentials = ""
|
|
if self.password:
|
|
credentials = "{0}:{1}@".format(
|
|
self.username, self.password)
|
|
|
|
query = ""
|
|
if self.query:
|
|
query = "?{0}".format(decode_utf8(self.query))
|
|
|
|
result = "{scheme}://{credentials}{host}{path}{query}".format(
|
|
scheme=self.scheme,
|
|
credentials=credentials,
|
|
host=decode_utf8(self.hostname),
|
|
path=decode_utf8(self.path),
|
|
query=query
|
|
)
|
|
return result
|
|
|
|
@classmethod
|
|
def from_uri(cls, uri, entry):
|
|
result = urlsplit(uri)
|
|
POTENTIAL_HTTP_PORTS.append(int(result.port or 80))
|
|
return cls(result.username,
|
|
result.password,
|
|
result.hostname,
|
|
result.port,
|
|
result.path,
|
|
result.query,
|
|
result.fragment,
|
|
result.scheme,
|
|
entry)
|
|
|
|
|
|
class URIMatcher(object):
|
|
regex = None
|
|
info = None
|
|
|
|
def __init__(self, uri, entries):
|
|
if type(uri).__name__ == 'SRE_Pattern':
|
|
self.regex = uri
|
|
else:
|
|
self.info = URIInfo.from_uri(uri, entries)
|
|
|
|
self.entries = entries
|
|
|
|
#hash of current_entry pointers, per method.
|
|
self.current_entries = {}
|
|
|
|
def matches(self, info):
|
|
if self.info:
|
|
return self.info == info
|
|
else:
|
|
return self.regex.search(info.full_url())
|
|
|
|
def __str__(self):
|
|
wrap = 'URLMatcher({0})'
|
|
if self.info:
|
|
return wrap.format(text_type(self.info))
|
|
else:
|
|
return wrap.format(self.regex.pattern)
|
|
|
|
def get_next_entry(self, method='GET'):
|
|
"""Cycle through available responses, but only once.
|
|
Any subsequent requests will receive the last response"""
|
|
|
|
if method not in self.current_entries:
|
|
self.current_entries[method] = 0
|
|
|
|
#restrict selection to entries that match the requested method
|
|
entries_for_method = [e for e in self.entries if e.method == method]
|
|
|
|
if self.current_entries[method] >= len(entries_for_method):
|
|
self.current_entries[method] = -1
|
|
|
|
if not self.entries or not entries_for_method:
|
|
raise ValueError('I have no entries for method %s: %s'
|
|
% (method, self))
|
|
|
|
entry = entries_for_method[self.current_entries[method]]
|
|
if self.current_entries[method] != -1:
|
|
self.current_entries[method] += 1
|
|
return entry
|
|
|
|
def __hash__(self):
|
|
return hash(text_type(self))
|
|
|
|
def __eq__(self, other):
|
|
return text_type(self) == text_type(other)
|
|
|
|
|
|
class HTTPretty(Py3kObject):
|
|
u"""The URI registration class"""
|
|
_entries = {}
|
|
latest_requests = []
|
|
GET = b'GET'
|
|
PUT = b'PUT'
|
|
POST = b'POST'
|
|
DELETE = b'DELETE'
|
|
HEAD = b'HEAD'
|
|
PATCH = b'PATCH'
|
|
METHODS = (GET, PUT, POST, DELETE, HEAD, PATCH)
|
|
last_request = HTTPrettyRequestEmpty()
|
|
_is_enabled = False
|
|
|
|
@classmethod
|
|
def reset(cls):
|
|
cls._entries.clear()
|
|
cls.latest_requests = []
|
|
cls.last_request = HTTPrettyRequestEmpty()
|
|
|
|
@classmethod
|
|
def historify_request(cls, headers, body='', append=True):
|
|
request = HTTPrettyRequest(headers, body)
|
|
cls.last_request = request
|
|
if append:
|
|
cls.latest_requests.append(request)
|
|
else:
|
|
cls.latest_requests[-1] = 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:
|
|
for response in responses:
|
|
response.uri = uri
|
|
response.method = method
|
|
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(method=method, uri=uri, **headers),
|
|
]
|
|
|
|
matcher = URIMatcher(uri, entries_for_this_uri)
|
|
if matcher in cls._entries:
|
|
matcher.entries.extend(cls._entries[matcher])
|
|
del cls._entries[matcher]
|
|
|
|
cls._entries[matcher] = entries_for_this_uri
|
|
|
|
def __str__(self):
|
|
return u'<HTTPretty with %d URI entries>' % len(self._entries)
|
|
|
|
@classmethod
|
|
def Response(cls, body, method=None, uri=None, adding_headers=None, forcing_headers=None,
|
|
status=200, streaming=False, **headers):
|
|
|
|
headers['body'] = body
|
|
headers['adding_headers'] = adding_headers
|
|
headers['forcing_headers'] = forcing_headers
|
|
headers['status'] = int(status)
|
|
headers['streaming'] = streaming
|
|
return Entry(method, uri, **headers)
|
|
|
|
@classmethod
|
|
def disable(cls):
|
|
cls._is_enabled = False
|
|
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.SSLSocket = old_sslsocket
|
|
ssl.__dict__['wrap_socket'] = old_ssl_wrap_socket
|
|
ssl.__dict__['SSLSocket'] = old_sslsocket
|
|
|
|
if not PY3:
|
|
ssl.sslwrap_simple = old_sslwrap_simple
|
|
ssl.__dict__['sslwrap_simple'] = old_sslwrap_simple
|
|
|
|
@classmethod
|
|
def is_enabled(cls):
|
|
return cls._is_enabled
|
|
|
|
@classmethod
|
|
def enable(cls):
|
|
cls._is_enabled = True
|
|
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.SSLSocket = FakeSSLSocket
|
|
|
|
ssl.__dict__['wrap_socket'] = fake_wrap_socket
|
|
ssl.__dict__['SSLSocket'] = FakeSSLSocket
|
|
|
|
if not PY3:
|
|
ssl.sslwrap_simple = fake_wrap_socket
|
|
ssl.__dict__['sslwrap_simple'] = fake_wrap_socket
|
|
|
|
|
|
def httprettified(test):
|
|
"A decorator tests that use HTTPretty"
|
|
def decorate_class(klass):
|
|
for attr in dir(klass):
|
|
if not attr.startswith('test_'):
|
|
continue
|
|
|
|
attr_value = getattr(klass, attr)
|
|
if not hasattr(attr_value, "__call__"):
|
|
continue
|
|
|
|
setattr(klass, attr, decorate_callable(attr_value))
|
|
return klass
|
|
|
|
def decorate_callable(test):
|
|
@functools.wraps(test)
|
|
def wrapper(*args, **kw):
|
|
HTTPretty.reset()
|
|
HTTPretty.enable()
|
|
try:
|
|
return test(*args, **kw)
|
|
finally:
|
|
HTTPretty.disable()
|
|
return wrapper
|
|
|
|
if isinstance(test, ClassTypes):
|
|
return decorate_class(test)
|
|
return decorate_callable(test)
|