Python Unit Test Reporting to TeamCity 技术文档

本文档旨在帮助用户了解如何使用 teamcity-messages 项目，将 Python 单元测试结果报告到 TeamCity 持续集成服务器。文档内容包括安装指南、使用说明、API 使用文档以及项目安装方式。

1. 安装指南

使用 pip 安装

你可以通过 pip 命令安装 teamcity-messages 包：

pip install teamcity-messages

从源码安装

你也可以从源码安装该项目：

python setup.py install

2. 项目的使用说明

teamcity-messages 包通过发送服务消息来向 TeamCity 报告构建状态。以下是如何在不同测试框架中使用该包的说明。

unittest

如果你使用 Python 自带的 unittest 框架，可以通过修改测试运行器来集成 TeamCity 报告功能：

import unittest
from teamcity import is_running_under_teamcity
from teamcity.unittestpy import TeamcityTestRunner

class Test(unittest.TestCase):
    ...

if __name__ == '__main__':
    if is_running_under_teamcity():
        runner = TeamcityTestRunner()
    else:
        runner = unittest.TextTestRunner()
    unittest.main(testRunner=runner)

你也可以在命令行中使用以下命令来运行测试：

python -m teamcity.unittestpy

nose

在 TeamCity 构建环境下，nose 的测试状态报告会自动启用。

py.test

在 TeamCity 构建环境下，py.test 的测试状态报告会自动启用。

Django

对于 Django 1.6+，你可以在 settings.py 中修改 TEST_RUNNER 设置，使用 TeamcityDjangoRunner 替代默认的 DiscoverRunner：

TEST_RUNNER = "teamcity.django.TeamcityDjangoRunner"

flake8

在 TeamCity 构建环境下，flake8 的测试状态报告会自动启用。

PyLint

在运行 pylint 时，添加 --output-format=teamcity.pylint_reporter.TeamCityReporter 参数：

pylint --output-format=teamcity.pylint_reporter.TeamCityReporter

tox

在 tox 的测试虚拟环境中传递 TEAMCITY_VERSION 环境变量：

[testenv]
passenv = TEAMCITY_VERSION

Twisted trial

在运行 trial 时，添加 --reporter=teamcity 参数：

trial --reporter=teamcity

Behave

对于 Behave 1.2.6，你可以通过以下代码启用 TeamCity 报告：

from behave.formatter import _registry
from behave.configuration import Configuration
from behave.runner import Runner
from teamcity.jb_behave_formatter import TeamcityFormatter

_registry.register_as("TeamcityFormatter", TeamcityFormatter)
configuration = Configuration()
configuration.format = ["TeamcityFormatter"]
configuration.stdout_capture = False
configuration.stderr_capture = False
Runner(configuration).run()

3. 项目 API 使用文档

teamcity-messages 提供了以下主要 API：

• is_running_under_teamcity(): 检查当前是否在 TeamCity 环境下运行。
• TeamcityTestRunner: 用于 unittest 框架的测试运行器。
• TeamcityDjangoRunner: 用于 Django 的测试运行器。
• TeamcityFormatter: 用于 Behave 的格式化器。

4. 项目安装方式

使用 pip 安装

pip install teamcity-messages

从源码安装

python setup.py install

通过以上步骤，你可以成功安装并使用 teamcity-messages 包，将 Python 单元测试结果报告到 TeamCity 持续集成服务器。