def add_command(cls, commands):
parser = commands.add_parser(
"version",
help="version",
epilog=epilog(),
description="Show used framework version.",
formatter_class=HelpFormatter)
parser.add_argument("input",
metavar="input",
type=argtype.logfile("r",
bufsize=1,
encoding="utf-8"),
nargs="?",
help="input log, default: stdin",
default="-")
parser.add_argument("output",
metavar="output",
type=argtype.file("w", bufsize=1,
encoding="utf-8"),
nargs="?",
help='output file, default: stdout',
default="-")
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser("metrics",
help="metrics report",
epilog=epilog(),
description="Generate metrics report.",
formatter_class=HelpFormatter)
parser.add_argument("input",
metavar="input",
type=argtype.logfile("r",
bufsize=1,
encoding="utf-8"),
nargs="?",
help="input log, default: stdin",
default="-")
parser.add_argument("output",
metavar="output",
type=argtype.file("w", bufsize=1,
encoding="utf-8"),
nargs="?",
help='output file, default: stdout',
default="-")
parser.add_argument(
"--format",
metavar="type",
type=str,
help="output format choices: 'openmetrics', default: openmetrics",
choices=["openmetrics"],
default="openmetrics")
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser("attributes",
help="attributes",
epilog=epilog(),
description="Show attributes.",
formatter_class=HelpFormatter)
parser.add_argument("name",
metavar="name",
type=str,
help="test name",
default="",
nargs="?")
parser.add_argument("--log",
metavar="input",
type=argtype.logfile("r",
bufsize=1,
encoding="utf-8"),
nargs="?",
help="input log, default: stdin",
default="-")
parser.add_argument("--output",
metavar="output",
type=argtype.file("w", bufsize=1,
encoding="utf-8"),
nargs="?",
help='output, default: stdout',
default="-")
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser(
"short",
help="short transform",
epilog=epilog(),
description="Transform log into a short format.",
formatter_class=HelpFormatter)
parser.add_argument("input",
metavar="input",
type=argtype.logfile("r",
bufsize=1,
encoding="utf-8"),
nargs="?",
help="input log, default: stdin",
default="-")
parser.add_argument("output",
metavar="output",
type=argtype.file("w", bufsize=1,
encoding="utf-8"),
nargs="?",
help='output file, default: stdout',
default="-")
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser(
"results",
help="results report",
epilog=epilog(),
description="Generate results comparison report.",
formatter_class=HelpFormatter)
cls.add_arguments(parser)
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser("document", help="document processing", epilog=epilog(),
description="Work with a document.",
formatter_class=HelpFormatter)
document_commands = parser.add_subparsers(title="commands", metavar="command",
description=None, help=None)
document_commands.required = True
convert_handler.add_command(document_commands)
toc_handler.add_command(document_commands)
def add_command(cls, commands):
parser = commands.add_parser("new", help="create new document", epilog=epilog(),
description="Create new document.",
formatter_class=HelpFormatter)
new_commands = parser.add_subparsers(title="commands", metavar="command",
description=None, help=None)
new_commands.required = True
requirements_handler.add_command(new_commands)
def add_command(cls, commands):
parser = commands.add_parser("show", help="show test data", epilog=epilog(),
description="Show test data.",
formatter_class=HelpFormatter)
show_commands = parser.add_subparsers(title="commands", metavar="command",
description=None, help=None)
show_commands.required = True
test_handler.add_command(show_commands)
tests_handler.add_command(show_commands)
def add_command(cls, commands):
parser = commands.add_parser("fails", help="fails transform", epilog=epilog(),
description="Transform log into a fails summary format.",
formatter_class=HelpFormatter)
parser.add_argument("input", metavar="input", type=argtype.logfile("r", bufsize=1, encoding="utf-8"),
nargs="?", help="input log, default: stdin", default="-")
parser.add_argument("output", metavar="output", type=argtype.file("w", bufsize=1, encoding="utf-8"),
nargs="?", help="output file, default: stdout", default="-")
parser.add_argument("-n", "--new", action="store_true", help="show only new fails", default=False)
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser("compact", help="compact transform", epilog=epilog(),
description="Transform log into compact raw log containing only test results.",
formatter_class=HelpFormatter)
parser.add_argument("--with-steps", action="store_true", help="include test steps, default: False")
parser.add_argument("input", metavar="input", type=argtype.file("r", bufsize=1, encoding="utf-8"),
nargs="?", help="input log, default: stdin", default="-")
parser.add_argument("output", metavar="output", type=argtype.file("w", bufsize=1, encoding="utf-8"),
nargs="?", help='output file, default: stdout', default="-")
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser("database",
help="database actions",
epilog=epilog(),
description="Database actions.",
formatter_class=HelpFormatter)
database_commands = parser.add_subparsers(title="commands",
metavar="command",
description=None,
help=None)
database_commands.required = True
create_handler.add_command(database_commands)
def add_command(cls, commands):
parser = commands.add_parser("requirements",
help="requirement processing",
epilog=epilog(),
description="Work with requirements.",
formatter_class=HelpFormatter)
requirement_commands = parser.add_subparsers(title="commands",
metavar="command",
description=None,
help=None)
requirement_commands.required = True
generate_handler.add_command(requirement_commands)
def add_command(cls, commands):
parser = commands.add_parser("create",
help="create database",
epilog=epilog(),
description="Create new database.",
formatter_class=HelpFormatter)
parser.add_argument("-f",
"--force",
action="store_true",
help="delete any existing database",
default=False)
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser(
"log",
help="retrieve last temporary test log",
epilog=epilog(),
description="Retrieve last temporary test log.",
formatter_class=HelpFormatter)
parser.add_argument("output",
metavar="output",
type=argtype.file("wb"),
help='output file, stdout: \'-\'')
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser("test",
help="test data",
epilog=epilog(),
description="Show single test data.",
formatter_class=HelpFormatter)
test_commands = parser.add_subparsers(title="commands",
metavar="command",
description=None,
help=None)
test_commands.required = True
details_handler.add_command(test_commands)
procedure_handler.add_command(test_commands)
messages_handler.add_command(test_commands)
def add_command(cls, commands):
parser = commands.add_parser(
"metrics",
help="metrics report",
epilog=epilog(),
description="Generate metrics comparison report.",
formatter_class=HelpFormatter)
cls.add_arguments(parser)
parser.add_argument("--name",
metavar="name",
type=str,
nargs="+",
help="metrics name, default: test-time",
default=["test-time"])
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser(
"compare",
help="comparison report",
epilog=epilog(),
description="Generate comparison report between runs.",
formatter_class=HelpFormatter)
report_commands = parser.add_subparsers(title="commands",
metavar="command",
description=None,
help=None)
report_commands.required = True
results_handler.add_command(report_commands)
metrics_handler.add_command(report_commands)
def add_command(cls, commands):
parser = commands.add_parser("report", help="generate report", epilog=epilog(),
description="Generate report.",
formatter_class=HelpFormatter)
report_commands = parser.add_subparsers(title="commands", metavar="command",
description=None, help=None)
report_commands.required = True
official_handler.add_command(report_commands)
compare_handler.add_command(report_commands)
totals_handler.add_command(report_commands)
passing_handler.add_command(report_commands)
fails_handler.add_command(report_commands)
version_handler.add_command(report_commands)
requirements_handler.add_command(report_commands)
srs_coverage_handler.add_command(report_commands)
map_handler.add_command(report_commands)
def add_command(cls, commands):
parser = commands.add_parser("transform",
help="log file transformation",
epilog=epilog(),
description="Transform log files.",
formatter_class=HelpFormatter)
transform_commands = parser.add_subparsers(title="commands",
metavar="command",
description=None,
help=None)
transform_commands.required = True
nice_handler.add_command(transform_commands)
short_handler.add_command(transform_commands)
slick_handler.add_command(transform_commands)
dots_handler.add_command(transform_commands)
index_handler.add_command(transform_commands)
compact_handler.add_command(transform_commands)
def add_command(cls, commands):
parser = commands.add_parser("report",
help="generate report",
epilog=epilog(),
description="Generate report.",
formatter_class=HelpFormatter)
report_commands = parser.add_subparsers(title="commands",
metavar="command",
description=None,
help=None)
report_commands.required = True
results_handler.add_command(report_commands)
specification_handler.add_command(report_commands)
tracebility_handler.add_command(report_commands)
coverage_handler.add_command(report_commands)
compare_handler.add_command(report_commands)
metrics_handler.add_command(report_commands)
def add_command(cls, commands):
parser = commands.add_parser("results", help="results report", epilog=epilog(),
description="Generate results report.",
formatter_class=HelpFormatter)
parser.add_argument("input", metavar="input", type=argtype.logfile("r", bufsize=1, encoding="utf-8"),
nargs="?", help="input log, default: stdin", default="-")
parser.add_argument("output", metavar="output", type=argtype.file("w", bufsize=1, encoding="utf-8"),
nargs="?", help='output file, default: stdout', default="-")
parser.add_argument("-a", "--artifacts", metavar="link", type=str, help='link to the artifacts')
parser.add_argument("--format", metavar="type", type=str,
help="output format choices: 'md', 'json', default: md (Markdown)", choices=["md", "json"], default="md")
parser.add_argument("--copyright", metavar="name", help="add copyright notice", type=str)
parser.add_argument("--confidential", help="mark as confidential", action="store_true")
parser.add_argument("--logo", metavar="path", type=argtype.file("rb"),
help='use logo image (.png)')
parser.add_argument("--title", metavar="name", help="custom title", type=str)
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser(
"specification",
help="specification report",
epilog=epilog(),
description="Generate specifiction report.",
formatter_class=HelpFormatter)
parser.add_argument("input",
metavar="input",
type=argtype.logfile("r",
bufsize=1,
encoding="utf-8"),
nargs="?",
help="input log, default: stdin",
default="-")
parser.add_argument("output",
metavar="output",
type=argtype.file("w", bufsize=1,
encoding="utf-8"),
nargs="?",
help='output file, default: stdout',
default="-")
parser.add_argument("--copyright",
metavar="name",
help="add copyright notice",
type=str)
parser.add_argument("--confidential",
help="mark as confidential",
action="store_true")
parser.add_argument("--logo",
metavar="path",
type=argtype.file("rb"),
help='use logo image (.png)')
parser.add_argument("--title",
metavar="name",
help="custom title",
type=str)
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser(
"compress",
help="compress transform",
epilog=epilog(),
description="Transform file into a compressed format.",
formatter_class=HelpFormatter)
parser.add_argument("input",
metavar="input",
type=argtype.logfile("rb"),
nargs="?",
help="input file, default: stdin",
default="-")
parser.add_argument("output",
metavar="output",
type=argtype.logfile("wb"),
nargs="?",
help='output file, default: stdout',
default="-")
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser("messages",
help="messages",
epilog=epilog(),
description="Show messages.",
formatter_class=HelpFormatter)
parser.add_argument("name",
metavar="name",
type=str,
help="test name",
default=".*?",
nargs="?")
parser.add_argument("--log",
metavar="input",
type=argtype.logfile("r",
bufsize=1,
encoding="utf-8"),
nargs="?",
help="input log, default: stdin",
default="-")
parser.add_argument("--output",
metavar="output",
type=argtype.file("w", bufsize=1,
encoding="utf-8"),
nargs="?",
help='output, default: stdout',
default="-")
format_choices = ["nice", "raw", "short", "slick"]
parser.add_argument(
"--format",
"-f",
metavar="name",
type=str,
choices=format_choices,
default="nice",
help=f"output format, choices are {format_choices}, default: nice")
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser(
"srs-coverage",
help="SRS (Software Requirements Specification) coverage report",
epilog=epilog(),
description=
"Generate SRS (Software Requirements Specification) coverage report.",
formatter_class=HelpFormatter)
parser.add_argument("srs",
metavar="srs",
type=argtype.file("r", bufsize=1,
encoding="utf-8"),
nargs=1,
help="source file")
parser.add_argument("input",
metavar="input",
type=argtype.logfile("r",
bufsize=1,
encoding="utf-8"),
nargs="?",
help="input log, default: stdin",
default="-")
parser.add_argument("output",
metavar="output",
type=argtype.file("w", bufsize=1,
encoding="utf-8"),
nargs="?",
help='output file, default: stdout',
default="-")
parser.add_argument("--only",
metavar="status",
type=str,
nargs="+",
help="verification status",
choices=["satisfied", "unsatisfied", "untested"],
default=["satisfied", "unsatisfied", "untested"])
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser("convert",
help="convert document",
epilog=epilog(),
description="Convert markdown document.",
formatter_class=HelpFormatter)
parser.add_argument("input",
metavar="input",
type=argtype.file("r", bufsize=1,
encoding="utf-8"),
nargs="?",
help="input file, default: stdin",
default="-")
parser.add_argument("output",
metavar="output",
type=argtype.file("w", bufsize=1,
encoding="utf-8"),
nargs="?",
help='output file, default: stdout',
default="-")
parser.add_argument("-f",
"--format",
metavar="format",
type=str,
help="format, default: html",
choices=["html"],
default="html")
parser.add_argument("-s",
"--stylesheet",
metavar="css",
type=argtype.file("r", bufsize=1,
encoding="utf-8"),
help="custom stylesheet",
default=stylesheet)
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser(
"fails",
help="fails report",
epilog=epilog(),
description="Generate report showing only failed tests.",
formatter_class=HelpFormatter)
parser.add_argument("input",
metavar="input",
type=argtype.file("r", bufsize=1,
encoding="utf-8"),
nargs="?",
help="input log, default: stdin",
default="-")
parser.add_argument("output",
metavar="output",
type=argtype.file("w", bufsize=1,
encoding="utf-8"),
nargs="?",
help='output file, default: stdout',
default="-")
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser(
"generate",
help="generate requirements",
epilog=epilog(),
description="Generate requirements from an SRS document.",
formatter_class=HelpFormatter)
parser.add_argument("input",
metavar="input",
type=argtype.file("r", bufsize=1,
encoding="utf-8"),
nargs="?",
help="input file, default: stdin",
default="-")
parser.add_argument("output",
metavar="output",
type=argtype.file("w", bufsize=1,
encoding="utf-8"),
nargs="?",
help='output file, default: stdout',
default="-")
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser(
"compare",
help="comparison report",
epilog=epilog(),
description="Generate comparison report between test runs.",
formatter_class=HelpFormatter)
parser.add_argument("--log",
metavar="pattern",
type=argtype.file("r", bufsize=1,
encoding="utf-8"),
nargs="+",
help="log file pattern",
required=True)
parser.add_argument(
"--log-link",
metavar="attribute",
help=
"attribute that is used as a link for the log, default: job.url",
type=str,
default="job.url")
parser.add_argument("--only",
metavar="pattern",
nargs="+",
help="compare only selected tests",
type=str,
required=False)
parser.add_argument("--order-by",
metavar="attribute",
type=str,
help="attribute that is used to order the logs")
parser.add_argument(
"--sort",
metavar="direction",
type=str,
help="sort direction. Either 'asc' or 'desc', default: asc",
choices=["asc", "desc"],
default="asc")
parser.add_argument("--format",
metavar="type",
type=str,
help="output format, default: md (Markdown)",
choices=["md"],
default="md")
parser.add_argument("output",
metavar="output",
type=argtype.file("w", bufsize=1,
encoding="utf-8"),
nargs="?",
help='output file, default: stdout',
default="-")
parser.add_argument("--copyright",
metavar="name",
help="add copyright notice",
type=str)
parser.add_argument("--confidential",
help="mark as confidential",
action="store_true")
parser.add_argument("--logo",
metavar="path",
type=argtype.file("rb"),
help='use logo image (.png)')
parser.set_defaults(func=cls())
def add_command(cls, commands):
parser = commands.add_parser(
"requirements-coverage",
help="requirements coverage report",
epilog=epilog(),
description="Generate requirements coverage report.",
formatter_class=HelpFormatter)
parser.add_argument("requirements",
metavar="source",
type=str,
help="requirements source file")
parser.add_argument("input",
metavar="input",
type=argtype.file("r", bufsize=1,
encoding="utf-8"),
nargs="?",
help="input log, default: stdin",
default="-")
parser.add_argument("output",
metavar="output",
type=argtype.file("w", bufsize=1,
encoding="utf-8"),
nargs="?",
help='output file, default: stdout',
default="-")
parser.add_argument(
"--show",
metavar="status",
type=str,
nargs="+",
help=
"verification status. Choices: 'satisfied', 'unsatisfied', 'untested'",
choices=["satisfied", "unsatisfied", "untested"],
default=["satisfied", "unsatisfied", "untested"])
parser.add_argument(
"--input-link",
metavar="attribute",
help=
"attribute that is used as a link to the input log, default: job.url",
type=str,
default="job.url")
parser.add_argument("--format",
metavar="type",
type=str,
help="output format, default: md (Markdown)",
choices=["md"],
default="md")
parser.add_argument("--copyright",
metavar="name",
help="add copyright notice",
type=str)
parser.add_argument("--confidential",
help="mark as confidential",
action="store_true")
parser.add_argument("--logo",
metavar="path",
type=argtype.file("rb"),
help='use logo image (.png)')
parser.set_defaults(func=cls())
