BDD - Python Behave log 为每个 Scenario 生成对应的 log 文件

2024-03-09 19:44
文章标签 python 生成 对应 log 每个 bdd scenario behave

本文主要是介绍BDD - Python Behave log 为每个 Scenario 生成对应的 log 文件，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

BDD - Python Behave log 为每个 Scenario 生成对应的 log 文件

  • 引言
  • 应用 Behave 官网 Log 配置文件
    • 项目 Setup
      • Feature 文件
      • steps 文件
      • Log 配置文件
      • environment.py 文件
      • behave.ini
    • 执行结果
  • 直接应用 Python logging 模块
    • 方式 1：应用 log 配置文件
      • log 配置文件
      • environment.py
      • Steps 文件
      • 执行结果
    • 方式 2：logging 方法配置
      • environment.py
      • 执行结果
    • 方式 3：dictConfig 配置
      • environment.py
      • 执行结果
  • 总结

引言

文章《BDD - Python Behave log 日志》只是简单的介绍了一下 log 的基本配置，而且默认是输出到 Console，这对于日常自动化测试是不够全面的，不利于 Automation Triage。今天就来了解一下更友好的日志配制，为每个 Scenario 配置不同的 log 文件，极大地方便定位 Scenario 运行失败的原因。

想了解更多 Behave 相关的文章，欢迎阅读《Python BDD Behave 系列》，持续更新中。

应用 Behave 官网 Log 配置文件

首先应用一下 Behave 官网 Log with Configfile 例子，发现所有的日志都会输出到一个固定的文件中。目前 Behave 1.2.6 版本 context.config.setup_logging() 方法还不支持动态改变 config 文件中的参数值，但是可以通过改源码来实现，可参考 Add support for value substitution in logging config file

项目 Setup

Feature 文件

log_with_config_file.feature, 3 个 Scenarios

# BDD/Features/log/log_with_config_file.featureFeature: Logging Example@log_testScenario: First ScenarioGiven I have a scenario 1When I perform an actionThen I should see the result@log_testScenario Outline: Second ScenarioGiven I have a scenario <number>When I perform an actionThen I should see the resultExamples:|number||2||3|

steps 文件

简单的日志记录

# BDD/steps/log_with_config_file_steps.pyfrom behave import given, when, then
import logging
from behave.configuration import LogLevel@given("I have a scenario {number}")
def step_given_scenario(context, number):logging.info(f"This is a log from scenario {number}")@when("I perform an action")
def step_when_perform_action(context)logging.info("I perform an action")@then("I should see the result")
def step_then_see_result(context):logging.error("I did not see the result")

Log 配置文件

behave_logging.ini
配置了文件输出，也可以配置日志输出到文件和 Console，这里日志文件是固定的 BDD/logs/behave.log

 # BDD/config/behave_logging.ini[loggers]keys=root[handlers]keys=Console,File[formatters]keys=Brief[logger_root]level = DEBUG# handlers = Filehandlers = Console,File[handler_File]class=FileHandlerargs=("BDD/logs/behave.log", 'w')level=DEBUGformatter=Brief[handler_Console]class=StreamHandlerargs=(sys.stderr,)level=DEBUGformatter=Brief[formatter_Brief]format= LOG.%(levelname)-8s  %(name)-10s: %(message)sdatefmt=

environment.py 文件

通过调用 Behave 方法 context.config.setup_logging() 应用上面的 log 配置文件，

# BDD/environment.pydef before_all(context):# create log diros.makedirs("BDD/logs", exist_ok=True) context.config.setup_logging(configfile="BDD/config/behave_logging.ini")

behave.ini

Behave 默认 log_capture 是 true 的，运行成功的 Scenario 是不会输出日志的。所以将该值设置为 false，确保不管 Scenario 运行成功与否，都输出日志。stdout_capture 为 false 是允许输出 print 语句，为 true 则不会输出。

# behave.ini
[behave]
paths=BDD/Features/log/log_with_config_file.feature
tags = log_test
log_capture = false
stdout_capture = false

执行结果

因为 behave.ini 已经配置了 feature 文件 path 及 tags，所以只需在项目根目录下直接运行 behave 命令就可以了。

日志按配置格式输出到 Console，同时也输出到 behave.log 文件中。

