Skip to content
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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions pages/linux/tmt-run.md
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`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> See also: `tmt`, `tmt-try`.

We do not use this syntax to reference other subcommands.

> 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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Run all steps, adjust the provision step options:
- Run all steps and adjust the provision step options:


`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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Use dry mode to see what actions would happen and use highest verbosity:
- Use dry mode to see what actions would happen and use the highest verbosity:


`tmt run --dry -vvv`
37 changes: 37 additions & 0 deletions pages/linux/tmt-try.md
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`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> See also: `tmt`, `tmt-run`.

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):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Quickly experiment with the default provision method (no tests in cwd):
- Quickly experiment with the default provision method (no tests in the CWD):


`tmt try`

- Run a test in the current working directory:

`{{cd path/to/test &&}} tmt try`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`{{cd path/to/test &&}} tmt try`
`cd {{path/to/test}} && tmt try`


- 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`
37 changes: 37 additions & 0 deletions pages/linux/tmt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# tmt

> Test Management Tool for creating, running and debugging tests.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> Test Management Tool for creating, running and debugging tests.
> Test Management Tool for creating, running, and debugging tests.

https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#serial-comma

> See also: `tmt-run`, `tmt-try`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> See also: `tmt-run`, `tmt-try`.
> Some subcommands such as `run`, `try`, etc. have their own usage documentation.

For subcommand mention we use this syntax:
https://github.com/tldr-pages/tldr/blob/main/contributing-guides/translation-templates/subcommand-mention.md

> More information: <https://tmt.readthedocs.io>.
- Look around to see what's available:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Look around to see what's available:
- List available tests, plans, and stories:


`tmt`

- Initialize tmt files/project structure:

`tmt init`

- Create a new test with template and link:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Create a new test with template and link:
- Create a new test with a template and link:


`tmt test create --template {{beakerlib}} --link {{verifies:issue#1234}}`

- List available tests, plans, or stories:

`tmt <test|plan|story> ls {{pattern}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`tmt <test|plan|story> ls {{pattern}}`
`tmt {{test|plan|story}} ls {{pattern}}`


- 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`