灵活元数据格式
项目描述
灵活元数据格式
描述
fmf Python模块和命令行工具实现了一种灵活的格式,用于在纯文本文件中定义元数据,这些文件可以存储在源代码附近,并以分层方式结构化,支持继承。
尽管这个建议最初是从围绕测试执行的用例中产生的,但这个格式是通用的,因此可以在更广泛的场景中使用,例如测试覆盖率映射。
使用这种方法,还可以结合测试执行元数据和测试覆盖率信息。由于它的弹性和层次结构,它提供了将数据组织成合理大小的文本文档的能力,同时防止重复。
摘要
命令行使用简单直观
fmf command [options]
以下是可以使用的命令:
fmf ls List identifiers of available objects fmf show Show metadata of available objects fmf init Initialize a new metadata tree fmf clean Remove cache directory and its content
示例
列出元数据树中存储的所有对象的名称
fmf ls
显示所有带有 'test' 属性的测试元数据
fmf show --key test
显示所有树节点(不仅是叶子节点)的元数据
fmf show --key test --whole
列出 /recursion 测试的所有属性
fmf show --key test --name /recursion
显示所有覆盖的需求
fmf show --key requirement --key coverage
搜索所有定义了 Tier1 标签的测试,并显示找到的简要总结
fmf show --key test --filter tags:Tier1 --verbose
使用任意的 Python 表达式访问更深层的对象并创建更复杂的条件
fmf show --condition "execute['how'] == 'shell'"
在当前目录中初始化一个新的元数据树
fmf init
检查各个命令的帮助信息以获取完整的选项列表。
选项
以下是最常用的选项列表。
选择
限制要列出的元数据。
- --key=KEYS
键内容定义(必需的属性)
- --name=NAMES
列出与正则表达式匹配名称的对象
- --filter=FLTRS
在选择对象时应用高级过滤
- --condition=EXPR
使用任意的 Python 表达式进行过滤
- --whole
考虑整个树(默认只考虑叶子节点)
对于过滤,也可以使用正则表达式。有关高级过滤选项,请参阅 pydoc fmf.filter。
格式
选择显示元数据的最佳格式。
- --format=FMT
使用 {} 扩展的自定义输出格式
- --value=VALUES
自定义格式字符串的值
有关自定义格式的详细信息,请参阅在线文档。
工具
各种实用选项。
- --path PATHS
元数据树的路径(默认:当前目录)
- --verbose
打印额外的信息到标准错误输出
- --debug
开启调试输出,不要捕获异常
检查各个命令的帮助信息以获取完整的选项列表。
安装
fmf 软件包在 Fedora 和 EPEL 中可用
dnf install fmf
从 Copr 存储库安装最新版本
dnf copr enable @teemtee/fmf dnf install fmf
或使用 PIP
pip install fmf
有关安装选项的详细信息,请参阅文档。
变量
以下是 fmf 理解的环境变量列表
- FMF_CACHE_DIRECTORY
用于缓存 fmf 标识符的 git clone 调用的目录。
链接
Git: https://github.com/teemtee/fmf
文档: http://fmf.readthedocs.io/
问题: https://github.com/teemtee/fmf/issues
版本: https://github.com/teemtee/fmf/releases
版权
版权 (c) 2018-2021 Red Hat, Inc.
本程序是免费软件;您可以在自由软件基金会发布的 GNU 通用公共许可证的条款下重新分发和/或修改它;无论是许可证的第 2 版,还是(您选择的)任何较新版本。
项目详情
下载文件
下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。