导航

pytest+jenkins+allure 生成测试报告发送邮件

Posted on 2021-03-12 15:14  Young哥哥  阅读(2190)  评论(0)  编辑  收藏  举报

更改记录

TIME Author Content
Young 新建

目录

前言

本次集成示意图

image.png

解释：

  1. 代码来自IDE、SVN、GIT、xCopy 此处我们用的IDE commit代码到 git(State)缓存区状态
  2. 多人协同的话merge代码到git(State), 否则直接 push 代码到中央仓库 (此处我们用Gitee)
  3. 如果推送成功，程序根据预先设置的webhook进行飞书机器人提醒
  4. jenkins有两种方式检测是否进行拉取代码进行构建
  • 自带的post build插件，自动检检测到代码有合并 ，trigger拉取事件进行CICD流程
  • 手工设置定时任务进行触发 ，即SchemeTask定时任务
  1. 构建成功，发送邮件到飞书邮箱
  2. 飞书邮箱里的URL地址链接打开链接到jenkins上关联的报告，报告能否打开取决于先前在jenkins上设置的权限认证，匿名用户配置具有查看Job 以及报告的权限

第一部分：Pycharm for Gitee

1. pycharm安装gitee插件

点击File

image.png

点击Settings...

弹出

image.png

点击Plugins

image.png

输入gitee，如下图

image.png

点击Search in repositories

弹出下图

image.png

点击Install（绿色的）

等待安装即可

然后到重新启动pycharm

image.png

看到上图的Checkout from Version Control下有Gitee

说明安装成功了

2. gitee关联本地Git

快速设置— 如果你知道该怎么操作，直接使用下面的地址

image.png

强烈建议所有的git仓库都有一个README, LICENSE, .gitignore文件

Git入门？查看 帮助 , Visual Studio / TortoiseGit / Eclipse / Xcode 下如何连接本站, 如何导入仓库

简易的命令行入门教程:

Git 全局设置:

git config --global user.name "Young"
git config --global user.email "vincentsys@yeah.net"

创建 git 仓库:

mkdir test
cd test
git init
touch README.md
git add README.md
git commit -m "first commit"
git remote add origin https://gitee.com/vincentsys/test.git
git push -u origin master

已有仓库 ?

cd existing_git_repo
git remote add origin https://gitee.com/vincentsys/test.git
git push -u origin master

3. Git关联远程仓库

一.本地安装GIT版本控制软件

img

二.配置Git,设置用户信息

git config --global user.name "Youngg"

git config --global user.email "vincentsys@yeah.net"

git config --list 获取Git配置信息

注意：git config命令的--global参数，用了这个参数，表示你这台机器上所有的Git仓库都会使用这个配置，当然也可以对某个仓库指定不同的用户名和Email地址。

三.Git连接远程仓库Gitee

  1. 在本地根据配置账户(user.name)生成密钥

命令: ssh-keygen -t rsa -C "vincentsys@yeah.net"

img

  1. 在GitHub里配置密钥

登录GitHub账户，在SSH keys里添加sshkey（打开.ssh文件下的 id_rsa.pub文件把密钥复制到Gitee ）

img

image-20210312111144846

  1. 检验是否链接上了github

img

The authenticity of host 'github.com (192.30.252.131)' can't be establis

RSA key fingerprint is 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48.

直接yes

img

连接成功!

四.本地远程仓库关联

  1. 在Gitee上创建仓库

img

img

  1. 本地创建仓库

img

  1. 本地仓库连接远程仓库

img

  1. 远程本地仓库同步

img

  1. 修改本地提交远程

    @1.添加文件

img

​ @2.把文件添加到版本库

第一步 git add 0701.txt ，命令git add告诉Git，把文件添加到仓库

img

第二步git commit -m 'first commit 命令git commit告诉Git，把文件提交到仓库，

