https://jira.whamcloud.com This file is an XML representation of an issue en-us 9.4.14 940014 05-12-2023 https://jira.whamcloud.com/browse/LU-16392 Lustre <p>There are a few regressions introduced in the bash completions for <tt>lctl</tt> and <tt>lfs</tt>.</p> <p>1. Attempting completion for <tt>lctl</tt> prints a message to stderr and does not generate any completions. To test this behavior interactively, type <tt>lctl &lt;tab&gt;</tt>. To test this behavior programmatically, run</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-bash"> source lustre/scripts/bash-completion/lustre; COMPLETIONS=$( _lustre_cmds lctl) &amp;&amp; [ ! -z <span class="code-quote-red">"<span class="code-object">$COMPLETIONS</span>"</span> ]</pre> </div></div> <p>An exit status of 1 indicates the bug is present.</p> <p> </p> <p>2. Completion for <tt>lfs check</tt> gives incorrect results.</p> <p> </p> <p>3. Attempting completion for <tt>lfs find -component-flags</tt> erroneously prints a message to stderr.</p> LU-16392

Bash completion regressions, lctl and lfs

Bug Minor Resolved Fixed Thomas Bertschinger Thomas Bertschinger Tue, 13 Dec 2022 17:58:54 +0000 Thu, 7 Dec 2023 11:12:34 +0000 Fri, 3 Feb 2023 14:05:26 +0000 Lustre 2.16.0 Lustre 2.16.0 0 4 <p>It looks like this is a regression from patch <a href="https://review.whamcloud.com/47162" class="external-link" target="_blank" rel="nofollow noopener">https://review.whamcloud.com/47162</a> "<tt><a href="https://jira.whamcloud.com/browse/LU-8621" title="Parser_execarg() prints help to stderr, usage to stdout" class="issue-link" data-issue-key="LU-8621"><del>LU-8621</del></a> utils: cmd help to stdout or short cmd error</tt>"</p> <p>Thomas, thanks for your bug report. Any chance you could investigate how to change bash completion to call "<tt>lctl --list-commands</tt>" to generate to command list instead of just a null input?</p> <p>Otherwise, it should be possible to revert the above patch to restore the basic functionality, with the accompanying spew of lines for any error (which is why it was changed originally).</p> <blockquote> <p>To test this behavior programmatically, run:</p> <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> <pre>source lustre/scripts/bash-completion/lustre; COMPLETIONS=$( _lustre_cmds lctl) &amp;&amp; [ ! -z "$COMPLETIONS" ] </pre> </div></div></blockquote> <p>Thanks for this. I was wondering how we might be able to write a regression test for this without having interactive usage. </p> <p>I considered resolving this by using <tt>lctl --list-commands</tt>, but there are two problems:</p> <ol> <li><tt>--list-commands</tt> truncates long options, thus generating incorrect completions (example: <tt>changelog_deregister)</tt></li> <li><tt>lctl --list-commands</tt> lists options for sub-commands which do not apply to the top-level command, and I don't know how to work around this within the bash completion interface (example: <tt>lctl pcc add</tt>: bash would suggest both <tt>pcc</tt> and <tt>add</tt> as completions)</li> </ol> <p>I have a patch in progress that adds an option <tt>--list-commands-brief</tt> which prints out subcommands without the above two problems. This has the advantage of not changing existing behavior of the CLI tools, but the disadvantage is adding a new, perhaps superfluous option. What do you think of this idea? An alternative would be modifying the format of <tt>lctl --list-commands</tt>.</p> <p>Note, in this bug report I only mentioned <tt>lctl</tt> but this problem applies to <tt>lfs</tt> as well.</p> <p>I was looking at the command truncation issue as well. It looks like we are out by only a character or two in a few rare cases. It would be better to misalign the output by a few characters to fit in the longest options I think, rather than creating a new option. </p> <p>For the sub-commands, is it possible to list only the top-level command, and then add eg. "<tt>lctl pcc &#45;&#45;list&#45;commands</tt>" to generate the list of sub commands for the completion (ie. it passes the sub-command as well, not just "<tt>lctl &#45;&#45;list&#45;commands</tt>").?</p> <p>Also, in a semi-related note, I'm not sure why "<tt>&#45;&#45;list&#45;commands</tt>" was used here instead of using "<tt>&#45;&#45;help</tt>" to get this list, but it would be good to allow both (though "<tt>&#45;&#45;list&#45;commands</tt>" should be used for the completions since it has existed much longer).</p> <p>"Thomas Bertschinger &lt;bertschinger@lanl.gov&gt;" uploaded a new patch: <a href="https://review.whamcloud.com/c/fs/lustre-release/+/49484" class="external-link" target="_blank" rel="nofollow noopener">https://review.whamcloud.com/c/fs/lustre-release/+/49484</a><br/> Subject: <a href="https://jira.whamcloud.com/browse/LU-16392" title="Bash completion regressions, lctl and lfs" class="issue-link" data-issue-key="LU-16392"><del>LU-16392</del></a> utils: use --list-commands for bash completion<br/> Project: fs/lustre-release<br/> Branch: master<br/> Current Patch Set: 1<br/> Commit: 7c02a52fd57e2a0fa7e35c6cf3dad16ba12cb8d1</p> <p>Does not affect b2_15- just master </p> <p>"Oleg Drokin &lt;green@whamcloud.com&gt;" merged in patch <a href="https://review.whamcloud.com/c/fs/lustre-release/+/49484/" class="external-link" target="_blank" rel="nofollow noopener">https://review.whamcloud.com/c/fs/lustre-release/+/49484/</a><br/> Subject: <a href="https://jira.whamcloud.com/browse/LU-16392" title="Bash completion regressions, lctl and lfs" class="issue-link" data-issue-key="LU-16392"><del>LU-16392</del></a> utils: use --list-commands for bash completion<br/> Project: fs/lustre-release<br/> Branch: master<br/> Current Patch Set: <br/> Commit: b4cc570ad11c1c07a6e1d825787ccc62c1245ca1</p> <p>Landed for 2.16</p> Related LU-5170 LU-8621 LU-13225 LU-12734 LU-930 Development Rank 1|i037v3: Rank (Obsolete) 9223372036854775807 Severity