fb7ca62fea
* feat(testing): Add TestClient class and a pytest example Add a contextual wrapper for the simulate_* methods and a pytest example demonstrating its use. Also deprecate "api" in favor of "app" in TestCase, since these utils can work with any WSGI app (not just those that express HTTP APIs). This terminology makes TestCase more consistent with the new simulate_* functions and with TestClient. Finally, deprecate "api_class" in TestCase and update the docstring for the testing module to demonstrate a less hacky alternative for controlling the api instance type. As a bonus, this avoids having to try and alias api_class (a class variable). Partially implements #16 * doc(testing): Clarify 'myapp' example code
81 lines
2.6 KiB
Python
81 lines
2.6 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.
|
|
|
|
"""Testing utilities.
|
|
|
|
This package contains various test classes and utility functions to
|
|
support functional testing for both Falcon-based apps and the Falcon
|
|
framework itself. Both unittest-style and pytest-style tests are
|
|
supported::
|
|
|
|
# -----------------------------------------------------------------
|
|
# unittest-style
|
|
# -----------------------------------------------------------------
|
|
|
|
from falcon import testing
|
|
import myapp
|
|
|
|
|
|
class MyTestCase(testing.TestCase):
|
|
def setUp(self):
|
|
super(MyTestCase, self).setUp()
|
|
|
|
# Assume the hypothetical `myapp` package has a
|
|
# function called `create()` to initialize and
|
|
# return a `falcon.API` instance.
|
|
self.app = myapp.create()
|
|
|
|
|
|
class TestMyApp(MyTestCase):
|
|
def test_get_message(self):
|
|
doc = {u'message': u'Hello world!'}
|
|
|
|
result = self.simulate_get('/messages/42')
|
|
self.assertEqual(result.json, doc)
|
|
|
|
|
|
# -----------------------------------------------------------------
|
|
# pytest-style
|
|
# -----------------------------------------------------------------
|
|
|
|
from falcon import testing
|
|
import pytest
|
|
|
|
import myapp
|
|
|
|
|
|
@pytest.fixture(scope='module')
|
|
def client():
|
|
# Assume the hypothetical `myapp` package has a
|
|
# function called `create()` to initialize and
|
|
# return a `falcon.API` instance.
|
|
return testing.TestClient(myapp.create())
|
|
|
|
|
|
def test_get_message(client):
|
|
doc = {u'message': u'Hello world!'}
|
|
|
|
result = client.simulate_get('/messages/42')
|
|
assert result.json == doc
|
|
"""
|
|
|
|
# Hoist classes and functions into the falcon.testing namespace
|
|
from falcon.testing.base import TestBase # NOQA
|
|
from falcon.testing.client import * # NOQA
|
|
from falcon.testing.helpers import * # NOQA
|
|
from falcon.testing.resource import capture_responder_args # NOQA
|
|
from falcon.testing.resource import SimpleTestResource, TestResource # NOQA
|
|
from falcon.testing.srmock import StartResponseMock # NOQA
|
|
from falcon.testing.test_case import TestCase # NOQA
|