Shellcheck and various other oddities #15

StaticRocket · 2024-03-10T04:15:56Z

Waste a Saturday fixing shellcheck warnings.

I've got another series in progress that reworks the patch logic since the application process is the same no matter what path is taken. Unfortunately I got distracted trying to simplify the current argument parsing as that's a little odd.

Eventually I'll see if I can integrate my common entrypoint script to cut out the image generation segment in kp_common.

Argument to -z is always false due to literal strings. Signed-off-by: Randolph Sapp <[email protected]>

Using "$@" will prevent unnecessary splitting of quoted parameters. For instance, if the following parameter was passed previously: "-a 'hello world'" it would be split into "-a" "hello" "world" which could break things later in processing. The kernel_patch_verify script will have to be reworked to deal with this independently as a lot of functions inherently rely on splitting for handling arrays. Signed-off-by: Randolph Sapp <[email protected]>

Paths mentioned in the `PATH` env variable should not end with `/`. Signed-off-by: Randolph Sapp <[email protected]>

Fix shellcheck warning about word splitting by making the split explicit. Signed-off-by: Randolph Sapp <[email protected]>

Signed-off-by: Randolph Sapp <[email protected]>

Use $(...) notation instead of legacy backticks `...`. Signed-off-by: Randolph Sapp <[email protected]>

Signed-off-by: Randolph Sapp <[email protected]>

Split the current `download_and_install_armgcc` function into a `download_and_install_armgcc_64` and `download_and_install_armgcc_32`. Signed-off-by: Randolph Sapp <[email protected]>

Standardize all functions on the use of FILE and URL variables. Signed-off-by: Randolph Sapp <[email protected]>

Signed-off-by: Randolph Sapp <[email protected]>

Paths mentioned in the `PATH` env variable should not end with `/`. Signed-off-by: Randolph Sapp <[email protected]>

Use $(...) notation instead of legacy backticks `...`. Signed-off-by: Randolph Sapp <[email protected]>

Fix word splitting issues that may arrise from docker mount parameters and other variables. Signed-off-by: Randolph Sapp <[email protected]>

Split the common code out into a file both scripts source. Signed-off-by: Randolph Sapp <[email protected]>

Prefer [ p ] && [ q ] as [ p -a q ] is not well defined. Signed-off-by: Randolph Sapp <[email protected]>

Prefer [ p ] || [ q ] as [ p -o q ] is not well defined. Signed-off-by: Randolph Sapp <[email protected]>

Use $(...) notation instead of legacy backticks `...`. Also fix the arithmetic sections. Signed-off-by: Randolph Sapp <[email protected]>

Check exit code directly with e.g. 'if ! mycmd;', not indirectly with $?. Signed-off-by: Randolph Sapp <[email protected]>

Use printf and some short templates to remove some redundant sections. Signed-off-by: Randolph Sapp <[email protected]>

Use static strings for the grep expressions not using variables. Make sure some reserved characters are escaped properly. Signed-off-by: Randolph Sapp <[email protected]>

