Python CGI FieldStorage 测试工具

Question

我该如何为Python的CGI脚本搭建一个小的测试环境呢？我不想启动一个服务器来测试，但我想给我的测试提供各种GET和POST的输入。

我觉得FieldStorage（或者说它背后的对象）是完全不可变的，所以我不知道怎么在测试环境中动态地提供CGI数据。

Answer 1

如果你不想使用像Mock这样的额外库，其实可以用一些测试数据来设置一个cgi.FieldStorage对象。下面的Python3示例假设你需要处理一个POST请求：

import unittest
from io import BytesIO

class TestForm(unittest.TestCase):

    def setUp(self):
        """
        Makes a cgi.FieldStorage object
        with some bogus fields.
        """
        # provide a byte string with the parameters
        # using the format b"name1=value1&name2=value2..."
        urlencode_data = b"firstname=Joe&lastname=Bloggs&email=joe.bloggs@company.com"
        urlencode_environ = {
            'CONTENT_LENGTH':   str(len(urlencode_data)),
            'CONTENT_TYPE':     'application/x-www-form-urlencoded',
            'QUERY_STRING':     '',
            'REQUEST_METHOD':   'POST',
        }
        data = BytesIO(urlencode_data)
        data.seek(0)
        self.fs = cgi.FieldStorage(fp=data, environ=urlencode_environ)

    # unit test methods come here
    # form fields are accessible via `self.fs`

这个想法来源于https://bugs.python.org/file9507/cgitest.py。在这里你可以找到其他有趣的例子，比如带文件上传的表单等等。

需要注意的是，cgi.FieldStorage的__init__方法没有文档说明，或者至少我在当前的cgi模块文档中找不到相关信息。

Answer 2

你可以使用一个叫做 Mock 的库来完成这个任务。比如说，假设你想测试你CGI脚本里的 function_to_test 函数，你可以写一个 单元测试类，像这样：

import unittest
import cgi

from mock import patch

def function_to_test():
    form = cgi.FieldStorage()
    if "name" not in form or "addr" not in form:
        return "<H1>Error</H1>\nPlease fill in the name and address.\n"
    text = "<p>name: {0}\n<p>addr: {1}\n"
    return text.format(form["name"].value, form["addr"].value)

@patch('cgi.FieldStorage')
class TestClass(unittest.TestCase):
    class TestField(object):
        def __init__(self, value):
            self.value = value

    FIELDS = { "name" : TestField("Bill"), "addr" : TestField("1 Two Street") }

    def test_cgi(self, MockClass):
        instance = MockClass.return_value
        instance.__getitem__ = lambda s, key: TestClass.FIELDS[key]
        instance.__contains__ = lambda s, key: key in TestClass.FIELDS
        text = function_to_test()
        self.assertEqual(text, "<p>name: Bill\n<p>addr: 1 Two Street\n")

    def test_err(self, MockClass):
        instance = MockClass.return_value
        instance.__contains__ = lambda self, key: False
        text = function_to_test()
        self.assertEqual(text,
            "<H1>Error</H1>\nPlease fill in the name and address.\n")

如果我把这段代码作为单元测试来运行，我会得到：

..
----------------------------------------------------------------------
Ran 2 tests in 0.003s

OK