PS C:\Automation\Test> behave
Feature: Logging Example # BDD/Features/log/log_with_config_file.feature:2@log_testScenario: First Scenario       # BDD/Features/log/log_with_config_file.feature:5Given I have a scenario 1    # BDD/steps/log_with_config_file_steps.py:7      
LOG.INFO      root      : This is a log from scenario 1When I perform an action     # BDD/steps/log_with_config_file_steps.py:14     
LOG.INFO      root      : I perform an actionThen I should see the result # BDD/steps/log_with_config_file_steps.py:22     
LOG.ERROR     root      : I did not see the result
scenario_name Second_Scenario_--_@1.1_@log_testScenario Outline: Second Scenario -- @1.1   # BDD/Features/log/log_with_config_file.feature:18Given I have a scenario 2                 # BDD/steps/log_with_config_file_steps.py:7
LOG.INFO      root      : This is a log from scenario 2When I perform an action                  # BDD/steps/log_with_config_file_steps.py:14
LOG.INFO      root      : I perform an actionThen I should see the result              # BDD/steps/log_with_config_file_steps.py:22
LOG.ERROR     root      : I did not see the result
scenario_name Second_Scenario_--_@1.2_@log_testScenario Outline: Second Scenario -- @1.2   # BDD/Features/log/log_with_config_file.feature:19Given I have a scenario 3                 # BDD/steps/log_with_config_file_steps.py:7
LOG.INFO      root      : This is a log from scenario 3When I perform an action                  # BDD/steps/log_with_config_file_steps.py:14
LOG.INFO      root      : I perform an actionThen I should see the result              # BDD/steps/log_with_config_file_steps.py:22
LOG.ERROR     root      : I did not see the result1 feature passed, 0 failed, 0 skipped
3 scenarios passed, 0 failed, 0 skipped
9 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m0.010s

在这里插入图片描述

直接应用 Python logging 模块

针对不同的 Scenario 动态创建 log 文件，输出到对应的 log 文件中，这里有三种方式实现

方式 1：应用 log 配置文件

log 配置文件

注意 args=(‘%(logfilename)s’,‘w’) 文件名可通过参数来设置的，不再是固定的。

