Skip to contentSkip to conversation

Using shellcheck for shell make check

RFC Petr Vorel 3 participants 4 messages Nov 29, 2021 – Nov 30, 2021

lore
Share & tools
lore

Petr Vorel

author
#0 lore raw

Hi,

checkbashisms does not detect all things: e.g. not catching {1..$FILE_COUNT} [1]. Maybe we should reconsider using *also* shellcheck as Joerg suggested (keep checkbashisms).

I don't like shellcheck output, but it can detects errors checkbashisms cannot detect (checkbashisms is regexp based, but shellcheck IMHO evaluates the code). Also it's configurable, thus ve could disable check we don't like or enable only what we want to check. Or we can run just --severity=warning or --severity=error. If you're not against it, I can have look into this.

Kind regards,
Petr

[1] https://lore.kernel.org/ltp/YZy5HNteJmoicTtJ@pevik/

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
#1 lore raw

Hi!

Quoted 9 lines

checkbashisms does not detect all things: e.g. not catching {1..$FILE_COUNT} [1]. Maybe we should reconsider using *also* shellcheck as Joerg suggested (keep checkbashisms).

I don't like shellcheck output, but it can detects errors checkbashisms cannot detect (checkbashisms is regexp based, but shellcheck IMHO evaluates the code). Also it's configurable, thus ve could disable check we don't like or enable only what we want to check. Or we can run just --severity=warning or --severity=error. If you're not against it, I can have look into this.

Sounds good, the more automated checks we have the less we will spend on review...

Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#2 lore raw

Hello,

Quoted 5 lines · Cyril Hrubis

Hi!

Quoted 4 lines

checkbashisms does not detect all things: e.g. not catching {1..$FILE_COUNT} [1]. Maybe we should reconsider using *also* shellcheck as Joerg suggested (keep checkbashisms).

Quoted 8 lines
Quoted 5 lines

I don't like shellcheck output, but it can detects errors checkbashisms cannot detect (checkbashisms is regexp based, but shellcheck IMHO evaluates the code). Also it's configurable, thus ve could disable check we don't like or enable only what we want to check. Or we can run just --severity=warning or --severity=error. If you're not against it, I can have look into this.

Sounds good, the more automated checks we have the less we will spend on review...

We can't vendor in a Haskell program, so it will have to be an optional check. Still it looks nice.

Tree-sitter also supports "Bash", which might be useful for LTP specific checks. That ofcourse is much higher hanging fruit.

Signature · 5 lines
Thank you,
Richard.

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
author
#3 lore raw

Hi Richie, Cyril,

Quoted 15 lines

Hello,

Quoted 10 lines · Cyril Hrubis

Hi!

Quoted 9 lines

checkbashisms does not detect all things: e.g. not catching {1..$FILE_COUNT} [1]. Maybe we should reconsider using *also* shellcheck as Joerg suggested (keep checkbashisms).

I don't like shellcheck output, but it can detects errors checkbashisms cannot detect (checkbashisms is regexp based, but shellcheck IMHO evaluates the code). Also it's configurable, thus ve could disable check we don't like or enable only what we want to check. Or we can run just --severity=warning or --severity=error. If you're not against it, I can have look into this.

Quoted 5 lines
Quoted 2 lines

Sounds good, the more automated checks we have the less we will spend on review...

We can't vendor in a Haskell program, so it will have to be an optional check. Still it looks nice.

Yes, I didn't plan to vendor it. But fortunately it's being packaged some of major distros [1] [2].

Quoted 2 lines

Tree-sitter also supports "Bash", which might be useful for LTP specific checks. That ofcourse is much higher hanging fruit.

Interesting, it might be worth to investigate. But yes, the most important goal is IMHO have valid portable POSIX syntax (to catch errors checkbashisms does not detect).

I'd have to think about LTP specific checks (the only I would come up now is LTP-003 - shell library API have TST_ prefix" but not sure how to test naming of shell API as any shell global variables are local).

Kind regards,
Petr

[1] https://pkgs.org/download/ShellCheck
[2] https://pkgs.org/download/shellcheck

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp