Support `--workdir-root` in the `tmt clean` command #2850

skycastlelily · 2024-04-12T07:35:49Z

Pull Request Checklist

implement the feature
extend the test coverage
include a release note

tmt/base.py

skycastlelily · 2024-09-25T09:07:42Z

Hi Petr, @psss, would you please spare some time to review this merge request,please? This is supposed to address #2807 , sorry for forgetting mentioned it before 1.36 release,and hope we can have this merged for 1.37: )

docs/releases.rst

martinhoyer

lgtm. Just nitpicks.
I'm surprised setting a workdir root is so complicated tbh (not necessarily related to these changes). :)

tmt/cli.py

tmt/utils/__init__.py

thrix · 2024-09-26T11:50:48Z

@skycastlelily would it be possible to log the workdir root please in case the verbose mode is enabled please?

Something like:

❯ env | grep WORKDIR
TMT_WORKDIR_ROOT=/var/home/mvadkert/.local/share/tmt

❯ tmt clean -v
clean
    workdir /var/home/mvadkert/.local/share/tmt
guests
runs
images
    testcloud

tmt/base.py

tmt/utils/__init__.py

tmt/options.py

skycastlelily · 2024-10-16T14:28:31Z

ah,yes, I misunderstood you by somehow overlooking "I for one would still use self.workdir_root" 😅,anyway,rebased and updated^^

…

On Wed, Oct 16, 2024 at 9:12 PM Miloš Prchlík ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In tmt/base.py <#2850 (comment)>: > @@ -3900,7 +3902,7 @@ def _stop_running_guests(self, run: Run) -> bool: def guests(self, run_ids: tuple[str, ...]) -> bool: """ Clean guests of runs """ self.info('guests', color='blue') - root_path = Path(self.opt('workdir-root')) + root_path = Path(self.workdir_root) This does not seem to be addressed yet. — Reply to this email directly, view it on GitHub <#2850 (comment)>, or unsubscribe <https:/notifications/unsubscribe-auth/AKFR23DJFT5KI25AAWU7TRTZ3ZQ4DAVCNFSM6AAAAABGDUNQC6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDGNZSGQZTCMBSGE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

tmt/cli.py

skycastlelily · 2024-10-16T15:00:49Z

Updated^^

…

On Wed, Oct 16, 2024 at 10:37 PM Miloš Prchlík ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In tmt/cli.py <#2850 (comment)>: > @@ -1930,25 +1935,24 @@ def clean(context: Context, exit_code = 0 if context.invoked_subcommand is None: assert context.obj.clean_logger is not None # narrow type - - # Set path to default - context.params['workdir_root'] = tmt.utils.WORKDIR_ROOT + root_path = effective_workdir_root(workdir_root) One more root_path we should root out and replace with workdir_root. We can definitely re-use the workdir_root name to hold the workdir root, the one we get from effective_workdir_root, it should be the same type and meaning. — Reply to this email directly, view it on GitHub <#2850 (review)>, or unsubscribe <https:/notifications/unsubscribe-auth/AKFR23F6EILSJA42FNOFZXTZ3Z223AVCNFSM6AAAAABGDUNQC6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDGNZSG4YTENBVGE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

happz · 2024-10-18T09:13:06Z

@skycastlelily please, check the tests, there seems to be some issue with a missing argument. No idea why pre-commit and linters did not report it :/

Edit: got it. It's the status subcommand in cli.py, it still accepts workdir_root from options, but it must accept _workdir_root, and do the workdir_root = path(_workdir_root) dance.

And linters didn't report it because they don't see into Click and options...

skycastlelily · 2024-10-18T14:23:21Z

Updated,should be good now:)

…

