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: 多模块(.py)中全局变量的导入

python: 多模块(.py)中全局变量的导入

文章目录 global关键字可变类型和不可变类型数据的内存地址单模块(单个py文件)的全局变量示例总结 多模块(多个py文件)的全局变量from x import x导入全局变量示例 import x导入全局变量示例 总结 global关键字 global 的作用范围是模块(.py)级别： 当你在一个模块（文件）中使用 global 声明变量时，这个变量只在该模块的全局命名空
阅读更多...
AI一键生成 PPT

AI一键生成 PPT

AI一键生成 PPT 操作步骤 作为一名打工人，是不是经常需要制作各种PPT来分享我的生活和想法。但是，你们知道，有时候灵感来了，时间却不够用了！😩直到我发现了Kimi AI——一个能够自动生成PPT的神奇助手！🌟 什么是Kimi？ 一款月之暗面科技有限公司开发的AI办公工具，帮助用户快速生成高质量的演示文稿。 无论你是职场人士、学生还是教师，Kimi都能够为你的办公文
阅读更多...
【Python编程】Linux创建虚拟环境并配置与notebook相连接

【Python编程】Linux创建虚拟环境并配置与notebook相连接

1.创建 使用 venv 创建虚拟环境。例如，在当前目录下创建一个名为 myenv 的虚拟环境： python3 -m venv myenv 2.激活 激活虚拟环境使其成为当前终端会话的活动环境。运行： source myenv/bin/activate 3.与notebook连接 在虚拟环境中，使用 pip 安装 Jupyter 和 ipykernel： pip instal
阅读更多...
内核启动时减少log的方式

内核启动时减少log的方式

内核引导选项 内核引导选项大体上可以分为两类：一类与设备无关、另一类与设备有关。与设备有关的引导选项多如牛毛，需要你自己阅读内核中的相应驱动程序源码以获取其能够接受的引导选项。比如，如果你想知道可以向 AHA1542 SCSI 驱动程序传递哪些引导选项，那么就查看 drivers/scsi/aha1542.c 文件，一般在前面 100 行注释里就可以找到所接受的引导选项说明。大多数选项是通过"_
阅读更多...
pdfmake生成pdf的使用

pdfmake生成pdf的使用

实际项目中有时会有根据填写的表单数据或者其他格式的数据，将数据自动填充到pdf文件中根据固定模板生成pdf文件的需求 文章目录 利用pdfmake生成pdf文件1.下载安装pdfmake第三方包2.封装生成pdf文件的共用配置3.生成pdf文件的文件模板内容4.调用方法生成pdf 利用pdfmake生成pdf文件 1.下载安装pdfmake第三方包 npm i pdfma
阅读更多...
poj 1258 Agri-Net（最小生成树模板代码）

poj 1258 Agri-Net（最小生成树模板代码）

感觉用这题来当模板更适合。 题意就是给你邻接矩阵求最小生成树啦。~ prim代码：效率很高。172k...0ms。 #include<stdio.h>#include<algorithm>using namespace std;const int MaxN = 101;const int INF = 0x3f3f3f3f;int g[MaxN][MaxN];int n
阅读更多...
poj 1287 Networking（prim or kruscal最小生成树）

poj 1287 Networking（prim or kruscal最小生成树）

题意给你点与点间距离，求最小生成树。 注意点是，两点之间可能有不同的路，输入的时候选择最小的，和之前有道最短路WA的题目类似。 prim代码： #include<stdio.h>const int MaxN = 51;const int INF = 0x3f3f3f3f;int g[MaxN][MaxN];int P;int prim(){bool vis[MaxN];
阅读更多...
poj 2349 Arctic Network uva 10369（prim or kruscal最小生成树）

poj 2349 Arctic Network uva 10369（prim or kruscal最小生成树）

题目很麻烦，因为不熟悉最小生成树的算法调试了好久。 感觉网上的题目解释都没说得很清楚，不适合新手。自己写一个。 题意：给你点的坐标，然后两点间可以有两种方式来通信：第一种是卫星通信，第二种是无线电通信。 卫星通信：任何两个有卫星频道的点间都可以直接建立连接，与点间的距离无关； 无线电通信：两个点之间的距离不能超过D，无线电收发器的功率越大，D越大，越昂贵。 计算无线电收发器D
阅读更多...
【机器学习】高斯过程的基本概念和应用领域以及在python中的实例

【机器学习】高斯过程的基本概念和应用领域以及在python中的实例

引言 高斯过程（Gaussian Process，简称GP）是一种概率模型，用于描述一组随机变量的联合概率分布，其中任何一个有限维度的子集都具有高斯分布 文章目录 引言一、高斯过程1.1 基本定义1.1.1 随机过程1.1.2 高斯分布 1.2 高斯过程的特性1.2.1 联合高斯性1.2.2 均值函数1.2.3 协方差函数（或核函数） 1.3 核函数1.4 高斯过程回归（Gauss
阅读更多...
hdu 1102 uva 10397（最小生成树prim）

hdu 1102 uva 10397（最小生成树prim）

hdu 1102: 题意： 给一个邻接矩阵，给一些村庄间已经修的路，问最小生成树。 解析： 把已经修的路的权值改为0，套个prim（）。 注意prim 最外层循坏为n-1。 代码： #include <iostream>#include <cstdio>#include <cstdlib>#include <algorithm>#include <cstri
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2