探索Allure Report:提升自动化测试效率的秘密武器(下)

发表于:2023-10-20 09:30

字体: | 上一篇 | 下一篇 | 我要投稿

 作者:程序员小濠    来源:知乎

  九.Allure2报告中添加用例优先级
  1.应用场景:用例执行时,希望按照严重级别执行测试用例
  2.解决:可以为每个用例添加一个等级的装饰器,用法:@allure.severity。
  3.Allure 对严重级别的定义分为 5 个级别:
  ·Blocker级别:中断缺陷(客户端程序无响应,无法执行下一步操作)。
  · Critical级别:临界缺陷( 功能点缺失)。
  · Normal级别:普通缺陷(数值计算错误)。
  · Minor级别:次要缺陷(界面错误与UI需求不符)。
  · Trivial级别:轻微缺陷(必输项无提示,或者提示不规范)。
  4.使用装饰器添加用例方法/类的级别。类上添加的级别,对类中没有添加级别的方法生效。
  #运行时添加命令行参数 --allure-severities:
  pytest --alluredir ./results --clean-alluredir --allure-severities normal,blocker
  import allure
  def test_with_no_severity_label():
      pass
  @allure.severity(allure.severity_level.TRIVIAL)
  def test_with_trivial_severity():
      pass
  @allure.severity(allure.severity_level.NORMAL)
  def test_with_normal_severity():
      pass
  @allure.severity(allure.severity_level.NORMAL)
  class TestClassWithNormalSeverity(object):
      def test_inside_the_normal(self):
          pass
      @allure.severity(allure.severity_level.CRITICAL)
      def test_critical_severity(self):
          pass
      @allure.severity(allure.severity_level.BLOCKER)
      def test_blocker_severity(self):
          pass
  十.Allure2报告中添加用例支持tags标签
  1.Allure2 添加用例标签-xfail、skipif
  import pytest
  # 用法:使用装饰器 @pytest.xfail()、@pytest.skipif()
  # 当用例通过时标注为 xfail
  @pytest.mark.xfail(condition=lambda: True, reason='这是一个预期失败的用例')
  def test_xfail_expected_failure():
      """this test is a xfail that will be marked as expected failure"""
      assert False
  # 当用例通过时标注为 xpass
  @pytest.mark.xfail
  def test_xfail_unexpected_pass():
      """this test is a xfail that will be marked as unexpected success"""
      assert True
  # 跳过用例
  @pytest.mark.skipif('2 + 2 != 5', reason='当条件触发时这个用例被跳过 @pytest.mark.skipif')
  def test_skip_by_triggered_condition():
      pass
  2.Allure2 添加用例标签-fixture
  应用场景:fixture 和 finalizer 是分别在测试开始之前和测试结束之后由 Pytest 调用的实用程序函数。Allure 跟踪每个 fixture 的调用,并详细显示调用了哪些方法以及哪些参数,从而保持了调用的正确顺序。
  import pytest
  @pytest.fixture()
  def func(request):
      print("这是一个fixture方法")
      # 定义一个终结器,teardown动作放在终结器中
      def over():
          print("session级别终结器")
      request.addfinalizer(over)
  class TestClass(object):
      def test_with_scoped_finalizers(self,func):
          print("测试用例")
  十一.Allure2报告中支持记录失败重试功能
  1.Allure 可以收集用例运行期间,重试的用例的结果,以及这段时间重试的历史记录。
  2.重试功能可以使用 pytest 相关的插件,例如 pytest-rerunfailures。重试的结果信息,会展示在详情页面的Retries 选项卡中。
  import pytest
  @pytest.mark.flaky(reruns=2, reruns_delay=2)   # reruns重试次数,reruns_delay每次重试间隔时间(秒)
  def test_rerun2():
      assert False
  十二.Allure2 报告中添加附件-图片
  1.应用场景:在做 UI 自动化测试时,可以将页面截图,或者出错的页面进行截图,将截图添加到测试报告中展示,辅助定位问题。
  2.解决方案
  Python:使用 allure.attach 或者 allure.attach.file() 添加图片。
  Java:直接通过注解或调用方法添加。
  3.python方法一
  语法:allure.attach.file(source, name, attachment_type, extension),
  参数解释:
      ①source:文件路径,相当于传一个文件。
      ②name:附件名字。
      ③attachment_type:附件类型,是 allure.attachment_type 其中的一种(支持 PNG、JPG、BMP、GIF 等)。
      ④extension:附件的扩展名。
  import allure
  class TestWithAttach:
      def test_pic(self):
          allure.attach.file("pic.png", name="图片", attachment_type=allure.attachment_type.PNG, extension="png")
  4.python方法二
  语法:allure.attach(body, name=None, attachment_type=None, extension=None)
  参数解释:
      ①body:要写入附件的内容
      ②name:附件名字。
      ③attachment_type:附件类型,是 allure.attachment_type 其中的一种(支持 PNG、JPG、BMP、GIF 等)。
      ④extension:附件的扩展名。
  5.裂图的原因以及解决办法
  ·图片上传过程中出现了网络中断或者传输过程中出现了错误。 解决方案:重新上传图片。
  · Allure 报告中的图片大小超过了 Allure 的限制。 解决方案:调整图片大小。
  · 图片本身存在问题。 解决方案:检查图片格式和文件本身。
  十三.Allure2报告中添加附件-日志
  1.应用场景:报告中添加详细的日志信息,有助于分析定位问题。 2.解决方案:使用 python 自带的 logging 模块生成日志,日志会自动添加到测试报告中。日志配置,在测试报告中使用 logger 对象生成对应级别的日志。
  # 创建一个日志模块: log_util.py
  import logging
  import os
  from logging.handlers import RotatingFileHandler
  # 绑定绑定句柄到logger对象
  logger = logging.getLogger(__name__)
  # 获取当前工具文件所在的路径
  root_path = os.path.dirname(os.path.abspath(__file__))
  # 拼接当前要输出日志的路径
  log_dir_path = os.sep.join([root_path, f'/logs'])
  if not os.path.isdir(log_dir_path):
      os.mkdir(log_dir_path)
  # 创建日志记录器,指明日志保存路径,每个日志的大小,保存日志的上限
  file_log_handler = RotatingFileHandler(os.sep.join([log_dir_path, 'log.log']), maxBytes=1024 * 1024, backupCount=10 , encoding="utf-8")
  # 设置日志的格式
  date_string = '%Y-%m-%d %H:%M:%S'
  formatter = logging.Formatter(
      '[%(asctime)s] [%(levelname)s] [%(filename)s]/[line: %(lineno)d]/[%(funcName)s] %(message)s ', date_string)
  # 日志输出到控制台的句柄
  stream_handler = logging.StreamHandler()
  # 将日志记录器指定日志的格式
  file_log_handler.setFormatter(formatter)
  stream_handler.setFormatter(formatter)
  # 为全局的日志工具对象添加日志记录器
  # 绑定绑定句柄到logger对象
  logger.addHandler(stream_handler)
  logger.addHandler(file_log_handler)
  # 设置日志输出级别
  logger.setLevel(level=logging.INFO)
  代码输出到用例详情页面。运行用例命令:pytest --alluredir ./results --clean-alluredir(注意不要加-vs)。
  import allure
  from pytest_test.log_util import logger
  @allure.feature("功能模块2")
  class TestWithLogger:
      @allure.story("子功能1")
      @allure.title("用例1")
      def test_case1(self):
          logger.info("用例1的 info 级别的日志")
          logger.debug("用例1的 debug 级别的日志")
          logger.warning("用例1的 warning 级别的日志")
          logger.error("用例1的 error 级别的日志")
          logger.fatal("用例1的  fatal 级别的日志")
  日志展示在 Test body 标签下,标签下可展示多个子标签代表不同的日志输出渠道:
  ·log 子标签:展示日志信息。
  · stdout 子标签:展示 print 信息。
  · stderr 子标签:展示终端输出的信息。
  禁用日志,可以使用命令行参数控制 --allure-no-capture
  pytest --alluredir ./results --clean-alluredir --allure-no-capture
  public void exampleTest() {
        byte[] contents = Files.readAllBytes(Paths.get("a.txt"));
        attachTextFile(byte[]的文件, "描述信息");
    }
  @Attachment(value = "{attachmentName}", type = "text/plain")
  public byte[] attachTextFile(byte[] contents, String attachmentName) {
        return contents;
  }
  调用方法添加。
  --String类型添加。 日志文件为String类型
  Allure.addAttachment("描述信息", "text/plain", 文件读取为String,"txt");
  --InputStream类型添加。日志文件为InputStream流
  Allure.addAttachment("描述信息", "text/plain", Files.newInputStream(文件Path), "txt");
  十四.Allure2报告中添加附件-html
  1.应用场景:可以定制测试报告页面效果,可以将 HTML 类型的附件显示在报告页面上。
  2.解决方案:使用 allure.attach() 添加 html 代码。
  语法:allure.attach(body, name, attachment_type, extension),
  参数解释:
      body:要写入附件的内容(HTML 代码块)。
      name:附件名字。
      attachment_type:附件类型,是 allure.attachment_type 其中的一种。
      extension:附件的扩展名。
  import allure
  class TestWithAttach:
      def test_html(self):
          allure.attach('<head></head><body> a page </body>',
                        '附件是HTML类型',
                        allure.attachment_type.HTML)
                        
      def test_html_part(self):
          allure.attach('''html代码块''',
                        '附件是HTML类型',
                        allure.attachment_type.HTML)
  十五.Allure2 报告中添加附件-视频
  使用 allure.attach.file() 添加视频。
  语法:allure.attach.file(source, name, attachment_type, extension)
  参数解释:
      source:文件路径,相当于传一个文件。
      name:附件名字。
      attachment_type:附件类型,是 allure.attachment_type 其中的一种。
      extension:附件的扩展名。
  import allure
  class TestWithAttach:
      def test_video(self):
          allure.attach.file("xxx.mp4", name="视频", attachment_type=allure.attachment_type.MP4, extension="mp4")
  十六.Allure2 报告定制
  应用场景:针对不同的项目可能需要对测试报告展示的效果进行定制,比如修改页面的 logo、修改项目的标题或者添加一些定制的功能等等。
  1.修改页面 Logo
  (1)修改allure.yml文件,在后面添加 logo 插件:custom-logo-plugin(在 allure 安装路径下:/allure-2.21.0/config/allure.yml,可以通过 where allure 或者which allure查看 allure 安装路径)
  (2)编辑 styles.css 文件,配置 logo 图片(logo图片可以提前准备好放在/custom-logo-plugin/static中)
  /* 打开 styles.css 文件,
  目录在安装allure时,解压的路径:/xxx/allure-2.21.0/plugins/custom-logo-plugin/static/styles.css,
  将内容修改图片logo和相应的大小:*/
  .side-nav__brand {
    background: url("logo.jpeg") no-repeat left center !important;
    margin-left: 10px;
    height: 40px;
    background-size: contain !important;
  }
  2.修改页面标题,编辑 styles.css 文件,添加修改标题对应的代码。
  /* 去掉图片后边 allure 文本 */
  .side-nav__brand-text {
    display: none;
  }
  /* 设置logo 后面的字体样式与字体大小 */
  .side-nav__brand:after {
    content: "测试报告";
    margin-left: 18px;
    height: 20px;
    font-family: Arial;
    font-size: 13px;
  }
  本文内容不用于商业目的,如涉及知识产权问题,请权利人联系51Testing小编(021-64471599-8017),我们将立即处理
《2023软件测试行业现状调查报告》独家发布~

关注51Testing

联系我们

快捷面板 站点地图 联系我们 广告服务 关于我们 站长统计 发展历程

法律顾问:上海兰迪律师事务所 项棋律师
版权所有 上海博为峰软件技术股份有限公司 Copyright©51testing.com 2003-2024
投诉及意见反馈:webmaster@51testing.com; 业务联系:service@51testing.com 021-64471599-8017

沪ICP备05003035号

沪公网安备 31010102002173号