1FMF(1) User Commands FMF(1)
2
6 fmf - Flexible Metadata Format
7
9 The fmf Python module and command line tool implement a flexible format
10 for defining metadata in plain text files which can be stored close to
11 the source code and structured in a hierarchical way with support for
12 inheritance.
13 Although the proposal initially originated from user stories centered
15 around test execution, the format is general and thus can be used in
16 broader scenarios, e.g. test coverage mapping.
17 Using this approach it's also possible to combine both test execution
19 metadata and test coverage information. Thanks to elasticity and hier‐
20 archy it provides ability to organize data into well-sized text docu‐
21 ments while preventing duplication.
22
24 Command line usage is straightforward:
25 fmf command [options]
27 There are following commands available:
29 fmf ls List identifiers of available objects
31 fmf show Show metadata of available objects
32 fmf init Initialize a new metadata tree
33
35 List names of all objects stored in the metadata tree:
36 fmf ls
38 Show all test metadata (with 'test' attribute defined):
40 fmf show --key test
42 Show metadata for all tree nodes (not only leaves):
44 fmf show --key test --whole
46 List all attributes for the /recursion tests:
48 fmf show --key test --name /recursion
50 Show all covered requirements:
52 fmf show --key requirement --key coverage
54 Search for all tests with the Tier1 tag defined and show a brief sum‐
56 mary of what was found:
57 fmf show --key test --filter tags:Tier1 --verbose
59 Initialize a new metadata tree in the current directory:
61 fmf init
63 Check help message of individual commands for the full list of avail‐
65 able options.
66
68 Here is the list of the most frequently used options.
69 Select
71 Limit which metadata should be listed.
72 --key=KEYS
74 Key content definition (required attributes)
75 --name=NAMES
77 List objects with name matching regular expression
78 --filter=FLTRS
80 Apply advanced filter when selecting objects
81 --whole
83 Consider the whole tree (leaves only by default)
84 For filtering regular expressions can be used as well. See pydoc
86 fmf.filter for advanced filtering options.
87 Format
89 Choose the best format for showing the metadata.
90 --format=FMT
92 Custom output format using the {} expansion
93 --value=VALUES
95 Values for the custom formatting string
96 See online documentation for details about custom format.
98 Utils
100 Various utility options.
101 --path PATHS
103 Path to the metadata tree (default: current directory)
104 --verbose
106 Print additional information standard error output
107 --debug
109 Turn on debugging output, do not catch exceptions
110 Check help message of individual commands for the full list of avail‐
112 able options.
113
115 The fmf package is available in Fedora and EPEL:
116 dnf install fmf
118 Install the latest version from the Copr repository:
120 dnf copr enable psss/fmf
122 dnf install fmf
123 or use PIP (sudo required if not in a virtualenv):
125 pip install fmf
127 See documentation for more details about installation options.
129
131 Git: https://github.com/psss/fmf
132 Docs: http://fmf.readthedocs.io/
134 Issues: https://github.com/psss/fmf/issues
136 Releases: https://github.com/psss/fmf/releases
138 Copr: http://copr.fedoraproject.org/coprs/psss/fmf
140 PIP: https://pypi.python.org/pypi/fmf
142 Travis: https://travis-ci.org/psss/fmf
144 Coveralls: https://coveralls.io/github/psss/fmf
146
148 Petr Šplíchal, Jakub Krysl, Jan Ščotka, Alois Mahdal and Cleber Rosa.
149
151 Copyright (c) 2018 Red Hat, Inc.
152 This program is free software; you can redistribute it and/or modify it
154 under the terms of the GNU General Public License as published by the
155 Free Software Foundation; either version 2 of the License, or (at your
156 option) any later version.
157 January 2018 FMF(1)