# BDD/config/logging_config.ini
[loggers]
keys=root[handlers]
keys=consoleHandler,fileHandler[formatters]
keys=sampleFormatter[logger_root]
level=DEBUG
handlers=consoleHandler,fileHandler[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=sampleFormatter
args=(sys.stdout,)[handler_fileHandler]
class=FileHandler
level=DEBUG
formatter=sampleFormatter
args=('%(logfilename)s','w')[formatter_sampleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
datefmt=%Y-%m-%d %H:%M:%S[log_file_template]
path={scenario_name}_{timestamp}.log

environment.py

根据 feature 名 和 Scenario 名及其位置生成 log 文件名

logging.config.fileConfig(“BDD/config/logging.ini”, defaults={‘logfilename’: log_file}) 应用 log 配置文件和动态设置 log 输出文件名
context.logger = logging.getLogger(f"{feature_name_str}_@{scenario_location_line}") 保持 log 的上下文关系

# BDD/environment.pydef before_scenario(context, scenario):# create log dirfeature_name_str = context.feature.name.replace(" ", "_")log_dir = f"BDD/logs/{feature_name_str}"os.makedirs(log_dir, exist_ok=True) # generate log file pathscenario_name = scenario.name.replace(" ", "_")current_time = datetime.datetime.now()formatted_time = current_time.strftime("%Y-%m-%d-%H-%M-%S")scenario_location_line = scenario.location.linelog_file = os.path.join(log_dir, f"{scenario_name}_{scenario_location_line}_{formatted_time}.log")# log setuplogging.config.fileConfig("BDD/config/logging.ini", defaults={'logfilename': log_file})context.logger = logging.getLogger(f"{feature_name_str}_@{scenario_location_line}")

Steps 文件

context.logger 拿到 logger 对象

# BDD/steps/log_with_config_file_steps.pyfrom behave import given, when, then
import logging
from behave.configuration import LogLevel@given("I have a scenario {number}")
def step_given_scenario(context, number):context.logger.info(f"This is a log from scenario {number}")@when("I perform an action")
def step_when_perform_action(context):context.logger.error(f"I perform an action")@then("I should see the result")
def step_then_see_result(context):context.logger.error("I should see the result")

执行结果

behave.ini 文件中的配置还跟之前一样，在项目根目录下直接运行 behave 命令即可。

log 有输出到终端：

PS C:Automation\Test> behave    
Feature: Logging Example # BDD/Features/log/log_with_config_file.feature:2@log_testScenario: First Scenario       # BDD/Features/log/log_with_config_file.feature:5Given I have a scenario 1    # BDD/steps/log_with_config_file_steps.py:7      
2024-03-09 16:00:09 - Logging_Example_@5 - INFO - This is a log from scenario 1   When I perform an action     # BDD/steps/log_with_config_file_steps.py:14     
2024-03-09 16:00:09 - Logging_Example_@5 - ERROR - I perform an actionThen I should see the result # BDD/steps/log_with_config_file_steps.py:22
2024-03-09 16:00:10 - Logging_Example_@5 - ERROR - I should see the result@log_testScenario Outline: Second Scenario -- @1.1   # BDD/Features/log/log_with_config_file.feature:18Given I have a scenario 2                 # BDD/steps/log_with_config_file_steps.py:7
2024-03-09 16:00:10 - Logging_Example_@18 - INFO - This is a log from scenario 2When I perform an action                  # BDD/steps/log_with_config_file_steps.py:14
2024-03-09 16:00:10 - Logging_Example_@18 - ERROR - I perform an actionThen I should see the result              # BDD/steps/log_with_config_file_steps.py:22
2024-03-09 16:00:10 - Logging_Example_@18 - ERROR - I should see the result@log_testScenario Outline: Second Scenario -- @1.2   # BDD/Features/log/log_with_config_file.feature:19Given I have a scenario 3                 # BDD/steps/log_with_config_file_steps.py:7
2024-03-09 16:00:10 - Logging_Example_@19 - INFO - This is a log from scenario 3When I perform an action                  # BDD/steps/log_with_config_file_steps.py:14
2024-03-09 16:00:10 - Logging_Example_@19 - ERROR - I perform an actionThen I should see the result              # BDD/steps/log_with_config_file_steps.py:22
2024-03-09 16:00:10 - Logging_Example_@19 - ERROR - I should see the result1 feature passed, 0 failed, 0 skipped
3 scenarios passed, 0 failed, 0 skipped
9 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m0.015s

同时，feature 名的 log 目录已经创建，并每个 Scenario 都有对应的 log 文件

在这里插入图片描述

在这里插入图片描述

方式 2：logging 方法配置

在 environment.py 文件中，通过 logging 模块方法配置 log 属性, 其它文件跟方式 1 保持不变

environment.py

# BDD/environment.pydef scenario_log_setup(scenario, log_file):# set loggerlogger = logging.getLogger(scenario.name)logger.setLevel(logging.DEBUG)# add handler for loggerfile_handler = logging.FileHandler(log_file)file_handler.setLevel(logging.DEBUG)console_handler = logging.StreamHandler()console_handler.setLevel(logging.DEBUG)# set format for loggerlog_format = '%(asctime)s %(levelname)s : %(message)s'formatter = logging.Formatter(log_format)file_handler.setFormatter(formatter)console_handler.setFormatter(formatter)logger.addHandler(file_handler)logger.addHandler(console_handler)return loggerdef before_scenario(context, scenario):# create log dirfeature_name_str = context.feature.name.replace(" ", "_")log_dir = f"BDD/logs/{feature_name_str}"os.makedirs(log_dir, exist_ok=True) # generate log file pathscenario_name = scenario.name.replace(" ", "_")  current_time = datetime.datetime.now()formatted_time = current_time.strftime("%Y-%m-%d-%H-%M-%S")scenario_location_line = scenario.location.linelog_file = os.path.join(log_dir, f"{scenario_name}_{scenario_location_line}_{formatted_time}.log")# log setupcontext.logger = scenario_log_setup(scenario, log_file)

执行结果

终端输出并写入 log 文件中

PS C:\Automation\Test> behave
Feature: Logging Example # BDD/Features/log/log_with_config_file.feature:2        @log_testScenario: First Scenario       # BDD/Features/log/log_with_config_file.feature:5Given I have a scenario 1    # BDD/steps/log_with_config_file_steps.py:7      
2024-03-09 16:42:02,505 CRITICAL : This is a log from scenario 1When I perform an action     # BDD/steps/log_with_config_file_steps.py:14     
2024-03-09 16:42:02,505 ERROR : I perform an actionThen I should see the result # BDD/steps/log_with_config_file_steps.py:22     
2024-03-09 16:42:02,505 ERROR : I should see the result@log_testScenario Outline: Second Scenario -- @1.1   # BDD/Features/log/log_with_config_file.feature:18Given I have a scenario 2                 # BDD/steps/log_with_config_file_steps.py:7       
2024-03-09 16:42:02,533 CRITICAL : This is a log from scenario 2When I perform an action                  # BDD/steps/log_with_config_file_steps.py:14
2024-03-09 16:42:02,534 ERROR : I perform an actionThen I should see the result              # BDD/steps/log_with_config_file_steps.py:22
2024-03-09 16:42:02,534 ERROR : I should see the result@log_testScenario Outline: Second Scenario -- @1.2   # BDD/Features/log/log_with_config_file.feature:19Given I have a scenario 3                 # BDD/steps/log_with_config_file_steps.py:7
2024-03-09 16:42:02,541 CRITICAL : This is a log from scenario 3When I perform an action                  # BDD/steps/log_with_config_file_steps.py:14
2024-03-09 16:42:02,543 ERROR : I perform an actionThen I should see the result              # BDD/steps/log_with_config_file_steps.py:22
2024-03-09 16:42:02,545 ERROR : I should see the result1 feature passed, 0 failed, 0 skipped
3 scenarios passed, 0 failed, 0 skipped
9 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m0.018s

log 文件生成

在这里插入图片描述

在这里插入图片描述

方式 3：dictConfig 配置

在 environment.py 文件中，通过定义一个 Log Config dict 调用 logging.config.dictConfig 配置 log 属性, 其它文件跟方式 1 保持不变

environment.py

def scenario_log_setup_with_config_dict(scenario, log_file):logging_config = {'version': 1,'disable_existing_loggers': False,'formatters': {'standard': {'format': '%(asctime)s %(levelname)s : %(message)s'},},'handlers': {'file_handler': {'class': 'logging.FileHandler','filename': log_file,'formatter': 'standard',},'console_handler':{'class':'logging.StreamHandler','formatter': 'standard',}},'loggers': {'': {'handlers': ['file_handler','console_handler'],'level': 'DEBUG',},}}logging.config.dictConfig(logging_config)return logging.getLogger(scenario.name)def before_scenario(context, scenario):# create log dirfeature_name_str = context.feature.name.replace(" ", "_")log_dir = f"BDD/logs/{feature_name_str}"os.makedirs(log_dir, exist_ok=True) scenario_name = scenario.name.replace(" ", "_")# generate log file pathcurrent_time = datetime.datetime.now()formatted_time = current_time.strftime("%Y-%m-%d-%H-%M-%S")scenario_location_line = scenario.location.linelog_file = os.path.join(log_dir, f"{scenario_name}_{scenario_location_line}_{formatted_time}.log")# log setup# good 1# logging.config.fileConfig("BDD/config/logging.ini", defaults={'logfilename': log_file})# context.logger = logging.getLogger(f"{feature_name_str}_@{scenario_location_line}")# good 2# context.logger = scenario_log_setup(scenario, log_file)# good 3context.logger = scenario_log_setup_with_config_dict(scenario, log_file)

执行结果

终端输出并写入 log 文件中

PS C:\Automation\Test> behave
Feature: Logging Example # BDD/Features/log/log_with_config_file.feature:2@log_testScenario: First Scenario       # BDD/Features/log/log_with_config_file.feature:5Given I have a scenario 1    # BDD/steps/log_with_config_file_steps.py:7
2024-03-09 17:17:31,197 CRITICAL : This is a log from scenario 1When I perform an action     # BDD/steps/log_with_config_file_steps.py:14
2024-03-09 17:17:31,199 ERROR : I perform an actionThen I should see the result # BDD/steps/log_with_config_file_steps.py:22
2024-03-09 17:17:31,202 ERROR : I should see the result@log_testScenario Outline: Second Scenario -- @1.1   # BDD/Features/log/log_with_config_file.feature:18Given I have a scenario 2                 # BDD/steps/log_with_config_file_steps.py:7
2024-03-09 17:17:31,212 CRITICAL : This is a log from scenario 2When I perform an action                  # BDD/steps/log_with_config_file_steps.py:14
2024-03-09 17:17:31,212 ERROR : I perform an actionThen I should see the result              # BDD/steps/log_with_config_file_steps.py:22
2024-03-09 17:17:31,212 ERROR : I should see the result@log_testScenario Outline: Second Scenario -- @1.2   # BDD/Features/log/log_with_config_file.feature:19Given I have a scenario 3                 # BDD/steps/log_with_config_file_steps.py:7
2024-03-09 17:17:31,212 CRITICAL : This is a log from scenario 3When I perform an action                  # BDD/steps/log_with_config_file_steps.py:14
2024-03-09 17:17:31,212 ERROR : I perform an actionThen I should see the result              # BDD/steps/log_with_config_file_steps.py:22
2024-03-09 17:17:31,212 ERROR : I should see the result1 feature passed, 0 failed, 0 skipped
3 scenarios passed, 0 failed, 0 skipped
9 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m0.004s

log 文件生成
在这里插入图片描述

在这里插入图片描述

总结

上面介绍了几种 log 处理方式， 比较推荐应用 Python logging 模块采用方式 1，应用 log 配置文件，优点就是代码可读性，可维护性更好。

这篇关于BDD - Python Behave log 为每个 Scenario 生成对应的 log 文件的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/791761。

相关文章

如何使用 Python 读取 Excel 数据

如何使用 Python 读取 Excel 数据

《如何使用Python读取Excel数据》：本文主要介绍使用Python读取Excel数据的详细教程,通过pandas和openpyxl,你可以轻松读取Excel文件,并进行各种数据处理操... 目录使用 python 读取 Excel 数据的详细教程1. 安装必要的依赖2. 读取 Excel 文件3. 读
阅读更多...
Python的time模块一些常用功能(各种与时间相关的函数)

Python的time模块一些常用功能(各种与时间相关的函数)

《Python的time模块一些常用功能(各种与时间相关的函数)》Python的time模块提供了各种与时间相关的函数,包括获取当前时间、处理时间间隔、执行时间测量等,：本文主要介绍Python的... 目录1. 获取当前时间2. 时间格式化3. 延时执行4. 时间戳运算5. 计算代码执行时间6. 转换为指
阅读更多...
利用Python调试串口的示例代码

利用Python调试串口的示例代码

《利用Python调试串口的示例代码》在嵌入式开发、物联网设备调试过程中,串口通信是最基础的调试手段本文将带你用Python+ttkbootstrap打造一款高颜值、多功能的串口调试助手,需要的可以了... 目录概述：为什么需要专业的串口调试工具项目架构设计1.1 技术栈选型1.2 关键类说明1.3 线程模
阅读更多...
Python ZIP文件操作技巧详解

Python ZIP文件操作技巧详解

《PythonZIP文件操作技巧详解》在数据处理和系统开发中,ZIP文件操作是开发者必须掌握的核心技能,Python标准库提供的zipfile模块以简洁的API和跨平台特性,成为处理ZIP文件的首选... 目录一、ZIP文件操作基础三板斧1.1 创建压缩包1.2 解压操作1.3 文件遍历与信息获取二、进阶技
阅读更多...
Python Transformers库(NLP处理库)案例代码讲解

Python Transformers库(NLP处理库)案例代码讲解

《PythonTransformers库(NLP处理库)案例代码讲解》本文介绍transformers库的全面讲解,包含基础知识、高级用法、案例代码及学习路径,内容经过组织,适合不同阶段的学习者,对... 目录一、基础知识1. Transformers 库简介2. 安装与环境配置3. 快速上手示例二、核心模
阅读更多...
Python正则表达式语法及re模块中的常用函数详解

Python正则表达式语法及re模块中的常用函数详解

《Python正则表达式语法及re模块中的常用函数详解》这篇文章主要给大家介绍了关于Python正则表达式语法及re模块中常用函数的相关资料,正则表达式是一种强大的字符串处理工具,可以用于匹配、切分、... 目录概念、作用和步骤语法re模块中的常用函数总结 概念、作用和步骤概念： 本身也是一个字符串，其中
阅读更多...
Python使用getopt处理命令行参数示例解析(最佳实践)

Python使用getopt处理命令行参数示例解析(最佳实践)

《Python使用getopt处理命令行参数示例解析(最佳实践)》getopt模块是Python标准库中一个简单但强大的命令行参数处理工具,它特别适合那些需要快速实现基本命令行参数解析的场景,或者需要... 目录为什么需要处理命令行参数？getopt模块基础实际应用示例与其他参数处理方式的比较常见问http
阅读更多...
SQL中redo log 刷⼊磁盘的常见方法

SQL中redo log 刷⼊磁盘的常见方法

《SQL中redolog刷⼊磁盘的常见方法》本文主要介绍了SQL中redolog刷⼊磁盘的常见方法,将redolog刷入磁盘的方法确保了数据的持久性和一致性,下面就来具体介绍一下,感兴趣的可以了解... 目录Redo Log 刷入磁盘的方法Redo Log 刷入磁盘的过程代码示例（伪代码）在数据库系统中，r
阅读更多...
python实现svg图片转换为png和gif

python实现svg图片转换为png和gif

《python实现svg图片转换为png和gif》这篇文章主要为大家详细介绍了python如何实现将svg图片格式转换为png和gif,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录python实现svg图片转换为png和gifpython实现图片格式之间的相互转换延展：基于Py
阅读更多...
Python中的getopt模块用法小结

Python中的getopt模块用法小结

《Python中的getopt模块用法小结》getopt.getopt()函数是Python中用于解析命令行参数的标准库函数,该函数可以从命令行中提取选项和参数,并对它们进行处理,本文详细介绍了Pyt... 目录getopt模块介绍getopt.getopt函数的介绍getopt模块的常用用法getopt模
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2