-m后面输入的是本次提交的说明，可以输入任意内容，当然最好是有意义的，这样你就能从历史记录里方便地找到改动记录。

img

​ @3.把本地推送到远程

img

此时已提交到远程

img

常遇问题

img

img

第二部分：Jenkins for Gitee

（一）简介

Gitee Jenkins Plugin 是Gitee基于 GitLab Plugin 开发的 Jenkins 插件。用于配置 Jenkins 触发器，接受Gitee平台发送的 WebHook 触发 Jenkins 进行自动化持续集成或持续部署，并可将构建状态反馈回Gitee平台。

1. 目前支持特性：
  • 推送代码到Gitee时，由配置的 WebHook 触发 Jenkins 任务构建。
  • 评论提交记录触发提交记录对应版本 Jenkins 任务构建
  • 提交 Pull Request 到Gitee项目时，由配置的 WebHook 触发 Jenkins 任务构建，支持PR动作：新建，更新，接受，关闭，审查通过，测试通过。
  • 支持 [ci-skip] 指令过滤 或者 [ci-build] 指令触发构建。
  • 过滤已经构建的 Commit 版本，若是分支 Push，则相同分支Push才过滤，若是 PR，则是同一个PR才过滤。
  • 按分支名过滤触发器。
  • 正则表达式过滤可触发的分支。
  • 设置 WebHook 验证密码。
  • 构建后操作可配置 PR 触发的构建结果评论到Gitee对应的PR中。
  • 构建后操作可配置 PR 触发的构建成功后可自动合并对应PR。
  • 对于 PR 相关的所有事件，若 PR 代码冲突不可自动合并，则不触发构建；且若配置了评论到PR的功能，则评论到 PR 提示冲突。
  • PR 评论可通过 WebHook 触发构建（可用于 PR 触发构建失败是便于从Gitee平台评论重新触发构建）
  • 支持配置 PR 不要求必须测试时过滤触发构建。（可用于不需测试则不构建部署测试环境）
  • 支持相同 PR 触发构建时，取消进行中的未完成构建，进行当前构建（相同 PR 构建不排队，多个不同 PR 构建仍需排队）
2. 计划中特性
  1. PR 审查并测试通过触发构建（可用户触发部署，且可配合自动合并 PR 的特性完善工作流。）
  2. 勾选触发方式自动添加WebHook至Gitee。

（二）插件安装

  1. 在线安装
    • 前往 Manage Jenkins -> Manage Plugins -> Available
    • 右侧 Filter 输入： Gitee
    • 下方可选列表中勾选 Gitee（如列表中不存在 Gitee，则点击 Check now 更新插件列表）
    • 点击 Download now and install after restart

输入图片说明

  1. 手动安装
    • 从 release 列表中进入最新发行版，下载对应的 XXX.hpi 文件
    • 前往 Manage Jenkins -> Manage Plugins -> Advanced
    • Upload Plugin File 中选择刚才下载的 XXX.hpi 点击 Upload
    • 后续页面中勾选 Restart Jenkins when installation is complete and no jobs are running

输入图片说明

（三）插件配置

1. 添加Gitee链接配置

  1. 前往 Jenkins -> Manage Jenkins -> Configure System -> Gitee Configuration -> Gitee connections

  2. 在 Connection name 中输入 Gitee 或者你想要的名字

  3. Gitee host URL 中输入Gitee完整 URL地址： https://gitee.com （Gitee私有化客户输入部署的域名）

  4. Credentials 中如还未配置Gitee APIV5 私人令牌，点击 Add - > Jenkins

  5. Domain 选择 Global credentials

  6. Kind 选择 Gitee API Token

  7. Scope 选择你需要的范围
    4. Gitee API Token 输入你的Gitee私人令牌，获取地址：https://gitee.com/profile/personal_access_tokens

  8. ID, Descripiton 中输入你想要的 ID 和描述即可。

  9. Credentials 选择配置好的 Gitee APIV5 Token

  10. 点击 Advanced ，可配置是否忽略 SSL 错误（视您的Jenkins环境是否支持），并可设置链接测超时时间（视您的网络环境而定）

  11. 点击 Test Connection 测试链接是否成功，如失败请检查以上 3，5，6 步骤。

