SensoroApiAutoTest/conftest.py

# !/usr/bin/python
# -*- coding:utf-8 -*-
# @Time : 2022/5/24 18:11
# @Author : wangjie
# @File : conftest.py
# @project : SensoroApi
import json
import os.path
import platform
import shutil
import time

import pytest
from py.xml import html

from common.robot_sender import RobotSender
from common.settings import ENV
from configs.dir_path_config import BASE_DIR
from configs.lins_environment import EntryPoint


def pytest_sessionstart():
    """在整个pytest运行过程开始之前设置allure报告的环境变量信息"""
    allure_env = {
        'OperatingEnvironment': ENV.name,
        'BaseUrl': EntryPoint.URL(),
        'PythonVersion': platform.python_version(),
        'Platform': platform.platform(),
        'PytestVersion': pytest.__version__,
    }
    allure_env_file = os.path.join(BASE_DIR, 'environment.properties')
    with open(allure_env_file, 'w', encoding='utf-8') as f:
        for _k, _v in allure_env.items():
            f.write(f'{_k}={_v}\n')


def pytest_sessionfinish(session, exitstatus):
    """运行完成后生成allure报告文件，再将本地启动方式放入该目录下"""
    # allure报告展示environment时所需要的数据，这里是在项目根路径下创建的environment.properties文件拷贝到allure-report报告中,保证环境文件不会被清空
    shutil.copy(BASE_DIR + '/environment.properties', BASE_DIR + '/Temp/environment.properties')
    # allure报告展示运行器时所需要的数据
    shutil.copy(BASE_DIR + '/executor.json', BASE_DIR + '/Temp/executor.json')
    # 使用allure generate -o 命令将./Temp目录下的临时报告导出到TestReport目录
    os.system(f'allure generate {BASE_DIR}/Temp -o {BASE_DIR}/outFiles/report --clean')
    # 将本地启动脚本和查看allure报告方法放入报告目录下面
    shutil.copy(BASE_DIR + '/open_report.sh', BASE_DIR + '/outFiles/report/open_report.sh')
    shutil.copy(BASE_DIR + '/查看allure报告方法', BASE_DIR + '/outFiles/report/查看allure报告方法')


def pytest_collection_modifyitems(items) -> None:
    """解决控制台用例参数化中文编码问题"""
    # 会使pytest-html报告里面的中文乱码，需要去手动改一下pytest-html源码即可
    # item表示每个测试用例，解决用例名称中文显示问题
    for item in items:
        item.name = item.name.encode("utf-8").decode("unicode-escape")
        item._nodeid = item._nodeid.encode("utf-8").decode("unicode-escape")


def pytest_configure(config):
    """修改pytest-html报告中Environment项目展示的信息"""
    # 添加项目名称
    config._metadata["项目名称"] = "lins接口自动化测试"
    # 删除Java_Home
    config._metadata.pop("JAVA_HOME")
    # 删除Plugins
    config._metadata.pop("Plugins")


@pytest.mark.optionalhook
def pytest_html_results_summary(prefix):
    """修改pytest-html报告中添加summary内容"""
    prefix.extend([html.p("所属部门: 测试组")])
    prefix.extend([html.p("测试人员: 汪杰")])


@pytest.mark.optionalhook
def pytest_html_results_table_header(cells):
    """pytest-html报告中表头添加Description"""
    cells.insert(1, html.th('Description'))  # 表头添加Description
    cells.pop(-1)  # 删除link


@pytest.mark.optionalhook
def pytest_html_results_table_row(report, cells):
    """修改pytest-html报告中表头Description对应的内容为测试用例的描述"""
    cells.insert(1, html.td(report.description))  # 表头对应的内容
    cells.pop(-1)  # 删除link列


# 收集用例
pytest_result = {
    "case_pass": 0,
    "case_fail": 0,
    "case_skip": 0,
    "case_error": 0,
    "case_count": 0
}


@pytest.mark.hookwrapper
def pytest_runtest_makereport(item, call):  # description取值为用例说明__doc__
    """获取测试结果、生成测试报告"""
    outcome = yield
    report = outcome.get_result()
    # 修改pytest-html报告中description取值为用例说明__doc__
    report.description = str(item.function.__doc__)

    with open(BASE_DIR + '/outFiles/pytest_result/pytest_result.json', 'w', encoding='utf-8') as f:
        if report.when == 'call':
            # print(f"测试报告：{report}")
            # print(f"步骤：{report.when}")
            # print(f"用例id：{report.nodeid}")
            # print(f"用例描述：{str(item.function.__doc__)}")
            # print(f"运行结果：{report.outcome}")
            if report.outcome == 'passed':
                pytest_result["case_pass"] += 1
            elif report.outcome == 'failed':
                pytest_result["case_fail"] += 1
            elif report.outcome == 'skipped':
                pytest_result["case_skip"] += 1
            elif report.outcome == 'errored':
                pytest_result["case_error"] += 1
        if report.when == 'setup':
            if report.outcome == 'skipped':
                pytest_result["case_skip"] += 1
        pytest_result["case_count"] = pytest_result["case_pass"] + pytest_result["case_fail"] + pytest_result[
            "case_skip"] + pytest_result["case_error"]

        # 将用例执行结果写入文件
        f.write(f'{json.dumps(pytest_result)}')


def pytest_terminal_summary(terminalreporter, exitstatus, config):
    """收集测试结果展示在控制台，并发送到企业微信"""
    with open(BASE_DIR + '/outFiles/pytest_result/pytest_result.json', 'r', encoding='utf-8') as f:
        pytest_result = json.loads(f.read())
        total_case = pytest_result['case_count']
        pass_case = pytest_result["case_pass"]
        fail_case = pytest_result["case_fail"]
        skip_case = pytest_result["case_skip"]
        error_case = pytest_result["case_error"]
        pass_rate = round((pass_case + skip_case) / total_case * 100, 2)
        run_time = round((time.time() - terminalreporter._sessionstarttime), 2)
    print("******用例执行结果统计******")
    print(f"总用例数：{total_case}条")
    print(f"通过：{pass_case}条")
    print(f"失败：{fail_case}条")
    print(f"跳过：{skip_case}条")
    print(f"报错：{error_case}条")
    print(f"用例通过率：{pass_rate}%")
    print(f"用时：{run_time}s")
    desc = f"""
本次执行情况如下：
总用例数为：<font color=\"info\">{total_case}条</font>
通过用例数为：<font color=\"info\">{pass_case}条</font>
失败用例数为：<font color=\"warning\">{fail_case}条</font>
错误用例数为：<font color=\"warning\">{error_case}条</font>
跳过用例数为：<font color=\"comment\">{skip_case}条</font>
通过率为：<font color=\"info\">{pass_rate}%</font>
用时为：<font color=\"info\">{run_time}s</font>
"""
    # 执行结果发送企业微信
    # RobotSender.send_enterprise_wechat(
    #     'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=50ab5cc5-7b5d-4ed0-a95b-ddd5daeeec5c', desc)

# @pytest.mark.optionalhook
# def pytest_html_results_table_html(report, data):
#     """"pytest-html报告中清除执行成功的用例logs"""
#     if report.passed:
#         del data[:]
#         data.append(html.div('pass用例不展示日志', class_='empty log'))