These instances of subshell execution have ((, which is the starting parameter for arithmetic operations. Make sure everything's padded well enough to prevent misinterpretation. Shells disambiguate (( differently or not at all. For subshell, add spaces around ( . For ((, fix parsing errors. Signed-off-by: Randolph Sapp <[email protected]>

Use glob instead of ls and print the files we get from that instead of attempting to reindexing them. Signed-off-by: Randolph Sapp <[email protected]>

I know right now docker ignores "-v : " but I do not want to see what happens if this ever changes. Besides, we can't do anything if we're not working in a git directory anyway. Signed-off-by: Randolph Sapp <[email protected]>

This just pruned stopped containers and dangling images before removing the built container. Use the official commands for these operations. Signed-off-by: Randolph Sapp <[email protected]>

Quote everything currently not relying on word splitting. Signed-off-by: Randolph Sapp <[email protected]>

Implied that the script exits 0 by default. With this shellcheck considers some of the code unreachable. Drop it so we can check on things. Signed-off-by: Randolph Sapp <[email protected]>

Replace all of the loose parameter passing with strict array packing and unpacking. Signed-off-by: Randolph Sapp <[email protected]>

To redirect stdout+stderr, 2>&1 must be last Signed-off-by: Randolph Sapp <[email protected]>

Cat is really only good for concatenating files. If we only want to read files we can use bash and printf directly. More keystrokes but faster at runtime than cat. Signed-off-by: Randolph Sapp <[email protected]>

Use -print0 and -0 when piping from find into xargs. Signed-off-by: Randolph Sapp <[email protected]>

Avoid x-prefix in comparisons as it no longer serves a purpose. Signed-off-by: Randolph Sapp <[email protected]>

egrep is non-standard and deprecated. Use grep -E instead. Signed-off-by: Randolph Sapp <[email protected]>

Reduce the number of redirects with subshell execution. Signed-off-by: Randolph Sapp <[email protected]>

Read without -r will mangle backslashes. We don't have to let wc count characters in a variable. Signed-off-by: Randolph Sapp <[email protected]>

StaticRocket · 2024-03-15T04:22:38Z

I'd like to thank the Ballmer Peak for this hellish PR. Have fun!

StaticRocket · 2024-03-18T03:17:59Z

Got 3 more planned reworks for this tool after this series:

Use my auto id remap entrypoint that's podman compliant as well as docker compliant. Scrap the current logic for creating and deleting that new tag that's currently used to achieve the same thing.
Tweak the compose file to mitigate committed files for each step
Move the tool building logic into the Dockerfile directly, or use a bind mount to prevent the build scripts from being committed

StaticRocket added 30 commits March 14, 2024 21:52

kps/kpv: fix ccache conditional logic

d849e9c

Argument to -z is always false due to literal strings. Signed-off-by: Randolph Sapp <[email protected]>

99-compiler-path: fix path variables

26c3840

Paths mentioned in the `PATH` env variable should not end with `/`. Signed-off-by: Randolph Sapp <[email protected]>

build-env: fix ARIA_OPTS word splitting

7b22825

Fix shellcheck warning about word splitting by making the split explicit. Signed-off-by: Randolph Sapp <[email protected]>

build-env: quote NPROC to silence shellcheck

1f74d4c

Signed-off-by: Randolph Sapp <[email protected]>

build-env: use $(...) for NPROC

9c2dc40

Use $(...) notation instead of legacy backticks `...`. Signed-off-by: Randolph Sapp <[email protected]>

build-env: use local keyword for function variables

cbae104

Signed-off-by: Randolph Sapp <[email protected]>

build-env: split the armgcc install for 32 and 64 bit

04f4b78

Split the current `download_and_install_armgcc` function into a `download_and_install_armgcc_64` and `download_and_install_armgcc_32`. Signed-off-by: Randolph Sapp <[email protected]>

build-env: standardize use of FILE and URL

93d90f7

Standardize all functions on the use of FILE and URL variables. Signed-off-by: Randolph Sapp <[email protected]>

build-env: factor out common git code

af725ce

Signed-off-by: Randolph Sapp <[email protected]>

kpv: fix PATH variable setting

6a854e9

Paths mentioned in the `PATH` env variable should not end with `/`. Signed-off-by: Randolph Sapp <[email protected]>

kpv: use $(...) to appease shellcheck

00c15b6

Use $(...) notation instead of legacy backticks `...`. Signed-off-by: Randolph Sapp <[email protected]>

kpv: fix word splitting issues

7370143

Fix word splitting issues that may arrise from docker mount parameters and other variables. Signed-off-by: Randolph Sapp <[email protected]>

kpv/kps: factor out common code

15452e3

Split the common code out into a file both scripts source. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: replace '-a' test calls with '&&'

4069ec5

Prefer [ p ] && [ q ] as [ p -a q ] is not well defined. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: use || instead of [ -o ]

24c7314

Prefer [ p ] || [ q ] as [ p -o q ] is not well defined. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: use $(...) to appease shellcheck

20a12ae

Use $(...) notation instead of legacy backticks `...`. Also fix the arithmetic sections. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: check command exit code directly

208ebfe

Check exit code directly with e.g. 'if ! mycmd;', not indirectly with $?. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: rework the usage section

1664d2e

Use printf and some short templates to remove some redundant sections. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: tweak grep strings

1aed026

Use static strings for the grep expressions not using variables. Make sure some reserved characters are escaped properly. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: standardize patches logic

e1895b3

Use glob instead of ls and print the files we get from that instead of attempting to reindexing them. Signed-off-by: Randolph Sapp <[email protected]>

kp_common: fix worktree mount logic

7cd042e

I know right now docker ignores "-v : " but I do not want to see what happens if this ever changes. Besides, we can't do anything if we're not working in a git directory anyway. Signed-off-by: Randolph Sapp <[email protected]>

Makefile: fixup the clean target

f028394

This just pruned stopped containers and dangling images before removing the built container. Use the official commands for these operations. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: quote damn near everything

eeac60b

Quote everything currently not relying on word splitting. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: remove final exit

70f71cf

Implied that the script exits 0 by default. With this shellcheck considers some of the code unreachable. Drop it so we can check on things. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: arrays son

c9995c7

Replace all of the loose parameter passing with strict array packing and unpacking. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: move 2>&1 to end of line

5e76a84

To redirect stdout+stderr, 2>&1 must be last Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: eliminate useless cats

a9807b3

Cat is really only good for concatenating files. If we only want to read files we can use bash and printf directly. More keystrokes but faster at runtime than cat. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: use print0 when piping into xargs

5f6c241

Use -print0 and -0 when piping from find into xargs. Signed-off-by: Randolph Sapp <[email protected]>

StaticRocket added 4 commits March 14, 2024 23:03

kernel_patch_verify: remove x-prefix in comparison

5f82940

Avoid x-prefix in comparisons as it no longer serves a purpose. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: replace egrep with grep -E

54b0321

egrep is non-standard and deprecated. Use grep -E instead. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: reduce redirects with subshell

d91009d

Reduce the number of redirects with subshell execution. Signed-off-by: Randolph Sapp <[email protected]>

kernel_patch_verify: add -r to read, use var count

7c3f06a

Read without -r will mangle backslashes. We don't have to let wc count characters in a variable. Signed-off-by: Randolph Sapp <[email protected]>

StaticRocket force-pushed the shellcheck branch from 750b693 to 7c3f06a Compare March 15, 2024 04:20

nmenon merged commit 39bdedb into nmenon:master Mar 19, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Shellcheck and various other oddities #15

Shellcheck and various other oddities #15

StaticRocket commented Mar 10, 2024 •

edited

Loading

StaticRocket commented Mar 15, 2024

StaticRocket commented Mar 18, 2024

Shellcheck and various other oddities #15

Shellcheck and various other oddities #15

Conversation

StaticRocket commented Mar 10, 2024 • edited Loading

StaticRocket commented Mar 15, 2024

StaticRocket commented Mar 18, 2024

StaticRocket commented Mar 10, 2024 •

edited

Loading