配置成功后如图所示：
Gitee链接配置

2. 新建构建任务

前往 Jenkins -> New Item , name 输入 'Gitee Test'，选择 Freestyle project 保存即可创建构建项目。

3. 任务全局配置

任务全局配置中需要选择前一步中的Gitee链接。前往某个任务（如'Gitee Test'）的 Configure -> General，Gitee connection 中选择前面所配置的Gitee链接，如图：

任务全局配置

4. 源码管理配置

前往某个任务（如'Gitee Test'）的 Configure -> Source Code Management 选项卡

  1. 点击 Git
  2. 输入你的仓库地址，例如
git@your.gitee.server:gitee_group/gitee_project.git
    • 点击 Advanced 按钮, Name 字段中输入 origin， Refspec 字段输入 +refs/heads/*:refs/remotes/origin/* +refs/pull/*/MERGE:refs/pull/*/MERGE
      ，注意新版jenkins不再接受多条同时包含 * 通配符的refs描述，如只对push触发可写前半部分，如只对PR触发可只写后半段。具体可见下图：输入图片说明

  1. 凭据Credentials 中请输入 git 仓库 https 地址对应的 用户名密码凭据，或者 ssh 对应的 ssh key 凭据，注意 Gitee API Token 凭据不可用于源码管理的凭据，只用于 gitee 插件的 API 调用凭据。

  2. Branch Specifier选项:

    1. 对于单仓库工作流输入: origin/${giteeSourceBranch}

  3. 对于 PR 工作流输入: pull/${giteePullRequestIid}/MERGE

  4. Additional Behaviours选项：

  5. 对于单仓库工作流，如果你希望推送的分支构建前合并默认分支（发布的分支），可以做以下操作：
    2. 点击 Add 下拉框

    1. 选择 Merge before build
    2. 设置 Name of repository 为 origin
      1. 设置 Branch to merge to 为 ${ReleaseBranch} 即您要合并的默认分支（发布分支）
    3. 对于 PR 工作流，Gitee服务端已经将 PR 的原分支和目标分支作了预合并，您可以直接构建，如果目标分支不是默认分支（发布分支），您也可以进行上诉构建前合并。

配置如图所示：

源码管理配置

5. 触发器配置

前往任务配置的触发器构建： Configure -> Build Triggers 选项卡

  1. Enabled Gitee triggers 勾选您所需要的构建触发规则，如 Push Event, Opened Merge Request Events，勾选的事件会接受WebHook，触发构建。目前支持触发事件有：
  • Push Events ：推送代码事件
  • Commit Comment Events ：评论提交记录事件
  • Opened Merge Request Events ：提交 PR 事件
    • Updated Merge Request Events ：更新 PR 事件
  • Accepted Merge Request Events ：接受/合并 PR 事件
    • Closed Merge Request Events ：关闭 PR 事件
  • Approved Pull Requests ： 审查通过 PR 事件
    • Tested Pull Requests ：测试通过 PR 事件
  1. Build Instruction Filter :
  • None : 无过滤
  • [ci-skip] skip build ：commit message 或者 PR 说明包含 [ci-skip] 时，跳过构建触发。
  • [ci-build] trigger build ：commit message 或者 PR 说明包含 [ci-build] 时，触发构建。

  1. Ignore last commit has build 该选项可以跳过已经构建过的 Commit 版本。

  2. Cancel incomplete build on same Pull Requests 该选项在 PR 触发构建时，会判断是否存在相同 PR 且未完成的构建，有则取消未完成构建，再进行当前构建。

  3. Ignore Pull Request conflicts 该选项在 PR 触发构建时，会根据 PR 冲突情况选择是否进行构建。

  4. Allowed branches 可以配置允许构建的分支，目前支持分支名和正则表达式的方式进行过滤。

  5. Secret Token for Gitee WebHook 该选项可以配置 WebHook 的密码，该密码需要与Gitee WebHook配置的密码一致方可触发构建。

  6. 注意：若 PR 状态为不可自动合并，则不触发构建。
    触发器配置

6. 构建后步骤配置

前往任务配置的构建后配置： Configure -> Post-build Actions 选项卡

7. 构建结果回评至Gitee

  1. 点击 Add post-build action 下拉框选择：Add note with build status on Gitee pull requests

  2. Advanced 中可以配置：

  • Add message only for failed builds ：仅为构建失败回评到Gitee
  • 自定义各状态的回评内容（内容可以引用 Jenkins 的环境变量，或者自定义的环境变量）
  1. 若开启该功能，还可将不可自动合并的状态回评至Gitee
8. 构建成功自动合并PR

点击 Add post-build action 下拉框选择：Accept Gitee pull request on success

构建后步骤配置

9. 新建Gitee项目WebHook

进入源码管理配置中设置的Gitee项目中，进入 管理 -> WebHooks

  1. 添加 WebHook， URL 填写 触发器配置：Build when a change is pushed to Gitee. Gitee webhook URL 中所示 URL，如：: http://127.0.0.1:8080/jenkins/project/fu
  2. 密码填写：触发器配置第 5 点中配置的 WebHook密码，不设密码可以不填
  3. 勾选 PUSH， Pull Request
10. 测试推送触发构建
  1. Gitee的 WebHook 管理中选择勾选了PUSH的 WebHook 点击测试，观察 Jenkins 任务的构建状态
  2. Gitee项目页面编辑一个文件提交，观察 Jenkins 任务的构建状态
11. 测试PR触发构建
  1. Gitee的 WebHook 管理中选择勾选了 Pull Request 的 WebHook 点击测试，观察 Jenkins 任务的构建状态
  2. 在Gitee项目中新建一个Pull Request，观察 Jenkins 任务的构建状态

（四）环境变量

目前支持环境变量见以下函数，其中不同的 WebHook 触发可能导致有些变量为空，具体请安装插件 EnvInject Plugin，于构建中查看 Environment Variables

    public Map<String, String> getBuildVariables() {
        MapWrapper<String, String> variables = new MapWrapper<>(new HashMap<String, String>());
        variables.put("giteeBranch", branch);
        variables.put("giteeSourceBranch", sourceBranch);
        variables.put("giteeActionType", actionType.name());
        variables.put("giteeUserName", userName);
        variables.put("giteeUserEmail", userEmail);
        variables.put("giteeSourceRepoHomepage", sourceRepoHomepage);
        variables.put("giteeSourceRepoName", sourceRepoName);
        variables.put("giteeSourceNamespace", sourceNamespace);
        variables.put("giteeSourceRepoURL", sourceRepoUrl);
        variables.put("giteeSourceRepoSshUrl", sourceRepoSshUrl);
        variables.put("giteeSourceRepoHttpUrl", sourceRepoHttpUrl);
        variables.put("giteePullRequestTitle", pullRequestTitle);
        variables.put("giteePullRequestDescription", pullRequestDescription);
        variables.put("giteePullRequestId", pullRequestId == null ? "" : pullRequestId.toString());
        variables.put("giteePullRequestIid", pullRequestIid == null ? "" : pullRequestIid.toString());
        variables.put("giteePullRequestTargetProjectId", pullRequestTargetProjectId == null ? "" : pullRequestTargetProjectId.toString());
        variables.put("giteePullRequestLastCommit", lastCommit);
        variables.put("giteePushCreated", created ? "true" : "false");
        variables.put("giteePushDeleted", deleted ? "true" : "false");
        variables.putIfNotNull("giteePullRequestState", pullRequestState);
        variables.putIfNotNull("giteeMergedByUser", mergedByUser);
        variables.putIfNotNull("giteePullRequestAssignee", pullRequestAssignee);
        variables.put("giteeTargetBranch", targetBranch);
        variables.put("giteeTargetRepoName", targetRepoName);
        variables.put("giteeTargetNamespace", targetNamespace);
        variables.put("giteeTargetRepoSshUrl", targetRepoSshUrl);
        variables.put("giteeTargetRepoHttpUrl", targetRepoHttpUrl);
        variables.put("giteeBefore", before);
        variables.put("giteeAfter", after);
        variables.put("giteeBeforeCommitSha", before);
        variables.put("giteeAfterCommitSha", after);
        variables.put("giteeRef", ref);
        variables.put("ref", ref);
        variables.put("beforeSha", beforeSha);
        variables.put("isTag", isTag);
        variables.put("sha", sha);
        variables.put("status", status);
        variables.put("stages", stages);
        variables.put("createdAt", createdAt);
        variables.put("finishedAt", finishedAt);
        variables.put("duration", buildDuration);
        variables.put("jsonBody", jsonBody);
        variables.put("noteBody", noteBody);
        variables.putIfNotNull("giteeTriggerPhrase", triggerPhrase);
        return variables;
    }

（五）打包或运行测试

打包 hpi 文件在仓库目录中执行： mvn package

直接运行测试执行：mvn hpi:run

第三部分：jenkins构建APIAutomation项目

1.基础环境配置

  • 安装allure-report插件

  • JDK配置

    参考上一章jenkins关联jmeter自动化部署教程

  • git配置

    参考上一章jenkins关联jmeter自动化部署教程

  • allure配置

    Manage Jenkisn -> 全局工具配置 ，配置如下图所示

    image.png

  • gitee配置

    1. Manage Jenkins -> 系统配置，配置如下图所示

      image.png

    2. 配置全局凭证：选择Gitee API令牌

      image.png

    3. Gitee API 令牌生成，登录gitee ->设置->私人令牌->生成

      image-20220714163353625将如上生成的令牌粘贴进入测试如下所示成功

      image.png

  • 全局属性配置

    Manage Jenkins -> 系统配置->全局属性，配置如下图所示

    image.png

  • 字符编码配置

    1. Manage Jenkins -> 系统配置->全局属性

      image.png

    2. Mange Jenkins -> Manage Nodes and Clouds

      image.png

      image-20220714163538759配置jenkins 启动文件

      添加如下内容:

      -Dhudson.model.DirectoryBrowserSupport.CSP= -Dfile.encoding=UTF-8 -Dsun.jnu.encoding=UTF-8

      image-20220714165833584

    3. 配置服务器环境变量

      设置jenkins所在服务器环境变量,右键我的电脑→属性→高级系统设置→环境变量，添加JAVA_TOOL_OPTIONS

      image.png

    4. CMD配置

      chcp 65001

      在命令行标题栏上点击右键，选择"属性"->"字体"，将字体修改为True Type字体"Lucida Console"

2. 构建项目

源码管理

image.png

配置凭证

image.png

所有配置的凭证在首页均可查看

image.png

构建触发器

image-20220714163639211生成的webhook钩子程序复制生成的密码粘贴到Gitee 项目 ->管理 ->

image.png

image-20220714163755061

构建

image-20210312132854385

PATH=$PATH;D:\user\local\Python\Python38-32\Scripts
PATH=$PATH;D:\user\local\Python\Python38-32\Scripts
xcopy  /y /c /h /r /s  APIAutomatormation  D:\user\workspace\py_workspace\APIAutomatormation\
cd /d  D:/user/workspace/py_workspace/APIAutomatormation
pytest -s -q --alluredir result
rem D:\user\local\allure-2.13.8\bin\allure.bat generate   result  -o  report --clean
rem xcopy /y/c/h/r/s report C:\Windows\System32\config\systemprofile\AppData\Local\Jenkins\.jenkins\workspace\APIAutomatormation\report
exit 0

构建后操作：添加Allure报告

image-20220714163822839第三部分：jenkins构建APIAutomation项目点击高级

image.png

构建后操作：邮件通知

image.png

image.png

邮件模板完整内容：

image.png

image.png

成功填写完成，build无误后 jenkins上会看到如下结果：

image.png

邮件成功通知：

image.png

邮件模板完整内容如下:

<!DOCTYPE html>
<html lang="en">
<body leftmargin="8" marginwidth="0" topmargin="8" marginheight="4" offset="0">
    <table width="95%" cellpadding="0" cellspacing="0"  style="font-size: 11pt; font-family: Tahoma, Arial, Helvetica, sans-serif">
        <tr>
              测试邮件，无需回复！<br/>
             各位同事，大家好，以下为${PROJECT_NAME }项目构建信息</br>
             <h4><font color="red">allure报告在线查看or下载allure-report.zip用firefox离线查看，测试用例见附件</font></h4>
             <h2>在线图表测试报告：<br/>
             <a HREF="${PROJECT_URL}${BUILD_NUMBER}/allure">${PROJECT_URL}${BUILD_NUMBER}/allure</a><h2>
            
        </tr>
        <tr>
            <td><br/>
            <b><font color="#0B610B">项目描述：${JOB_DESCRIPTION}<br></font></b>
            <hr size="2" width="100%" align="center" /></td>
        </tr>
        <tr>
            <td>
                <ul>
                    <li>项目名称 ： ${PROJECT_NAME}</li>
                    <li>构建编号 ： 第${BUILD_NUMBER}次构建</li>
                    <li>SVN 版本： ${SVN_REVISION}</li>
                    <li>触发原因： ${CAUSE}</li>
                    <li>构建状态： ${BUILD_STATUS}</li>
                    <li>构建日志： <a href="${BUILD_URL}console">${BUILD_URL}console</a></li>
                    <li>构建  Url ： <a href="${BUILD_URL}">${BUILD_URL}</a></li>
                    <li>工作目录 ： <a href="${PROJECT_URL}ws">${PROJECT_URL}ws</a></li>
                    <li>项目  Url ： <a href="${PROJECT_URL}">${PROJECT_URL}</a></li>
                    <li>系统allure测试报告：<a HREF="${PROJECT_URL}${BUILD_NUMBER}/allure">${PROJECT_URL}${BUILD_NUMBER}/allure</a><li>
                </ul>
　　　　</td>
        <tr>
　　　　     <td>
            <b><font color="#0B610B">构建日志 (最后 100行):</font></b>
　　　　    <hr size="2" width="100%" align="center" />
            </td>
        </tr>
        <tr>
　          <td>
                <textarea cols="80" rows="30" readonly="readonly" style="font-family: Courier New">${BUILD_LOG, maxLines=100}</textarea>
            </td>
        </tr>
        ${JELLY_SCRIPT}
    </table>
</body>
</html>

第四部分：采坑记录

一. 本地测试通过，上传代码等到gitee服务器运行到jenkins主机，出现如下目录or路径不存在

image.png

本地排查思路：

  1. 看到有 unucodeescape 错误，开始以为乱码导致，然后在每个文件头加字符编码配置# _*_ coding:utf-8 _*_ 之后发现不可用

  2. 看到提示No such file or directory ：在本机排查发现该文件在当前目录存在，但是就是为何找不到，怀疑是sys.path没有将当前项目路径添加到 PYTHONPATH当中，修改代码如下：

execFilePath = os.path.dirname(__file__) + '/testcase'
# 追加logging
# D:\user\workspace\py_workspace\APIAutomationFramework\testcase
# execfile = execFilePath + '/test_API.py'

# execfile = r'D:/user/workspace/py_workspace/APIAutomationFramework/testcase/test_API.py'
#此处修改为绝对路径
execfile = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'testcase', 'test_API.py')
python_install_cmd = os.path.join(sys.path[10], 'python.exe')
os.system("python " + execfile)

之后发现仍然不可用 ，

  1. 定位代码logUtils类， 怀疑该行代码有问题

image.png

查看对应的源码解析，排查到 **os.path.dirname(__file__)**引用相对路径的问题，查询结果如下

python3 获取当前路径及os.path.dirname的使用

方法一：

    import sys,os
    os.getcwd()#然后就可以看见结果了

方法二：

import os
os.path.dirname(os.path.realpath('__file__'))#注意：添加单引号

python中的os.path.dirname(file)的使用

(1)当"print os.path.dirname(file)"所在脚本是以完整路径被运行的， 那么将输出该脚本所在的完整路径，比如：


python d:/pythonSrc/test/test.py

那么将输出 d:/pythonSrc/test

(2)当"print os.path.dirname(file)"所在脚本是以相对路径被运行的， 那么将输出空目录，比如：

python test.py

那么将输出空字符串
python中的os.path.dirname(path)

语法：os.path.dirname(path)
功能：去掉文件名，返回目录
如：

print(os.path.dirname('W:\Python_File\juan之购物车.py'))
#结果
#W:\Python_File
print(os.path.dirname('W:\Python_File'))
#结果
#W:\

参考博客：https://www.cnblogs.com/yuehouse/p/12028368.html

然后并没有卵用， 再次排查

  1. 定位到可能是否由于fileConfig(p) 加载参数配置只能以windows环境下“\” 标识，查阅相关资料如下

首先，"/"左倾斜是正斜杠,""右倾斜是反斜杠,可以记为：除号是正斜杠一般来说对于目录分隔符，Unix和Web用正斜杠/，Windows用反斜杠，但是现在Windows 不限制，都可使用

（一）目录中的斜杠们

python读文件需要输入的目录参数，列出以下例子：

path = r"C:\Windows\temp\readme.txt"

path1 = r"c:\windows\temp\readme.txt"

path2 = "c:\\windows\\temp\\readme.txt"

path3 = "c:/windows/temp/readme.txt"

打开文件函数open()中的参数可以是path也可以是path1、path2、path3。

​

path：""为字符串中的特殊字符，加上r后变为原始字符串，则不会对字符串中的"\t"、"\r" 进行字符串转义

path1：大小写不影响windows定位到文件

path2：用一个""取消第二个""的特殊转义作用，即为"\"

path3：用正斜杠做目录分隔符也可以转到对应目录，并且在python中path3的方式也省去了反斜杠\转义的烦恼

（二）正则表达式中的斜杠们

正则表达式匹配反斜杠"\"，为什么是"\\\\"或是 r"\\"呢？

因为在正则表达式中\为特殊符号，为了取消它在正则表达式中的特殊意义需要加一个\就变成了\\，但是问题又来了，\也是字符串中的特殊字符，所以又要分别对两个\取消其特殊意义，即为\\\\。Python中有一个原始字符串操作符，用于那些字符串中出现特殊字符，在原始字符串中，没有转义字符和不能打印的字符。这样就可以取消了\在字符串中的转义功能，即r"\\"。

然而仍然没有卵用 ，

  1. 最后排查到最后一行代码：

image-20220714165406405定位该行问题发现，该文件只有配置文件引用，在logging.conf 下

的确由于该路径被找不到，目前很疑惑根本原因暂未找到同样是windows操作环境，换台机器就无法操作，很让人疑惑，总之更改为项目路径好使

二. 本地测试，生成的报告单独在桌面直接用index打开数据无法加载，但是在IDE里可以

显示如下情况：

image-20220714165425556处于loading状态，说明有数据只是没法加载出来

问题解决

  • 其实在allure-report下index.html文件是不能直接打开的，出现页面都是loading的情况，这是因为直接allure报告用浏览器是打不开的，需要用allure命令渲染之后打开才能展示效果（allure常识）。

  • allure使用了两种方式来渲染页面。分别是 allure open 和 allure serve。前者用于在本地渲染和查看结果，后者用于在本地渲染后对外展示结果。这里我们使用allure open。运行命令

allure open allure-report目录

image-20220714165438263
即可自动打开浏览器展示渲染好的结果。这里的allure-report为allure generate生成的结果所在目录。

三. 集成到jenkins上发现结果无数据

这里有两两种场景：1. 一种是无数据 2. 一种是有数据只不过处于loading状态加载不出来

目前处于第1种结果：具体表现形式如下：

image-20220714165454201排查可能原因：

  1. 首先明确 pytest生成的数据默认在allure-result目录下，这里我更改了result目录，通过本地的IDE和cmd命令行发现没有问题，那么只能是jenkins windows Execute shell命令行有问题

    命令行内容如下

   xcopy  /y /c /h /r /s  APIAutomatormation  D:\user\workspace\py_workspace\APIAutomatormation\
   cd /d  D:/user/workspace/py_workspace/APIAutomatormation
   python run_main.py 
   exit 0

之后发现，是压根''python run_main.py '' 压根就没有执行，估计是jenkins内部没有识别python变量，手工添加python执行路径：

$PYTHON_PATH\python.exe run_main.py

发现执行到一半又不能执行了：

定位到如下位置：

image-20220714165513401发现代码里又引用了相对路径，再次添加绝对路径进行执行该命令，console控制乱码错误显示如下：

image-20220714165530803估计问题不在这里，再次查询Google， 查到原来jenkins集成allure执行的时候是不需要手工执行生成报告的，查看会自动帮你做

  1. 再次更改执行命令如下：
   PATH=$PATH;D:\user\local\Python\Python38-32\Scripts
   PATH=$PATH;D:\user\local\Python\Python38-32\Scripts
   xcopy  /y /c /h /r /s  APIAutomatormation  D:\user\workspace\py_workspace\APIAutomatormation\
   cd /d  D:/user/workspace/py_workspace/APIAutomatormation
   pytest -s -q --alluredir result
   D:\user\local\allure-2.13.8\bin\allure.bat generate   result  -o  report --clean
   exit 0

运行之后发现仍然没有数据，并且pytest -s -q --alluredir result 这行命令似乎没有执行 ，发现pytest找不到该命令，实际path已经配置了python环境变量 ， 手工将pytest所在目录也添加到path环境变量中，显示如下：

image-20220714165548399终于pytest可以执行了，但是report没有结果数据,查看jenkins console发现 取的report是工作空间目录的结果report数据 ， 于是手工复制生成的报告拷贝到jenkins工作空间当中

命令行变为如下

   xcopy  /y /c /h /r /s  APIAutomatormation/report  C:\Windows\System32\config\systemprofile\AppData\Local\Jenkins\.jenkins\workspace\APIAutomatormation\report

然而很坑爹并没有卵用

  1. 再次查看result路径，发现其实生成了 result是有数据的，只不过没有体现在report里，原来jenkins 不用你手工生成报告，插件会自动帮你生成，最后一步取消 ；完整结果显示如下：
   PATH=$PATH;D:\user\local\Python\Python38-32\Scripts
   PATH=$PATH;D:\user\local\Python\Python38-32\Scripts
   xcopy  /y /c /h /r /s  APIAutomatormation  D:\user\workspace\py_workspace\APIAutomatormation\
   cd /d  D:/user/workspace/py_workspace/APIAutomatormation
   pytest -s -q --alluredir result
   exit 0

完美解决

最后构建后操作生成报告的地方一定要注意 result 和 report填写路径要正确，否则数据仍然不会展示的

image-20220714165602647

Ending....