7aaeaaab9e
Some tests were failing under Py3K since the json library behaves a little
differently when it comes to decoding bytestrings. To fix this, the
simulate_request helper method was extended to take a new "decode" arg,
so tests can get a decoded string right off the bat.
Here is the docstring:
decode: If set to a character encoding, such as 'utf-8',
the method will assume the response is a single
byte string and will decode it and return a single
wide string instead of the raw WSGI response iterable.
100 lines
3.0 KiB
Python
100 lines
3.0 KiB
Python
"""Defines the TestSuite class.
|
|
|
|
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 itertools
|
|
|
|
try:
|
|
import testtools as unittest
|
|
except ImportError: # pragma: nocover
|
|
import unittest
|
|
|
|
import falcon
|
|
from falcon.testing.srmock import StartResponseMock
|
|
from falcon.testing.helpers import create_environ
|
|
|
|
|
|
class TestBase(unittest.TestCase):
|
|
"""Scaffolding around testtools.TestCase for testing a Falcon API endpoint.
|
|
|
|
Note: If testtools is not available, falls back to using unittest.
|
|
|
|
Inherit from this and write your test methods. If the child class defines
|
|
a before(self) method, this method will be called before executing each
|
|
test method. Likewise, child classes may define an after(self) method to
|
|
execute actions after each test method returns.
|
|
|
|
Attributes:
|
|
api: falcon.API instance used in simulating requests.
|
|
srmock: falcon.testing.StartResponseMock instance used in
|
|
simulating requests.
|
|
test_route: Randomly-generated route string (path) that tests can
|
|
use when wiring up resources.
|
|
|
|
|
|
"""
|
|
|
|
def setUp(self):
|
|
"""Initializer, unittest-style"""
|
|
|
|
super(TestBase, self).setUp()
|
|
self._id = itertools.count(0)
|
|
self.api = falcon.API()
|
|
self.srmock = StartResponseMock()
|
|
self.test_route = '/{0}'.format(next(self._id))
|
|
|
|
before = getattr(self, 'before', None)
|
|
if callable(before):
|
|
before()
|
|
|
|
def tearDown(self):
|
|
"""Destructor, unittest-style"""
|
|
|
|
after = getattr(self, 'after', None)
|
|
if callable(after):
|
|
after()
|
|
|
|
super(TestBase, self).tearDown()
|
|
|
|
def simulate_request(self, path, decode=None, **kwargs):
|
|
""" Simulates a request.
|
|
|
|
Simulates a request to the API for testing purposes.
|
|
|
|
Args:
|
|
path: Request path for the desired resource
|
|
decode: If set to a character encoding, such as 'utf-8',
|
|
the method will assume the response is a single
|
|
byte string and will decode it and return a single
|
|
wide string instead of the raw WSGI response iterable.
|
|
kwargs: Same as falcon.testing.create_environ()
|
|
|
|
"""
|
|
|
|
if not path:
|
|
path = '/'
|
|
|
|
result = self.api(create_environ(path=path, **kwargs),
|
|
self.srmock)
|
|
|
|
if decode is not None:
|
|
if not result:
|
|
return ''
|
|
|
|
return result[0].decode(decode)
|
|
|
|
return result
|