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.

Sign up for GitHub

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

Document overview of supported restraint scripts #3379

Merged
merged 3 commits into from
Nov 27, 2024
+23 −13
Merged

Document overview of supported restraint scripts #3379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d43454
Document overview of supported `restraint` scripts
psss Nov 26, 2024
d25bd2d
Update the `restraint` story to prevent duplication
psss Nov 26, 2024
1cb4d32
Fix the `rstrnt-*` script names
psss Nov 26, 2024
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
21 changes: 21 additions & 0 deletions docs/questions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,27 @@ Metadata Specification and are supposed to be synced temporarily
to keep backward compatibility.


.. _restraint-compatibility:

Restraint Compatibility
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

For backward-compatibility ``tmt`` provides selected commands
of the `restraint`__ framework so that existing tests can be more
easily migrated. Currently the following scripts are supported:

* ``rhts-abort`` and ``rstrnt-abort`` — :ref:`/stories/features/abort`
* ``rhts-reboot`` and ``rstrnt-reboot`` — :ref:`/stories/features/reboot`
* ``rhts-submit-log`` and ``rstrnt-report-log`` — :ref:`/stories/features/report-log`
* ``rhts-report-result`` and ``rstrnt-report-result`` — :ref:`/stories/features/report-result`

Note that these scripts cover only the common use cases and some
of their irrelevant options, such as ``--server`` used for the
restraint server, are ignored.

__ https://restraint.readthedocs.io/


Why is the 'id' key added to my test during export?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
15 changes: 2 additions & 13 deletions stories/deferred/restraint.fmf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,8 @@ description: |

Although implementation of the full execute step plugin has
been deferred, backward compatibility scripts have been
provided for several most commonly used restraint commands:

rstrnt-abort
:ref:`/stories/features/abort`

rstrnt-reboot
:ref:`/stories/features/reboot`

rstrnt-report-log
:ref:`/stories/features/report-log`

rstrnt-report-result
:ref:`/stories/features/report-result`
provided for several most commonly used restraint commands.
See the :ref:`restraint-compatibility` section for details.

example:
- tmt run --all execute --how restraint