Skip to content

Commit

Permalink
tmt, tmt-run, tmt-try: add pages (#14921)
Browse files Browse the repository at this point in the history
Co-authored-by: Wiktor Perskawiec <[email protected]>
Co-authored-by: Lena <[email protected]>
  • Loading branch information
3 people authored Nov 25, 2024
1 parent df8d443 commit f8e3196
Show file tree
Hide file tree
Showing 3 changed files with 109 additions and 0 deletions.
36 changes: 36 additions & 0 deletions pages/linux/tmt-run.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# tmt run

> Execute tmt test steps. By default, all steps are run.
> 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 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 the highest verbosity:

`tmt run --dry -vvv`
36 changes: 36 additions & 0 deletions pages/linux/tmt-try.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# tmt try

> Quickly experiment with tests and environments.
> More information: <https://tmt.readthedocs.io/en/stable/stories/cli.html#try>.
- 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`

- 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.
> Some subcommands such as `run`, `try`, etc. have their own usage documentation.
> More information: <https://tmt.readthedocs.io>.
- List available tests, plans, and stories:

`tmt`

- Initialize tmt files/project structure:

`tmt init`

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

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

- List available tests, plans, or stories:

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

0 comments on commit f8e3196

Please sign in to comment.