对cherry webapp进行单元测试



我最近不得不重写我们的rest api,并从Flask切换到Cherrypy(主要是由于Python 3的兼容性)。但是现在我被困在试图编写单元测试,Flask有一个非常漂亮的内置测试客户端,您可以使用它向应用程序发送虚假请求(无需启动服务器)。我找不到任何类似的功能cherryypy,有这样的功能,或者我卡住了启动服务器和做实际的请求对它?

据我所知,CherryPy确实没有为这种类型的测试提供工具(没有运行的服务器)。尽管如此,这样做还是相当容易的(尽管它依赖于CherryPy的一些内部结构)。

这里有一个简单的展示:

from StringIO import StringIO
import unittest
import urllib
import cherrypy
local = cherrypy.lib.httputil.Host('127.0.0.1', 50000, "")
remote = cherrypy.lib.httputil.Host('127.0.0.1', 50001, "")
class Root(object):
    @cherrypy.expose
    def index(self):
        return "hello world"
    @cherrypy.expose
    def echo(self, msg):
        return msg
def setUpModule():
    cherrypy.config.update({'environment': "test_suite"})
    # prevent the HTTP server from ever starting
    cherrypy.server.unsubscribe()
    cherrypy.tree.mount(Root(), '/')
    cherrypy.engine.start()
setup_module = setUpModule
def tearDownModule():
    cherrypy.engine.exit()
teardown_module = tearDownModule
class BaseCherryPyTestCase(unittest.TestCase):
    def webapp_request(self, path='/', method='GET', **kwargs):
        headers = [('Host', '127.0.0.1')]
        qs = fd = None
        if method in ['POST', 'PUT']:
            qs = urllib.urlencode(kwargs)
            headers.append(('content-type', 'application/x-www-form-urlencoded'))
            headers.append(('content-length', '%d' % len(qs)))
            fd = StringIO(qs)
            qs = None
        elif kwargs:
            qs = urllib.urlencode(kwargs)
        # Get our application and run the request against it
        app = cherrypy.tree.apps['']
        # Let's fake the local and remote addresses
        # Let's also use a non-secure scheme: 'http'
        request, response = app.get_serving(local, remote, 'http', 'HTTP/1.1')
        try:
            response = request.run(method, path, qs, 'HTTP/1.1', headers, fd)
        finally:
            if fd:
                fd.close()
                fd = None
        if response.output_status.startswith('500'):
            print response.body
            raise AssertionError("Unexpected error")
        # collapse the response into a bytestring
        response.collapse_body()
        return response
class TestCherryPyApp(BaseCherryPyTestCase):
    def test_index(self):
        response = self.webapp_request('/')
        self.assertEqual(response.output_status, '200 OK')
        # response body is wrapped into a list internally by CherryPy
        self.assertEqual(response.body, ['hello world'])
    def test_echo(self):
        response = self.webapp_request('/echo', msg="hey there")
        self.assertEqual(response.output_status, '200 OK')
        self.assertEqual(response.body, ["hey there"])
        response = self.webapp_request('/echo', method='POST', msg="hey there")
        self.assertEqual(response.output_status, '200 OK')
        self.assertEqual(response.body, ["hey there"])
if __name__ == '__main__':
    unittest.main()

编辑,我已经扩展了这个答案作为一个CherryPy食谱。

似乎还有另一种执行单元测试的方法。我刚刚找到并检查了下面的配方,它可以很好地与樱桃3.5。

http://docs.cherrypy.org/en/latest/advanced.html测试您的应用程序

    import cherrypy
    from cherrypy.test import helper
    class SimpleCPTest(helper.CPWebCase):
        def setup_server():
            class Root(object):
                @cherrypy.expose
                def echo(self, message):
                    return message
            cherrypy.tree.mount(Root())
        setup_server = staticmethod(setup_server)
        def test_message_should_be_returned_as_is(self):
            self.getPage("/echo?message=Hello%20world")
            self.assertStatus('200 OK')
            self.assertHeader('Content-Type', 'text/html;charset=utf-8')
            self.assertBody('Hello world')
        def test_non_utf8_message_will_fail(self):
            """
            CherryPy defaults to decode the query-string
            using UTF-8, trying to send a query-string with
            a different encoding will raise a 404 since
            it considers it's a different URL.
            """
            self.getPage("/echo?message=A+bient%F4t",
                         headers=[
                             ('Accept-Charset', 'ISO-8859-1,utf-8'),
                             ('Content-Type', 'text/html;charset=ISO-8859-1')
                         ]
            )
            self.assertStatus('404 Not Found')

我发现Sylvain Hellegouarch的答案对解决这个问题非常有帮助,但它使用了Python 2。我改编了他们的答案,使用Python 3:

import io
import unittest
import urllib
import urllib.parse
import cherrypy
from cherrypy.lib import httputil
local = httputil.Host('127.0.0.1', 50000, '')
remote = httputil.Host('127.0.0.1', 50001, '')
class Root(object):
    @cherrypy.expose
    def index(self):
        return 'hello world'
    @cherrypy.expose
    def echo(self, msg):
        return msg
def setUpModule():
    cherrypy.config.update({'environment': 'test_suite'})
    # prevent the HTTP server from ever starting
    cherrypy.server.unsubscribe()
    cherrypy.tree.mount(Root(), '/')
    cherrypy.engine.start()
setup_module = setUpModule
def tearDownModule():
    cherrypy.engine.exit()
teardown_module = tearDownModule
class BaseCherryPyTestCase(unittest.TestCase):
    def webapp_request(self, path='/', method='GET', **kwargs):
        headers = [('Host', '127.0.0.1')]
        qs = fd = None
        if method in ['POST', 'PUT']:
            qs = urllib.parse.urlencode(kwargs)
            headers.append(('content-type', 'application/x-www-form-urlencoded'))
            headers.append(('content-length', f'{len(qs)}'))
            fd = io.BytesIO(qs.encode())
            qs = None
        elif kwargs:
            qs = urllib.parse.urlencode(kwargs)
        # Get our application and run the request against it
        app = cherrypy.tree.apps['']
        # Let's fake the local and remote addresses
        # Let's also use a non-secure scheme: 'http'
        request, response = app.get_serving(local, remote, 'http', 'HTTP/1.1')
        try:
            response = request.run(method, path, qs, 'HTTP/1.1', headers, fd)
        finally:
            if fd:
                fd.close()
                fd = None
        if response.output_status.startswith(b'500'):
            print(response.body)
            raise AssertionError('Unexpected error')
        # collapse the response into a bytestring
        response.collapse_body()
        return response
class TestCherryPyApp(BaseCherryPyTestCase):
    def test_index(self):
        response = self.webapp_request('/')
        self.assertEqual(response.output_status, b'200 OK')
        # response body is wrapped into a list internally by CherryPy
        self.assertEqual(response.body, [b'hello world'])
    def test_echo(self):
        response = self.webapp_request('/echo', msg='hey there')
        self.assertEqual(response.output_status, b'200 OK')
        self.assertEqual(response.body, [b'hey there'])
        response = self.webapp_request('/echo', method='POST', msg='hey there')
        self.assertEqual(response.output_status, b'200 OK')
        self.assertEqual(response.body, [b'hey there'])

最新更新