django测试的HTML报告

Question

我有一个包含API的Django项目（如果需要的话，可以使用rest框架创建）。我已经为API添加了一些测试，但是为了全面了解这些测试，无论通过还是失败，我都需要创建一个HTML报告。测试完成后，应生成HTML表报告，该报告显示测试期间涵盖的端点和HTTP响应，测试结果以及缺少测试的组合。

很遗憾，我不知道该怎么做。我知道覆盖范围可以给我详细的html报告，但这不是我所需要的，我需要这样的东西：

|端点说明| 200 | 400 | 403 | 404 || GET / endpoint1 |通行证|通过|通过| N / A || POST / endpoint1 |通行证|失败|丢失| N / A |

有人对此有任何想法吗？也许有些库可以帮助解决这个问题，或者我应该为此使用什么策略？

提前谢谢您

Answer 1

由于Django使用python的标准unittest库，因此您必须调整其某些部分。

First，您需要某种方式来指定哪些测试实际测试哪个端点。自定义装饰器很方便：

from functools import wraps

def endpoint(path, code):
    """
    Mark some test as one which tests specific endpoint.
    """
    def inner(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            return func(*args, **kwargs)
        return wrapper

    inner._endpoint_path = path
    inner._endpoint_code = code
    return inner


class MyTestCase(TestCase):
    @endpoint(path='/path/one', code=200)
    def test_my_path_is_ok(self):
        response = self.client.get('/path/one?foo=bar')
        self.assertEqual(response.status_code, 200)

    @endpoint(path='/path/one', code=404)
    def test_my_path_expected_errors(self):
        response = self.client.get('/path/one?foo=qux')
        self.assertEqual(response.status_code, 404)

    def test_some_other_stuff(self):
        # this one will not be included in our results grid.
        pass

您可以使用“魔术”方法（例如，特殊方法的名称来猜测它们正在测试的端点），但是explicit is better than implicit，对吧？

Then，您需要一种方法来收集测试结果-特别是那些测试端点的结果。在这里，我们制作了unittest.TestResult的（非常草稿）子类来处理它：

class EndpointsTestResult(TestResult):
    def __init__(self):
         super(EndpointsTestResult, self).__init__()
         self.endpoint_results = {}

    def addError(self, test, err):
        super(EndpointsTestResult, self).addError(test, err)
        if hasattr(test, '_endpoint_path'):
            branch = self.endpoint_results.setdefault(getattr(test, '_endpoint_path'), {})
            branch[getattr(test, '_endpoint_code')] = 'MISSING'

    def addFailure(self, test, err):
        # similar as addError()

    def addSuccess(self, test):
        # similar as addError()

最后是时候实际输出结果了。让我们对unittest.TextTestRunner进行分类，并在我们的自定义运行器中进行指定：

class EndpointsTestRunner(TextTestRunner):
    def _makeResult(self):
         self._result = EndpointsTestResult()
         return self._result

    def run(self, test):        
        super(EndpointsTestRunner).run(test)
        # After running a test, print out the table
        generate_a_nifty_table(self._result.endpoint_results)


class EndpointsDjangoRunner(django.test.runner.DiscoverRunner):
    test_runner = EndpointsTestRunner

现在我们有了自定义EndpointsDjangoRunner，我们应该在settings.py中指定它：

TEST_RUNNER = 'path.to.the.EndpointsDjangoRunner'

就是这样。如果您发现代码中有任何尴尬的错误，请告诉我。

Answer 2

晚宴，但这是我为Django测试输出HTML测试报告的解决方案。 （基于HtmlTestRunner cannot be directly used with Django DiscoverRunner）

以下类（如果放置在tests / html_test_reporter.py中，可以用作DiscoverRunner，并已修补为使用HTMLTestRunner。

from django.test.runner import DiscoverRunner
from HtmlTestRunner import HTMLTestRunner

class MyHTMLTestRunner(HTMLTestRunner):
    def __init__(self, **kwargs):
        # Pass any required options to HTMLTestRunner 
        super().__init__(combine_reports=True, report_name='all_tests', add_timestamp=False, **kwargs)

class HtmlTestReporter(DiscoverRunner):
    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        # Patch over the test_runner in the super class.
        html_test_runner = MyHTMLTestRunner
        self.test_runner=html_test_runner

然后运行：

python manage.py test -v 2 --testrunner tests.html_test_reporter.HtmlTestReporter

默认情况下，Django项目使用django.test.runner.DiscoverRunner来搜索测试，然后使用PyTest运行它们。 HTMLTestRunner可以与PyTest一起使用以输出HTML测试报告，但是似乎可以通过DiscoverRunner将PyTest配置为使用HTMLRunner。

希望这会有所帮助。