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-6056 Lustre <p>sanity-hsm (and probably all test scripts) contains several instances of the following</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> local fid=$(make_large_for_striping $f) [ $? != 0 ] &amp;&amp; skip <span class="code-quote">"not enough free space"</span> &amp;&amp; <span class="code-keyword">return</span> </pre> </div></div> <p>This is wrong since the exit status of make_large_for_striping gets discarded when used with the local built-in.</p> <p>If this is rewritten as</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> local fid fid=$(make_large_for_striping $f) [ $? != 0 ] &amp;&amp; skip <span class="code-quote">"not enough free space"</span> &amp;&amp; <span class="code-keyword">return</span> </pre> </div></div> <p>then it will work as intended.</p> <p>From the Google Bash Style Guide "Declaration and assignment must be separate statements when the assignment value is provided by a command substitution; as the 'local' builtin does not propagate the exit code from the command substitution."</p> LU-6056

sanity-hsm uses bash's local built-in incorrectly

Bug Minor Resolved Fixed Bruno Faccini John Hammond hsm tests Fri, 19 Dec 2014 17:13:06 +0000 Fri, 5 Jun 2015 00:33:06 +0000 Fri, 16 Jan 2015 18:29:21 +0000 Lustre 2.7.0 Lustre 2.7.0 0 5 <p>Faccini Bruno (bruno.faccini@intel.com) uploaded a new patch: <a href="http://review.whamcloud.com/13159" class="external-link" target="_blank" rel="nofollow noopener">http://review.whamcloud.com/13159</a><br/> Subject: <a href="https://jira.whamcloud.com/browse/LU-6056" title="sanity-hsm uses bash&#39;s local built-in incorrectly" class="issue-link" data-issue-key="LU-6056"><del>LU-6056</del></a> tests: fix -hsm wrong usage of bash's local built-in<br/> Project: fs/lustre-release<br/> Branch: master<br/> Current Patch Set: 1<br/> Commit: 7e729e909e24b77dfc5e8dc1ef4a9dabd34cccc7</p> <p>Wow, thanks to have found this John!<br/> Since I am guilty to have written the specific code snippet shown in your submission text, with my recent patch for <a href="https://jira.whamcloud.com/browse/LU-3852" title="sanity-hsm test_251: client26-vm &quot;dd: no space left on device&quot;" class="issue-link" data-issue-key="LU-3852"><del>LU-3852</del></a>, I have just pushed patch at <a href="http://review.whamcloud.com/13159" class="external-link" target="_blank" rel="nofollow noopener">http://review.whamcloud.com/13159</a> to fix this, as you have indicated, in sanity-hsm script where I have found a few more occurrences (only by searching for the '$?' pattern and identifying if associated command was used in a 'local' assignment) in addition to mine.<br/> Concerning the other possible occurrences of such bug in our other scripts and since it does not look really easy to be automatically detected, I have a question, did you find it just by reading the script or have used some code browser/tool that could also be widely run on all our scripts?</p> <p>&gt; Concerning the other possible occurrences of such bug in our other scripts and since it does not look really easy to be automatically detected, I have a question, did you find it just by reading the script or have used some code browser/tool that could also be widely run on all our scripts?</p> <p>I only noticed because (while running locally) I could see that make_large_for_cancel() was failing but that the [ $? != 0 ] test was not detecting the failure. This reminded me of the strange behavior of local.</p> <p>About auditing the other scripts, maybe something like the following could be used:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">awk ' /local/ { last_local_nr = NR; last_local_line = $0; } /\$\?/ { <span class="code-keyword">if</span> (last_local_nr == NR - 1) { printf <span class="code-quote">"%4d:%s\n"</span>, last_local_nr, last_local_line printf <span class="code-quote">"%4d:%s\n"</span>, NR, $0; printf <span class="code-quote">"----\n"</span> } } ' lustre/tests/sanity-hsm.sh </pre> </div></div> <p>Obviously it doesn't catch everything.</p> <div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent"> <pre> 535: local st=$($LFS hsm_state $f) 536: [[ $? == 0 ]] || error "$LFS hsm_state $f failed" ---- 1155: local fid=$(make_large_for_striping $f) 1156: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 2032: local fid=$(make_large_for_progress $f) 2033: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 2071: local fid=$(make_large_for_progress $f) 2072: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 2092: local fid=$(make_large_for_progress $f) 2093: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 2272: local fid=$(make_large_for_progress $f) 2273: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 2295: local fid=$(make_large_for_progress_aligned $f) 2296: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 2318: local fid=$(make_large_for_progress $f) 2319: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 2384: local fid=$(make_large_for_progress $f) 2385: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 2419: local fid=$(make_large_for_progress $f) 2420: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 2457: local fid=$(make_large_for_progress $f) 2458: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 2652: local fid=$(make_large_for_progress $f) 2653: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 2775: local fid=$(make_large_for_progress $f) 2776: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 2883: local fid=$(make_large_for_progress $f) 2884: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 3160: local fid=$(make_large_for_progress $f) 3161: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 3473: local fid=$(make_large_for_cancel $f) 3474: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 3516: local fid=$(make_large_for_progress $f) 3517: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 3563: local fid=$(make_large_for_cancel $f) 3564: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 3671: local fid=$(make_large_for_progress $f) 3672: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 3732: local fid=$(make_large_for_progress $f) 3733: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- 3936: local fid=$(make_large_for_cancel $f) 3937: [ $? != 0 ] &amp;&amp; skip "not enough free space" &amp;&amp; return ---- </pre> </div></div> <p>Oleg Drokin (oleg.drokin@intel.com) merged in patch <a href="http://review.whamcloud.com/13159/" class="external-link" target="_blank" rel="nofollow noopener">http://review.whamcloud.com/13159/</a><br/> Subject: <a href="https://jira.whamcloud.com/browse/LU-6056" title="sanity-hsm uses bash&#39;s local built-in incorrectly" class="issue-link" data-issue-key="LU-6056"><del>LU-6056</del></a> tests: fix -hsm wrong usage of bash's local built-in<br/> Project: fs/lustre-release<br/> Branch: master<br/> Current Patch Set: <br/> Commit: 37145b39ecc2bd78e669f962ec6cfe7cebb06c5c</p> <p>Oops, just discovered that my change title had a typo, missing the "sanity" pattern in front of "-hsm" ...<br/> John, do you agree that we can close this ticket now?</p> <p>&gt; John, do you agree that we can close this ticket now?</p> <p>Yes.</p> <p>Patch landed to Master.</p> Development Rank 1|hzx2wf: Rank (Obsolete) 16868 Severity