BDD - Python Behave log 日志

2024-01-01 21:44
文章标签 python 日志 log bdd behave

本文主要是介绍BDD - Python Behave log 日志,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

BDD - Python Behave log 日志

  • 引言
  • Behave log
    • Behave log 项目准备
      • feature 文件
      • step 文件
      • environment.py 文件
    • Behave log 执行
      • log_capture 模式
        • log_capture 开模式
        • log_capture 关模式即普通模式
      • logging-filter
      • logging-level
        • logcapture 模式
        • no-logcapture 模式
      • logging_format
        • log_capture 模式
        • no-logcapture 模式

引言

日志在整个测试运行中是非常重要的,帮助我们定位问题。也许你习惯用 Print。。。。,尽管效果差不多,但是显得不那么专业了,也不方便日志管理。今天我们来了解一下 Behave 日志机制。

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

Behave log

Behave 使用 Python 的标准 logging 模块进行日志记录。这意味着 Behave 继承了 Python 的日志机制,可以使用相同的配置和方法。

Behave log 项目准备

举个简单的实例

feature 文件

创建 log.feature 文件,准备一些 log 记录,一个运行会失败的 Scenario, 一个运行会成功的 Scenario

# log.featureFeature: Log ExampleScenario: PassingGiven I create log records with:| category | level   | message || root     |  FATAL  | Hello Alice  || foo      |  ERROR  | Hello Bob    || foo.bar  |  WARN   | Hello Charly || bar      |  INFO   | Hello Dora   || baz      |  DEBUG  | Hello Emily  |When another step passesScenario: FailingGiven I create log records with:| category | level   | message || root     |  FATAL  | Hello Alice  || foo      |  ERROR  | Hello Bob    || foo.bar  |  WARN   | Hello Charly || bar      |  INFO   | Hello Dora   || baz      |  DEBUG  | Hello Emily  |When another step fails

step 文件

# log_steps.pyfrom behave import *
from behave.configuration import LogLevel
import loggingdef make_log_record(category, level, message):if category in ("root", "__ROOT__"):category = Nonelogger = logging.getLogger(category)logger.log(level, message)@Given('I create log records with')
def step_I_create_logrecords_with_table(context):assert context.table, "REQUIRE: context.table"context.table.require_columns(["category", "level", "message"])for row in context.table.rows:category = row["category"]if category == "__ROOT__":category = Nonelevel = LogLevel.parse_type(row["level"])message = row["message"]make_log_record(category, level, message)# -----------------------------------------------------------------------------
# STEPS FOR: passing
# -----------------------------------------------------------------------------
@When('{word:w} step passes')
def step_passes(context, word):"""Step that always passes, mostly needed in examples."""pass# -----------------------------------------------------------------------------
# STEPS FOR: failing
# -----------------------------------------------------------------------------
@when(u'{word:w} step fails')
def step_fails(context, word):"""Step that always fails, mostly needed in examples."""assert False, "EXPECT: Failing step"

environment.py 文件

context.config.setup_logging() 简单地全局配置日志记录系统的基本配置,以设置默认的日志处理器、日志级别、格式等参数。

# environment.pyfrom behave import *def before_all(context):pass# print("Before all tests")context.before_all = "before all"# -- SAME-AS:# import logging# logging.basicConfig(level=context.config.logging_level)context.config.setup_logging()

Behave log 执行

log_capture 模式

  • Behave 默认 log_capture 模式是开的
  • log_capture 模式可通过命令行方式设置
  • log_capture 模式也可在 behave 配置文件 behave.ini 中设置
  • log_capture 模式只有在 Scenario 运行失败时才会捕获 log 记录
log_capture 开模式

