Allure Pytest 项目启动与配置教程

Allure Pytest 项目启动与配置教程

allure-pytest Deprecated, please use https://github.com/allure-framework/allure-python instead 项目地址: https://gitcode.com/gh_mirrors/al/allure-pytest

1. 项目目录结构及介绍

Allure Pytest 项目的主要目录结构如下：

allure-pytest/
├── allure            # 存放 Allure 相关的资源和文件
├── demo              # 示例代码和测试用例
├── tests             # 测试用例目录
├── .coveragerc       # coverage 配置文件
├── .gitignore        # git 忽略文件
├── .travis.yml       # Travis CI 配置文件
├── LICENSE           # 许可证文件
├── MANIFEST.in       # 打包配置文件
├── README.rst        # 项目说明文件
├── setup.py          # 项目安装和打包脚本
├── tox.ini           # tox 测试配置文件

• allure 目录包含与 Allure 报告生成相关的资源。
• demo 目录包含一些示例代码和测试用例，用于演示 Allure Pytest 的使用。
• tests 目录包含项目的单元测试用例。
• .coveragerc 是 coverage 工具的配置文件，用于测量代码覆盖率。
• .gitignore 指定 git 应该忽略的文件和目录。
• .travis.yml 是用于配置 Travis CI 持续集成服务的文件。
• LICENSE 包含项目的许可证信息。
• MANIFEST.in 指定在打包项目时应该包括的文件和目录。
• README.rst 包含项目的详细说明。
• setup.py 用于安装和打包项目。
• tox.ini 配置 tox，一个用于运行测试的自动化工具。

2. 项目的启动文件介绍

项目的启动主要是通过 setup.py 文件来进行的。这个文件定义了如何安装和卸载项目，以及如何打包项目以便分发。

from setuptools import setup, find_packages

setup(
    name='allure-pytest',
    version='1.7.10',
    packages=find_packages(),
    # 项目的依赖
    install_requires=[
        'pytest',
        'allure-python'
    ],
    # 指定入口点
    entry_points={
        'pytest11': [
            'allure = allure_pytest.plugin',
        ],
    },
    # 其他元数据
    author='Allure Framework Team',
    author_email='dev@allure-framework.org',
    description='Pytest plugin for Allure Report',
    long_description=open('README.rst').read(),
    license='Apache License 2.0',
    keywords='pytest allure testing report',
    url='https://github.com/allure-framework/allure-pytest',
)

3. 项目的配置文件介绍

项目的配置主要通过 pytest 配置文件和 tox 配置文件来进行。

• pytest 配置文件通常是 pytest.ini，tox.ini 或者 pyproject.toml。这里并没有直接提供 pytest.ini，但是可以在项目根目录创建一个来配置 pytest。例如：

[pytest]
# 添加任何 pytest 配置
addopts = -v

• tox.ini 文件用于配置 tox，一个自动化测试的环境管理工具。它允许你测试多个 Python 版本和其他配置，而无需手动设置环境。例如：

[tox]
envlist = py27, py35, py36

[testenv]
deps =
    pytest
    allure-python
commands =
    pytest

在 tox.ini 中，我们定义了要测试的 Python 环境列表，并为每个环境指定了依赖和要运行的命令。

allure-pytest Deprecated, please use https://github.com/allure-framework/allure-python instead 项目地址: https://gitcode.com/gh_mirrors/al/allure-pytest