Files
deb-python-falcon/falcon/testing/helpers.py
kgriffs 6cf8c6e2b7 doc: Remove module docstrings
The docstrings were only adding clutter to the generated docs on RTD.
2014-04-04 15:40:34 -05:00

145 lines
4.4 KiB
Python

# Copyright 2013 by Rackspace Hosting, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import random
import io
import sys
from datetime import datetime
import six
import falcon
# Constants
DEFAULT_HOST = 'falconframework.org'
def httpnow():
"""Returns the current UTC time as an HTTP date
Returns:
An HTTP date string, e.g., "Tue, 15 Nov 1994 12:45:26 GMT". See
also: http://goo.gl/R7So4
"""
return falcon.dt_to_http(datetime.utcnow())
def rand_string(min, max):
"""Returns a randomly-generated string, of a random length
Args:
min: Minimum string length to return, inclusive
max: Maximum string length to return, inclusive
"""
int_gen = random.randint
string_length = int_gen(min, max)
return ''.join([chr(int_gen(ord(' '), ord('~')))
for i in range(string_length)])
def create_environ(path='/', query_string='', protocol='HTTP/1.1', port='80',
headers=None, app='', body='', method='GET',
wsgierrors=None):
""" Creates a 'mock' PEP-3333 environ dict for simulating WSGI requests
Args:
path: The path for the request (default '/')
query_string: The query string to simulate, without a
leading '?' (default '')
protocol: The HTTP protocol to simulate (default 'HTTP/1.1')
port: The TCP port to simulate (default '80')
headers: Optional headers to set as a dict or an iterable of tuples
that can be converted to a dict (default None)
app: Value for the SCRIPT_NAME environ variable, described in
PEP-333: 'The initial portion of the request URL's "path" that
corresponds to the application object, so that the application
knows its virtual "location". This may be an empty string, if the
application corresponds to the "root" of the server.' (default '')
body: The body of the request (default '')
method: The HTTP method to use (default 'GET')
wsgierrors: The stream to use as wsgierrors (default sys.stderr)
"""
body = io.BytesIO(body.encode('utf-8')
if isinstance(body, six.text_type) else body)
# NOTE(kgriffs): nocover since this branch will never be
# taken in Python3. However, the branch is tested under Py2,
# in test_utils.TestFalconTesting.test_unicode_path_in_create_environ
if six.PY2 and isinstance(path, unicode): # pragma: nocover
path = path.encode('utf-8')
env = {
'SERVER_PROTOCOL': protocol,
'SERVER_SOFTWARE': 'gunicorn/0.17.0',
'SCRIPT_NAME': app,
'REQUEST_METHOD': method,
'PATH_INFO': path,
'QUERY_STRING': query_string,
'HTTP_USER_AGENT': 'curl/7.24.0 (x86_64-apple-darwin12.0)',
'REMOTE_PORT': '65133',
'RAW_URI': '/',
'REMOTE_ADDR': '127.0.0.1',
'SERVER_NAME': 'localhost',
'SERVER_PORT': port,
'wsgi.url_scheme': 'http',
'wsgi.input': body,
'wsgi.errors': wsgierrors or sys.stderr,
'wsgi.multithread': False,
'wsgi.multiprocess': True,
'wsgi.run_once': False
}
if protocol != 'HTTP/1.0':
env['HTTP_HOST'] = DEFAULT_HOST
content_length = body.seek(0, 2)
body.seek(0)
if content_length != 0:
env['CONTENT_LENGTH'] = content_length
if headers is not None:
_add_headers_to_environ(env, headers)
return env
def _add_headers_to_environ(env, headers):
if not isinstance(headers, dict):
# Try to convert
headers = dict(headers)
for name, value in headers.items():
name = name.upper().replace('-', '_')
if value is None:
value = ''
else:
value = value.strip()
if name == 'CONTENT_TYPE':
env[name] = value
elif name == 'CONTENT_LENGTH':
env[name] = value
else:
env['HTTP_' + name.upper()] = value