所以执行命令 behave -f plain --logcapturebehave -f plain 效果是一样的,只有在 Scenario 运行失败时才会捕获 log 记录(看到 Captured logging: 部分

PS C:\Automation\Test\bdd> behave -f plain   
Feature: Log ExampleScenario: PassingGiven I create log records with ... passed in 0.000s| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |When another step passes ... passed in 0.001sScenario: FailingGiven I create log records with ... passed in 0.001s| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |When another step fails ... failed in 0.001s
Assertion Failed: EXPECT: Failing step
Captured logging:
CRITICAL:root:Hello Alice
ERROR:foo:Hello Bob
WARNING:foo.bar:Hello Charly
INFO:bar:Hello DoraFailing scenarios:Features/log/log.feature:13  Failing0 features passed, 1 failed, 0 skipped
1 scenario passed, 1 failed, 0 skipped
3 steps passed, 1 failed, 0 skipped, 0 undefined
Took 0m0.003s
log_capture 关模式即普通模式

命令行选项 --no-logcapture 普通模式,运行成功的 Scenario 也会输出 log

也可以在配置文件 behave.ini 设置,只需执行命令 behave -f plain
[behave]
log_capture = false

PS C:\Automation\Test\bdd> behave -f plain  --no-logcapture
Feature: Log ExampleScenario: Passing
CRITICAL:root:Hello Alice
ERROR:foo:Hello Bob
WARNING:foo.bar:Hello Charly
INFO:bar:Hello DoraGiven I create log records with ... passed in 0.000s| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |When another step passes ... passed in 0.000sScenario: Failing
CRITICAL:root:Hello Alice
ERROR:foo:Hello Bob
WARNING:foo.bar:Hello Charly
INFO:bar:Hello DoraGiven I create log records with ... passed in 0.013s| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |When another step fails ... failed in 0.000s
Assertion Failed: EXPECT: Failing stepFailing scenarios:Features/log/log.feature:13  Failing0 features passed, 1 failed, 0 skipped
1 scenario passed, 1 failed, 0 skipped
3 steps passed, 1 failed, 0 skipped, 0 undefined
Took 0m0.013s

logging-filter

根据 log catalog 来过滤 log 记录,只输出想要的 log 信息,前提条件是 log_capture 模式下
e.g.
过滤出包含 foo catalog 的日志记录: behave --logcapture --logging-filter=foo
过滤出包含子类 foo.bar catalog 的日志记录:behave --logcapture --logging-filter=foo.bar
过滤出包含非 foo catalog 的日志记录:behave --logcapture --logging-filter=-foo
过滤出包含 foo 或 bar catalog 的日志记录:behave --logcapture --logging-filter=foo,bar

过滤出包含 foo.bar 或不包含 bar catalog 的日志记录:behave --logcapture --logging-filter=foo.bar,-bar
所以会包含下面这些 log 记录
root --》 非 bar
foo.bar–》foo.bar

  Captured logging:CRITICAL:root:Hello Alice  ERROR:foo:Hello BobWARNING:foo.bar:Hello Charly
PS C:\ForKelly\Automation\Test\bdd> behave --logcapture --logging-filter=foo.bar,-bar
Feature: Log Example # Features/log/log.feature:1Scenario: Passing                 # Features/log/log.feature:3Given I create log records with # steps/log_steps.py:13| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |When another step passes        # steps/log_steps.py:30Scenario: Failing                 # Features/log/log.feature:13Given I create log records with # steps/log_steps.py:13| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |When another step fails         # steps/log_steps.py:40Assertion Failed: EXPECT: Failing stepCaptured logging:CRITICAL:root:Hello AliceERROR:foo:Hello BobWARNING:foo.bar:Hello CharlyFailing scenarios:Features/log/log.feature:13  Failing0 features passed, 1 failed, 0 skipped
1 scenario passed, 1 failed, 0 skipped
3 steps passed, 1 failed, 0 skipped, 0 undefined
Took 0m0.001s

logging-level

日志级别(logging level)用于指定日志消息的严重程度。不同的级别对应不同的常量(debug,info, warning, error),logcapture 模式和 logcapture 模式都可以应用.

logcapture 模式
PS C:\Automation\Test\bdd> behave -f plain -T --logging-level=WARN
Feature: Log ExampleScenario: PassingGiven I create log records with ... passed| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |When another step passes ... passedScenario: FailingGiven I create log records with ... passed| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |When another step fails ... failed
Assertion Failed: EXPECT: Failing step
Captured logging:
CRITICAL:root:Hello Alice
ERROR:foo:Hello Bob
WARNING:foo.bar:Hello CharlyFailing scenarios:Features/log/log.feature:13  Failing0 features passed, 1 failed, 0 skipped
1 scenario passed, 1 failed, 0 skipped
3 steps passed, 1 failed, 0 skipped, 0 undefined
Took 0m0.000s
no-logcapture 模式
PS C:Automation\Test\bdd> behave -f plain -T --logging-level=WARN --no-logcapture
Feature: Log ExampleScenario: Passing
CRITICAL:root:Hello Alice
ERROR:foo:Hello Bob
WARNING:foo.bar:Hello CharlyGiven I create log records with ... passed| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |When another step passes ... passedScenario: Failing
CRITICAL:root:Hello Alice
ERROR:foo:Hello Bob
WARNING:foo.bar:Hello CharlyGiven I create log records with ... passed| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |When another step fails ... failed
Assertion Failed: EXPECT: Failing stepFailing scenarios:Features/log/log.feature:13  Failing0 features passed, 1 failed, 0 skipped
1 scenario passed, 1 failed, 0 skipped
3 steps passed, 1 failed, 0 skipped, 0 undefined
Took 0m0.003s

logging_format

logging.Formatter 类用于配置日志的输出格式。通过使用格式化字符串,您可以指定日志消息的显示方式,包括日期、日志级别、消息内容等。
behave -f plain -T --logging-format=‘LOG.%(levelname)-8s %(name)-10s: %(message)s’

也可以通过配置文件设置:
[behave]
logging_format = %(asctime)s LOG.%(levelname)-8s %(name)s: %(message)s
logging_datefmt = %Y-%m-%dT%H:%M:%S

log_capture 模式
 [behave]
# config for log
log_capture = true
logging_level = WARN
logging_format = %(asctime)s  LOG.%(levelname)-8s %(name)s: %(message)s
logging_datefmt = %Y-%m-%dT%H:%M:%S
PS C:\Automation\Test\bdd> behave
Feature: Log Example # Features/log/log.feature:1Scenario: Passing                 # Features/log/log.feature:3Given I create log records with # steps/log_steps.py:13| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |When another step passes        # steps/log_steps.py:30Scenario: Failing                 # Features/log/log.feature:13Given I create log records with # steps/log_steps.py:13| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |When another step fails         # steps/log_steps.py:40Assertion Failed: EXPECT: Failing stepCaptured logging:2024-01-01T20:51:36  LOG.CRITICAL root: Hello Alice2024-01-01T20:51:36  LOG.ERROR    foo: Hello Bob2024-01-01T20:51:36  LOG.WARNING  foo.bar: Hello CharlyFailing scenarios:Features/log/log.feature:13  Failing0 features passed, 1 failed, 0 skipped
1 scenario passed, 1 failed, 0 skipped
3 steps passed, 1 failed, 0 skipped, 0 undefined
Took 0m0.002s
no-logcapture 模式
 [behave]
# config for log
log_capture = false
logging_level = WARN
logging_format = %(asctime)s  LOG.%(levelname)-8s %(name)s: %(message)s
logging_datefmt = %Y-%m-%dT%H:%M:%S
PS C:\Automation\Test\bdd> behave
Feature: Log Example # Features/log/log.feature:1Scenario: Passing                 # Features/log/log.feature:3Given I create log records with # steps/log_steps.py:13| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |
2024-01-01T20:53:25  LOG.CRITICAL root: Hello Alice
2024-01-01T20:53:25  LOG.ERROR    foo: Hello Bob
2024-01-01T20:53:25  LOG.WARNING  foo.bar: Hello CharlyWhen another step passes        # steps/log_steps.py:30Scenario: Failing                 # Features/log/log.feature:13Given I create log records with # steps/log_steps.py:13| category | level | message      || root     | FATAL | Hello Alice  || foo      | ERROR | Hello Bob    || foo.bar  | WARN  | Hello Charly || bar      | INFO  | Hello Dora   || baz      | DEBUG | Hello Emily  |
2024-01-01T20:53:25  LOG.CRITICAL root: Hello Alice
2024-01-01T20:53:25  LOG.ERROR    foo: Hello Bob
2024-01-01T20:53:25  LOG.WARNING  foo.bar: Hello CharlyWhen another step fails         # steps/log_steps.py:40Assertion Failed: EXPECT: Failing stepFailing scenarios:Features/log/log.feature:13  Failing0 features passed, 1 failed, 0 skipped
1 scenario passed, 1 failed, 0 skipped
3 steps passed, 1 failed, 0 skipped, 0 undefined
Took 0m0.003s

这篇关于BDD - Python Behave log 日志的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/560599

相关文章

Python版本信息获取方法详解与实战

《Python版本信息获取方法详解与实战》在Python开发中,获取Python版本号是调试、兼容性检查和版本控制的重要基础操作,本文详细介绍了如何使用sys和platform模块获取Python的主... 目录1. python版本号获取基础2. 使用sys模块获取版本信息2.1 sys模块概述2.1.1

一文详解Python如何开发游戏

《一文详解Python如何开发游戏》Python是一种非常流行的编程语言,也可以用来开发游戏模组,:本文主要介绍Python如何开发游戏的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、python简介二、Python 开发 2D 游戏的优劣势优势缺点三、Python 开发 3D

Python函数作用域与闭包举例深度解析

《Python函数作用域与闭包举例深度解析》Python函数的作用域规则和闭包是编程中的关键概念,它们决定了变量的访问和生命周期,:本文主要介绍Python函数作用域与闭包的相关资料,文中通过代码... 目录1. 基础作用域访问示例1:访问全局变量示例2:访问外层函数变量2. 闭包基础示例3:简单闭包示例4

Python实现字典转字符串的五种方法

《Python实现字典转字符串的五种方法》本文介绍了在Python中如何将字典数据结构转换为字符串格式的多种方法,首先可以通过内置的str()函数进行简单转换;其次利用ison.dumps()函数能够... 目录1、使用json模块的dumps方法:2、使用str方法:3、使用循环和字符串拼接:4、使用字符

Python版本与package版本兼容性检查方法总结

《Python版本与package版本兼容性检查方法总结》:本文主要介绍Python版本与package版本兼容性检查方法的相关资料,文中提供四种检查方法,分别是pip查询、conda管理、PyP... 目录引言为什么会出现兼容性问题方法一:用 pip 官方命令查询可用版本方法二:conda 管理包环境方法

基于Python开发Windows自动更新控制工具

《基于Python开发Windows自动更新控制工具》在当今数字化时代,操作系统更新已成为计算机维护的重要组成部分,本文介绍一款基于Python和PyQt5的Windows自动更新控制工具,有需要的可... 目录设计原理与技术实现系统架构概述数学建模工具界面完整代码实现技术深度分析多层级控制理论服务层控制注

pycharm跑python项目易出错的问题总结

《pycharm跑python项目易出错的问题总结》:本文主要介绍pycharm跑python项目易出错问题的相关资料,当你在PyCharm中运行Python程序时遇到报错,可以按照以下步骤进行排... 1. 一定不要在pycharm终端里面创建环境安装别人的项目子模块等,有可能出现的问题就是你不报错都安装

Python打包成exe常用的四种方法小结

《Python打包成exe常用的四种方法小结》本文主要介绍了Python打包成exe常用的四种方法,包括PyInstaller、cx_Freeze、Py2exe、Nuitka,文中通过示例代码介绍的非... 目录一.PyInstaller11.安装:2. PyInstaller常用参数下面是pyinstal

Python爬虫HTTPS使用requests,httpx,aiohttp实战中的证书异步等问题

《Python爬虫HTTPS使用requests,httpx,aiohttp实战中的证书异步等问题》在爬虫工程里,“HTTPS”是绕不开的话题,HTTPS为传输加密提供保护,同时也给爬虫带来证书校验、... 目录一、核心问题与优先级检查(先问三件事)二、基础示例:requests 与证书处理三、高并发选型:

Python中isinstance()函数原理解释及详细用法示例

《Python中isinstance()函数原理解释及详细用法示例》isinstance()是Python内置的一个非常有用的函数,用于检查一个对象是否属于指定的类型或类型元组中的某一个类型,它是Py... 目录python中isinstance()函数原理解释及详细用法指南一、isinstance()函数