在单元测试中使用 wsgiref.simple_server

Question

我有一些像这样的功能：

URL = 'http://localhost:8080'
def func():
    response = urlopen(URL)
    return process(response)

我想用单元测试来测试它。

我做了这样的事情：

from wsgiref.simple_server import make_server
def app_200_hello(environ,start_response):
    stdout = StringIO('Hello world')
    start_response("200 OK", [('Content-Type','text/plain')])
    return [stdout.getvalue()]

s = make_server('localhost', 8080, app_200_hello)

class TestFunc(unittest.TestCase):
    def setUp(self):
        s.handle_request()

    def test1(self):
        r = func()
        assert r, something

if __name__ == '__main__':
    unittest.main()

在 setUp() 处，我的测试停止，因为 s.handle_request() 等待请求。 我怎样才能解决这个问题？ 在另一个线程中运行 s.handle_request() ？ 或者也许还有另一个 解决方案？

编辑： 我想测试“func”函数，而不是“app_200_hello”

Answer 1

如果您正在测试 WSGI 应用程序，我强烈推荐 werkzeug.test 它通过以下方式解决了这些问题在没有服务器的情况下测试应用程序本身：

from werkzeug.test import Client

# then in your test case
def test1(self):
    client = Client(app_200_hello)
    appiter, status, headers = client.open()
    assert ''.join(appiter) == 'Hello World'
    assert status == '200 OK'

这种方法完全消除了对 WSGI 服务器的需要。

当然，如果您确实想启动服务器，则必须使用单独的线程或进程，但之后必须确保将其停止。 然而，令我震惊的是，您唯一想要使用真实服务器进行测试的时间是生产集成测试，在这种情况下，您的服务器将不是 wsgiref，它将是您可能不必启动的真实服务器-像这样停下来。

Answer 2

单独进程中启动服务器，

使用多处理在setUp中的

self.port = 8000
server = make_server('', self.port, make_my_wsgi_ap())
self.server_process = multiprocessing.Process(target=server.serve_forever)
self.server_process.start()

执行以下操作：然后在tearDown中执行以下操作：

self.server_process.terminate()
self.server_process.join()
del(self.server_process)

我发现，如果您没有明确地将del()放在那里，则后续服务器实例可能会出现端口问题已经被使用了。

Answer 3

您的服务器必须是一个单独的进程。

您需要使用 subprocess.Popen() 启动它。

如果您使用的是 Python 2.6，则可以在拆解期间终止子进程。

def setUp( self ):
    self.server= subprocess.Popen( "python","myserver","etc." )
def tearDown( self ):
    self.server.kill()

如果您不使用 Python 2.6，终止服务器可能会令人不快。

Answer 4

您还可以提供一个并不实际运行服务器的 urlopen 模拟版本。

假设您的原始代码位于 mycode.py 中，在您的测试代码中，您将执行以下操作：

import mycode

class TestFunc(unittest.TestCase):
    def setUp(self):
        # patch mycode, to use mock version of urlopen
        self._original_urlopen = mycode.urlopen
        mycode.urlopen=self.mock_urlopen

    def tearDown(self):
        # unpatch urlopen
        mycode.urlopen=self._original_urlopen

    def mock_urlopen(self,url):
        # return whatever data you need urlopen to return

    def test1(self):
        r = func()
        assert r, something

if __name__ == '__main__':
    unittest.main()

这被称为“猴子修补”，有些人对此不以为然，但对于测试您的代码来说，它可以使生活变得有趣容易得多，因为您不需要更改原始代码即可使其可测试。

Answer 5

我的解决方案：

URL = 'http://localhost:8085'
def func():
    response = urlopen(URL)
    return response.read()

import unittest
from wsgiref.simple_server import WSGIServer, WSGIRequestHandler
import threading
from urllib2 import urlopen
from cStringIO import StringIO

def app_200_hello(environ,start_response):
    stdout = StringIO('Hello world')
    start_response("200 OK", [('Content-Type','text/plain')])
    return [stdout.getvalue()]

server = WSGIServer(('localhost', 8085), WSGIRequestHandler)
server.set_app(app_200_hello)

t = threading.Thread(target=server.serve_forever)
t.start()

class TestFunc(unittest.TestCase):
    def setUp(self):
        pass

    def test1(self):
        r = func()
        self.assertEqual(r, 'Hello world')

    def __del__(self):
        server.shutdown()

if __name__ == '__main__':
    unittest.main()

我在另一个线程中启动“服务器”并在 TestFunc 析构函数中将其关闭。