allure安装pycharm
时间: 2024-12-26 13:18:36 浏览: 8
### 安装和配置 Allure 生成测试报告
#### 使用 pip 安装 `allure-pytest` 插件
为了使 PyTest 能够与 Allure 集成并生成详细的测试报告,需通过 Python 的包管理工具 pip 来安装特定插件。
```bash
pip install allure-pytest
```
此命令会下载并安装必要的库来支持 Allure 报告功能[^2]。
#### 设置 PyCharm 默认测试运行器
确保 PyCharm 正确识别所使用的测试框架非常重要。如果默认设置不是 pytest,则可能无法正常工作或不会触发 Allure 报告的创建过程。
进入 PyCharm 的首选项/设置界面,在导航栏中依次点击 File -> Settings (对于 macOS 用户则是 PyCharm -> Preferences),找到 Tools 下面的 "Python Integrated Tools" 选项卡,将 Default test runner 更改为 `pytest`[^3]。
#### 编写带有 Allure 注解的测试案例
编写测试脚本时可以加入一些特殊的装饰器或者方法调用来增强最终生成的 HTML 报表的信息量。比如:
```python
import allure
import pytest
@allure.title('这是一个简单的加法函数')
def add(a, b):
return a + b
@pytest.mark.parametrize("a,b,expected", [
(1, 2, 3),
(-1, -1, -2),
])
@allure.feature('算术运算')
@allure.story('验证基本数学操作')
def test_addition(a, b, expected):
assert add(a, b) == expected
```
上述代码片段展示了如何利用 @allure.* 系列标签为测试用例添加元数据描述[^1]。
#### 执行测试并指定保存位置
当准备就绪之后就可以执行测试了。此时应该告诉 PyTest 将收集到的结果存储在哪里以便后续处理。这可以通过向 pytest.main() 函数传递参数实现:
```python
if __name__ == "__main__":
pytest.main(['-s', '--alluredir=./report/result', './tests/test_sample.py'])
```
这里 `-s` 参数允许显示标准输出流中的打印信息;而 `--alluredir=...` 则指定了结果目录的位置;最后跟的是要被执行的具体测试模块路径。
#### 生产可视化报表
完成以上步骤后,还需要借助额外工具——Allure Commandline 来解析之前产生的 JSON 文件并将它们转换成为美观易读的网页形式展示出来。可以从官方网站获取适合操作系统版本的二进制文件,并按照说明文档完成本地部署。一旦准备好环境变量配置,只需简单输入如下指令即可查看最新一轮 CI 流水线上的质量概况:
```bash
allure serve ./report/result/
```
这条命令会在浏览器里打开一个临时服务器实例,提供交互式的仪表板让用户浏览各个维度下的统计数据概览图以及单个 case 的详情页链接等资源。
阅读全文