如何测试此代码答案

【问题标题】：How to test this code如何测试此代码
【发布时间】：2013-04-21 07:05:12
【问题描述】：

我正在尝试 TDD 和单元测试，但从未真正认真地做过。

我有一个从程序输出的 XML 文件。我想将其转换为 JSON。我找到了xmltodict，所以我想做的是：

def to_json(filename):
    with open(filename) as f:
        xml_ = f.read()
        dict_ = xmltodict.parse(xml_)
        json_ = json.dumps(dict_)
    return json_

我将如何测试这个？我应该把它分成 3 个功能并分别测试吗？我应该对错误的文件名进行“防御性”编码吗？ parse 和 dumps 方法抛出的错误呢？

最后，有没有很好的参考资料/书籍/博客文章讨论这类事情？我知道我应该进行单元测试并且非常喜欢 TDD 的想法，但实际上我不知道自己在做什么。

【问题讨论】：

我将打开文件与转换为 json 分开。测试代码会更容易。
加上您的代码已经编写好了，TDD 以另一种方式工作 - 首先您编写测试，然后在尝试通过测试时编写代码。
我试过了，但我什至不确定那些初始测试会是什么样子。

标签： python unit-testing tdd

【解决方案1】：

这是我的见解：

首先，我将“打开文件”逻辑与实际转换步骤分开。

然后，基本上你需要确保你的函数转换合法且正确的 xml，如果 xml 无效或损坏则抛出异常。

这是一个你应该拥有的简单示例：

import json
import unittest
import xmltodict


def to_json(xml_):
    dict_ = xmltodict.parse(xml_)
    json_ = json.dumps(dict_)
    return json_


class TestToJson(unittest.TestCase):
    def test_good_xml(self):
        xml = """<?xml version="1.0"?>
                <catalog>
                   <book id="bk101">
                      <author>Gambardella, Matthew</author>
                      <title>XML Developer's Guide</title>
                   </book>
                   <book id="bk102">
                      <author>Ralls, Kim</author>
                      <title>Midnight Rain</title>
                   </book>
                </catalog>"""
        self.assertEquals(json.loads(to_json(xml)), {"catalog": {
        "book": [{"@id": "bk101", "author": "Gambardella, Matthew", "title": "XML Developer\'s Guide"},
                 {"@id": "bk102", "author": "Ralls, Kim", "title": "Midnight Rain"}]}})

    def test_bad_xml(self):
        xml = "<broken><broken"
        self.assertRaises(Exception, to_json, xml)


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

就您应该测试不同的有效和无效 xml 字符串而言，您可以使用一个很棒的 ddt 包，它会针对不同的输入自动增加您的测试方法。

此外，您可能希望在您的 xmltodict 返回无效 dict 对象的实际情况中进行一些无法实现的测试。在这种情况下，您需要 mock xmltodict.parse 函数并将其更改为 return_value。

谈到 TDD。你的代码已经写好了。 TDD 使用不同的方法，您首先编写测试，然后尝试通过编写实际代码使它们通过。您绝对应该尝试一下 - 它有很多好处。

一些资源：

【讨论】：