On Fri, Oct 18, 2024 at 5:13 PM Miloš Prchlík ***@***.***> wrote: @skycastlelily <https:/skycastlelily> please, check the tests, there seems to be some issue with a missing argument. No idea why pre-commit and linters did not report it :/ — Reply to this email directly, view it on GitHub <#2850 (comment)>, or unsubscribe <https:/notifications/unsubscribe-auth/AKFR23FK6HF4FPVOHY3MKJ3Z4DGLTAVCNFSM6AAAAABGDUNQC6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMRRHEZDQOJVGU> . You are receiving this because you were mentioned.Message ID: ***@***.***>

docs/releases.rst

skycastlelily · 2024-10-21T14:59:07Z

Updated😅

…

On Mon, Oct 21, 2024 at 7:16 PM Miloš Prchlík ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In docs/releases.rst <#2850 (comment)>: > @@ -4,10 +4,12 @@ Releases ====================== - This line should not be removed. — Reply to this email directly, view it on GitHub <#2850 (review)>, or unsubscribe <https:/notifications/unsubscribe-auth/AKFR23GKUJVGTGPECMSCPGLZ4TPBDAVCNFSM6AAAAABGDUNQC6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDGOBRG4ZDEMJQGM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

…rkdir_root

psss

Looks good, just one nitpick. Also proposing a minore release note enhancement in 94b9098. @skycastlelily, does it look goot to you?

psss · 2024-10-22T09:56:46Z

tmt/cli.py

- logger=context.obj.logger.clone().apply_verbosity_options(**kwargs),
- cli_invocation=CliInvocation.from_context(context))
+ logger=context.obj.logger.clone().
+ apply_verbosity_options(**kwargs),


Is the new line really needed here?

psss · 2024-10-22T10:06:00Z

@skycastlelily, what about extending /tests/clean/basic a bit to add at least a very basic coverage for the new option?

skycastlelily requested review from psss, lukaszachy, happz, thrix and janhavlin as code owners April 12, 2024 07:35

skycastlelily mentioned this pull request Apr 12, 2024

tmt clean (virtual)guests doesn't work well with --workdir-root cli opt #2834

Open

happz reviewed Apr 16, 2024

View reviewed changes

tmt/base.py Outdated Show resolved Hide resolved

skycastlelily force-pushed the effective branch from bccb7e3 to b4e2de6 Compare April 16, 2024 14:36

skycastlelily changed the title ~~Accept CLI input in get_effective_root , and have Clean use it.~~ Accept CLI input in effective_workdir_root , and have Clean use it. Apr 16, 2024

skycastlelily force-pushed the effective branch 2 times, most recently from 1f8d67b to 8bd2d7f Compare April 24, 2024 01:19

skycastlelily force-pushed the effective branch 2 times, most recently from 8c8da09 to 8d9a62a Compare August 22, 2024 08:37

skycastlelily mentioned this pull request Aug 22, 2024

users are not able to choose workdir-root if they run tmt clean command #2807

Open

skycastlelily force-pushed the effective branch from 8d9a62a to d3ee2a2 Compare August 27, 2024 08:46

skycastlelily requested a review from frantisekz as a code owner August 28, 2024 03:33

skycastlelily force-pushed the effective branch from b845dbc to caa18b9 Compare August 28, 2024 08:47

skycastlelily force-pushed the effective branch from caa18b9 to 4a5c49e Compare September 25, 2024 08:58

skycastlelily added this to the 1.37 milestone Sep 25, 2024

skycastlelily added the ci | full test Pull request is ready for the full test execution label Sep 25, 2024

thrix requested a review from happz September 26, 2024 11:36

thrix reviewed Sep 26, 2024

View reviewed changes

docs/releases.rst Outdated Show resolved Hide resolved

thrix reviewed Sep 26, 2024

View reviewed changes

docs/releases.rst Outdated Show resolved Hide resolved

martinhoyer reviewed Sep 26, 2024

View reviewed changes

tmt/cli.py Show resolved Hide resolved

tmt/utils/__init__.py Outdated Show resolved Hide resolved

happz reviewed Sep 26, 2024

View reviewed changes

