cypress-allure(Api说明)
目录
- cy.allure常用方法:
- cy.logStep(name)/cy.step(name): 定义allure里的step步骤
- cy.allure().writeExecutorInfo(info)
- cy.allure().tms(name, url): 链接标签
- cy.allure().issue(name, url):bug链接标签
- cy.allure().link(name, url, type): 选择tms或者issue标签
- cy.allure().label(name, value): allure报告详情里的tags标签
- cy.allure().owner(owner): allure报告详情里的作者信息
- cy.allure().severity(): allure报告详情里的优先级
- cy.allure().description(): allure报告详情里的描述信息
- cy.allure().descriptionHtml(): allure报告详情里的描述信息展示html样式
- cy.allure().epic(str)/ feature()/ story()
- cy.allure().parentSuite(str)/ suite(str)/ subSuite(str)
- cy.allure().testParameter(name, vlaue): allure报告详情里的参数展示
- cy.allure().parameter(name, value):allure报告详情里的步骤展示参数
- cy.allure()配置文件属性,定义在cypress.json的env中
cy.allure常用方法:
cy.logStep(name)/cy.step(name): 定义allure里的step步骤
- logStep(name): 定义子步骤
- step(name, isParent:false): 是否为父步骤,false则为子步骤
cy.allure().writeExecutorInfo(info)
- info为对象属性
- **name**:
- **type**: 可用的图标: default(默认), github action, jenkins, bamboo, teamcity
- **buildOrder**: 如果buildOrders是相同的-它将被视为重试
- **buildName**:
- **buildUrl**: 链接到CI构建
- **reportUrl**: 链接报告
- **reportName**:
cy.allure().tms(name, url): 链接标签
cy.allure().issue(name, url):bug链接标签
cy.allure().link(name, url, type): 选择tms或者issue标签
-type:
tms:选择生成tms标签链接
issue:选择生成issue标签链接
cy.allure().label(name, value): allure报告详情里的tags标签
cy.allure().owner(owner): allure报告详情里的作者信息
cy.allure().severity(): allure报告详情里的优先级
cy.allure().description(): allure报告详情里的描述信息
cy.allure().descriptionHtml(): allure报告详情里的描述信息展示html样式
cy.allure().epic(str)/ feature()/ story()
- epic(str): 史诗 (层级:1)
- feature(str): 特性场景 (层级:2)
- story(str): 故事 (层级:3)
cy.allure().parentSuite(str)/ suite(str)/ subSuite(str)
- parentSuite(str): 父套件
- suite(str): 套件
- subSuite(str): 子套件
cy.allure().testParameter(name, vlaue): allure报告详情里的参数展示
cy.allure().parameter(name, value):allure报告详情里的步骤展示参数
cy.allure()配置文件属性,定义在cypress.json的env中
属性 | 描述 | 默认值 |
---|---|---|
allure | 启用Allure插件 | false |
allureResultsPath | 自定义allure结果文件夹的路径 | allure-results |
tmsPrefix | 测试中从allure API链接到测试管理系统的前缀子字符串或带有*的模式 | "" |
issuePrefix | 从allure API到bug跟踪系统的链接前缀 | "" |
allureLogCypress | 记录cypress链接器(命令),并将它们作为步骤显示在报告中 | true |
allureLogGherkin | 从cucumber预处理器记录gherkin的步骤 | 如果没有直接指定,则继承allureLogCypress值 |
allureAttachRequests | 将cy.request头、正文、响应头、响应正文自动添加到step中 | false |
allureOmitPreviousAttemptScreenshots | 当重试被使用时,忽略在以前的尝试中附加的截图 | false |
allureSkipAutomaticScreenshots | 不要自动添加截图(针对那些使用自定义脚本等的用户) | false |
allureClearSkippedTests | 从报告中删除跳过的测试 | false |
allureAddAnalyticLabels | 向测试添加框架和语言标签(仅用于allure分析) | false |
allureAddVideoOnPass | 在通过测试的报告中附上视频 | false |