-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
tmt, tmt-run, tmt-try: add pages #14921
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,37 @@ | ||||||
# tmt run | ||||||
|
||||||
> Execute tmt test steps. By default, all steps are run. | ||||||
> See also: `tmt`, `tmt-try`. | ||||||
> More information: <https://tmt.readthedocs.io/en/stable/overview.html#run>. | ||||||
- Run all test steps for each plan: | ||||||
|
||||||
`tmt run` | ||||||
|
||||||
- Run only the discover step to show what tests would be run: | ||||||
|
||||||
`tmt run discover -v` | ||||||
|
||||||
- Run all steps, adjust the provision step options: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
`tmt run --all provision --how {{container}} --image {{fedora:rawhide}}` | ||||||
|
||||||
- Run only selected plans and tests: | ||||||
|
||||||
`tmt run plan --name {{/plan/name}} test --name {{/test/name}}` | ||||||
|
||||||
- Show results from the last run in a web browser: | ||||||
|
||||||
`tmt run --last report --how {{html}} --open` | ||||||
|
||||||
- Run tests with the provided context: | ||||||
|
||||||
`tmt run --context {{key=value}} -c {{distro=fedora}}` | ||||||
|
||||||
- Run tests interactively (debug test code in the middle of a test): | ||||||
|
||||||
`tmt run --all execute --how {{tmt}} --interactive` | ||||||
|
||||||
- Use dry mode to see what actions would happen and use highest verbosity: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
`tmt run --dry -vvv` |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,37 @@ | ||||||
# tmt try | ||||||
|
||||||
> Quickly experiment with tests and environments. | ||||||
> See also: `tmt`, `tmt-run`. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
the same as above |
||||||
> More information: <https://tmt.readthedocs.io/en/stable/stories/cli.html#try>. | ||||||
- Quickly experiment with the default provision method (no tests in cwd): | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
`tmt try` | ||||||
|
||||||
- Run a test in the current working directory: | ||||||
|
||||||
`{{cd path/to/test &&}} tmt try` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
- Use a specific operating system: | ||||||
|
||||||
`tmt try {{fedora-41}}` | ||||||
|
||||||
- Select both custom image and provision method: | ||||||
|
||||||
`tmt try {{fedora@container}}` | ||||||
|
||||||
- Select tests with custom filter: | ||||||
|
||||||
`tmt try --test {{feature}}` | ||||||
|
||||||
- Provision guest and wait for instructions: | ||||||
|
||||||
`tmt try --ask` | ||||||
|
||||||
- Directly log into the guest without asking: | ||||||
|
||||||
`tmt try --login` | ||||||
|
||||||
- Display help: | ||||||
|
||||||
`tmt try --help` |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,37 @@ | ||||||
# tmt | ||||||
|
||||||
> Test Management Tool for creating, running and debugging tests. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
> See also: `tmt-run`, `tmt-try`. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
For subcommand mention we use this syntax: |
||||||
> More information: <https://tmt.readthedocs.io>. | ||||||
- Look around to see what's available: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
`tmt` | ||||||
|
||||||
- Initialize tmt files/project structure: | ||||||
|
||||||
`tmt init` | ||||||
|
||||||
- Create a new test with template and link: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
`tmt test create --template {{beakerlib}} --link {{verifies:issue#1234}}` | ||||||
|
||||||
- List available tests, plans, or stories: | ||||||
|
||||||
`tmt <test|plan|story> ls {{pattern}}` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
- Show detailed test metadata in the given context: | ||||||
|
||||||
`tmt --context {{arch=aarch64}} test show` | ||||||
|
||||||
- Validate tmt files against the specification: | ||||||
|
||||||
`tmt lint` | ||||||
|
||||||
- Use filter: | ||||||
|
||||||
`tmt tests ls --filter {{tag:foo}} --filter {{tier:0}}` | ||||||
|
||||||
- Display help: | ||||||
|
||||||
`tmt --help` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do not use this syntax to reference other subcommands.