tmt/base.py Outdated Show resolved Hide resolved

happz reviewed Sep 26, 2024

View reviewed changes

tmt/base.py Outdated Show resolved Hide resolved

happz reviewed Sep 26, 2024

View reviewed changes

tmt/utils/__init__.py Outdated Show resolved Hide resolved

happz reviewed Sep 26, 2024

View reviewed changes

tmt/options.py Outdated Show resolved Hide resolved

therazix approved these changes Oct 15, 2024

View reviewed changes

skycastlelily force-pushed the effective branch from ff423c9 to 687c21b Compare October 16, 2024 14:27

happz reviewed Oct 16, 2024

View reviewed changes

tmt/cli.py Outdated Show resolved Hide resolved

skycastlelily force-pushed the effective branch from d42582c to c15154b Compare October 18, 2024 14:22

happz reviewed Oct 21, 2024

View reviewed changes

docs/releases.rst Outdated Show resolved Hide resolved

skycastlelily force-pushed the effective branch from 316683b to f071b81 Compare October 21, 2024 14:58

happz approved these changes Oct 22, 2024

View reviewed changes

skycastlelily added 8 commits October 22, 2024 10:45

Accept CLI input in effective_workdir_root, and have Common accept wo…

2443812

…rkdir_root

Add support workdir-root for clean command

a759186

Update default value,doc and add verbose log

25ab975

update^^

a49a587

squash: don't create local variable

67eb02b

squash: no root_path^^

8feaaaf

squash: fix test error

680e7d8

squash:update^^

8791204

happz force-pushed the effective branch from f071b81 to 8791204 Compare October 22, 2024 08:46

happz added command | clean tmt clean command code | cli Changes related to the command line interface status | ready for merge The only missing piece is to do the rebase the current 'main' and let the CI finish. labels Oct 22, 2024

Improve slightly the release note

94b9098

psss approved these changes Oct 22, 2024

View reviewed changes

psss changed the title ~~Accept CLI input in effective_workdir_root , and have Clean use it.~~ Support --workdir-root in the tmt clean command Oct 22, 2024

psss added status | need tests Test coverage to be added for the affected code and removed status | ready for merge The only missing piece is to do the rebase the current 'main' and let the CI finish. labels Oct 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support `--workdir-root` in the `tmt clean` command #2850

Support `--workdir-root` in the `tmt clean` command #2850

skycastlelily commented Apr 12, 2024 •

edited by psss

Loading

skycastlelily commented Sep 25, 2024

martinhoyer left a comment

thrix commented Sep 26, 2024

skycastlelily commented Oct 16, 2024 via email

skycastlelily commented Oct 16, 2024 via email

happz commented Oct 18, 2024 •

edited

Loading

skycastlelily commented Oct 18, 2024 via email

skycastlelily commented Oct 21, 2024 via email

psss left a comment

psss Oct 22, 2024

psss commented Oct 22, 2024

Support --workdir-root in the tmt clean command #2850

Are you sure you want to change the base?

Support --workdir-root in the tmt clean command #2850

Conversation

skycastlelily commented Apr 12, 2024 • edited by psss Loading

skycastlelily commented Sep 25, 2024

martinhoyer left a comment

Choose a reason for hiding this comment

thrix commented Sep 26, 2024

skycastlelily commented Oct 16, 2024 via email

skycastlelily commented Oct 16, 2024 via email

happz commented Oct 18, 2024 • edited Loading

skycastlelily commented Oct 18, 2024 via email

skycastlelily commented Oct 21, 2024 via email

psss left a comment

Choose a reason for hiding this comment

psss Oct 22, 2024

Choose a reason for hiding this comment

psss commented Oct 22, 2024

Support `--workdir-root` in the `tmt clean` command #2850

Support `--workdir-root` in the `tmt clean` command #2850

skycastlelily commented Apr 12, 2024 •

edited by psss

Loading

happz commented Oct 18, 2024 •

edited

Loading